wine_bouncer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05d3c52c66c94f2d17a796353a96ac724347c49b
-  data.tar.gz: 0846548c763afb90e24495bf27b0edc6313ff5e2
+  metadata.gz: d9ca00d6af297ea83a1b780674f0138125560ba6
+  data.tar.gz: 87685246db6c845a980a28b7e2de53e2aed44bf8
 SHA512:
-  metadata.gz: 453a70450b8d2fec220ba2d9b735c59cd8aa8a1051e69b10deb0f915a473c328fe8184959a21e36fbde01f8a5c437e61f799e830f4e52f2e7a3ab4b29081557a
-  data.tar.gz: ca991e46f4a2cb4f74273fc3b9afe4acf97618b48612c0e2f085601f05f6771f6d263225ba2713a0bdc577fd7da2eaf3ba26a870022634a4ac705cea996cb127
+  metadata.gz: 3c10d58093da1170c43819866b4484b157773325309811277853629d60af8da127b75b8837cdd72840f760f5ba3d9cdd468fd502790ebd6b3328b6e4324ac3f2
+  data.tar.gz: 99caeb2b029573f56f7705e3bf5078941f4b2fec45b5deebf570aad449cc00c3d6dd7386d7d565354c8b7d1bb1b3e5cdd49e67dbd57b795c3a241738389e559a

data/.travis.yml

@@ -7,13 +7,11 @@ rvm:
   - 2.0
   - 2.1
 env:
-  - 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 doorkeeper=1.4.1
   - rails=3.2.18 grape=0.9.0
