devise-remote-user 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48592394d5ad5267cdcdc0bc948a590670611ff8
-  data.tar.gz: 46b4a6ffb866678720842a98258f9cfc0757f32c
+  metadata.gz: 5c22c1528b31943554d224bf190fcc0ff7abb81c
+  data.tar.gz: c5dd7031e1926d72301aac9694ae375e317802a3
 SHA512:
-  metadata.gz: b72a73def63dbe2cd8157e1e50bd4c582a406562f61223611d534c6079545e92c96494a4beb858882100ac340cad67f3e56534127d41f01eac8735bdfd92d62b
-  data.tar.gz: 363d81d3272248acd1d83ea1812110f413180fa47cbb42cbab76fa6c34be117a03e4d554198f208c48d6fff9ce2acaf4af5040ffc51f7b31dc296267b6f31c7a
+  metadata.gz: 75dac7385bbdb025cac7159f6e14b6ab40d28ca3eaa3cc0abd520b05a3161cc2da80f9f8c03d622f7b5ee6fdf6a849ec8c7670c472ad76b7d97651bc2fc945fb
+  data.tar.gz: 526eb0280f61dc90f3d7cd3261a4528af94c31d8548a2b8881ed2e55e6ddf2c6d544e87ec082baf1f7775b98fe3ff314234495e71d2fd19532d31ced3483d01b

data/README.md

@@ -19,7 +19,7 @@ bundle install
 
 Sorry, there are no generators yet, so ...
 
-- Add `:remote_user_authenticatable` symbol to `devise` statement in User model.
+- Add `:remote_user_authenticatable` symbol to `devise` statement in User model, before other authentication strategies (e.g., `:database_authenticatable`).
 - Add `before_filter :authenticate_user!` to ApplicationController, if not already present.  This ensures that remote user is logged in locally (via database)
 
 Configuration options:
@@ -28,17 +28,19 @@ Configuration options:
 - `attribute_map` - Hash (default: `{}`).  Map of User model attributes to request environment keys for updating the local user when auto-creation is enabled.
 - `auto_create` - Boolean (default: `false`). Whether to auto-create a local user from the remote user attributes.  Note: Also requires adding the Warden callbacks as shown below.
 - `auto_update` - Boolean (default: `false`). Whether to auto-update authenticated user attributes from remote user attributes.
