devise-remote-user 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a9bc050013fedd473e25664f0dfb2cd08ffa238
-  data.tar.gz: 2bbb78ac903122fda30d48d4aca37f3fbda0a884
+  metadata.gz: 2ba593036cec8c5f0fc38ba79eb8e2040897dd7e
+  data.tar.gz: cf65b35d2b96bd7ea3bf3bc38d1a22bce3b0684c
 SHA512:
-  metadata.gz: 3faabf423507e954037323361475d52bd764ce49d9d36eb456289aaa01d537692aa3133ac3756b26da9a95f12653e0bfbe081c4d067a378bc079a71b3983c059
-  data.tar.gz: 9bc972ecd74d21732ebf255fc06facaa58ed46afd3796f2ecb541bec53c3eaecb917fadaba3b50504549397605109b70e13df4436eaad42526726fe8dffe4c54
+  metadata.gz: 0cf34573776063dc5c328d5122e8d5f9585d4a03fa73fa8655b4e90be8d39832478c26758f9682ccd894bf163713443fc18202f6f50c2e07cd34faa3b047c01d
+  data.tar.gz: ad3d09d20daebf8d1de5e252b91522011e3f160cad5b98df85e4954a5eafccd41afa47e3af84703e607d3cfb04b7c037be0a8a6f98d8cc3b3d34bbb6a53c3539

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -20,12 +20,31 @@ bundle install
 Sorry, there are no generators yet, so ...
 
 - Add `:remote_user_authenticatable` symbol to `devise` statement in User model.
-- Add `require 'devise-remote-user'` to devise initializer at `config/initializers/devise.rb`
 - Add `before_filter :authenticate_user!` to ApplicationController, if not already present.  This ensures that remote user is logged in locally (via database)
 
-Configuration options in `config/intializers/devise.rb`:
+Configuration options:
 