-  - rails=4.0.5 grape=0.9.0
+  - rails=4.1.1 grape=0.9.0 doorkeeper=1.4.1
   - rails=4.1.1 grape=0.9.0
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+## 0.2.1
+*[#12](https://github.com/antek-drzewiecki/wine_bouncer/pull/12): Added a rails generator to generate the WineBouncer configuration file. Thanks @whatasunnyday.
+*[#7](https://github.com/antek-drzewiecki/wine_bouncer/pull/7): Added support for Doorkeeper 2.0.0 and 2.0.1. Thanks @whatasunnyday .
+
 ## 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/Gemfile

@@ -2,15 +2,15 @@ source 'https://rubygems.org'
 
 ENV['grape'] ||= '0.9.0'
 ENV['rails'] ||= '4.1.1'
+ENV['doorkeeper'] ||= '2.0.1'
 
 gem 'rails', ENV['rails']
 
 gem 'activerecord'
 gem 'grape', ENV['grape']
+gem 'doorkeeper', ENV['doorkeeper']
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+gem 'codeclimate-test-reporter', group: :test, require: nil
 
 # Specify your gem's dependencies in wine_bouncer.gemspec
 gemspec
-
-

data/README.md

@@ -4,7 +4,7 @@
 [![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. 
+Protect your precious Grape API with Doorkeeper.
 WineBouncer uses minimal modification, to make the magic happen.
 
 Table of Contents
@@ -24,7 +24,7 @@ Table of Contents
 
 ## Requirements
 - Ruby > 1.9.3
-- Doorkeeper > 1.4.0
+- Doorkeeper > 1.4.0 and =< 2.0.1
 - Grape > 0.8
 
 ## Installation
@@ -45,17 +45,23 @@ bundle
 When upgrading from a previous version, see [UPGRADING](UPGRADING.md). You might also be interested at the [CHANGELOG](CHANGELOG.md).
 
 ## 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.  
+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/initializers/wine_bouncer.rb` with the following configuration.
+To get started with WineBouncer, run the configuration initializer:
+
+```shell
+$ 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
 WineBouncer.configure do |config|
-    config.auth_strategy = :default
+  config.auth_strategy = :default
 
-    config.define_resource_owner do
-        User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
-    end
+  config.define_resource_owner do
+    User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
+  end
 end
 ```
 
@@ -70,7 +76,7 @@ class Api < Grape::API
 end
 ```
 
-WineBouncer relies on Grape's endpoint method description to define if an endpoint method should be protected. 
+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:
 
@@ -84,30 +90,30 @@ Example:
 
 ``` ruby
  class MyAwesomeAPI < Grape::API
-    desc 'protected method with required public scope', 
+    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: [] } 
+
+    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
@@ -122,7 +128,7 @@ Example:
 
 WineBouncer comes with a strategy that can be perfectly used with [grape-swagger](https://github.com/tim-vandecasteele/grape-swagger) with a syntax compliant with the [swagger spec](https://github.com/wordnik/swagger-spec/).
 This might be one of the simplest methods to protect your API and serve it with documentation. You can use [swagger-ui](https://github.com/wordnik/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.
@@ -192,7 +198,7 @@ You can use the default scopes of Doorkeeper by just adding `authorizations: { o
 
 ### 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. 
+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
 
@@ -200,12 +206,12 @@ This gem raises the following exceptions which can be handled in your Grape API,
 
 * `WineBouncer::Errors::OAuthUnauthorizedError`
    when the request is unauthorized.
-* `WineBouncer::Errors::OAuthForbiddenError` 
+* `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. 
+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.
 

data/lib/generators/templates/wine_bouncer.rb

@@ -0,0 +1,7 @@
+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

data/lib/generators/wine_bouncer/initializer_generator.rb

@@ -0,0 +1,12 @@
+module WineBouncer
+  module Generators
+    class InitializerGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a sample WineBouncer initializer.'
+      def copy_initializer
+        copy_file 'wine_bouncer.rb', 'config/initializers/wine_bouncer.rb'
+      end
+    end
+  end
+end

data/lib/wine_bouncer/version.rb

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

data/spec/lib/generators/wine_bouncer/initializer_generator_spec.rb

@@ -0,0 +1,18 @@
+require 'generator_spec'
+require 'rails_helper'
+require 'spec_helper'
+require 'generators/wine_bouncer/initializer_generator'
+
+describe WineBouncer::Generators::InitializerGenerator, type: :generator do
+  destination '/tmp'
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  it 'creates a test initializer' do
+    assert_file 'config/initializers/wine_bouncer.rb', /WineBouncer\.configure/
+  end
+end
+

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

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 describe ::WineBouncer::AuthMethods do
 

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

@@ -1,10 +1,10 @@
-require 'spec_helper'
+require 'rails_helper'
 require 'wine_bouncer/auth_strategies/default'
 
 describe ::WineBouncer::AuthStrategies::Default do
   subject(:klass) { ::WineBouncer::AuthStrategies::Default.new }
 
-  let(:scopes) { [ 'public', 'private' ] }
+  let(:scopes) { %w(public private) }
   let(:scopes_hash) { { scopes: scopes } }
   let(:auth_context) { { auth: scopes_hash } }
 

data/spec/rails_helper.rb

@@ -1,15 +1,12 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
+ENV['RAILS_ENV'] ||= 'test'
 ORM = (ENV['orm'] || :active_record).to_sym
 require 'spec_helper'
-require File.expand_path("../dummy/config/environment", __FILE__)
+require File.expand_path('../dummy/config/environment', __FILE__)
 require 'rspec/rails'
 require 'wine_bouncer'
 require 'factory_girl'
 require 'database_cleaner'
-require "codeclimate-test-reporter"
-
-CodeClimate::TestReporter.start
 
 # Add additional requires below this line. Rails is not loaded until this point!
 
@@ -40,13 +37,15 @@ module ApiHelper
   end
 end
 
+def orm_name
+  orm = Doorkeeper.configuration.orm
+  [:mongoid2, :mongoid3, :mongoid4].include?(orm.to_sym) ? :mongoid : orm
+end
 
-require "shared/orm/#{Doorkeeper.configuration.orm_name}"
+require "shared/orm/#{orm_name}"
 
 FactoryGirl.find_definitions
 
-
-
 RSpec.configure do |config|
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
   #config.fixture_path = "#{::Rails.root}/spec/fixtures"

data/spec/spec_helper.rb

@@ -14,6 +14,8 @@
 # users commonly want.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

data/wine_bouncer.gemspec

@@ -18,14 +18,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'grape', '~> 0.8'
-  spec.add_runtime_dependency 'doorkeeper', '~> 1.4.0'
+  spec.add_runtime_dependency 'doorkeeper', '>= 1.4', '<= 2.0.1'
 
   spec.add_development_dependency "railties"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec-rails", "~> 3.1.0"
   spec.add_development_dependency 'factory_girl', '~> 4.4.0'
+  spec.add_development_dependency "generator_spec", "~> 0.9.0"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "database_cleaner", "~> 1.3.0"
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wine_bouncer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Antek Drzewiecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -28,16 +28,22 @@ dependencies:
   name: doorkeeper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - <=
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +114,20 @@ dependencies:
     - - ~>
       - !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
@@ -153,6 +173,8 @@ files:
 - README.md
 - Rakefile
 - UPGRADING.md
+- lib/generators/templates/wine_bouncer.rb
+- lib/generators/wine_bouncer/initializer_generator.rb
 - lib/wine_bouncer.rb
 - lib/wine_bouncer/auth_methods/auth_methods.rb
 - lib/wine_bouncer/auth_strategies/default.rb
@@ -215,6 +237,7 @@ files:
 - spec/factories/user.rb
 - spec/intergration/oauth2_default_strategy_spec.rb
 - spec/intergration/oauth2_swagger_strategy_spec.rb
+- 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/rails_helper.rb
@@ -300,6 +323,7 @@ test_files:
 - spec/factories/user.rb
 - spec/intergration/oauth2_default_strategy_spec.rb
 - spec/intergration/oauth2_swagger_strategy_spec.rb
+- 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/rails_helper.rb