+- `logout_url` - String (default: `'/'`).  For redirecting to a remote user logout URL after signing out of the Rails application.  Include `DeviseRemoteUser::ControllerBehavior` in your application controller to enable (by overriding Devise's `after_sign_out_path_for`).
 
-Set options in `config/intializers/devise.rb`:
+Set options in a Rails initializer (e.g., `config/intializers/devise.rb`):
 
 ```ruby
-require 'devise-remote-user'
+require 'devise_remote_user'
 
 DeviseRemoteUser.configure do |config|
   config.env_key = 'REMOTE_USER'
   config.auto_create = true
   config.auto_update = true
   config.attribute_map = {email: 'mail'}
+  config.logout_url = "http://my.host/path.to.remote.logout"
 end
 ```
 

data/devise_remote_user.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |s|
   s.test_files = Dir["spec/**/*"]
   s.extra_rdoc_files = ["LICENSE", "README.md"]
   s.require_paths = ["lib"]
-  s.add_dependency "rails", ">= 3.2"
+  s.add_dependency "rails", ">= 3.2", "< 5.0"
   s.add_dependency "devise"
   s.add_development_dependency "sqlite3"
-  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rspec-rails", "~> 2.14.1"
   s.add_development_dependency "factory_girl_rails"
   s.add_development_dependency "capybara"
 end

data/lib/devise_remote_user.rb

@@ -1,5 +1,6 @@
 require 'devise'
 require 'devise_remote_user/engine'
+require 'devise_remote_user/controller_behavior'
 
 module DeviseRemoteUser
 
@@ -25,6 +26,12 @@ module DeviseRemoteUser
   mattr_accessor :attribute_map
   @@attribute_map = {}
 
+  # Settings for redirecting to the remote user logout URL
+  # Enable by including DeviseRemoteUser::Controllers::Helpers in ApplicationController
+  # (it overrides Devise's after_sign_out_path_for method).
+  mattr_accessor :logout_url
+  @@logout_url = '/'
+
   def self.configure
     yield self
   end

data/lib/devise_remote_user/controller_behavior.rb

@@ -0,0 +1,16 @@
+module DeviseRemoteUser
+  module ControllerBehavior
+
+    def after_sign_out_path_for(resource_or_scope)
+      return DeviseRemoteUser.logout_url if remote_user_authenticated? and DeviseRemoteUser.logout_url
+      super
+    end
+
+    private 
+
+    def remote_user_authenticated?
+      request.env[DeviseRemoteUser.env_key].present?
+    end
+
+  end
+end

data/lib/devise_remote_user/version.rb

@@ -1,3 +1,3 @@
 module DeviseRemoteUser
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/controllers/application_controller_spec.rb

@@ -12,45 +12,45 @@ describe ApplicationController do
     end
   end
 
+  after { User.destroy_all }
+
   describe "remote user authentication" do
-    describe "remote user exists" do
+
+    describe "when remote user exists" do
       let(:user) { FactoryGirl.create(:user) }
-      after { user.delete }
+      before { controller.remote_user_name = user.email }
       it "should login the remote user" do
-        controller.remote_user_name = user.email
         get :index
-        controller.user_signed_in?.should be_true
-        controller.current_user.should eq(user)
+        expect(controller.user_signed_in?).to be_true
+        expect(controller.current_user).to eq(user)
       end
     end
-    describe "remote user not present" do
+
+    describe "when remote user is not present" do
+      before { controller.remote_user_name = nil }
       it "should do nothing" do
-        controller.remote_user_name = nil
         get :index
-        controller.user_signed_in?.should be_false
+        expect(controller.user_signed_in?).to be_false
       end
     end
-    describe "remote user does not exist" do
+
+    describe "when remote user does not exist" do
       let(:email) { "foo@bar.com" }
-      describe "auto-creation enabled" do
-        before { DeviseRemoteUser.auto_create = true }
-        after { @user.delete }
+      before { controller.remote_user_name = email }
+
+      describe "and auto-creation is enabled" do
+        before { allow(DeviseRemoteUser).to receive(:auto_create) { true } }
         it "should create and sign in a new user" do
-          User.find_by_email(email).should be_nil
-          controller.remote_user_name = email
           get :index
-          response.should be_successful
-          controller.user_signed_in?.should be_true
-          @user = User.find_by_email(email)
-          @user.should_not be_nil
-          controller.current_user.should eq(@user)
+          expect(response).to be_successful
+          expect(controller.user_signed_in?).to be_true
+          expect(User.find_by_email(email)).to eq(controller.current_user)
         end
       end
-      describe "auto-creation disabled" do
-        before { DeviseRemoteUser.auto_create = false }
+
+      describe "and auto-creation is disabled" do
+        before { allow(DeviseRemoteUser).to receive(:auto_create) { false } }
         it "should not create a user for the remote user" do
-          User.find_by_email(email).should be_nil
-          controller.remote_user_name = email
           get :index
           response.should_not be_successful
           controller.user_signed_in?.should be_false
@@ -58,47 +58,49 @@ describe ApplicationController do
         end
       end
     end
-    describe "a local database user is already signed in" do
+
+    describe "when a local database user is already signed in" do
       let(:local_user) { FactoryGirl.create(:user) }
       before do
-        DeviseRemoteUser.auto_create = true
+        allow(DeviseRemoteUser).to receive(:auto_create) { true }
         controller.remote_user_name = remote_user.email
         sign_in local_user
       end
-      after { local_user.delete }
-      describe "remote user exists" do
+
+      describe "and remote user exists" do
         let(:remote_user) { FactoryGirl.create(:user) }
-        after { remote_user.delete }
         it "should not clobber the existing user session" do
           get :index
-          controller.current_user.should eq(local_user)
-          controller.current_user.should_not eq(remote_user)
+          expect(controller.current_user).to eq(local_user)
+          expect(controller.current_user).not_to eq(remote_user)
         end
       end
-      describe "remote user does not exist" do
+
+      describe "and remote user does not exist" do
         let(:remote_user) { FactoryGirl.build(:user) }
         it "should not clobber the existing user session" do
           get :index
-          controller.current_user.should eq(local_user)
-          controller.current_user.should_not eq(remote_user)
-          User.find_by_email(remote_user.email).should be_nil
+          expect(controller.current_user).to eq(local_user)
+          expect(controller.current_user).not_to eq(remote_user)
+          expect(User.find_by_email(remote_user.email)).to be_nil
         end
       end
     end
+
     describe "auto-updating user attributes" do
       let(:user) { FactoryGirl.create(:user, first_name: 'Hardy', last_name: 'HarHar', nickname: "Laurel's Buddy", display_name: 'Hardy HarHar') }
       before do
-        DeviseRemoteUser.attribute_map = {
-          first_name: 'givenName',
-          nickname: 'eduPersonNickname',
-          last_name: 'sn',
-          display_name: 'displayName'
-          }
+        allow(DeviseRemoteUser).to receive(:attribute_map) do
+          { first_name: 'givenName', 
+            nickname: 'eduPersonNickname', 
+            last_name: 'sn', 
+            display_name: 'displayName' } 
+        end
       end
-      after { user.delete }
-      describe "auto-creation disabled" do
-        before { DeviseRemoteUser.auto_update = false }
-        it "should not update the user attributes" do
+
+      describe "when auto-creation is disabled" do
+        before do
+          allow(DeviseRemoteUser).to receive(:auto_update) { false } 
           controller.remote_user_name = user.email
           controller.remote_user_attributes = {
             'givenName' => 'Fleece',
@@ -106,35 +108,42 @@ describe ApplicationController do
             'eduPersonNickname' => 'Iconoclast',
             'displayName' => 'Fleece Vest (Iconoclast)'
           }
+        end
+        it "should not update the user attributes" do
           get :index
           user.reload
-          user.first_name.should == 'Hardy'
-          user.last_name.should == 'HarHar'
-          user.display_name.should == 'Hardy HarHar'
-          user.nickname.should == "Laurel's Buddy"
+          expect(user.first_name).to eq('Hardy')
+          expect(user.last_name).to eq('HarHar')
+          expect(user.display_name).to eq('Hardy HarHar')
+          expect(user.nickname).to eq("Laurel's Buddy")
         end
       end
-      describe "auto-creation enabled" do
-        before { DeviseRemoteUser.auto_update = true }
-        describe "database authentication wins" do
+
+      describe "when auto-creation is enabled" do
+        before do
+          allow(DeviseRemoteUser).to receive(:auto_update) { true }
+          controller.remote_user_attributes = {
+            'givenName' => 'Fleece',
+            'sn' => 'Vest',
+            'eduPersonNickname' => 'Iconoclast',
+            'displayName' => 'Fleece Vest (Iconoclast)'
+          }
+        end
+
+        describe "and database authentication wins" do
+          before { sign_in user }
           it "should not update the user attributes" do
-            sign_in user
-            controller.remote_user_attributes = {
-              'givenName' => 'Fleece',
-              'sn' => 'Vest',
-              'eduPersonNickname' => 'Iconoclast',
-              'displayName' => 'Fleece Vest (Iconoclast)'
-            }
             get :index
             user.reload
-            user.first_name.should == 'Hardy'
-            user.last_name.should == 'HarHar'
-            user.display_name.should == 'Hardy HarHar'
-            user.nickname.should == "Laurel's Buddy"
+            expect(user.first_name).to eq('Hardy')
+            expect(user.last_name).to eq('HarHar')
+            expect(user.display_name).to eq('Hardy HarHar')
+            expect(user.nickname).to eq("Laurel's Buddy")
           end
         end
-        describe "remote user authentication wins" do
-          it "should update the user attributes" do
+
+        describe "and remote user authentication wins" do
+          before do
             controller.remote_user_name = user.email
             controller.remote_user_attributes = {
               'givenName' => 'Fleece',
@@ -142,16 +151,19 @@ describe ApplicationController do
               'eduPersonNickname' => 'Iconoclast',
               'displayName' => 'Fleece Vest (Iconoclast)'
             }
+          end
+          it "should update the user attributes" do
             get :index
             user.reload
-            user.first_name.should == 'Fleece'
-            user.last_name.should == 'Vest'
-            user.display_name.should == 'Fleece Vest (Iconoclast)'
-            user.nickname.should == 'Iconoclast'
+            expect(user.first_name).to eq('Fleece')
+            expect(user.last_name).to eq('Vest')
+            expect(user.display_name).to eq('Fleece Vest (Iconoclast)')
+            expect(user.nickname).to eq('Iconoclast')
           end
         end
       end
     end
+
   end
 
 end

data/spec/controllers/devise/sessions_controller_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Devise::SessionsController do
+  before { @request.env["devise.mapping"] = Devise.mappings[:user] }
+  describe "logout" do
+    let(:user) { FactoryGirl.create(:user) }
+    describe "when user is remotely authenticated" do
+      before { @request.env[DeviseRemoteUser.env_key] = user.email }
+      it "should redirect to DeviseRemoteUser.logout_url" do
+        expect(get :destroy).to redirect_to(DeviseRemoteUser.logout_url)
+      end
+    end
+    describe "when user is not remotely authenticated" do
+      it "should redirect to the root path (Devise default)" do
+        expect(get :destroy).to redirect_to(root_path)
+      end
+    end
+  end
+
+end

data/spec/controllers/devise/sessions_controller_spec.rb~

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Devise::SessionsController do
+  before { @request.env["devise.mapping"] = Devise.mappings[:user] }
+  describe "logout" do
+    let(:user) { FactoryGirl.create(:user) }
+    describe "when user is remotely authenticated" do
+      before { controller.remote_user_name = user.email }
+      it "should redirect to DeviseRemoteUser.logout_url" do
+        expect(get :destroy).to redirect_to(DeviseRemoteUser.logout_url)
+      end
+    end
+    describe "when user is not remotely authenticated" do
+      it "should redirect to the root path (Devise default)" do
+        expect(get :destroy).to redirect_to(root_path)
+      end
+    end
+  end
+
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -5,6 +5,8 @@ class ApplicationController < ActionController::Base
 
   before_filter :authenticate_user!
 
+  include DeviseRemoteUser::ControllerBehavior
+
   def index
     render text: "You have reached your destination!"
   end

data/spec/dummy/spec/features/#logout_spec.rb#

@@ -0,0 +1 @@
+require 'spec_helper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-remote-user
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,6 +17,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +62,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
@@ -112,12 +118,16 @@ files:
 - Rakefile
 - devise_remote_user.gemspec
 - lib/devise_remote_user.rb
+- lib/devise_remote_user/controller_behavior.rb
 - lib/devise_remote_user/engine.rb
 - lib/devise_remote_user/manager.rb
 - lib/devise_remote_user/model.rb
 - lib/devise_remote_user/strategy.rb
 - lib/devise_remote_user/version.rb
 - spec/controllers/application_controller_spec.rb
+- spec/controllers/application_controller_spec.rb~
+- spec/controllers/devise/sessions_controller_spec.rb
+- spec/controllers/devise/sessions_controller_spec.rb~
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/images/.keep
@@ -130,6 +140,7 @@ files:
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/models/user.rb~
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -153,31 +164,30 @@ files:
 - spec/dummy/config/locales/devise.en.yml
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/db/development.sqlite3
 - spec/dummy/db/migrate/20131101150807_devise_create_users.rb
 - spec/dummy/db/migrate/20131101184256_add_name_fields_to_user.rb
+- spec/dummy/db/migrate/20131101184256_add_name_fields_to_user.rb~
 - spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/factories/user_factories.rb
-- spec/spec_helper.rb
-- spec/controllers/application_controller_spec.rb~
-- spec/dummy/app/models/user.rb~
-- spec/dummy/db/development.sqlite3
-- spec/dummy/db/migrate/20131101184256_add_name_fields_to_user.rb~
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
+- spec/dummy/spec/features/#logout_spec.rb#
 - spec/dummy/tmp/cache/assets/development/sprockets/13fe41fee1fe35b49d145bcc06610705
 - spec/dummy/tmp/cache/assets/development/sprockets/2f5173deea6c795b8fdde723bb4b63af
 - spec/dummy/tmp/cache/assets/development/sprockets/357970feca3ac29060c1e3861e2c0953
 - spec/dummy/tmp/cache/assets/development/sprockets/cffd775d018f68ce5dba1ee0d951a994
 - spec/dummy/tmp/cache/assets/development/sprockets/d771ace226fc8215a3572e0aa35bb0d6
 - spec/dummy/tmp/cache/assets/development/sprockets/f7cbd26ba1d28d48de824f0e94586655
+- spec/factories/user_factories.rb
 - spec/factories/user_factories.rb~
+- spec/spec_helper.rb
 homepage: http://github.com/duke-libraries/devise-remote-user
 licenses:
 - BSD
@@ -198,13 +208,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A devise extension for remote user authentication.
 test_files:
 - spec/controllers/application_controller_spec.rb
 - spec/controllers/application_controller_spec.rb~
+- spec/controllers/devise/sessions_controller_spec.rb
+- spec/controllers/devise/sessions_controller_spec.rb~
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
@@ -248,6 +260,7 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/dummy/README.rdoc
+- spec/dummy/spec/features/#logout_spec.rb#
 - spec/dummy/tmp/cache/assets/development/sprockets/13fe41fee1fe35b49d145bcc06610705
 - spec/dummy/tmp/cache/assets/development/sprockets/2f5173deea6c795b8fdde723bb4b63af
 - spec/dummy/tmp/cache/assets/development/sprockets/357970feca3ac29060c1e3861e2c0953