wine_bouncer 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c16d471f3bf4c00fc8aabb999f0225071ba3e199
-  data.tar.gz: 2e6c872a709af181da9c42d19394da0e01a0db29
+  metadata.gz: e08374333bc4fe68a78e7f177b74179d550ddba2
+  data.tar.gz: e9e635c0d5f531108e3bf39dbfb847a4eab71ddf
 SHA512:
-  metadata.gz: aeee07c8f60e126290e75e311abc94ed2086640dd39a0f2e128775e83b6168d31d5e064e0f826f992409071cb5bb2f60624509d1ba14fb7f04b68e8947d041f8
-  data.tar.gz: 47c5faa48f155eac4747f3f26caee1ef877157913f897e98821032311f14231b0d7634ceaa23a47da2402eaec02d9c8cae3b6ee82ae5f2437e9c2fd7ec656899
+  metadata.gz: 3fbecb2d1db85e84b23f059d5a73bd9313c8cb73c259797bc7e78bd06694ed80ac3dee5e295b1fc15373bcdc39587f1a470cade1e9533698ba8c261a450e680e
+  data.tar.gz: b3060def1967e6361ca3c8a174c97face42dacd6821288dc2206cb7b678d9a8d4aa0f5732a63a8dd913052ec9d832d395f8940f2200106bae34e7801b10db098

data/.travis.yml

@@ -6,19 +6,16 @@ rvm:
   - 1.9.3
   - 2.0
   - 2.1
-  - 2.2
 env:
-  - rails=3.2.18 grape=0.8.0
-  - rails=4.1.1 grape=0.8.0
-  - rails=3.2.18 grape=0.9.0 doorkeeper=1.4.1
   - rails=3.2.18 grape=0.9.0
-  - rails=4.1.1 grape=0.9.0 doorkeeper=1.4.1
   - rails=4.1.1 grape=0.9.0
+  - rails=3.2.18 grape=0.10.0
+  - rails=4.1.1 grape=0.10.0 doorkeeper=1.4.1
+  - rails=4.1.1 grape=0.10.0
+  - rails=4.1.1 grape=0.11.0 doorkeeper=2.1.1
 matrix:
   allow_failures:
-    - env: rails=3.2.18 grape=0.8.0
-    - env: rails=3.2.18 grape=0.9.0 doorkeeper=1.4.1
-    - env: rails=3.2.18 grape=0.9.0
+    - rvm: 1.9.3
 addons:
   code_climate:
     repo_token: ab1b6ce5f973da033f80ae2e99fadbb32b2f9c37892703956d8ef954c8e8134e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 Changelog
 =========
+
+## 0.3.0
+[#21](https://github.com/antek-drzewiecki/wine_bouncer/pull/21): Added an Easy DSL for WineBouncer. Thanks @masarakki .
+[#23](https://github.com/antek-drzewiecki/wine_bouncer/pull/23): Added support for Doorkeeper 2.1.1 and refactored strategies.
+
 ## 0.2.2
 *[#17](https://github.com/antek-drzewiecki/wine_bouncer/pull/17): Added a new protected strategy. Thanks @whatasunnyday .
 

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ENV['grape'] ||= '0.9.0'
+ENV['grape'] ||= '0.10.0'
 ENV['rails'] ||= '4.1.1'
 ENV['doorkeeper'] ||= '2.0.1'
 

data/README.md

@@ -25,8 +25,8 @@ Table of Contents
 
 ## Requirements
 - Ruby > 1.9.3
-- Doorkeeper > 1.4.0 and =< 2.0.1
-- Grape > 0.8
+- Doorkeeper > 1.4.0 and =< 2.1.1
+- Grape > 0.8 and =< 0.11.0
 
 ## Installation
 
@@ -44,6 +44,7 @@ bundle
 
 ## Upgrading
 When upgrading from a previous version, see [UPGRADING](UPGRADING.md). You might also be interested at the [CHANGELOG](CHANGELOG.md).
+Note this is the last version that will support Grape 0.8 and 0.9. Grape 0.10 will be the next minimum Grape version.
 
 ## 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.
@@ -54,6 +55,7 @@ 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:
 
 ``` ruby
@@ -77,39 +79,37 @@ class Api < Grape::API
 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.
+### Easy DSL
 
-Example:
+WineBouncer comes with an easy DSL and relies on Grape's DSL extentions to define if an endpoint method should be protected.
+You can protect an endpoint by calling `oauth2` method with optional scopes in front of the endpoint definition.
 
 ``` ruby
  class MyAwesomeAPI < Grape::API
-    desc 'protected method with required public scope',
-    auth: { scopes: ['public'] }
+    desc 'protected method with required public scope'
+    oauth2 'public'
     get '/protected' do
        { hello: 'world' }
     end
 
+    oauth2 'public'
+    get '/with_no_description' do
+       { hello: 'undescribed 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' ] }
+    desc 'This method needs the public or private scope.'
+    oauth2 'public', 'write'
     get '/method' do
       { hello: 'public or private user.' }
     end
 
     desc 'This method uses Doorkeepers default scopes.',
-    auth: { scopes: [] }
+    oauth2
     get '/protected_with_default_scope' do
        { hello: 'protected unscoped world' }
     end
@@ -120,10 +120,15 @@ Example:
     format :json
     use ::WineBouncer::OAuth2
     mount MyAwesomeAPI
-    add_swagger_documentation
  end
 ```
 
+### Authentication strategies
+
+Behaviour of the authentication can be customized by selecting an authentication strategy. The following authentication strategies are provided in the gem.
+
+#### Default
+The default strategy only authenticates endpoints which are annotated by the `oauth2` method. Un-annotated endpoints still can be accessed without authentication.
 
 #### Swagger
 
@@ -146,98 +151,32 @@ WineBouncer.configure do |config|
 end
 ```
 
-Then you can start documenting and protecting your API like the example below.
+Then you can start protecting your API like the example below.
 
 ``` ruby
-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
+desc 'This method needs the public or private scope.',
+  :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
+oauth2 'public', 'write'
+get '/method' do
+  { hello: 'public or private user.' }
 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' }, ... ] }`.
+The Swagger strategy uses scopes and injects them in the authorizations description for external application to be read.
 
 #### 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`. 
+The protected strategy is very similar to the default strategy except any public end point must explicitly set. To make an end point public, use `oauth2: false`.
 If the authorization is not set, the end point is assumed to be protected and Doorkeeper's default scopes are used.
 
-Example:
-
-``` ruby
- 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
 

data/UPGRADING.md

@@ -1,6 +1,33 @@
 Upgrading WineBouncer
 =====================
 
+## Upgrading to >=  0.3.0
+
+An new DSL has been introduced to WineBouncer. This DSL will become the preferred way to authorize your endpoints.
+The authentication trough endpoint description will become deprecated in the future version.
+
+The old way to authorize your endpoints:
+
+```
+  desc 'protected method with required public and private scope',
+  auth: { scopes: ['public','private'] }
+  get '/protected' do
+     { hello: 'world' }
+  end
+```
+
+You may now write:
+```
+  desc 'protected method with required public and private scope'
+  oauth2 'public', 'private'
+  get '/protected' do
+     { hello: 'world' }
+  end
+```
+
+And even remove the description.
+
+Note this is the last version that will support Grape 0.8 and 0.9. Grape 0.10 will be the next minimum Grape version.
 
 ### Upgrading to >= 0.2.0
 
@@ -19,4 +46,4 @@ end
 The required Grape version is now from 0.8 and above.
 
 ------
-From version 0.1.0 upgrade instructions are given.
+From version 0.1.0 upgrade instructions are given.

data/lib/wine_bouncer.rb

@@ -4,7 +4,9 @@ require 'wine_bouncer/version'
 require 'wine_bouncer/errors'
 require 'wine_bouncer/configuration'
 require 'wine_bouncer/oauth2'
+require 'wine_bouncer/base_strategy'
 require 'wine_bouncer/auth_methods/auth_methods'
+require 'wine_bouncer/extension'
 
 module WineBouncer
 end

data/lib/wine_bouncer/auth_strategies/default.rb

@@ -1,27 +1,25 @@
 module WineBouncer
   module AuthStrategies
-    class Default
+    class Default < ::WineBouncer::BaseStrategy
 
-      def endpoint_protected?(context)
-        has_authorizations?(context)
+      def endpoint_protected?
+        !!endpoint_authorizations
       end
 
-      def has_auth_scopes?(context)
-        has_authorizations?(context) && endpoint_authorizations(context).has_key?(:scopes) && !endpoint_authorizations(context)[:scopes].empty?
+      def has_auth_scopes?
+        !!endpoint_authorizations &&
+            endpoint_authorizations.has_key?(:scopes) &&
+            !endpoint_authorizations[:scopes].empty?
       end
 
-      def auth_scopes(context)
-        endpoint_authorizations(context)[:scopes].map(&:to_sym)
+      def auth_scopes
+        endpoint_authorizations[:scopes].map(&:to_sym)
       end
 
       private
 
-      def has_authorizations?(context)
-        !!endpoint_authorizations(context)
-      end
-
-      def endpoint_authorizations(context)
-         context[:auth]
+      def endpoint_authorizations
+          api_context.options[:route_options][:auth]
       end
     end
   end

data/lib/wine_bouncer/auth_strategies/protected.rb

@@ -1,34 +1,34 @@
 module WineBouncer
   module AuthStrategies
-    class Protected
+    class Protected < WineBouncer::BaseStrategy
 
-      def endpoint_protected?(context)
-        has_authorizations?(context)
+      def endpoint_protected?
+        has_authorizations?
       end
 
-      def has_auth_scopes?(context)
-        endpoint_authorizations(context) && 
-          endpoint_authorizations(context).has_key?(:scopes) && 
-          endpoint_authorizations(context)[:scopes].any?
+      def has_auth_scopes?
+        endpoint_authorizations &&
+          endpoint_authorizations.has_key?(:scopes) &&
+          endpoint_authorizations[:scopes].any?
       end
 
-      def auth_scopes(context)
-        endpoint_authorizations(context)[:scopes].map(&:to_sym)
+      def auth_scopes
+        endpoint_authorizations[:scopes].map(&:to_sym)
       end
 
       private
 
-      def nil_authorizations?(context)
-        endpoint_authorizations(context).nil?
+      def nil_authorizations?
+        endpoint_authorizations.nil?
       end
 
 
-      def has_authorizations?(context)
-        nil_authorizations?(context) || endpoint_authorizations(context)
+      def has_authorizations?
+        nil_authorizations? || endpoint_authorizations
       end
 
-      def endpoint_authorizations(context)
-         context[:auth]
+      def endpoint_authorizations
+        api_context.options[:route_options][:auth]
       end
     end
   end

data/lib/wine_bouncer/auth_strategies/swagger.rb

@@ -1,33 +1,32 @@
 module WineBouncer
   module AuthStrategies
-    class Swagger
+    class Swagger < ::WineBouncer::BaseStrategy
 
-      def endpoint_protected?(context)
-        has_authorizations?(context) && !!authorization_type_oauth2(context)
+      def endpoint_protected?
+        has_authorizations? && !!authorization_type_oauth2
       end
 
-      def has_auth_scopes?(context)
-        endpoint_protected?(context) && !authorization_type_oauth2(context).empty?
+      def has_auth_scopes?
+        endpoint_protected? && !authorization_type_oauth2.empty?
       end
 
-      def auth_scopes(context)
-        authorization_type_oauth2(context).map{ |hash| hash[:scope].to_sym }
+      def auth_scopes
+        authorization_type_oauth2.map { |hash| hash[:scope].to_sym }
       end
 
       private
 
-      def has_authorizations?(context)
-        !!endpoint_authorizations(context)
+      def has_authorizations?
+        !!endpoint_authorizations
       end
 
-      def endpoint_authorizations(context)
-        context[:authorizations]
+      def endpoint_authorizations
+         api_context.options[:route_options][:authorizations]
       end
 
-      def authorization_type_oauth2(context)
-        endpoint_authorizations(context)[:oauth2]
+      def authorization_type_oauth2
+        endpoint_authorizations[:oauth2]
       end
-
     end
   end
 end

data/lib/wine_bouncer/base_strategy.rb

@@ -0,0 +1,5 @@
+module WineBouncer
+  class BaseStrategy
+    attr_accessor :api_context
+  end
+end

data/lib/wine_bouncer/extension.rb

@@ -0,0 +1,20 @@
+module WineBouncer
+  module Extension
+    def oauth2(*scopes)
+      scopes = Array(scopes)
+      description = if respond_to?(:route_setting) # >= grape-0.10.0
+        route_setting(:description)
+      else
+        @last_description ||= {}
+      end
+      # case WineBouncer.configuration.auth_strategy
+      # when :default
+      description[:auth] = { scope: scopes }
+      # when :swagger
+      description[:authorizations] = { oauth2: scopes.map{|x| {scope: x}} }
+      # end
+    end
+
+    Grape::API.extend self
+  end
+end

data/lib/wine_bouncer/oauth2.rb

@@ -44,22 +44,11 @@ module WineBouncer
     # Authorization control.
     ############
 
-    ###
-    # Returns true if the Api endpoint, method is configured as an protected method, false otherwise.
-    ###
-    def valid_route_context?
-      context && context.options && context.options[:route_options]
-    end
-
-    def route_context
-      context.options[:route_options]
-    end
-
     ###
     # returns true if the endpoint is protected, otherwise false
     ###
     def endpoint_protected?
-      auth_strategy.endpoint_protected?(route_context)
+      auth_strategy.endpoint_protected?
     end
 
     ###
@@ -67,8 +56,8 @@ module WineBouncer
     # [ nil ] if none, otherwise an array of [ :scopes ]
     ###
     def auth_scopes
-      return *nil unless auth_strategy.has_auth_scopes?(route_context)
-      auth_strategy.auth_scopes(route_context)
+      return *nil unless auth_strategy.has_auth_scopes?
+      auth_strategy.auth_scopes
     end
 
     ###
@@ -98,6 +87,7 @@ module WineBouncer
     ###
     def before
       set_auth_strategy(WineBouncer.configuration.auth_strategy)
+      auth_strategy.api_context = context
       #extend the context with auth methods.
       context.extend(WineBouncer::AuthMethods)
       context.protected_endpoint = endpoint_protected?

data/lib/wine_bouncer/version.rb

@@ -1,3 +1,3 @@
 module WineBouncer
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/spec/dummy/app/api/default_api.rb

@@ -24,10 +24,21 @@ module Api
       { hello: resource_owner.name }
     end
 
-    desc 'This method uses Doorkeepers default scopes', auth: { }
+    desc 'This method uses Doorkeepers default scopes', auth: {}
     get '/protected_without_scope' do
       { hello: 'protected unscoped world' }
     end
+
+    desc 'oauth2_dsl'
+    oauth2 'public'
+    get '/oauth2_dsl' do
+      { hello: 'oauth2_dsl' }
+    end
+
+    get '/not_described_world' do
+      { hello: 'non described world' }
+    end
+
   end
 
   class DefaultApiUnderTest < Grape::API
@@ -36,5 +47,5 @@ module Api
     use ::WineBouncer::OAuth2
     mount MountedDefaultApiUnderTest
   end
-
 end
+

data/spec/dummy/app/api/protected_api.rb

@@ -28,6 +28,16 @@ module Api
     get '/protected_without_scope' do
       { hello: 'protected unscoped world' }
     end
+
+    desc 'oauth2_dsl'
+    oauth2 'public'
+    get '/oauth2_dsl' do
+      { hello: 'oauth2_dsl' }
+    end
+
+    get '/not_described_world' do
+      { hello: 'non described world' }
+    end
   end
 
   class ProtectedApiUnderTest < Grape::API

data/spec/dummy/app/api/swagger_api.rb

@@ -28,6 +28,16 @@ module Api
     get '/protected_without_scope' do
       { hello: 'protected unscoped world' }
     end
+
+    desc 'oauth2 dsl'
+    oauth2 'public'
+    get '/oauth2_dsl' do
+      { hello: 'oauth2_dsl' }
+    end
+
+    get '/not_described_world' do
+      { hello: 'non described world' }
+    end
   end
 
   class SwaggerApiUnderTest < Grape::API

data/spec/intergration/oauth2_default_strategy_spec.rb

@@ -80,6 +80,33 @@ describe Api::MountedDefaultApiUnderTest, type: :api do
     end
   end
 
+  context 'oauth2_dsl' do
+    it 'allows to call an protected endpoint without scopes' do
+      get '/default_api/oauth2_dsl', nil, 'HTTP_AUTHORIZATION' => "Bearer #{token.token}"
+
+      expect(last_response.status).to eq(200)
+      json = JSON.parse(last_response.body)
+      expect(json).to have_key('hello')
+      expect(json['hello']).to eq('oauth2_dsl')
+
+    end
+
+    it 'raises an error when an protected endpoint without scopes is called without token ' do
+      expect { get '/default_api/oauth2_dsl' }.to raise_exception(WineBouncer::Errors::OAuthUnauthorizedError)
+    end
+  end
+
+
+  context 'not_described_world' do
+    it 'allows to call an endpoint without description' do
+      get '/default_api/not_described_world'
+      expect(last_response.status).to eq(200)
+      json = JSON.parse(last_response.body)
+      expect(json).to have_key('hello')
+      expect(json['hello']).to eq('non described world')
+    end
+  end
+
   context 'resource_owner' do
     it 'is available in the endpoint' do
       get '/default_api/protected_user', nil, 'HTTP_AUTHORIZATION' => "Bearer #{token.token}"
@@ -91,5 +118,4 @@ describe Api::MountedDefaultApiUnderTest, type: :api do
       expect(json['hello']).to eq(user.name)
     end
   end
-
 end

data/spec/intergration/oauth2_protected_strategy_spec.rb

@@ -83,6 +83,36 @@ describe Api::MountedProtectedApiUnderTest, type: :api do
     end
   end
 
+  context 'oauth2_dsl' do
+    it 'allows to call an protected endpoint without scopes' do
+      get '/protected_api/oauth2_dsl', nil, 'HTTP_AUTHORIZATION' => "Bearer #{token.token}"
+
+      expect(last_response.status).to eq(200)
+      json = JSON.parse(last_response.body)
+      expect(json).to have_key('hello')
+      expect(json['hello']).to eq('oauth2_dsl')
+
+    end
+
+    it 'raises an error when an protected endpoint without scopes is called without token ' do
+      expect { get '/protected_api/oauth2_dsl' }.to raise_exception(WineBouncer::Errors::OAuthUnauthorizedError)
+    end
+  end
+
+  context 'not_described_world' do
+    it 'authentication is required for a non described endpoint' do
+      get '/protected_api/not_described_world', nil, 'HTTP_AUTHORIZATION' => "Bearer #{token.token}"
+      expect(last_response.status).to eq(200)
+      json = JSON.parse(last_response.body)
+      expect(json).to have_key('hello')
+      expect(json['hello']).to eq('non described world')
+    end
+
+    it 'raises an error when an protected endpoint without scopes is called without token ' do
+      expect { get '/protected_api/not_described_world' }.to raise_exception(WineBouncer::Errors::OAuthUnauthorizedError)
+    end
+  end
+
   context 'resource_owner' do
     it 'is available in the endpoint' do
       get '/protected_api/protected_user', nil, 'HTTP_AUTHORIZATION' => "Bearer #{token.token}"

data/spec/intergration/oauth2_swagger_strategy_spec.rb

@@ -82,6 +82,32 @@ describe Api::MountedSwaggerApiUnderTest, type: :api do
     end
   end
 
+  context 'oauth2_dsl' do
+    it 'allows to call an protected endpoint without scopes' do
+      get '/swagger_api/oauth2_dsl', nil, 'HTTP_AUTHORIZATION' => "Bearer #{token.token}"
+
+      expect(last_response.status).to eq(200)
+      json = JSON.parse(last_response.body)
+      expect(json).to have_key('hello')
+      expect(json['hello']).to eq('oauth2_dsl')
+
+    end
+
+    it 'raises an error when an protected endpoint without scopes is called without token ' do
+      expect { get '/swagger_api/oauth2_dsl' }.to raise_exception(WineBouncer::Errors::OAuthUnauthorizedError)
+    end
+  end
+
+  context 'not_described_world' do
+    it 'allows to call an endpoint without description' do
+      get '/swagger_api/not_described_world'
+      expect(last_response.status).to eq(200)
+      json = JSON.parse(last_response.body)
+      expect(json).to have_key('hello')
+      expect(json['hello']).to eq('non described world')
+    end
+  end
+
   context 'resource_owner' do
     it 'is available in the endpoint' do
       get '/swagger_api/protected_user', nil, 'HTTP_AUTHORIZATION' => "Bearer #{token.token}"

data/spec/lib/wine_bouncer/auth_strategies/default_spec.rb

@@ -6,61 +6,71 @@ describe ::WineBouncer::AuthStrategies::Default do
 
   let(:scopes) { %w(public private) }
   let(:scopes_hash) { { scopes: scopes } }
-  let(:auth_context) { { auth: scopes_hash } }
+  let(:auth_context) { { route_options: { auth: scopes_hash } } }
 
 
   context 'endpoint_authorizations' do
     it 'returns the auth key of the authentication hash.' do
-      expect(klass.send(:endpoint_authorizations, auth_context)).to eq(scopes_hash)
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.send :endpoint_authorizations).to eq(scopes_hash)
     end
 
     it 'returns nil when the authentication key has no hash key.' do
-      invalid_hash = { some: scopes_hash }
-      expect(klass.send(:endpoint_authorizations, invalid_hash ) ).to eq(nil)
-    end
-  end
-
-  context 'has_authorizations?' do
-    it 'returns true when the context has the auth key.' do
-      expect(klass.send(:has_authorizations?, auth_context)).to eq(true)
-    end
-
-    it 'returns false when the context has no auth key.' do
-      invalid_hash = { some: scopes_hash }
-      expect(klass.send(:has_authorizations?, invalid_hash ) ).to eq(false)
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { some: scopes_hash } } }
+      klass.api_context = context_double
+      expect(klass.send :endpoint_authorizations).to eq(nil)
     end
   end
 
   context 'endpoint_protected?' do
     it 'returns true when the context has the auth key.' do
-      expect(klass.endpoint_protected?(auth_context)).to eq(true)
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.endpoint_protected?).to eq(true)
     end
 
     it 'returns false when the context has no auth key.' do
-      invalid_hash = { some: scopes }
-      expect(klass.endpoint_protected?( invalid_hash ) ).to eq(false)
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { some: scopes_hash } } }
+      klass.api_context = context_double
+      expect(klass.endpoint_protected?).to eq(false)
     end
   end
 
   context 'has_auth_scopes?' do
     it 'returns true when the context has the auth key.' do
-      expect(klass.has_auth_scopes?(auth_context)).to eq(true)
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.has_auth_scopes?).to eq(true)
     end
 
     it 'returns false when the context has no auth key.' do
-      invalid_hash = { some: scopes_hash }
-      expect(klass.has_auth_scopes?(invalid_hash) ).to eq(false)
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { some: scopes_hash } } }
+      klass.api_context = context_double
+      expect(klass.has_auth_scopes?).to eq(false)
     end
 
     it 'returns false when the auth scopes contain a blank scope array' do
-      blank_scopes = { auth: { scopes: [] } }
-      expect(klass.has_auth_scopes?(blank_scopes) ).to eq(false)
+
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { auth: { scopes: [] } } } }
+      klass.api_context = context_double
+      expect(klass.has_auth_scopes?).to eq(false)
     end
   end
 
   context 'auth_scopes' do
     it 'returns an array of scopes' do
-      expect(klass.auth_scopes(auth_context)).to eq([:public, :private])
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.auth_scopes).to eq([:public, :private])
     end
   end
 end

data/spec/lib/wine_bouncer/auth_strategies/swagger_spec.rb

@@ -0,0 +1,114 @@
+require 'rails_helper'
+require 'wine_bouncer/auth_strategies/swagger'
+
+describe ::WineBouncer::AuthStrategies::Swagger do
+  subject(:klass) { ::WineBouncer::AuthStrategies::Swagger.new }
+
+  let(:scopes) { [{ scope: 'private', description: 'anything' },{ scope: 'public', description: 'anything' }] }
+  let(:scopes_map) { { oauth2: scopes } }
+  let(:auth_context) { { route_options: { authorizations: scopes_map } } }
+
+
+  context 'endpoint_authorizations' do
+    it 'returns the auth key of the authentication hash.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.send :endpoint_authorizations).to eq(scopes_map)
+    end
+
+    it 'returns nil when the authentication key has no hash key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { some: scopes_map } } }
+      klass.api_context = context_double
+      expect(klass.send :endpoint_authorizations).to eq(nil)
+    end
+  end
+
+  context 'has_authorizations?' do
+    it 'returns true when it has an authentication hash.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.send :has_authorizations?).to eq(true)
+    end
+
+    it 'returns false when there is no authentication key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { some: scopes_map } } }
+      klass.api_context = context_double
+      expect(klass.send :has_authorizations?).to eq(false)
+    end
+  end
+
+  context 'authorization_type_oauth2' do
+    it 'returns the scopes.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.send :authorization_type_oauth2).to eq(scopes)
+    end
+
+    it 'returns nil when there is no oauth2 key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { authorizations: { no_oauth: scopes } } } }
+      klass.api_context = context_double
+      expect(klass.send :authorization_type_oauth2).to eq(nil)
+    end
+  end
+
+  context 'endpoint_protected?' do
+    it 'returns true when the context has the auth key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.endpoint_protected?).to eq(true)
+    end
+
+    it 'returns false when the context has no auth key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { some: scopes_map } } }
+      klass.api_context = context_double
+      expect(klass.endpoint_protected?).to eq(false)
+    end
+  end
+
+  context 'has_auth_scopes?' do
+    it 'returns true when the context has the auth key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.has_auth_scopes?).to eq(true)
+    end
+
+    it 'returns false when the context has no authorizations key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { some: scopes_map } } }
+      klass.api_context = context_double
+      expect(klass.has_auth_scopes?).to eq(false)
+    end
+
+    it 'returns false when the context has no oauth2 key.' do
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { authorizations: { no_oauth: scopes } } } }
+      klass.api_context = context_double
+      expect(klass.has_auth_scopes?).to eq(false)
+    end
+
+    it 'returns false when the auth scopes contain a blank scope array' do
+      context_double = double()
+      allow(context_double).to receive(:options) { { route_options: { authorizations: { oauth2: [] } } } }
+      klass.api_context = context_double
+      expect(klass.has_auth_scopes?).to eq(false)
+    end
+  end
+
+  context 'auth_scopes' do
+    it 'returns an array of scopes' do
+      context_double = double()
+      allow(context_double).to receive(:options) { auth_context }
+      klass.api_context = context_double
+      expect(klass.auth_scopes).to eq([:private, :public])
+    end
+  end
+end

data/wine_bouncer.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'grape', '~> 0.8'
-  spec.add_runtime_dependency 'doorkeeper', '>= 1.4', '<= 2.0.1'
+  spec.add_runtime_dependency 'grape', '~> 0.8', '<= 0.11.0'
+  spec.add_runtime_dependency 'doorkeeper', '>= 1.4', '<= 2.1.1'
 
   spec.add_development_dependency "railties"
   spec.add_development_dependency "bundler", "~> 1.7"

metadata

@@ -1,159 +1,165 @@
 --- !ruby/object:Gem::Specification
 name: wine_bouncer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Antek Drzewiecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: doorkeeper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - "<="
+    - - <=
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - "<="
+    - - <=
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
 description: 
@@ -163,9 +169,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -180,8 +186,10 @@ files:
 - lib/wine_bouncer/auth_strategies/default.rb
 - lib/wine_bouncer/auth_strategies/protected.rb
 - lib/wine_bouncer/auth_strategies/swagger.rb
+- lib/wine_bouncer/base_strategy.rb
 - lib/wine_bouncer/configuration.rb
 - lib/wine_bouncer/errors.rb
+- lib/wine_bouncer/extension.rb
 - lib/wine_bouncer/oauth2.rb
 - lib/wine_bouncer/version.rb
 - spec/dummy/README.rdoc
@@ -243,6 +251,7 @@ files:
 - spec/lib/generators/wine_bouncer/initializer_generator_spec.rb
 - spec/lib/wine_bouncer/auth_methods/auth_methods_spec.rb
 - spec/lib/wine_bouncer/auth_strategies/default_spec.rb
+- spec/lib/wine_bouncer/auth_strategies/swagger_spec.rb
 - spec/rails_helper.rb
 - spec/shared/orm/active_record.rb
 - spec/spec_helper.rb
@@ -257,17 +266,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby gem that allows Oauth2 protection with Doorkeeper for Grape Api's
@@ -331,6 +340,7 @@ test_files:
 - spec/lib/generators/wine_bouncer/initializer_generator_spec.rb
 - spec/lib/wine_bouncer/auth_methods/auth_methods_spec.rb
 - spec/lib/wine_bouncer/auth_strategies/default_spec.rb
+- spec/lib/wine_bouncer/auth_strategies/swagger_spec.rb
 - spec/rails_helper.rb
 - spec/shared/orm/active_record.rb
 - spec/spec_helper.rb