warden-github-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0d71776d5d7ebaad54e82b9acc5483d13bc1690
-  data.tar.gz: 0955b110b3602bf13205c7c401d7194e59f27d17
+  metadata.gz: 37e76cad468bc0b04658632d0eb31771dede50b3
+  data.tar.gz: c6fecc13ba562142149e111f77030bf853b3cbb8
 SHA512:
-  metadata.gz: 2772ed766c5f10da6b5799f981041584fcd0c31acfdb22be76c545983b8693df167f884c26890dc4f36231e4ec05c031278ee1d3d8a1a122b9fb6a97409008c7
-  data.tar.gz: 181144304f3d540561f809068df3fb93321f9a8625a5993df865de8e300cd970afb63aaeba6afab1e3b82134701e070500b71fb604ac2ee5bd44c7b25196b2d0
+  metadata.gz: 9a6f23ae1e3bb517759c974626c446c248cd8856fa103a8ea3c307266ef3cc713da76bd133531b7bdaf4254291a2c041f5034d0812d0fe5b43e18eb238054c46
+  data.tar.gz: f5fe6318363b452b5556ce99949ded463fcd86c4f7a33c484b91edc50daa4d5bed824af1d7a85c054740687a1f1b21a869d0a09104d03c7177905221c3efbea1

data/.travis.yml

@@ -5,3 +5,35 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - ruby-head
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+env:
+  - "RAILS_VERSION=3.1.0"
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0.pre"
+  - "RAILS_VERSION=master"
+matrix:
+  allow_failures:
+    - env: "RAILS_VERSION=master"
+    - rvm: ruby-head
+  exclude:
+    - rvm: 1.8.7
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: 1.9.2
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: jruby-18mode
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: rbx-18mode
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: 1.8.7
+      env: "RAILS_VERSION=master"
+    - rvm: 1.9.2
+      env: "RAILS_VERSION=master"
+    - rvm: jruby-18mode
+      env: "RAILS_VERSION=master"
+    - rvm: rbx-18mode
+      env: "RAILS_VERSION=master"
+

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## v1.0.1
+
+- Fully test on Rails 4
+- Improve mock user membership stubbing
+- Add testing instructions to README
+
+## v1.0.0
+
+- Add Devise compatibility
+
+## v0.0.1
+
+- Initial release

data/Gemfile

@@ -6,6 +6,19 @@ if ENV['EDGE']
   gem 'warden-github', :github => 'atmos/warden-github'
 end
 
+rails_version = ENV['RAILS_VERSION']
+
+rails_opts = case rails_version
+             when 'master'
+               { :github => 'rails/rails' }
+             when nil
+               {}
+             else
+               "~> #{rails_version}"
+             end
+
+gem "rails", rails_opts
+
 group :development do
   unless ENV['CI']
     gem 'debugger',   :platforms => :ruby_19, :require => false

data/README.md

@@ -12,7 +12,7 @@ It is built on top of [warden-github](https://github.com/atmos/warden-github), w
 
 **Wouldn't it be nice to**
 
-- use your organization and it's teams for user access control?
+- use your organization and its teams for user access control?
 - add a new employee to your GitHub organization or team in order to grant them access to your app's admin area?
 
 The motivation for this gem was to provide a very easy authorization (not authentication) mechanism to existing rails apps for admins, especially in combination with organization and team memberships.
@@ -61,6 +61,18 @@ class UsersController < ApplicationController
 end
 ```
 
+## Installation
+
+To use this gem, add it to your `Gemfile`:
+
+```ruby
+gem 'warden-github-rails', '~> 1.0'
+```
+
+If you're using devise, make sure to use version 2.2.4 or newer.
+Previous versions are not compatible with warden-github-rails and thus will not work.
+See the note at [*Using alongside Devise and other Warden Gems*](#using-alongside-devise-and-other-warden-gems) for an explanation.
+
 ## Usage
 
 ### Configuration
@@ -167,6 +179,48 @@ end
 
 Once a user is logged in, you'll have access to it in the controller using `github_user`. It is an instance of `Warden::GitHub::User` which is defined in the [warden-github](https://github.com/atmos/warden-github/blob/master/lib/warden/github/user.rb) gem. The instance has several methods to access user information such as `#name`, `#id`, `#email`, etc. It also features a method `#api` which returns a preconfigured [Octokit](https://github.com/pengwynn/octokit) client for that user.
 
+### Test Helpers
+
+This gems comes with a couple test helpers to make your life easier:
+
+-   A method is added to `Rack::Response` called `#github_oauth_redirect?` which
+    returns true if the response is a redirect to a url that starts with
+    `https://github.com/login/oauth/authorize`. You can use it in your request
+    tests to make sure the OAuth dance is initiated. In rspec you could verify
+    this as follows:
+
+    ```ruby
+    subject { get '/some-url-that-triggers-oauth' }
+    it { should be_github_oauth_redirect }
+    ```
+
+-   A mock user that allows you to stub team and organization memberships:
+
+    ```ruby
+    user = Warden::GitHub::Rails::TestHelpers::MockUser.new
+    user.stub_membership(team: [234, 987], org: 'some-inc')
+    user.team_member?(234) # => true
+    user.organization_member?('rails') # => false
+    ```
+
+-   A method that creates a mock user and logs it in. If desired, the scope can
+    be specified. The method returns the mock user so that you can manipulate it
+    further:
+
+    ```ruby
+    user = github_login(:admin)
+
+    get '/org/rails/admin'
+    expect(response).to be_not_found
+
+    user.stub_membership(org: 'rails')
+    get '/org/rails/admin'
+    expect(response).to be_ok
+    ```
+
+In order to use the mock user and the `#github_login` method, make sure to
+include `Warden::GitHub::Rails::TestHelpers` in your tests.
+
 ## Using alongside Devise and other Warden Gems
 
 Currently this gem does not play nicely with other gems that setup a warden middleware.
@@ -175,7 +229,7 @@ The warden middleware configures a warden instance and adds it to the rack envir
 Any other warden middleware downstream checks for any existing warden instance in the environment and, if present, skips itself.
 I've opened an [issue](https://github.com/hassox/warden/issues/67) on the warden repository to discuss possible workarounds.
 
-Nevertheless, this gem is compatible with devise.
+Nevertheless, this gem is compatible with devise for version 2.2.4 and newer.
 devise allows you to specify a block that will be invoked when the warden middleware is configured.
 This functionality is used in this gem in order to setup the github strategy for warden instead of inserting our own middleware.
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/warden/github/rails/test_helpers/mock_user.rb

@@ -10,8 +10,10 @@ module Warden
             @memberships = { :team => [], :org => [] }
           end
 
-          def stub_membership(membership)
-            memberships.fetch(membership.keys.first) << membership.values.first
+          def stub_membership(args)
+            args.each do |type, values|
+              memberships.fetch(type).concat(Array(values))
+            end
           end
 
           def team_member?(id)

data/spec/integration/controller_helpers_spec.rb

@@ -11,14 +11,14 @@ describe 'controller helpers' do
 
         context 'when not logged in' do
           it 'initiates the oauth flow' do
-            request.should be_github_oauth_redirect
+            expect(request).to be_github_oauth_redirect
           end
         end
 
         context 'when logged in' do
           before { github_login(scope) }
           it 'does nothing' do
-            request.should be_ok
+            expect(request).to be_ok
           end
         end
       end
@@ -26,15 +26,15 @@ describe 'controller helpers' do
       describe '#github_logout' do
         context 'when not logged in' do
           it 'does nothing' do
-            get("/#{type}/logout").body.should eq 'false'
+            expect(get("/#{type}/logout").body).to eq('false')
           end
         end
 
         context 'when logged in' do
           it 'logs out the user' do
             github_login(scope)
-            get("/#{type}/logout").body.should eq 'true'
-            get("/#{type}/logout").body.should eq 'false'
+            expect(get("/#{type}/logout").body).to eq('true')
+            expect(get("/#{type}/logout").body).to eq('false')
           end
         end
       end
@@ -44,14 +44,14 @@ describe 'controller helpers' do
 
         context 'when not logged in' do
           it 'returns false' do
-            request.body.should eq 'false'
+            expect(request.body).to eq('false')
           end
         end
 
         context 'when logged in' do
           it 'returns true' do
             github_login(scope)
-            request.body.should eq 'true'
+            expect(request.body).to eq('true')
           end
         end
       end
@@ -61,15 +61,15 @@ describe 'controller helpers' do
 
         context 'when not logged in' do
           it 'returns nil' do
-            request.body.should be_blank
+            expect(request.body).to be_blank
           end
         end
 
         context 'when logged in' do
           it 'returns the logged in user' do
             github_login(scope)
-            request.body.
-              should include 'Warden::GitHub::Rails::TestHelpers::MockUser'
+            expect(request.body).to \
+              include('Warden::GitHub::Rails::TestHelpers::MockUser')
           end
         end
       end
@@ -79,14 +79,14 @@ describe 'controller helpers' do
 
         context 'when not logged in' do
           it 'should be nil' do
-            request.body.should be_blank
+            expect(request.body).to be_blank
           end
         end
 
         context 'when logged in' do
           it "returns the user's session" do
             github_login(scope)
-            request.body.should == { :foo => :bar }.to_s
+            expect(request.body).to eq({ :foo => :bar }.to_s)
           end
         end
       end

data/spec/integration/scope_spec.rb

@@ -7,10 +7,10 @@ describe 'request to custom configured scope' do
     request = get url
     params = Addressable::URI.parse(request.location).query_values
 
-    request.should be_github_oauth_redirect
-    params.fetch('client_id').should eq args.fetch(:client_id)
-    params.fetch('redirect_uri').should =~ args.fetch(:redirect_uri)
-    params.fetch('scope').should eq args.fetch(:scope)
+    expect(request).to be_github_oauth_redirect
+    expect(params.fetch('client_id')).to eq(args.fetch(:client_id))
+    expect(params.fetch('redirect_uri')).to match(args.fetch(:redirect_uri))
+    expect(params.fetch('scope')).to eq(args.fetch(:scope))
   end
 
   context 'user' do

data/spec/integration/view_helpers_spec.rb

@@ -5,7 +5,7 @@ describe 'view helpers' do
     subject(:request) { get "/view_tests/user" }
 
     it 'is defined' do
-      request.body.should include 'true'
+      expect(request.body).to include('true')
     end
   end
 
@@ -13,7 +13,7 @@ describe 'view helpers' do
     subject(:request) { get "/view_tests/authenticated" }
 
     it 'is defined' do
-      request.body.should include 'true'
+      expect(request.body).to include('true')
     end
   end
 end

data/spec/rails_app/config/routes.rb

@@ -49,5 +49,5 @@ RailsApp::Application.routes.draw do
 
   # Everything else should be a 404:
 
-  match '*all' => responses[404]
+  get '*all' => responses[404]
 end

data/spec/spec_helper.rb

@@ -23,6 +23,9 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 
   config.include Rack::Test::Methods
   config.include Warden::GitHub::Rails::TestHelpers

data/spec/unit/config_spec.rb

@@ -5,19 +5,19 @@ describe Warden::GitHub::Rails::Config do
 
   describe '#default_scope' do
     it 'defaults to :user' do
-      config.default_scope.should be :user
+      expect(config.default_scope).to eq(:user)
     end
   end
 
   describe '#scopes' do
     it 'defaults to an empty hash' do
-      config.scopes.should == {}
+      expect(config.scopes).to eq({})
     end
   end
 
   describe '#teams' do
     it 'defaults to an empty hash' do
-      config.scopes.should == {}
+      expect(config.scopes).to eq({})
     end
   end
 
@@ -25,35 +25,35 @@ describe Warden::GitHub::Rails::Config do
     it 'adds a scope with its configs' do
       scope_config = double
       config.add_scope :admin, scope_config
-      config.scopes[:admin].should eq scope_config
+      expect(config.scopes[:admin]).to eq(scope_config)
     end
   end
 
   describe '#add_team' do
     it 'adds a name mapping for a team' do
       config.add_team :marketing, 1234
-      config.teams[:marketing].should eq 1234
+      expect(config.teams[:marketing]).to eq(1234)
     end
 
     it 'normalizes the input' do
       config.add_team 'marketing', '1234'
-      config.teams[:marketing].should eq 1234
+      expect(config.teams[:marketing]).to eq(1234)
     end
   end
 
   describe '#team_id' do
     context 'when passed a numeric value' do
       it 'returns that value' do
-        config.team_id('1234').should eq 1234
-        config.team_id(1234).should eq 1234
+        expect(config.team_id('1234')).to eq(1234)
+        expect(config.team_id(1234)).to eq(1234)
       end
     end
 
     context 'when passed an alias' do
       it 'returns the id for the alias' do
         config.add_team :marketing, 1234
-        config.team_id(:marketing).should eq 1234
-        config.team_id('marketing').should eq 1234
+        expect(config.team_id(:marketing)).to eq(1234)
+        expect(config.team_id('marketing')).to eq(1234)
       end
     end
 

data/spec/unit/mock_user_spec.rb

@@ -7,14 +7,15 @@ describe Warden::GitHub::Rails::TestHelpers::MockUser do
     subject(:user) { described_class.new }
 
     it 'stubs memberships' do
-      user.should_not be_team_member(123)
-      user.should_not be_organization_member('foobar')
+      expect(user).not_to be_team_member(123)
+      expect(user).not_to be_team_member(456)
+      expect(user).not_to be_organization_member('foobar')
 
-      user.stub_membership(:team => 123)
-      user.stub_membership(:org => 'foobar')
+      user.stub_membership(:org => 'foobar', :team => [123, 456])
 
-      user.should be_team_member(123)
-      user.should be_organization_member('foobar')
+      expect(user).to be_team_member(123)
+      expect(user).to be_team_member(456)
+      expect(user).to be_organization_member('foobar')
     end
   end
 end

data/spec/unit/rails_spec.rb

@@ -4,7 +4,7 @@ describe Warden::GitHub::Rails do
   describe '.setup' do
     it 'yields a config instance' do
       described_class.setup do |config|
-        config.should be_a described_class::Config
+        expect(config).to be_a(described_class::Config)
       end
     end
   end

data/spec/unit/test_helpers_spec.rb

@@ -6,7 +6,7 @@ describe Warden::GitHub::Rails::TestHelpers do
       it 'uses the default scope from config to login' do
         Warden::GitHub::Rails.stub(:default_scope => :foobar)
         should_receive(:login_as).with do |_, opts|
-          opts.fetch(:scope).should be :foobar
+          expect(opts.fetch(:scope)).to eq(:foobar)
         end
 
         github_login
@@ -16,7 +16,7 @@ describe Warden::GitHub::Rails::TestHelpers do
     context 'when a scope is specified' do
       it 'uses that scope to login' do
         should_receive(:login_as).with do |_, opts|
-          opts.fetch(:scope).should be :admin
+          expect(opts.fetch(:scope)).to eq(:admin)
         end
 
         github_login(:admin)
@@ -28,12 +28,12 @@ describe Warden::GitHub::Rails::TestHelpers do
 
       should_receive(:login_as).with do |user, _|
         expected_user = user
-        user.should be_a Warden::GitHub::Rails::TestHelpers::MockUser
+        expect(user).to be_a(Warden::GitHub::Rails::TestHelpers::MockUser)
       end
 
       user = github_login
 
-      user.should be expected_user
+      expect(user).to eq(expected_user)
     end
   end
 end

data/warden-github-rails.gemspec

@@ -14,12 +14,12 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($/) - Dir.glob('example/**/*')
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
 
-  gem.add_development_dependency 'rspec', '~> 2.12'
+  gem.add_development_dependency 'rspec', '~> 2.14'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'rails', '>= 3.2'
   gem.add_development_dependency 'rack-test', '~> 0.6'
   gem.add_development_dependency 'addressable', '~> 2.3'
 
   gem.add_dependency 'warden-github', '~> 0.14.0'
-  gem.add_dependency 'railties', '>= 3.2'
+  gem.add_dependency 'railties', '>= 3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warden-github-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Philipe Fatio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
 description: An easy drop in solution for rails to use GitHub authentication.
 email:
 - me@phili.pe
@@ -118,6 +118,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -179,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: An easy drop in solution for rails to use GitHub authentication.