devise_ichain_authenticatable 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c464140caabf7bc6a25efdc813300f15633122e
-  data.tar.gz: ba7d54cf541b68092ed802e76a639a740c0c2f8e
+  metadata.gz: 9f527cdc5099cd67334d3d9497ae0f4584df0292
+  data.tar.gz: 3419f6f040a85f47d948b8c1a13e55aa23fbc803
 SHA512:
-  metadata.gz: 81b07af69ed0fd985790d1210c2002d0d639c6815f4665efdc6b062337fb3a068145c4b715d141b5e96d33d7d215604baabed1a399b7d49e64c3209ff8252b32
-  data.tar.gz: 56759efd6146ded0216362b3ccaca0d1a047b2d8208db839c5b6375572c96c10865ef085fa65026e80b09dda0f81ba55fe06cadcd204c94bfabc308f65850878
+  metadata.gz: 48911f54980f20aca91f8d656f7f0a479c743b5364b7a3baa5de73b6768ea708c9ee47329077f86cc694af9c3735d74db4f49ba3629fe05e5350ede4400e54b1
+  data.tar.gz: 4469b6c2bbd0fc5c87ca1913cdbd2451cdd796418be7a803dfec9a146b3e250cd237b9c206a1ecf616c8cd56fcf6355a266efec767b406c190f4fd73a9dec44c

data/README.md

@@ -90,6 +90,13 @@ Devise.setup do |config|
  # Activate the test mode, useful when no real iChain is present, like in
  # testing and development environments
  # config.ichain_test_mode = false
+
+ # In test mode, you can skip asking for the user information by always
+ # forcing the following username. The user will be permanently signed in.
+ # config.ichain_force_test_username = "testuser"
+
+ # In test mode, force the following additional attributes
+ # config.ichain_force_test_attributes = {:email => "testuser@example.com"}
 end
 ```
 
@@ -104,14 +111,24 @@ the following helpers would be available: `new_user_ichain_session_path`,
 Test mode
 ---------
 
-If the test mode is enabled in the configuration file, anytime
+This gem provides a test mode, extremely useful during the development
+phase, in which an iChain proxy is not usually configured or even available.
+```ichain_registerable```will have no effect if test mode is enabled.
+
+By default, if the test mode is enabled in the configuration file, anytime
 authentication is required, a very simple form asking for the username and the
 additional parameters will be displayed. The entered values will be completely
-trusted with no check. ```ichain_registerable```will have no effect if test mode
-is enabled.
-
-This mode is extremely useful during the development phase, in which an iChain
-proxy is not usually configured or even available.
+trusted with no check and stored in the Rails' session.
+
+In some situations this approach is not useful, either because the application
+lacks sessions' management and/or user interface (for example, applications
+based on [rails-api](https://github.com/rails-api/rails-api)), either because
+you simply want to skip asking for the test user information. In those
+cases, a username and/or a set of additional attributes can be forced using the
+```ichain_force_test_username``` and ```ichain_force_test_attributes```
+configuration options. If ```ichain_force_test_username``` is set, the username
+will be used in every single request, which means that the user will be
+permanently signed in.
 
 Contact
 -------

data/app/controllers/devise/ichain_sessions_controller.rb

@@ -1,19 +1,16 @@
 class Devise::IchainSessionsController < DeviseController
   prepend_before_filter :require_no_authentication, :only => [ :new, :test ]
 
-  # GET /resource/sign_in
   def new
     return new_test if ::Devise.ichain_test_mode
     self.resource = resource_class.new
     @back_url = base_url + after_sign_in_path_for(resource_name)
-    # The slash at the end is very important
     @login_url = resource_class.ichain_login_url
     @context = ::Devise.ichain_context
     @proxypath = ::Devise.ichain_proxypath
     respond_with resource
   end
 
-  # DELETE /resource/sign_out
   def destroy
     redirect_url = base_url + after_sign_out_path_for(resource_name)
     if ::Devise.ichain_test_mode
@@ -23,7 +20,6 @@ class Devise::IchainSessionsController < DeviseController
       set_flash_message :notice, :signed_out if signed_out && is_navigational_format?
       redirect_to redirect_url
     else
-      # The final slash is very important, indeed
       logout_url = resource_class.ichain_logout_url
       logout_url += "?" + {:url => redirect_url}.to_query
       redirect_to logout_url

data/app/views/devise/ichain_sessions/new_test.html.erb

@@ -3,9 +3,11 @@
 <%= form_tag(@login_url, :method => :post, :enctype => 'application/x-www-form-urlencoded') do %>
   <div><%= label_tag :username, "Username" %><br />
   <%= text_field_tag :username, "" %></div>
-  <%- @fields.each do |field| %>
-    <div><%= label_tag "attributes[#{field}]",  field.to_s.humanize %><br />
-    <%= text_field_tag "attributes[#{field}]", "" %></div>
+  <%- if ::Devise.ichain_force_test_attributes.blank? -%>
+    <%- @fields.each do |field| %>
+      <div><%= label_tag "attributes[#{field}]",  field.to_s.humanize %><br />
+      <%= text_field_tag "attributes[#{field}]", "" %></div>
+    <%- end -%>
   <%- end -%>
 
   <div><%= submit_tag "Sign in" %></div>

data/lib/devise_ichain_authenticatable.rb

@@ -9,12 +9,16 @@ module Devise
   autoload :IchainFailureApp, 'devise/ichain_failure_app'
 
   # Configuration params
-  @@ichain_test_mode = false
   @@ichain_base_url = nil
   @@ichain_context = "default"
   @@ichain_proxypath = "reverse"
   @@ichain_username_header = "HTTP_X_USERNAME"
   @@ichain_attribute_headers = {:email => "HTTP_X_EMAIL"}
+
+  @@ichain_test_mode = false
+  @@ichain_force_test_username = nil
+  @@ichain_force_test_attributes = nil
+
   # The slashes at the end of the urls looks to be relevant
   @@ichain_login_path = "ICSLogin/"
   @@ichain_registration_path = "ICSLogin/auth-up/"
@@ -23,7 +27,8 @@ module Devise
   mattr_accessor :ichain_test_mode, :ichain_base_url,
     :ichain_login_path, :ichain_registration_path, :ichain_logout_path,
     :ichain_context, :ichain_proxypath,
-    :ichain_username_header, :ichain_attribute_headers
+    :ichain_username_header, :ichain_attribute_headers,
+    :ichain_force_test_username, :ichain_force_test_attributes
 end
 
 Devise.add_module :ichain_authenticatable,

data/lib/devise_ichain_authenticatable/strategy.rb

@@ -11,9 +11,16 @@ class Devise::Strategies::IchainAuthenticatable < Devise::Strategies::Authentica
   end
 
   def authenticate!
+    proxy_user = nil
     if ::Devise.ichain_test_mode
-      unless session[:ichain_test_username].blank?
+      if ::Devise.ichain_force_test_username
+        proxy_user = ::Devise.ichain_force_test_username.to_s
+      elsif session[:ichain_test_username]
         proxy_user = session[:ichain_test_username]
+      end
+      if ::Devise.ichain_force_test_attributes
+        attributes = ::Devise.ichain_force_test_attributes
+      else
         attributes = session[:ichain_test_attributes] || {}
       end
     else

data/lib/devise_ichain_authenticatable/version.rb

@@ -1,3 +1,3 @@
 module DeviseIchainAuthenticatable
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_ichain_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ancor González Sosa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Devise extension to allow authentication via iChain