warden-github-rails 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37e76cad468bc0b04658632d0eb31771dede50b3
-  data.tar.gz: c6fecc13ba562142149e111f77030bf853b3cbb8
+  metadata.gz: 94c4bcff3c0978874ae4233194457aa095b6ec98
+  data.tar.gz: 952a958502aef15b84ca89c4912d7577ea4ab0f4
 SHA512:
-  metadata.gz: 9a6f23ae1e3bb517759c974626c446c248cd8856fa103a8ea3c307266ef3cc713da76bd133531b7bdaf4254291a2c041f5034d0812d0fe5b43e18eb238054c46
-  data.tar.gz: f5fe6318363b452b5556ce99949ded463fcd86c4f7a33c484b91edc50daa4d5bed824af1d7a85c054740687a1f1b21a869d0a09104d03c7177905221c3efbea1
+  metadata.gz: df68ab5d8e005762758a1c42ebf734a5dd477dc3b9e553658bdad6518af55b9d5ec924b9b205a924ec0f5e95b5f236bddbb2d8e4473a7db2623531a20fa58e02
+  data.tar.gz: a5ca3a4d19fb32f664b3ae819df6243a557f252b01b59382965507b49cb99d88be888b1c9cdf0eb8d931205a541f480c2b337441f8ba7303d16c4639eafc4c2e

data/.travis.yml

@@ -1,39 +1,23 @@
 language: ruby
 script: "bundle exec rspec"
 rvm:
-  - 1.8.7
   - 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=4.0.0"
   - "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"
-
+      env: "RAILS_VERSION=4.0.0"

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.1.0
+
+- Upgrade to octokit.rb version 2
+- Require ruby 1.9 or higher
+
 ## v1.0.1
 
 - Fully test on Rails 4

data/Gemfile

@@ -3,14 +3,14 @@ source 'https://rubygems.org'
 gemspec
 
 if ENV['EDGE']
-  gem 'warden-github', :github => 'atmos/warden-github'
+  gem 'warden-github', github: 'atmos/warden-github'
 end
 
 rails_version = ENV['RAILS_VERSION']
 
 rails_opts = case rails_version
              when 'master'
-               { :github => 'rails/rails' }
+               { github: 'rails/rails' }
              when nil
                {}
              else
@@ -21,7 +21,7 @@ gem "rails", rails_opts
 
 group :development do
   unless ENV['CI']
-    gem 'debugger',   :platforms => :ruby_19, :require => false
-    gem 'ruby-debug', :platforms => :ruby_18, :require => false
+    gem 'debugger',   platforms: :ruby_19, require: false
+    gem 'ruby-debug', platforms: :ruby_18, require: false
   end
 end

data/README.md

@@ -22,12 +22,12 @@ They allow you to restrict access to members of your organization or a certain t
 This is how your rails `routes.rb` could look like:
 
 ```ruby
-constraints(:subdomain => 'admin') do
-  github_authenticate(:org => 'my_company_inc') do
+constraints(subdomain: 'admin') do
+  github_authenticate(org: 'my_company_inc') do
     resources :users
     resources :projects
 
-    github_authenticated(:team => 'sysadmins') do
+    github_authenticated(team: 'sysadmins') do
       resource :infrastructure
     end
   end
@@ -43,14 +43,14 @@ class UsersController < ApplicationController
 
   def new
     github_authenticate! # Performs OAuth flow when not logged in.
-    @user = User.new(:name => github_user.name, :email => github_user.email)
+    @user = User.new(name: github_user.name, email: github_user.email)
   end
 
   def create
-    attrs = params.require(:user).permit(:name, :email).merge(:github_id => github_user.id)
+    attrs = params.require(:user).permit(:name, :email).merge(github_id: github_user.id)
     @user = User.create(attrs)
 
-    if @user
+    if @user.persisted?
       redirect_to :show
     else
       render :new
@@ -61,12 +61,30 @@ class UsersController < ApplicationController
 end
 ```
 
