https://github.com/davydovanton/web_bouncer
Simple and module auth lib for any rack projects
https://github.com/davydovanton/web_bouncer
Last synced: 16 days ago
JSON representation
Simple and module auth lib for any rack projects
- Host: GitHub
- URL: https://github.com/davydovanton/web_bouncer
- Owner: davydovanton
- License: mit
- Created: 2017-04-07T23:14:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-15T17:11:58.000Z (over 6 years ago)
- Last Synced: 2025-05-21T10:25:55.607Z (about 1 month ago)
- Language: Ruby
- Homepage:
- Size: 33.2 KB
- Stars: 16
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# WebBouncer
> **A bouncer** is the first face you see when entering a bar, pub, or night club, and how they treat you often sets the mood for the night. they make sure everyone who enters the establishment is of legal drinking age, not overly intoxicated, dressed according the the bars dresscode, not carying any weapons or drugs ([urbandictionary.com](http://www.urbandictionary.com/define.php?term=bouncer)).
In this project, I try to build simple and module auth lib for **any** rack projects.
**Important:** Now it's just a prototype.
## Goals
In Ruby, we have many different auth libs, but each project has one of the shortcomings:
* hard for customization
* works only with rails
* doesn't have documentation or examples of usage
That's why I want to try to build simple and lightweight "auth framework" with the following principles:
### Don't reinvent a wheel
Use only existed solution like OAuth, warden, rodauth or jwt.
### simple and lightweight
If you want to use default logic just use it. If you want to write custom logic you will have an easy way for this.
### Modularity
Ruby has many awesome web frameworks like Rails, hanami, Sinatra, roda, grape, etc. I want to build the solution for all of this. Also if you need to use only oauth or jwt - use only this.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'web_bouncer'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install web_bouncer
## Usage
### Base
Add `WebBouncer` and `Rack::Session` middlewares to your `config.ru`:
```ruby
# config.ru
require 'web_bouncer'
require "web_bouncer/oauth_middleware"
use Rack::Session::Cookie, secret: ENV['SESSIONS_SECRET']
use WebBouncer['middleware.oauth']
run Hanami.app
```
#### Configurable
You can set specific options for you auth middleware. We use configuration without a global state, that's why you need to create config hash and pass it to middleware:
```ruby
# config.ru
require 'web_bouncer'
require "web_bouncer/oauth_middleware"
config = {
model: :account,
login_redirect: '/admin',
logout_redirect: '/'
}
use Rack::Session::Cookie, secret: ENV['WEB_SESSIONS_SECRET']
use WebBouncer['middleware.oauth'], config
run Hanami.app
```
Now we support following options:
* `model` - auth model name. Default: `:account`
* `login_redirect` - path for redirect after login. Default: `'/'`
* `logout_redirect` - path for redirect after logout. Default: `'/'`
* `failure_redirect` - path for redirect after failure Default: `'/'`
#### Controller Helpers
All helpers like `#authenticate!` or `#authenticated?` you can find in `authentication` container.
##### How to use it with Hanami
Add this helper to `application.rb` config file:
```ruby
# apps/app_name/application.rb
require 'web_bouncer/authentication'
# ...
controller.prepare do
include WebBouncer['authentication']
end
```
### OAuth
First of all setup your OAuth app:
```ruby
# config.ru
use OmniAuth::Builder do
provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET'], provider_ignores_state: true
end
```
If you want to define custom oauth actions, you need to use dry-containers. For this, you redefine container with an object which has `#call` methods (proc, class, etc.). After, you need to return success or failure monad. For example:
```ruby
# lib/auth/oauth/github_callback.rb
class GithubCallback < WebBouncer::OauthCallback
def call(oauth_response)
login = oauth_response['extra']['raw_info']['login']
if settings[:repository].find(login)
Success(login)
else
Failure(:not_found)
end
end
end
# lib/auth/oauth_container.rb
class WebBouncer::OauthContainer
register 'oauth.github_callback', GithubCallback
register 'oauth.facebook_callback' do |settings, oauth_response|
email = oauth_response['email']
if settings[:model].find(login)
Success(login)
else
Failure(:not_found)
end
end
end
```
Now, when you call `/auth/github` you'll create github account and set it to `env` variable. If you call `/auth/facebook` you'll get a error and that's all. If you call different provider you'll call base oauth action.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).