warden-github-rails 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0d71776d5d7ebaad54e82b9acc5483d13bc1690
+  data.tar.gz: 0955b110b3602bf13205c7c401d7194e59f27d17
+SHA512:
+  metadata.gz: 2772ed766c5f10da6b5799f981041584fcd0c31acfdb22be76c545983b8693df167f884c26890dc4f36231e4ec05c031278ee1d3d8a1a122b9fb6a97409008c7
+  data.tar.gz: 181144304f3d540561f809068df3fb93321f9a8625a5993df865de8e300cd970afb63aaeba6afab1e3b82134701e070500b71fb604ac2ee5bd44c7b25196b2d0

data/.travis.yml

@@ -4,7 +4,4 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
+  - 2.0.0

data/README.md

@@ -167,9 +167,17 @@ 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.
 
-## Known Limitations
+## Using alongside Devise and other Warden Gems
 
-Currently, this gem does not play nicely with [Devise](https://github.com/plataformatec/devise). Devise is built on top of warden and performs some monkeypatching of warden which breaks this gem. Support will be added as soon as possible.
+Currently this gem does not play nicely with other gems that setup a warden middleware.
+The reason is that warden simply does not have support for multiple middlewares.
+The warden middleware configures a warden instance and adds it to the rack environment.
+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.
+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.
 
 ## Additional Information
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+1.0.0

data/lib/warden/github/rails.rb

@@ -5,7 +5,6 @@ require 'warden/github/rails/routes'
 require 'warden/github/rails/railtie'
 require 'warden/github/rails/config'
 require 'warden/github/rails/controller_helpers'
-require 'warden/github/rails/view_helpers'
 
 require 'forwardable'
 
@@ -16,8 +15,6 @@ module Warden
 
       def_delegators :config,
                      :default_scope,
-                     :warden_config,
-                     :warden_config=,
                      :scopes,
                      :team_id
 

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

@@ -4,9 +4,6 @@ module Warden
       class Config
         BadConfig = Class.new(StandardError)
 
-        # A cache of the warden config for the active manager.
-        attr_accessor :warden_config
-
         # Default scope to use when not explicitly specified.
         attr_accessor :default_scope
 

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

@@ -2,6 +2,10 @@ module Warden
   module GitHub
     module Rails
       module ControllerHelpers
+        def self.included(klass)
+          klass.helper_method(:github_authenticated?, :github_user)
+        end
+
         # Initiates the OAuth flow if not already authenticated for the
         # specified scope.
         def github_authenticate!(scope=Rails.default_scope)

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

@@ -2,22 +2,37 @@ module Warden
   module GitHub
     module Rails
       class Railtie < ::Rails::Railtie
-        config.app_middleware.use Warden::Manager do |config|
-          config.failure_app = lambda { |env| [403, {}, [env['warden'].message]] }
-          Rails.warden_config = config
-          Rails.scopes.each do |scope, scope_config|
-            config.scope_defaults scope, :strategies => [:github],
-                                         :config => scope_config
+        initializer 'warden-github-rails.warden' do |app|
+          # When devise is used, it inserts a warden middlware. Multiple warden
+          # middlewares do not work properly. Devise allows for a block to be
+          # specified that is invoked when its warden middleware is configured.
+          # This makes it possible to setup warden-github-rails through devise.
+          if defined?(::Devise)
+            ::Devise.warden { |config| setup_scopes(config) }
+          else
+            app.config.middleware.use Warden::Manager do |config|
+              setup_failure_app(config)
+              setup_scopes(config)
+            end
           end
         end
 
-        initializer 'warden-github-rails.controller_helpers' do
+        initializer 'warden-github-rails.helpers' do
           ActiveSupport.on_load(:action_controller) do
             include ControllerHelpers
           end
+        end
+
+        def setup_scopes(config)
+          Rails.scopes.each do |scope, scope_config|
+            config.scope_defaults scope, :strategies => [:github],
+                                         :config => scope_config
+          end
+        end
 
-          ActiveSupport.on_load(:action_view) do
-            include ViewHelpers
+        def setup_failure_app(config)
+          config.failure_app = lambda do |env|
+            [403, {}, [env['warden'].message]]
           end
         end
       end

data/spec/integration/view_helpers_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'view helpers' do
+  describe '#github_user' do
+    subject(:request) { get "/view_tests/user" }
+
+    it 'is defined' do
+      request.body.should include 'true'
+    end
+  end
+
+  describe '#github_authenticated?' do
+    subject(:request) { get "/view_tests/authenticated" }
+
+    it 'is defined' do
+      request.body.should include 'true'
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+class ViewTestsController < ActionController::Base
+end

data/spec/rails_app/app/views/view_tests/authenticated.html.erb

@@ -0,0 +1 @@
+<%= !!defined?(github_authenticated?) %>

data/spec/rails_app/app/views/view_tests/user.html.erb

@@ -0,0 +1 @@
+<%= !!defined?(github_user) %>

data/spec/rails_app/config/routes.rb

@@ -43,6 +43,10 @@ RailsApp::Application.routes.draw do
     end
   end
 
+  %w[ user authenticated ].each do |method|
+    get "/view_tests/#{method}" => "view_tests##{method}"
+  end
+
   # Everything else should be a 404:
 
   match '*all' => responses[404]

data/warden-github-rails.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rspec', '~> 2.12'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'rails', '~> 3.2'
+  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.13.2'
-  gem.add_dependency 'railties', '~> 3.2'
+  gem.add_dependency 'warden-github', '~> 0.14.0'
+  gem.add_dependency 'railties', '>= 3.2'
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: warden-github-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Philipe Fatio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,39 +27,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,33 +83,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: warden-github
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.13.2
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.13.2
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 description: An easy drop in solution for rails to use GitHub authentication.
@@ -146,13 +131,16 @@ files:
 - lib/warden/github/rails/test_helpers.rb
 - lib/warden/github/rails/test_helpers/mock_user.rb
 - lib/warden/github/rails/version.rb
-- lib/warden/github/rails/view_helpers.rb
 - spec/integration/controller_helpers_spec.rb
 - spec/integration/membership_spec.rb
 - spec/integration/route_spec.rb
 - spec/integration/scope_spec.rb
+- spec/integration/view_helpers_spec.rb
 - spec/rails_app/app/controllers/scoped_controller.rb
 - spec/rails_app/app/controllers/unscoped_controller.rb
+- spec/rails_app/app/controllers/view_tests_controller.rb
+- spec/rails_app/app/views/view_tests/authenticated.html.erb
+- spec/rails_app/app/views/view_tests/user.html.erb
 - spec/rails_app/config.ru
 - spec/rails_app/config/application.rb
 - spec/rails_app/config/boot.rb
@@ -174,41 +162,38 @@ files:
 - warden-github-rails.gemspec
 homepage: https://github.com/fphilipe/warden-github-rails
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2808666797376643453
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2808666797376643453
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An easy drop in solution for rails to use GitHub authentication.
 test_files:
 - spec/integration/controller_helpers_spec.rb
 - spec/integration/membership_spec.rb
 - spec/integration/route_spec.rb
 - spec/integration/scope_spec.rb
+- spec/integration/view_helpers_spec.rb
 - spec/rails_app/app/controllers/scoped_controller.rb
 - spec/rails_app/app/controllers/unscoped_controller.rb
+- spec/rails_app/app/controllers/view_tests_controller.rb
+- spec/rails_app/app/views/view_tests/authenticated.html.erb
+- spec/rails_app/app/views/view_tests/user.html.erb
 - spec/rails_app/config.ru
 - spec/rails_app/config/application.rb
 - spec/rails_app/config/boot.rb

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

@@ -1,18 +0,0 @@
-module Warden
-  module GitHub
-    module Rails
-      module ViewHelpers
-        # Checks whether a user is logged in for the specified scope.
-        def github_authenticated?(scope=Rails.default_scope)
-          request.env['warden'].authenticated?(scope)
-        end
-
-        # Returns the currently signed in user for the specified scope. See the
-        # documentation for Warden::GitHub::User for available methods.
-        def github_user(scope=Rails.default_scope)
-          request.env['warden'].user(scope)
-        end
-      end
-    end
-  end
-end