wine_bouncer 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31605fc8a6a31a80b7a7a12e762eff6207874b58
-  data.tar.gz: b84a10c2d919c4a5a7ceb5299ce4e2a16ea7f1cc
+  metadata.gz: 05d3c52c66c94f2d17a796353a96ac724347c49b
+  data.tar.gz: 0846548c763afb90e24495bf27b0edc6313ff5e2
 SHA512:
-  metadata.gz: 275f39b746cecc8bc7d288f81681b22f7c61a6000c3dca2622a4c8da0c32d63e3604ffa55f43b1002df6bc84dd278b540e56e00e5e917e665e7f346fc737709e
-  data.tar.gz: 9be8224be9082524d1727476d4e508b755b21f33d5bf11ab631b21d912f3aed7f9255087a84b8e58c9f107a59584253d68f583905c3a5c11f3865b4c60df8356
+  metadata.gz: 453a70450b8d2fec220ba2d9b735c59cd8aa8a1051e69b10deb0f915a473c328fe8184959a21e36fbde01f8a5c437e61f799e830f4e52f2e7a3ab4b29081557a
+  data.tar.gz: ca991e46f4a2cb4f74273fc3b9afe4acf97618b48612c0e2f085601f05f6771f6d263225ba2713a0bdc577fd7da2eaf3ba26a870022634a4ac705cea996cb127

data/.travis.yml

@@ -7,10 +7,14 @@ rvm:
   - 2.0
   - 2.1
 env:
-  - rails=3.1.12
-  - rails=3.2.18
-  - rails=4.0.5
-  - rails=4.1.1
+  - rails=3.1.12 grape=0.8.0
+  - rails=3.2.18 grape=0.8.0
+  - rails=4.0.5 grape=0.8.0
+  - rails=4.1.1 grape=0.8.0
+  - rails=3.1.12 grape=0.9.0
+  - rails=3.2.18 grape=0.9.0
+  - rails=4.0.5 grape=0.9.0
+  - rails=4.1.1 grape=0.9.0
 addons:
   code_climate:
-    repo_token: f010f83a5eb6671c85aaa0aec44c1fd43404537a4f4898d1b9ab248ac8a1487d
+    repo_token: ab1b6ce5f973da033f80ae2e99fadbb32b2f9c37892703956d8ef954c8e8134e

data/CHANGELOG.md

@@ -1,2 +1,6 @@
 Changelog
-=========
+=========
+
+## 0.2.0
+*[#4](https://github.com/antek-drzewiecki/wine_bouncer/pull/4): Support for newer versions of grape ( > 0.8 ).
+*[#6](https://github.com/antek-drzewiecki/wine_bouncer/pull/6): Added the option to configure the resource owner.

data/CONTRIBUTING.md

@@ -1,8 +1,6 @@
 Changelog
 =========
 
-
-
 ## Fork the project
 
 Fork the project on the [project page]( https://github.com/Antek-drzewiecki/wine_bouncer/fork )
@@ -54,5 +52,4 @@ Push to the branch.
 
 Check your feature branch, once its passes Travis-CI, create a pull request
 
-
 Thanks you for participating!

data/Gemfile

@@ -1,9 +1,12 @@
 source 'https://rubygems.org'
 
+ENV['grape'] ||= '0.9.0'
+ENV['rails'] ||= '4.1.1'
 
 gem 'rails', ENV['rails']
 
 gem 'activerecord'
+gem 'grape', ENV['grape']
 
 gem "codeclimate-test-reporter", group: :test, require: nil
 

data/README.md

@@ -1,7 +1,7 @@
 # WineBouncer
 
-[![Build Status](https://travis-ci.org/Antek-drzewiecki/wine_bouncer.svg?branch=master)](https://travis-ci.org/Antek-drzewiecki/wine_bouncer)
-[![Code Climate](https://codeclimate.com/github/Antek-drzewiecki/wine_bouncer/badges/gpa.svg)](https://codeclimate.com/github/Antek-drzewiecki/wine_bouncer)
+[![Build Status](https://travis-ci.org/antek-drzewiecki/wine_bouncer.svg?branch=master)](https://travis-ci.org/antek-drzewiecki/wine_bouncer)
+[![Code Climate](https://codeclimate.com/github/antek-drzewiecki/wine_bouncer/badges/gpa.svg)](https://codeclimate.com/github/antek-drzewiecki/wine_bouncer)
 [![Gem Version](https://badge.fury.io/rb/wine_bouncer.svg)](http://badge.fury.io/rb/wine_bouncer)
 
 Protect your precious Grape API with Doorkeeper. 
@@ -23,9 +23,9 @@ Table of Contents
 
 
 ## Requirements
-- Ruby >1.9.3
+- Ruby > 1.9.3
 - Doorkeeper > 1.4.0
-- Grape > 0.8.0
+- Grape > 0.8
 
 ## Installation
 
@@ -47,11 +47,15 @@ When upgrading from a previous version, see [UPGRADING](UPGRADING.md). You might
 ## 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, create a rails initializer in your Rails app at `config/initializer/wine_bouncer.rb` with the following configuration.
+To get started with WineBouncer, create a rails initializer in your Rails app at `config/initializers/wine_bouncer.rb` with the following configuration.
 
 ``` ruby
 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
 ```
 
@@ -123,61 +127,62 @@ To get started ensure you also have included the `grape-swagger` gem in your gem
 
 Run `bundle` to install the missing gems.
 
-Create a rails initializer in your Rails app at `config/initializer/wine_bouncer.rb` with the following configuration.
+Create a rails initializer in your Rails app at `config/initializers/wine_bouncer.rb` with the following configuration.
 
 ``` ruby
-    WineBouncer.configure do |config|
-        config.auth_strategy = :swagger
+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.
 
 ``` 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 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
+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.

data/UPGRADING.md

@@ -1,4 +1,22 @@
 Upgrading WineBouncer
 =====================
 
+
+### Upgrading to >= 0.2.0
+
+To use the `resource_owner` you now need to define how WineBouncer gets the resource owner. In most cases he needs to return the User that is logged in, but not in all cases.
+You now additionally need to specify `define_resource_owner` in your configuration. Mostly this the following code will work:
+
+``` ruby
+WineBouncer.configure do |c|
+  .......
+  c.define_resource_owner do
+    User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
+  end
+end
+```
+
+The required Grape version is now from 0.8 and above.
+
+------
 From version 0.1.0 upgrade instructions are given.

data/lib/wine_bouncer/auth_methods/auth_methods.rb

@@ -11,7 +11,7 @@ module WineBouncer
     end
 
     def resource_owner
-      User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
+       instance_eval(&WineBouncer.configuration.defined_resource_owner)
     end
 
     def client_credential_token?

data/lib/wine_bouncer/configuration.rb

@@ -7,6 +7,7 @@ module WineBouncer
   class Configuration
 
     attr_accessor :auth_strategy
+    attr_accessor :defined_resource_owner
 
     def auth_strategy=(strategy)
       @auth_strategy= strategy
@@ -19,6 +20,16 @@ module WineBouncer
     def require_strategies
       require "wine_bouncer/auth_strategies/#{auth_strategy}"
     end
+
+    def define_resource_owner &block
+      fail(ArgumentError, 'define_resource_owner expects a block in the configuration') unless block_given?
+      @defined_resource_owner = block
+    end
+
+    def defined_resource_owner
+      fail(Errors::UnconfiguredError, 'Please define define_resource_owner to configure the resource owner') unless @defined_resource_owner
+      @defined_resource_owner
+    end
   end
 
    def self.configuration

data/lib/wine_bouncer/oauth2.rb

@@ -79,14 +79,13 @@ module WineBouncer
       unless valid_doorkeeper_token?(*scopes)
         if !doorkeeper_token || !doorkeeper_token.accessible?
           error = Doorkeeper::OAuth::InvalidTokenResponse.from_access_token(doorkeeper_token)
+          # TODO: localization and better error reporting
           raise WineBouncer::Errors::OAuthUnauthorizedError, 'unauthorized'
         else
           error = Doorkeeper::OAuth::ForbiddenTokenResponse.from_scopes(scopes)
+          # TODO: localization and better error reporting
           raise WineBouncer::Errors::OAuthForbiddenError, "missing permissions"
         end
-
-        # headers.merge!(error.headers.reject { |k| ['Content-Type'].include? k })
-        # doorkeeper_error_renderer(error, options)
       end
     end
 

data/lib/wine_bouncer/version.rb

@@ -1,3 +1,3 @@
 module WineBouncer
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/intergration/oauth2_default_strategy_spec.rb

@@ -10,6 +10,10 @@ describe Api::MountedDefaultApiUnderTest, type: :api do
   before (:example) do
     WineBouncer.configure do |c|
       c.auth_strategy = :default
+
+      c.define_resource_owner do
+        User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
+      end
     end
   end
 

data/spec/intergration/oauth2_swagger_strategy_spec.rb

@@ -11,6 +11,10 @@ describe Api::MountedSwaggerApiUnderTest, type: :api do
   before (:example) do
     WineBouncer.configure do |c|
       c.auth_strategy = :swagger
+
+      c.define_resource_owner do
+        User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
+      end
     end
   end
 

data/spec/lib/wine_bouncer/auth_methods/auth_methods_spec.rb

@@ -15,7 +15,6 @@ describe ::WineBouncer::AuthMethods do
       tested_class.doorkeeper_access_token = token
       expect(tested_class.doorkeeper_access_token).to eq(token)
     end
-
   end
 
   context 'has_resource_owner?' do
@@ -84,4 +83,24 @@ describe ::WineBouncer::AuthMethods do
       expect(tested_class.protected_endpoint?).to be false
     end
   end
+
+
+  context 'resource_owner' do
+    it 'runs the configured block' do
+      result = 'called block'
+      foo = Proc.new { result }
+
+      WineBouncer.configure do |c|
+        c.auth_strategy = :default
+        c.define_resource_owner &foo
+      end
+
+      expect(tested_class.resource_owner).to be(result)
+    end
+
+    it 'raises an argument error when the block is not configured' do
+      WineBouncer.configuration= WineBouncer::Configuration.new
+      expect { tested_class.resource_owner }.to raise_error(WineBouncer::Errors::UnconfiguredError)
+    end
+  end
 end

data/wine_bouncer.gemspec

@@ -17,7 +17,7 @@ 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.0'
+  spec.add_runtime_dependency 'grape', '~> 0.8'
   spec.add_runtime_dependency 'doorkeeper', '~> 1.4.0'
 
   spec.add_development_dependency "railties"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wine_bouncer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Antek Drzewiecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: doorkeeper
   requirement: !ruby/object:Gem::Requirement