devise_auth_proxy 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb482273df7b5210882d40b4baa9a524f8981a885a4165d57ff1e12255ad057f
-  data.tar.gz: 2d452531bc30dcf873834a9412ec111d14eac314c28ae20939da5451a388f066
+  metadata.gz: 20805a1ba1bcb48973d41d94dca1e8d631009db673d682b4d420422ffe1ba236
+  data.tar.gz: bfb81e6096594674589512479b6a8ef1a6ce8dd379ed48b64771b9283e74bc48
 SHA512:
-  metadata.gz: 3c3430f08cd3f30e177905833fa01140257383a826f5403077c13603494a35789bae094b7ae0bd0fdceabc9b8ae6abfa09aec6a2e5bb198aa1e07ede468342a4
-  data.tar.gz: dd23d00047233114e3cda97f6bc93094a020670927a6bf728fdd14ba30dadf1f985f82e57fd2afbb5b4cfecdfc01f2ae70cf6a9c98f49623b063f5da3eb30215
+  metadata.gz: e49b03595c57b9388a99f55c40242da8ef2d0b00cfcf870648d4af1020a9b090a6059e2ef7e7f81651e770a738c3577460ef21d8ccae5086d07dc3d6adb93622
+  data.tar.gz: a7bf31dbf8a6923f223e4495a39b94f57bd8900d796e1de67f4e14a8310558e637eec3e5c35cfe3473a23bbf73437d8a1e5b75fd09221669d1091c9a527e929c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devise_auth_proxy (0.1.14)
+    devise_auth_proxy (0.1.15)
       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/model.rb

@@ -8,9 +8,6 @@ module Devise
 
       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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_auth_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - QuangTK