devise-remote-user 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+The usual github deal: Fork, branch, submit pull request.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013, Duke University Libraries
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+  Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+  Neither the name of the {organization} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,31 @@
+devise-remote-user
+==================
+
+A devise extension for remote user authentication.
+
+## Installation
+
+Add to Gemfile:
+
+```
+gem 'devise-remote-user'
+```
+
+Then
+
+```
+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`:
+
+`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.
+

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/devise_remote_user.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "devise_remote_user/version"
+
+Gem::Specification.new do |s|
+
+  s.name        = "devise-remote-user"
+  s.version     = DeviseRemoteUser::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Chandek-Stark"]
+  s.email       = ["lib-drs@duke.edu"]
+  s.homepage    = "http://github.com/duke-libraries/devise-remote-user"
+  s.summary     = "A devise extension for remote user authentication."
+  s.description = "A devise extension for remote user authentication."
+  s.license     = "BSD"
+
+  s.files = `git ls-files`.split("\n")
+  s.extra_rdoc_files = ["LICENSE", "README.md"]
+  s.require_paths = ["lib"]
+  s.add_dependency "rails", ">= 3.2"
+  s.add_dependency "devise"
+end

data/lib/devise_remote_user/model.rb

@@ -0,0 +1,44 @@
+require 'devise_remote_user/strategy'
+
+module Devise::Models
+  module RemoteUserAuthenticatable
+    extend ActiveSupport::Concern
+
+    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 }
+      end
+
+    end
+
+  end
+end

data/lib/devise_remote_user/strategy.rb

@@ -0,0 +1,21 @@
+require 'devise/strategies/authenticatable'
+
+module Devise
+
+  module Strategies
+    class RemoteUserAuthenticatable < Authenticatable
+
+      def valid?
+        env[Devise.remote_user_env_key].present?
+      end
+
+      def authenticate!
+        resource = mapping.to.find_for_remote_user_authentication(env)
+        resource ? success!(resource) : fail
+      end
+
+    end
+  end
+end
+
+Warden::Strategies.add(:remote_user_authenticatable, Devise::Strategies::RemoteUserAuthenticatable)

data/lib/devise_remote_user/version.rb

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

data/lib/devise_remote_user.rb

@@ -0,0 +1,31 @@
+require 'devise'
+
+module DeviseRemoteUser
+  class Engine < Rails::Engine
+  end
+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'
+  
+  # Enable user auto-creation for remote user
+  mattr_accessor :remote_user_autocreate
+  @@remote_user_autocreate = 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
+
+  # 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 = {}
+end
+
+Devise.add_module(:remote_user_authenticatable,
+                  :strategy => true,
+                  :controller => :sessions,
+                  :model => 'devise_remote_user/model')

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: devise-remote-user
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Chandek-Stark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .gitignore
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- devise_remote_user.gemspec
+- lib/devise_remote_user.rb
+- lib/devise_remote_user/model.rb
+- lib/devise_remote_user/strategy.rb
+- lib/devise_remote_user/version.rb
+homepage: http://github.com/duke-libraries/devise-remote-user
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A devise extension for remote user authentication.
+test_files: []