devise_ichain_authenticatable 0.2.0 → 0.2.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2RmMzFkMDdkZjIyMjYzZmQ5MjNjNzgxOTliNTk0NjhlM2U0Y2FmNA==
+  data.tar.gz: !binary |-
+    MDI2MjhhZTBkMTBjMTcwMGQwM2RkODU4NzIyOTViZjQ5ZmNjMWM4Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MzA1YTE4MDA5NTBhNDJmNmRmNGUzNzZhMTNiODJmMGI3MGIxMDIzZmZkMzVj
+    YTJkYTBmMTg1YjcyZGNhYjRjMWJmYWFkZmEwZjk1N2MxNWRlZjY4ZmJlM2I4
+    MWZlNTJlYTc1MGZjODY1YjdhYjNiOThkZjU3NzMzNDBjNTM5ODM=
+  data.tar.gz: !binary |-
+    NmIwZjg1ZTNhZjUwODlkMDgwZDNhMTM0N2M4NTRkZjA0MTU4OTEyOTA1YmYy
+    Mzk4YmE0NWUwZjg2ZGQwYzVjYjFlZDI3Njc1NGI4ZmRhMDc4ZjE2YjU2NjBi
+    NTQ2ZTM2MTdmOGM0NzQzMmNjZTc1OTMwM2VmMjVmYzYzZThjM2U=

data/README.md

@@ -1,5 +1,120 @@
 Devise iChain Authenticatable
 =============================
 
-Devise extension to allow authentication via iChain. Proper documentation is on
-the way.
+iChain based authentication for the
+[Devise](http://github.com/plataformatec/devise) authentication framework.
+The plugin adds two new modules to Devise: `ichain_autenticatable` and
+`ichain_registerable`. This plugin is compatible with Database Authenticatable,
+so users in your application can be authenticated with both mechanism if
+desired.
+
+Requirements
+------------
+
+The plugin should be compatible with Ruby 1.8.7, 1.9.3 and 2.0, but have only be
+tested in production with Ruby 1.9.3.
+
+In the same way, it should work with any version of Devise equal or greater than 2.2
+and with any version of Rails equal or greater than 3.2, but have only be tested
+with Rails 3.2 and Devise 2.2.
+
+Reporting of success stories with other setups would be highly appreciated.
+
+Installation and basic setup
+---------------------------
+
+First of all, install Devise following the great documentation available in
+[its official website](http://github.com/plataformatec/devise). Then, just add
+the following line to your Gemfile and run the bundle command.
+
+    gem "devise_ichain_authenticatable"
+
+Only two changes are required in your user model. First, you obviously need to
+add the new modules to the devise call. In the other hand, you need to provide
+a way to link the iChain usernames to your application users by implementing
+the `for_ichain_username` class method. For example:
+
+```ruby
+class User < ActiveRecord::Base
+  devise :ichain_authenticatable, :ichain_registerable
+
+  def self.for_ichain_username(username, attributes)
+    find_or_create_by_login(username)
+  end
+end
+```
+
+After performing a valid iChain authentication, the plugin will call the
+`from_ichain_username` class method of your model
+passing two parameters: the username validated by iChain and a hash of
+additional parameters defined in the configuration of your iChain proxy
+(see `config.ichain_attributes_header` below).
+The method is expected to return a valid user object. If the returned
+value is evaluated to false or nil, the authentication will fail.
+
+In the example, an ActiveRecord based model is used, but the plugin will
+work with any storage backend as long as it's supported by Devise and
+the `from_ichain_username` is properly implemented.
+
+Finally, you'll need to add some configuration to your
+`config/initializers/devise.rb` in order to tell your app how to talk
+to your iChain proxy.
+
+```ruby
+Devise.setup do |config|
+ ...
+ # You will always need to set this parameter.
+ config.ichain_base_url = "https://my.application.org"
+
+ # The header used by your iChain proxy to pass the username.
+ # config.ichain_username_header = "HTTP_X_USERNAME"
+
+ # Additional parameters, beyond the username, provided by the iChain proxy.
+ # HTTP_X_EMAIL is expected by default. Set to {} if no additional attributes
+ # are configured in the proxy.
+ # config.ichain_attributes_header = {:email => "HTTP_X_EMAIL"}
+
+ # Configuration options for requests sent to the iChain proxy
+ # config.ichain_context = "default"
+ # config.ichain_proxypath = "reverse"
+
+ # Activate the test mode, useful when no real iChain is present, like in
+ # testing and development environments
+ # config.ichain_test_mode = false
+end
+```
+
+Helpers
+-------
+
+This plugin provides the expected URL helpers, analogous to those provided by
+Database Authenticable and Registerable. For example, for a model called User,
+the following helpers would be available: `new_user_ichain_session_path`,
+`destroy_user_ichain_session_path`, `new_ichain_registration_path`...
+
+Test mode
+---------
+
+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.
+
+Contact
+-------
+
+Ancor González Sosa
+
+* http://github.com/ancorgs
+* ancor@suse.de
+
+License
+-------
+
+The Redmine iChain Plugin is licensed under the MIT License (MIT-LICENSE.txt).
+
+Copyright (c) 2013 Ancor González Sosa

data/lib/devise_ichain_authenticatable/version.rb

@@ -1,3 +1,3 @@
 module DeviseIchainAuthenticatable
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: devise_ichain_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Ancor González Sosa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,27 +51,26 @@ files:
 homepage: https://github.com/openSUSE/devise_ichain_authenticatable
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Devise extension to allow authentication via iChain
 test_files: []
 has_rdoc: