devise_auth_proxy 0.1.14 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb482273df7b5210882d40b4baa9a524f8981a885a4165d57ff1e12255ad057f
-  data.tar.gz: 2d452531bc30dcf873834a9412ec111d14eac314c28ae20939da5451a388f066
+  metadata.gz: b729be65182611e2eea74a226c4df6b3dfdeda4f740e413cbfd412de8cf46702
+  data.tar.gz: 230e8bec895d53a1d353406e90f14f03d329ddf42a2f99990ae4debf9fff905a
 SHA512:
-  metadata.gz: 3c3430f08cd3f30e177905833fa01140257383a826f5403077c13603494a35789bae094b7ae0bd0fdceabc9b8ae6abfa09aec6a2e5bb198aa1e07ede468342a4
-  data.tar.gz: dd23d00047233114e3cda97f6bc93094a020670927a6bf728fdd14ba30dadf1f985f82e57fd2afbb5b4cfecdfc01f2ae70cf6a9c98f49623b063f5da3eb30215
+  metadata.gz: 886b7820587d7fe3499cc5cfa9617976ac53926c1bd90639b4bcbe3e5f77444011dc9bc40c29a39bbf27c231aca79b2692444c4b334b6f78c231b9c11b91172b
+  data.tar.gz: 262293792ff984a618575afb8b81ae305cadbde8d1e04ef7a3d233fca0dccb84422ce1ff884d63b71a83556a2cf97db8151f29374497b9b789d65cc0d803974c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devise_auth_proxy (0.1.14)
+    devise_auth_proxy (0.1.19)
       devise
 
 GEM

data/README.md

@@ -1,15 +1,15 @@
-# Devise::AuthProxy
+# DeviseAuthProxy
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devise/auth_proxy`. To experiment with that code, run `bin/console` for an interactive prompt.
+A devise extension for proxy user authentication.
 
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/devise_auth_proxy.svg)](http://badge.fury.io/rb/devise_auth_proxy)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'devise-auth_proxy'
+gem 'devise_auth_proxy'
 ```
 
 And then execute:
@@ -18,11 +18,35 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install devise-auth_proxy
+    $ gem install devise_auth_proxy
 
 ## Usage
 
-TODO: Write usage instructions here
+Invoke hook 
+* Add `:auth_proxy_authenticatable` symbol to `devise` statement in User model, before other authentication strategies (e.g., `:database_authenticatable`).
+
+Configuaration options:
+* `env_key` - String (default: 'AUTH_PROXY'). Request environment key for the proxy 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 proxy 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 proxy user attributes.
+* `logout_url` - String (default: '/'). For redirecting to a proxy user logout URL after signing out of the Rails application. Include DeviseAuthProxy::ControllerBehavior in your application controller to enable (by overriding Devise's after_sign_out_path_for).
+
+
+Set options in a Rails initializer (e.g., `config/intializers/devise.rb`):
+
+```
+require 'devise_auth_proxy'
+
+DeviseAuthProxy.configure do |config|
+  config.env_key = 'HTTP_AUTH_PROXY'
+  config.auto_create = true
+  config.auto_update = true
+  config.attribute_map = { email: 'mail' }
+  config.logout_url = "http://localhost:3000/logout"
+end
+```
+
 
 ## Development
 
@@ -32,7 +56,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devise-auth_proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/devise-auth_proxy/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/me0den/devise_auth_proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/me0den/devise_auth_proxy/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +65,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Devise::AuthProxy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/devise-auth_proxy/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the DeviseAuthProxy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/me0den/devise_auth_proxy/blob/master/CODE_OF_CONDUCT.md).

data/lib/devise_auth_proxy.rb

@@ -3,7 +3,7 @@ require 'devise_auth_proxy/version'
 
 module DeviseAuthProxy
   class << self
-    attr_accessor :env_key, :auto_create, :auto_update, :auth_key, :attribute_map, :logout_url
+    attr_accessor :env_key, :auto_create, :auto_update, :auth_key, :attribute_map, :default_role, :logout_url
   end
 
   # request.env key for remote user name
@@ -23,6 +23,9 @@ module DeviseAuthProxy
   # Map of User model attributes to request.env keys for updating a local user when auto-creation is enabled.
   self.attribute_map = {}
 
+  # Set default role for new user.
+  self.default_role = []
+
   # Settings for redirecting to the remote user logout URL
   # Enable by including DeviseAuthProxy::Controllers::Helpers in ApplicationController
   # (it overrides Devise's after_sign_out_path_for method).
@@ -32,7 +35,7 @@ module DeviseAuthProxy
     yield self
   end
 
-  def self.remote_user_id env
+  def self.proxy_user_id(env)
     case env_key
     when Proc
       env_key.call(env)

data/lib/devise_auth_proxy/controller.rb

@@ -0,0 +1,17 @@
+module DeviseAuthProxy
+  module Controller
+
+    # Modify session controller after user log out.
+    # To redirect user to a custom url.
+    def after_sign_out_path_for(resource_or_scope)
+      DeviseAuthProxy.logout_url if proxy_user_authenticated? and DeviseAuthProxy.logout_url
+      super
+    end
+
+    private
+
+    def proxy_user_authenticated?
+      DeviseAuthProxy.proxy_user_id(request.env).present?
+    end
+  end
+end

data/lib/devise_auth_proxy/manager.rb

@@ -27,31 +27,37 @@ module DeviseAuthProxy
     end
 
     def create_user
-      unless Devise.mappings[:user].strategies.include?(:database_authenticatable)
+      unless Devise.mappings[:admin_user].strategies.include?(:database_authenticatable)
         return klass.create(user_criterion)
       end
 
       random_password = SecureRandom.hex(16)
-      attrs = user_criterion.merge({password: random_password, password_confirmation: random_password})
+      attrs = user_criterion.merge({
+                                       password: random_password,
+                                       password_confirmation: random_password,
+                                       roles: DeviseAuthProxy.default_role
+                                   })
+
+
       klass.create(attrs)
     end
 
     def update_user(user)
-      user.update_attributes(remote_user_attributes)
+      user.update_attributes(proxy_user_attributes)
     end
 
     protected
 
-    def remote_user_attributes
+    def proxy_user_attributes
       DeviseAuthProxy.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}
+      {auth_key => proxy_user_id}
     end
 
-    def remote_user_id
-      DeviseAuthProxy.remote_user_id(env)
+    def proxy_user_id
+      DeviseAuthProxy.proxy_user_id(env)
     end
 
     def auth_key

data/lib/devise_auth_proxy/model.rb

@@ -7,10 +7,6 @@ module Devise
       extend ActiveSupport::Concern
 
       included do
-        attr_reader :current_password, :password
-      end
-
-      module ClassMethod
         def self.find_for_auth_proxy_authentication(env)
           manager = DeviseAuthProxy::Manager.new(self, env)
           manager.find_or_create_user

data/lib/devise_auth_proxy/strategy.rb

@@ -5,12 +5,16 @@ module Devise
     class AuthProxyAuthenticatable < Authenticatable
 
       def valid?
-        DeviseAuthProxy.remote_user_id(env).present?
+        DeviseAuthProxy.proxy_user_id(env).present?
       end
 
       def authenticate!
         resource = mapping.to.find_for_auth_proxy_authentication(env)
-        resource ? success!(resource) : fail
+
+        return fail(:invalid) unless resource
+
+        remember_me(resource)
+        success!(resource)
       end
 
     end

data/lib/devise_auth_proxy/version.rb

@@ -1,3 +1,3 @@
 module DeviseAuthProxy
-  VERSION = "0.1.14"
+  VERSION = "0.1.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_auth_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.19
 platform: ruby
 authors:
 - QuangTK
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -44,6 +44,7 @@ files:
 - bin/setup
 - devise_auth_proxy.gemspec
 - lib/devise_auth_proxy.rb
+- lib/devise_auth_proxy/controller.rb
 - lib/devise_auth_proxy/manager.rb
 - lib/devise_auth_proxy/model.rb
 - lib/devise_auth_proxy/strategy.rb