+## Example App
+
+This repository includes an example app in [example/](example/).
+To play with it, follow these steps:
+
+1.  [Create an OAuth application in your GitHub settings](https://github.com/settings/applications/new).
+    Set the callback URL to `http://localhost:3000/`
+
+2.  Check out this repo and run:
+
+    ```
+    $ bundle
+    $ cd example
+    $ GITHUB_CLIENT_ID=your_id_from_step1 GITHUB_CLIENT_SECRET=your_secret_from_step1 bundle exec rails s
+    ```
+
+3.  Point your browser to [http://localhost:3000/](http://localhost:3000/) and enjoy!
+
 ## Installation
 
 To use this gem, add it to your `Gemfile`:
 
 ```ruby
-gem 'warden-github-rails', '~> 1.0'
+gem 'warden-github-rails', '~> 1.1.0'
 ```
 
 If you're using devise, make sure to use version 2.2.4 or newer.
@@ -88,14 +106,14 @@ Here's how such a config might look like:
 
 ```ruby
 Warden::GitHub::Rails.setup do |config|
-  config.add_scope :user,  :client_id     => 'foo',
-                           :client_secret => 'bar',
-                           :scope         => 'user'
+  config.add_scope :user,  client_id:     'foo',
+                           client_secret: 'bar',
+                           scope:         'user'
 
-  config.add_scope :admin, :client_id     => 'abc',
-                           :client_secret => 'xyz',
-                           :redirect_uri  => '/admin/login/callback',
-                           :scope         => 'repo'
+  config.add_scope :admin, client_id:     'abc',
+                           client_secret: 'xyz',
+                           redirect_uri:  '/admin/login/callback',
+                           scope:         'repo'
 
   config.default_scope = :admin
 
@@ -129,17 +147,17 @@ github_unauthenticated do
 end
 
 # Only matches when member of the organization. Initiates login if not logged in.
-github_authenticate(:org => 'my_company') do
+github_authenticate(org: 'my_company') do
   resource :admin
 end
 
 # Only matches when member of the team. Does not initiate login if not logged in.
-github_authenticated(:team => 'markting') do
+github_authenticated(team: 'markting') do
   get '/dashboard' => 'dashboard#show'
 end
 
 # Using dynamic membership values:
-github_authenticate(:org => lambda { |req| r.params[:id] }) do
+github_authenticate(org: lambda { |req| req.params[:id] }) do
   get '/orgs/:id' => 'orgs#show'
 end
 ```
@@ -162,7 +180,7 @@ class SomeController < ActionController::Base
 
   def settings
     github_authenticate!
-    @settings = UserSettings.find_by_github_user_id(github_user.id)
+    @settings = UserSettings.find_by(github_user_id: github_user.id)
   end
 
   def finish_wizard
@@ -177,7 +195,10 @@ end
 
 ### Communicating with the GitHub API
 
-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.
+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/octokit/octokit.rb) client for that user.
 
 ### Test Helpers
 
@@ -239,7 +260,7 @@ This functionality is used in this gem in order to setup the github strategy for
 
 - [warden-github](https://github.com/atmos/warden-github)
     - [warden](https://github.com/hassox/warden)
-    - [octokit](https://github.com/pengwynn/octokit)
+    - [octokit](https://github.com/octokit/octokit.rb)
 
 ### Maintainers
 

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/warden/github/rails/controller_helpers.rb

@@ -9,7 +9,7 @@ module Warden
         # Initiates the OAuth flow if not already authenticated for the
         # specified scope.
         def github_authenticate!(scope=Rails.default_scope)
-          request.env['warden'].authenticate!(:scope => scope)
+          request.env['warden'].authenticate!(scope: scope)
         end
 
         # Logs out a user if currently logged in for the specified scope.

data/lib/warden/github/rails/railtie.rb

@@ -25,8 +25,8 @@ module Warden
 
         def setup_scopes(config)
           Rails.scopes.each do |scope, scope_config|
-            config.scope_defaults scope, :strategies => [:github],
-                                         :config => scope_config
+            config.scope_defaults scope, strategies: [:github],
+                                         config: scope_config
           end
         end
 

data/lib/warden/github/rails/routes.rb

@@ -6,10 +6,10 @@ module Warden
         # authenticated, it initiates the OAuth flow.
         #
         # Team and organization memberships can be checked by specifying a hash
-        # such as `:team => 'foobar'` or `:org => 'my_company'`.
+        # such as `team: 'foobar'` or `org: 'my_company'`.
         def github_authenticate(scope=nil, options={}, &routes_block)
           github_constraint(scope, options, routes_block) do |warden, scope|
-            warden.authenticate!(:scope => scope)
+            warden.authenticate!(scope: scope)
           end
         end
 
@@ -17,10 +17,10 @@ module Warden
         # not authenticated, it does not initiate the OAuth flow.
         #
         # Team and organization memberships can be checked by specifying a hash
-        # such as `:team => 'foobar'` or `:org => 'my_company'`.
+        # such as `team: 'foobar'` or `org: 'my_company'`.
         def github_authenticated(scope=nil, options={}, &routes_block)
           github_constraint(scope, options, routes_block) do |warden, scope|
-            warden.authenticated?(:scope => scope)
+            warden.authenticated?(scope: scope)
           end
         end
 
@@ -30,7 +30,7 @@ module Warden
         # limited usage.
         def github_unauthenticated(scope=nil, options={}, &routes_block)
           github_constraint(scope, options, routes_block) do |warden, scope|
-            not warden.authenticated?(:scope => scope)
+            not warden.authenticated?(scope: scope)
           end
         end
 

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

@@ -7,7 +7,7 @@ module Warden
 
           def initialize(*args)
             super
-            @memberships = { :team => [], :org => [] }
+            @memberships = { team: [], org: [] }
           end
 
           def stub_membership(args)

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

@@ -10,7 +10,7 @@ module Warden
         # Login a mock GitHub user and return it.
         def github_login(scope=Rails.default_scope)
           MockUser.new.tap do |user|
-            login_as(user, :scope => scope)
+            login_as(user, scope: scope)
           end
         end
       end

data/spec/integration/controller_helpers_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe 'controller helpers' do
   {
-    :scoped   => :admin,
-    :unscoped => Warden::GitHub::Rails.default_scope
+    scoped:   :admin,
+    unscoped: Warden::GitHub::Rails.default_scope
   }.each do |type, scope|
     context "when using #{type}" do
       describe '#github_authenticate!' do
@@ -86,7 +86,7 @@ describe 'controller helpers' do
         context 'when logged in' do
           it "returns the user's session" do
             github_login(scope)
-            expect(request.body).to eq({ :foo => :bar }.to_s)
+            expect(request.body).to eq({ foo: :bar }.to_s)
           end
         end
       end

data/spec/integration/membership_spec.rb

@@ -13,7 +13,7 @@ describe 'request to a protected resource' do
         context 'and team member' do
           before do
             user = github_login
-            user.stub_membership(:team => 123)
+            user.stub_membership(team: 123)
           end
 
           it { should be_ok }
@@ -37,7 +37,7 @@ describe 'request to a protected resource' do
         context 'and team member' do
           before do
             user = github_login
-            user.stub_membership(:team => 456)
+            user.stub_membership(team: 456)
           end
 
           it { should be_ok }
@@ -57,7 +57,7 @@ describe 'request to a protected resource' do
         context 'and team member' do
           before do
             user = github_login
-            user.stub_membership(:team => 123)
+            user.stub_membership(team: 123)
           end
 
           it { should be_ok }
@@ -72,7 +72,7 @@ describe 'request to a protected resource' do
   end
 
   context 'that requires an organization membership' do
-    { :org => :foobar_inc, :organization => 'some_org' }.each do |key, value|
+    { org: :foobar_inc, organization: 'some_org' }.each do |key, value|
       context "which is specified as #{key}" do
         subject { get "/#{key}/protected" }
 
@@ -84,7 +84,7 @@ describe 'request to a protected resource' do
           context 'and organization member' do
             before do
               user = github_login
-              user.stub_membership(:org => value)
+              user.stub_membership(org: value)
             end
 
             it { should be_ok }
@@ -105,7 +105,7 @@ describe 'request to a protected resource' do
         context 'and organization member' do
           before do
             user = github_login
-            user.stub_membership(:org => 'some_org')
+            user.stub_membership(org: 'some_org')
           end
 
           it { should be_ok }
@@ -128,7 +128,7 @@ describe 'request to a resource that only exists when logged in' do
       context 'when team member' do
         before do
           user = github_login
-          user.stub_membership(:team => 123)
+          user.stub_membership(team: 123)
         end
 
         it { should be_ok }
@@ -146,7 +146,7 @@ describe 'request to a resource that only exists when logged in' do
       context 'when team member' do
         before do
           user = github_login
-          user.stub_membership(:team => 456)
+          user.stub_membership(team: 456)
         end
 
         it { should be_ok }
@@ -160,14 +160,14 @@ describe 'request to a resource that only exists when logged in' do
   end
 
   context 'that requires an organization membership' do
-    { :org => :foobar_inc, :organization => 'some_org' }.each do |key, value|
+    { org: :foobar_inc, organization: 'some_org' }.each do |key, value|
       context "which is specified as #{key}" do
         subject { get "/#{key}/conditional" }
 
         context 'when organization member' do
           before do
             user = github_login
-            user.stub_membership(:org => value)
+            user.stub_membership(org: value)
           end
 
           it { should be_ok }

data/spec/integration/scope_spec.rb

@@ -16,18 +16,18 @@ describe 'request to custom configured scope' do
   context 'user' do
     it 'passes the correct configs to the oauth flow' do
       test_redirect('/protected',
-                    :client_id => 'foo',
-                    :redirect_uri => /\/protected$/,
-                    :scope => 'user')
+                    client_id: 'foo',
+                    redirect_uri: /\/protected$/,
+                    scope: 'user')
     end
   end
 
   context 'admin' do
     it 'passes the correct configs to the oauth flow' do
       test_redirect('/admin/protected',
-                    :client_id => 'abc',
-                    :redirect_uri => /\/admin\/login\/callback$/,
-                    :scope => 'repo')
+                    client_id: 'abc',
+                    redirect_uri: /\/admin\/login\/callback$/,
+                    scope: 'repo')
     end
   end
 end

data/spec/rails_app/app/controllers/scoped_controller.rb

@@ -1,21 +1,21 @@
 class ScopedController < ActionController::Base
   def authenticate
     github_authenticate!(:admin)
-    render :nothing => true
+    render nothing: true
   end
 
   def logout
     was_logged_in = !github_user(:admin).nil?
     github_logout(:admin)
-    render :text => was_logged_in
+    render text: was_logged_in
   end
 
   def authenticated
-    render :text => github_authenticated?(:admin)
+    render text: github_authenticated?(:admin)
   end
 
   def user
-    render :text => github_user(:admin)
+    render text: github_user(:admin)
   end
 
   def session
@@ -23,6 +23,6 @@ class ScopedController < ActionController::Base
       session[:foo] = :bar
     end
 
-    render :text => github_session(:admin)
+    render text: github_session(:admin)
   end
 end

data/spec/rails_app/app/controllers/unscoped_controller.rb

@@ -1,21 +1,21 @@
 class UnscopedController < ActionController::Base
   def authenticate
     github_authenticate!
-    render :nothing => true
+    render nothing: true
   end
 
   def logout
     was_logged_in = !github_user.nil?
     github_logout
-    render :text => was_logged_in
+    render text: was_logged_in
   end
 
   def authenticated
-    render :text => github_authenticated?
+    render text: github_authenticated?
   end
 
   def user
-    render :text => github_user
+    render text: github_user
   end
 
   def session
@@ -23,6 +23,6 @@ class UnscopedController < ActionController::Base
       session[:foo] = :bar
     end
 
-    render :text => github_session
+    render text: github_session
   end
 end

data/spec/rails_app/config/initializers/session_store.rb

@@ -1 +1 @@
-RailsApp::Application.config.session_store :cookie_store, :key => '_rails_app_session'
+RailsApp::Application.config.session_store :cookie_store, key: '_rails_app_session'

data/spec/rails_app/config/initializers/warden_github_rails.rb

@@ -1,12 +1,12 @@
 Warden::GitHub::Rails.setup do |config|
-  config.add_scope :user,  :client_id     => ENV['GITHUB_CLIENT_ID'] || 'foo',
-                           :client_secret => ENV['GITHUB_CLIENT_SECRET'] || 'bar',
-                           :scope         => 'user'
+  config.add_scope :user,  client_id:     ENV['GITHUB_CLIENT_ID'] || 'foo',
+                           client_secret: ENV['GITHUB_CLIENT_SECRET'] || 'bar',
+                           scope:         'user'
 
-  config.add_scope :admin, :client_id     => ENV['GITHUB_CLIENT_ID'] || 'abc',
-                           :client_secret => ENV['GITHUB_CLIENT_SECRET'] || 'xyz',
-                           :redirect_uri  => '/admin/login/callback',
-                           :scope         => 'repo'
+  config.add_scope :admin, client_id:     ENV['GITHUB_CLIENT_ID'] || 'abc',
+                           client_secret: ENV['GITHUB_CLIENT_SECRET'] || 'xyz',
+                           redirect_uri:  '/admin/login/callback',
+                           scope:         'repo'
 
   config.add_team :marketing, 456
 end

data/spec/rails_app/config/initializers/wrap_parameters.rb

@@ -1,4 +1,4 @@
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters :format => [:json]
+  wrap_parameters format: [:json]
 end
 

data/spec/rails_app/config/routes.rb

@@ -15,23 +15,23 @@ RailsApp::Application.routes.draw do
   github_authenticated(:admin)   { get '/admin/conditional'         => responses[200] }
   github_unauthenticated(:admin) { get '/admin/conditional_inverse' => responses[200] }
 
-  github_authenticate(:team => 123)  { get '/team/protected'   => responses[200] }
-  github_authenticated(:team => 123) { get '/team/conditional' => responses[200] }
+  github_authenticate(team: 123)  { get '/team/protected'   => responses[200] }
+  github_authenticated(team: 123) { get '/team/conditional' => responses[200] }
 
-  github_authenticate(:team => :marketing)  { get '/team_alias/protected'   => responses[200] }
-  github_authenticated(:team => :marketing) { get '/team_alias/conditional' => responses[200] }
+  github_authenticate(team: :marketing)  { get '/team_alias/protected'   => responses[200] }
+  github_authenticated(team: :marketing) { get '/team_alias/conditional' => responses[200] }
 
-  github_authenticate(:org => :foobar_inc)  { get '/org/protected'   => responses[200] }
-  github_authenticated(:org => :foobar_inc) { get '/org/conditional' => responses[200] }
+  github_authenticate(org: :foobar_inc)  { get '/org/protected'   => responses[200] }
+  github_authenticated(org: :foobar_inc) { get '/org/conditional' => responses[200] }
 
-  github_authenticate(:organization => 'some_org')  { get '/organization/protected'   => responses[200] }
-  github_authenticated(:organization => 'some_org') { get '/organization/conditional' => responses[200] }
+  github_authenticate(organization: 'some_org')  { get '/organization/protected'   => responses[200] }
+  github_authenticated(organization: 'some_org') { get '/organization/conditional' => responses[200] }
 
-  github_authenticated(:org => lambda { |req| req.params[:id] }) do
+  github_authenticated(org: lambda { |req| req.params[:id] }) do
     get '/dynamic_org/:id' => responses[200]
   end
 
-  github_authenticated(:team => lambda { |req| req.params[:id] }) do
+  github_authenticated(team: lambda { |req| req.params[:id] }) do
     get '/dynamic_team/:id' => responses[200]
   end
 

data/spec/unit/mock_user_spec.rb

@@ -11,7 +11,7 @@ describe Warden::GitHub::Rails::TestHelpers::MockUser do
       expect(user).not_to be_team_member(456)
       expect(user).not_to be_organization_member('foobar')
 
-      user.stub_membership(:org => 'foobar', :team => [123, 456])
+      user.stub_membership(org: 'foobar', team: [123, 456])
 
       expect(user).to be_team_member(123)
       expect(user).to be_team_member(456)

data/spec/unit/test_helpers_spec.rb

@@ -4,7 +4,7 @@ describe Warden::GitHub::Rails::TestHelpers do
   describe '#github_login' do
     context 'when no scope is specified' do
       it 'uses the default scope from config to login' do
-        Warden::GitHub::Rails.stub(:default_scope => :foobar)
+        Warden::GitHub::Rails.stub(default_scope: :foobar)
         should_receive(:login_as).with do |_, opts|
           expect(opts.fetch(:scope)).to eq(:foobar)
         end

data/warden-github-rails.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |gem|
   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 'warden-github', '~> 1.0'
   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.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Philipe Fatio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement