Skip to content

Latest commit

 

History

History
269 lines (205 loc) · 8.37 KB

README.md

File metadata and controls

269 lines (205 loc) · 8.37 KB
Raw

WineBouncer

Build Status Code Climate Gem Version

Protect your precious Grape API with Doorkeeper. WineBouncer uses minimal modification, to make the magic happen.

Table of Contents

Requirements

  • Ruby > 1.9.3
  • Doorkeeper > 1.4.0 and =< 2.0.1
  • Grape > 0.8

Installation

Add this line to your application's Gemfile:

gem 'wine_bouncer'

And then execute:

bundle

Upgrading

When upgrading from a previous version, see UPGRADING. You might also be interested at the CHANGELOG.

Usage

WineBouncer is a custom Grape Middleware used for Authentication and Authorization. We assume you have a Grape API mounted in your Rails application together with Doorkeeper.

To get started with WineBouncer, run the configuration initializer:

$ rails g wine_bouncer:initializer

This creates a rails initializer in your Rails app at config/initializers/wine_bouncer.rb with the following configuration:

WineBouncer.configure do |config|
  config.auth_strategy = :default

  config.define_resource_owner do
    User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
  end
end

Then register WineBouncer as Grape middleware in your Grape API.

class Api < Grape::API
   default_format :json
   format :json
   use ::WineBouncer::OAuth2
   mount YourAwesomeApi
end

WineBouncer relies on Grape's endpoint method description to define if an endpoint method should be protected. It comes with authorization strategies that allow a custom format for your authorization definition. Pick an authentication strategy to get started. Currently the following strategies are included:

Authentication strategies

Default

The default strategy uses the auth: key in the description options hash to define API method authentication. It accepts an hash with options. Currently the only option is for scopes which is an array of scopes for authorization. WineBouncer uses the default Doorkeeper behaviour for scopes.

Example:

 class MyAwesomeAPI < Grape::API
    desc 'protected method with required public scope',
    auth: { scopes: ['public'] }
    get '/protected' do
       { hello: 'world' }
    end

    desc 'Unprotected method'
    get '/unprotected' do
      { hello: 'unprotected world' }
    end

    desc 'This method needs the public or private scope.',
    auth: { scopes: [ 'public', 'private' ] }
    get '/method' do
      { hello: 'public or private user.' }
    end

    desc 'This method uses Doorkeepers default scopes.',
    auth: { scopes: [] }
    get '/protected_with_default_scope' do
       { hello: 'protected unscoped world' }
    end
 end

 class Api < Grape::API
    default_format :json
    format :json
    use ::WineBouncer::OAuth2
    mount MyAwesomeAPI
    add_swagger_documentation
 end

Swagger

WineBouncer comes with a strategy that can be perfectly used with grape-swagger with a syntax compliant with the swagger spec. This might be one of the simplest methods to protect your API and serve it with documentation. You can use swagger-ui to view your documentation.

To get started ensure you also have included the grape-swagger gem in your gemfile.

Run bundle to install the missing gems.

Create a rails initializer in your Rails app at config/initializers/wine_bouncer.rb with the following configuration.

WineBouncer.configure do |config|
    config.auth_strategy = :swagger

    config.define_resource_owner do
            User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
    end
end

Then you can start documenting and protecting your API like the example below.

class MyAwesomeAPI < Grape::API
   desc 'protected method with required public scope',
   authorizations: { oauth2: [{ scope: 'public' }] }
   get '/protected' do
      { hello: 'world' }
   end

   desc 'Unprotected method'
   get '/unprotected' do
     { hello: 'unprotected world' }
   end

   desc 'This method uses Doorkeepers default scopes.',
   authorizations: { oauth2: [] }
   get '/protected_with_default_scope' do
      { hello: 'protected unscoped world' }
   end

   desc 'It even works with other options!',
   authorizations: { oauth2: [] },
   :entity => Api::Entities::Response,
   http_codes: [
       [200, 'OK', Api::Entities::Response],
       [401, 'Unauthorized', Api::Entities::Error],
       [403, 'Forbidden', Api::Entities::Error]
   ],
   :notes => <<-NOTE
   Marked down notes!
   NOTE
   get '/extended_api' do
      { hello: 'Awesome world' }
   end
end

class Api < Grape::API
   default_format :json
   format :json
   use ::WineBouncer::OAuth2
   mount MyAwesomeAPI
   add_swagger_documentation
end

The Swagger strategy uses the authorizations: { oauth2: [] } in the method description syntax to define API method authentication and authorization. It defaults assumes when no description is given that no authorization should be used like the /unprotected method. When the authentication syntax is mentioned in the method description, the method will be protected. You can use the default scopes of Doorkeeper by just adding authorizations: { oauth2: [] } or state your own scopes with authorizations: { oauth2: [ { scope: 'scope1' }, { scope: 'scope2' }, ... ] }.

Protected

The protected strategy is very similiar to the default strategy except any public end point must explicitly set. To make an end point public, use auth: false. If the authorization is not set, the end point is assumed to be protected and Doorkeeper's default scopes are used.

Example:

 class MyAwesomeAPI < Grape::API
    desc 'protected method with required public scope', 
    auth: { scopes: ['public'] }
    get '/protected' do
       { hello: 'world' }
    end
    
    desc 'Unprotected method'
    get '/unprotected', auth: false do
      { hello: 'unprotected world' }
    end
    
    desc 'This method needs the public or private scope.',
    auth: [:public, :private]
    # Doorkeeper's default scopes are [:public, :private] so auth can be omitted. See next example.
    get '/method' do
      { hello: 'public or private user.' }
    end
    
    desc 'This method uses Doorkeepers default scopes.'
    get '/protected_with_default_scope' do
       { hello: 'protected unscoped world' }
    end
 end
 
 class Api < Grape::API
    default_format :json
    format :json
    use ::WineBouncer::OAuth2
    mount MyAwesomeAPI
    add_swagger_documentation
 end

Token information

WineBouncer comes with free extras! Methods for resource_owner and doorkeeper_access_token get included in your endpoints. You can use them to get the current resource owner, and the access_token object of doorkeeper.

Exceptions and Exception handling

This gem raises the following exceptions which can be handled in your Grape API, see Grape documentation.

  • WineBouncer::Errors::OAuthUnauthorizedError when the request is unauthorized.
  • WineBouncer::Errors::OAuthForbiddenError when the token is found but scopes do not match.

Development

Since we want the gem tested against several rails versions we use the same way to prepare our development environment as Doorkeeper.

To install the development environment for rails 3.2.18, you can also specify a different rails version to test against.

rails=3.2.18 bundle install

To run the specs.

rails=3.2.18 bundle exec rake

Contributing

For contributing to the gem see CONTRIBUTING.