-`remote_user_autocreate` - Boolean (default: false). Whether to auto-create a local user for the remote user.
-`remote_user_env_var` - String (default: 'REMOTE_USER').  Request environment key for the remote user id.
-`remote_user_attribute_map` - Hash (default: {}).  Map of User model attributes to request environment keys for updating the local user when auto-creation is enabled.
+- `env_var` - String (default: `'REMOTE_USER'`).  Request environment key for the remote user id.
+- `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.
 
+Set options in `config/intializers/devise.rb`:
+
+```ruby
+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'}
+end
+
+# Uses Warden after_authentication callback to implement auto_update feature
+DeviseRemoteUser.add_warden_callbacks
+```
+
+## Tests
+
+Sorry, they haven't been added yet because this code was refactored from en existing Rails app.

data/Rakefile

@@ -5,3 +5,9 @@ rescue LoadError
 end
 
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/devise_remote_user.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_dependency "rails", ">= 3.2"
   s.add_dependency "devise"
+  s.add_development_dependency "rspec"
 end

data/lib/devise_remote_user.rb

@@ -1,31 +1,48 @@
 require 'devise'
 
 module DeviseRemoteUser
-  class Engine < Rails::Engine
-  end
-end
+  
+  class Engine < Rails::Engine; end
 
-module Devise
   # request.env key for remote user name
   # Set to 'HTTP_REMOTE_USER' in config/initializers/devise.rb if behind reverse proxy
-  mattr_accessor :remote_user_env_key
-  @@remote_user_env_key = 'REMOTE_USER'
+  mattr_accessor :env_key
+  @@env_key = 'REMOTE_USER'
   
-  # Enable user auto-creation for remote user
-  mattr_accessor :remote_user_autocreate
-  @@remote_user_autocreate = false
+  # Enable user auto-creation of user from remote user attributes
+  mattr_accessor :auto_create
+  @@auto_create = false
+
+  # Enable user auto-update of user attributes from remote user attributes
+  mattr_accessor :auto_update
+  @@auto_update = false
 
   # User attribute used for lookup of remote user
   # Defaults to Devise.authentication_keys.first
-  mattr_accessor :remote_user_auth_key
-  @@remote_user_auth_key = nil
+  mattr_accessor :auth_key
+  @@auth_key = nil
 
   # Map of User model attributes to request.env keys for updating a local user when auto-creation is enabled.
-  mattr_accessor :remote_user_attribute_map
-  @@remote_user_attribute_map = {}
+  mattr_accessor :attribute_map
+  @@attribute_map = {}
+
+  def self.configure
+    yield self
+  end
+
+  def self.add_warden_callbacks
+    if auto_update
+      Warden::Manager.after_authentication do |user, auth, opts|
+        manager = DeviseRemoteUser::Manager.new(auth.env)
+        manager.update_user(user)
+      end
+    end
+  end
+
 end
 
 Devise.add_module(:remote_user_authenticatable,
                   :strategy => true,
                   :controller => :sessions,
                   :model => 'devise_remote_user/model')
+

data/lib/devise_remote_user/manager.rb

@@ -0,0 +1,59 @@
+module DeviseRemoteUser
+
+  #
+  # The Manager class is responsible for connecting the appliation's User 
+  # class with remote user information in the request environment.
+  #
+  class Manager
+
+    attr_reader :env
+    
+    def initialize(env)
+      @env = env
+    end
+
+    def find_or_create_user
+      user = find_user
+      if !user && DeviseRemoteUser.auto_create
+        user = create_user
+      end
+      user
+    end
+
+    def find_user
+      User.where(user_criterion).first
+    end
+
+    def create_user
+      random_password = SecureRandom.hex(16)
+      attrs = user_criterion.merge({password: random_password, password_confirmation: random_password})
+      user = User.create(attrs)
+      update_user(user)
+      user
+    end
+
+    def update_user(user)
+      user.update_attributes(remote_user_attributes)
+    end
+
+    protected
+    
+    def remote_user_attributes
+      DeviseRemoteUser.attribute_map.inject({}) { |h, (k, v)| h[k] = env[v] if env.has_key?(v); h }
+    end
+
+    def user_criterion
+      {auth_key => remote_user_id}
+    end
+
+    def remote_user_id
+      env[DeviseRemoteUser.env_key]
+    end
+
+    def auth_key
+      DeviseRemoteUser.auth_key || Devise.authentication_keys.first
+    end
+    
+  end
+
+end

data/lib/devise_remote_user/model.rb

@@ -1,4 +1,5 @@
 require 'devise_remote_user/strategy'
+require 'devise_remote_user/manager'
 
 module Devise::Models
   module RemoteUserAuthenticatable
@@ -7,35 +8,8 @@ module Devise::Models
     module ClassMethods
 
       def find_for_remote_user_authentication(env)
-        user = User.where(auth_key => remote_user_id(env)).first
-        if !user && Devise.remote_user_autocreate
-          user = create_user!(env)
-        end
-        user
-      end
-
-      private
-
-      def auth_key
-        Devise.remote_user_auth_key || self.authentication_keys.first
-      end
-
-      def create_user!(env)
-        random_password = SecureRandom.hex(16)
-        attrs = {
-          auth_key => remote_user_id(env),
-          :password => random_password,
-          :password_confirmation => random_password
-        }.merge(remote_user_attributes(env))
-        User.create! attrs
-      end
-
-      def remote_user_id(env)
-        env[Devise.remote_user_env_key]
-      end
-
-      def remote_user_attributes(env)
-        Devise.remote_user_attribute_map.inject({}) { |h, (k, v)| h[k] = env[v] if env.has_key?(v); h }
+        manager = DeviseRemoteUser::Manager.new(env)
+        manager.find_or_create_user
       end
 
     end

data/lib/devise_remote_user/strategy.rb

@@ -6,7 +6,7 @@ module Devise
     class RemoteUserAuthenticatable < Authenticatable
 
       def valid?
-        env[Devise.remote_user_env_key].present?
+        env[DeviseRemoteUser.env_key].present?
       end
 
       def authenticate!

data/lib/devise_remote_user/version.rb

@@ -1,3 +1,3 @@
 module DeviseRemoteUser
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-remote-user
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A devise extension for remote user authentication.
 email:
 - lib-drs@duke.edu
@@ -48,6 +62,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .gitignore
+- .rspec
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -55,9 +70,11 @@ files:
 - Rakefile
 - devise_remote_user.gemspec
 - lib/devise_remote_user.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/spec_helper.rb
 homepage: http://github.com/duke-libraries/devise-remote-user
 licenses:
 - BSD