devise_aaf_rc_authenticatable 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 912d174bde0b9d41951b5ef751a68e3331709865
+  data.tar.gz: 77fea7ba019546f867f2e2aa3b589f65ac0c96b3
+SHA512:
+  metadata.gz: aac9c7896eda68e13a24d486504592099a09793853fd43525c5232d06606810ce11f301ce3efd3bd491c754916613ea3342229d19e094ee06bc87714a7437394
+  data.tar.gz: 79e4c5f4b50714cdb1760cb08c85feb3881e57fb864ef8960e21c252503a37a64ca6c65a341ee0def370e701796ae7e215f93f516bc599bb7798788eab55330d

data/.ruby-gemset

@@ -0,0 +1 @@
+devise_aaf_rc

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+  gem "json", ">= 0"
+  gem "json-jwt", ">= 0"
+  gem "builder", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.15)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.6)
+    builder (3.2.2)
+    faraday (0.7.6)
+      addressable (~> 2.2)
+      multipart-post (~> 1.1)
+      rack (~> 1.1)
+    git (1.2.7)
+    github_api (0.4.10)
+      faraday (~> 0.7.6)
+      hashie (~> 1.2.0)
+      multi_json (~> 1.0)
+      oauth2 (~> 0.5.2)
+    hashie (1.2.0)
+    highline (1.6.21)
+    i18n (0.6.5)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    json-jwt (0.4.1)
+      activesupport (>= 2.3)
+      i18n
+      json (>= 1.4.3)
+      url_safe_base64
+    mini_portile (0.6.0)
+    multi_json (1.2.0)
+    multipart-post (1.2.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.5.2)
+      faraday (~> 0.7)
+      multi_json (~> 1.0)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    url_safe_base64 (0.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  builder
+  bundler (>= 1.0.0)
+  jeweler (~> 2.0.1)
+  json
+  json-jwt
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Intersect Australia Limited
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+devise_aaf_rc_authenticatable
+=============================
+
+Devise AAF Rapid Connect Authenticatable is an authentication strategy for the Devise[http://github.com/plataformatec/devise] authentication framework.

data/README.rdoc

@@ -0,0 +1,62 @@
+= devise_aaf_rc_authenticatable
+
+Devise AAF Rapid Connect Authenticatable is an authentication strategy for the Devise[http://github.com/plataformatec/devise] authentication framework.
+
+This is customised for Intersect Australia.
+
+== Prerequisites
+* devise ~> 1.5.4 (which requires rails ~> 3.1)
+
+== Usage
+In the Gemfile for your application:
+
+    gem "devise_aaf_rc_authenticatable"
+
+To get the latest version, pull directly from github instead of the gem:
+
+    gem "devise_aaf_rc_authenticatable", :git => "git://github.com/IntersectAustralia/devise_aaf_rc_authenticatable.git"
+
+== Setup
+Run the rails generators for devise (please check the devise[http://github.com/plataformatec/devise] documents for further instructions)
+
+    rails generate devise:install
+    rails generate devise MODEL_NAME
+
+Run the rails generator for 'devise_aaf_rc_authenticatable'
+
+    rails generate devise_aaf_rc_authenticatable:install
+
+== Configuration
+In initializer 'config/initializers/devise.rb' :
+
+* config.aaf_rc_logger <em>(default: true)</em>
+* config.aaf_rc_create_user <em>(default: true)</em>
+* config.aaf_rc_config <em>(default:#{Rails.root}/config/aaf_rc.yml)</em>
+
+In configuration 'config/aaf_rc.yml' :
+
+* user-mapping
+  * A hash-map of the AAF attributes that you want saved to your User model.
+
+* aaf_rc_login_url
+  * The URL to your AAF IdP
+
+== Contributing to devise_aaf_rc_authenticatable
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== References
+* Devise[http://github.com/plataformatec/devise]
+* AAF Rapid Connect[http://rapid.aaf.edu.au]
+
+== Copyright
+
+Copyright (c) 2013 Intersect Australia Limited. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the devise_imapable plugin.'
+Rake::TestTask.new(:test) do |t|
+  # t.libs << 'lib'
+  # t.libs << 'test'
+  # t.pattern = 'test/**/*_test.rb'
+  # t.verbose = true
+end
+
+desc 'Generate documentation for the devise_aaf_rc_authenticatable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DeviseAafRcAuthenticatable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "devise_aaf_rc_authenticatable"
+    gemspec.summary = "AAF Rapid Connect authentication module for Devise"
+    gemspec.description = "Devise AAF Rapid Connect Authenticatable is an authentication strategy for the Devise[http://github.com/plataformatec/devise] authentication framework."
+    gemspec.email = ["gabriel@intersect.org.au", "shuqian@intersect.org.au", "danielt@intersect.org.au", "jake@intersect.org.au"]
+    gemspec.homepage = "http://github.com/IntersectAustralia/devise_aaf_rc_authenticatable"
+    gemspec.authors = ["Gabriel Gasser Noblia", "Shuqian Hon", "Daniel Theodosius", "Jake Farrell"]
+    gemspec.add_runtime_dependency "devise", ">= 1.5.4"
+    gemspec.version = "0.0.2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/app/controllers/devise/aaf_rc_sessions_controller.rb

@@ -0,0 +1,32 @@
+class Devise::AafRcSessionsController < Devise::SessionsController
+  unloadable
+  prepend_before_filter :require_no_authentication, :only => [:aaf_new, :aaf_create]
+  prepend_before_filter :allow_params_authentication!, :only => :aaf_create
+
+  def aaf_new
+    config = YAML.load(ERB.new(File.read(::Devise.aaf_rc_config || "#{Rails.root}/config/aaf_rc.yml")).result)[Rails.env]
+
+    redirect_to config['aaf_rc_login_url']
+  end
+
+  def aaf_create
+    self.resource = warden.authenticate!(auth_options)
+    set_flash_message(:notice, :signed_in) if is_navigational_format?
+    sign_in(resource_name, resource)
+    respond_with resource, :location => after_sign_in_path_for(resource)
+  end
+
+  def aaf_destroy
+    session.delete(:attributes)
+    session.delete(:jwt)
+    session.delete(:jwt_unauthorized)
+  end
+
+  def destroy
+    session.delete(:attributes)
+    session.delete(:jwt)
+    session.delete(:jwt_unauthorized)
+    super
+  end
+
+end

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  devise:
+    failure:
+      invalid_aaf: 'You must be an approved user to access this site.'
+      invalid_audience: 'Invalid audience.'
+      invalid_timing: 'Invalid timing.'
+      invalid_jwt: 'Signature was invalid or JWT was otherwise erroneous.'
+    aaf_rc_sessions:
+      signed_in: 'Logged in successfully.'
+      signed_out: 'Logged out successfully.'

data/devise_aaf_rc_authenticatable.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: devise_aaf_rc_authenticatable 0.0.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "devise_aaf_rc_authenticatable"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Gabriel Gasser Noblia", "Shuqian Hon", "Daniel Theodosius", "Jake Farrell"]
+  s.date = "2014-06-26"
+  s.description = "Devise AAF Rapid Connect Authenticatable is an authentication strategy for the Devise[http://github.com/plataformatec/devise] authentication framework."
+  s.email = ["gabriel@intersect.org.au", "shuqian@intersect.org.au", "danielt@intersect.org.au", "jake@intersect.org.au"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".ruby-gemset",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/devise/aaf_rc_sessions_controller.rb",
+    "config/locales/en.yml",
+    "devise_aaf_rc_authenticatable.gemspec",
+    "lib/devise_aaf_rc_authenticatable.rb",
+    "lib/devise_aaf_rc_authenticatable/exception.rb",
+    "lib/devise_aaf_rc_authenticatable/logger.rb",
+    "lib/devise_aaf_rc_authenticatable/model.rb",
+    "lib/devise_aaf_rc_authenticatable/routes.rb",
+    "lib/devise_aaf_rc_authenticatable/schema.rb",
+    "lib/devise_aaf_rc_authenticatable/strategy.rb",
+    "lib/devise_aaf_rc_authenticatable/version.rb",
+    "lib/generators/devise_aaf_rc_authenticatable/install_generator.rb",
+    "lib/generators/devise_aaf_rc_authenticatable/templates/aaf_rc.yml",
+    "rails/init.rb"
+  ]
+  s.homepage = "http://github.com/IntersectAustralia/devise_aaf_rc_authenticatable"
+  s.rubygems_version = "2.2.2"
+  s.summary = "AAF Rapid Connect authentication module for Devise"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<json-jwt>, [">= 0"])
+      s.add_development_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<devise>, [">= 1.5.4"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<json-jwt>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<devise>, [">= 1.5.4"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<json-jwt>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<devise>, [">= 1.5.4"])
+  end
+end
+

data/lib/devise_aaf_rc_authenticatable.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'devise'
+
+require 'devise_aaf_rc_authenticatable/exception'
+require 'devise_aaf_rc_authenticatable/logger'
+require 'devise_aaf_rc_authenticatable/schema'
+require 'devise_aaf_rc_authenticatable/routes'
+
+begin
+  Rails::Engine
+rescue
+else
+  module DeviseAafRcAuthenticatable
+    class Engine < Rails::Engine
+    end
+  end
+end
+
+# Get aaf_rc information from config/aaf_rc.yml now
+module Devise
+  # Allow logging
+  mattr_accessor :aaf_rc_logger
+  @@aaf_rc_logger = true
+  
+  # Add valid users to database
+  mattr_accessor :aaf_rc_create_user
+  @@aaf_rc_create_user = false
+  
+  mattr_accessor :aaf_rc_config
+  @@aaf_rc_config = "#{Rails.root}/config/aaf_rc.yml"
+  
+end
+
+# Add aaf_rc_authenticatable strategy to defaults.
+#
+Devise.add_module(:aaf_rc_authenticatable,
+                  :route => :aaf_rc_authenticatable,
+                  :strategy   => true,
+                  :controller => :aaf_rc_sessions,
+                  :model  => 'devise_aaf_rc_authenticatable/model')

data/lib/devise_aaf_rc_authenticatable/exception.rb

@@ -0,0 +1,6 @@
+module DeviseAafRcAuthenticatable
+
+  class AafRcException < Exception
+  end
+
+end

data/lib/devise_aaf_rc_authenticatable/logger.rb

@@ -0,0 +1,11 @@
+module DeviseAafRcAuthenticatable
+
+  class Logger    
+    def self.send(message, logger = Rails.logger)
+      if ::Devise.aaf_rc_logger
+        logger.add 0, "  \e[36mAAF Rapid Connect:\e[0m #{message}"
+      end
+    end
+  end
+
+end

data/lib/devise_aaf_rc_authenticatable/model.rb

@@ -0,0 +1,70 @@
+require 'devise_aaf_rc_authenticatable/strategy'
+
+module Devise
+  module Models
+    module AafRcAuthenticatable
+      extend ActiveSupport::Concern
+
+      # Need to determine why these need to be included
+      included do
+        attr_reader :password, :current_password
+        attr_accessor :password_confirmation
+      end
+
+      def update_with_password(params={})
+        params.delete(:current_password)
+        self.update_without_password(params)
+      end
+
+      def update_without_password(params={})
+        params.delete(:password)
+        params.delete(:password_confirmation)
+
+        result = update_attributes(params)
+        result
+      end
+
+      # Hook called after AAF authentication.
+      def after_aaf_rc_authentication
+      end
+
+      module ClassMethods
+
+        def authenticate_with_aaf_rc(attributes={})
+
+          auth_key = self.authentication_keys.first
+
+          auth_key_value = (self.case_insensitive_keys || []).include?(auth_key) ? attributes['mail'].downcase : attributes['mail']
+
+          resource = where(auth_key => auth_key_value).first
+
+          if (resource.nil? && !Devise.aaf_rc_create_user)
+            logger.info("User(#{auth_key_value}) not found.  Not configured to create the user.")
+            return nil
+          end
+
+          if (resource.nil? && Devise.aaf_rc_create_user)
+            logger.info("Creating user(#{auth_key_value}).")
+            resource = new
+            save_user_aaf_rc_attributes(resource, attributes)
+            resource.aaf_rc_before_save if resource.respond_to?(:aaf_rc_before_save)
+            resource.save
+          end
+
+          resource
+        end
+
+        private
+        def save_user_aaf_rc_attributes(resource, attributes)
+          config = YAML.load(ERB.new(File.read(::Devise.aaf_rc_config || "#{Rails.root}/config/aaf_rc.yml")).result)[Rails.env]
+          config['user-mapping'].each do |aaf_attr, db_field|
+            logger.info("Saving #{attributes[aaf_attr]} to #{db_field}")
+            field = "#{db_field}="
+            value = attributes[aaf_attr]
+            resource.send(field, value.to_s) if resource.respond_to?(field)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/devise_aaf_rc_authenticatable/routes.rb

@@ -0,0 +1,12 @@
+ActionDispatch::Routing::Mapper.class_eval do
+  protected
+  
+  def devise_aaf_rc_authenticatable(mapping, controllers)
+    resource :session, :only => [], :controller => controllers[:aaf_rc_sessions], :path => "" do
+      get :aaf_new, :path => mapping.path_names[:aaf_new]
+      post :aaf_create, :path => mapping.path_names[:aaf_sign_in]
+      get :aaf_destroy, :path => mapping.path_names[:aaf_sign_out]
+    end
+
+  end
+end

data/lib/devise_aaf_rc_authenticatable/schema.rb

@@ -0,0 +1,14 @@
+## Using email now instead of login. Will add an option later on.
+
+# Devise::Schema.class_eval do
+#     # Creates login
+#     #
+#     # == Options
+#     # * :null - When true, allow columns to be null.
+#     def aaf_rc_authenticatable(options={})
+#       null = options[:null] || false
+# 
+#       apply_schema :login, String, :null => null
+#     end
+# 
+# end

data/lib/devise_aaf_rc_authenticatable/strategy.rb

@@ -0,0 +1,63 @@
+require 'devise/strategies/authenticatable'
+require 'json'
+require 'json/jwt'
+
+module Devise
+  module Strategies
+    class AafRcAuthenticatable < Authenticatable
+
+      def valid?
+        params["assertion"].present? || (session["jwt"].present? && !session["jwt_unauthorized"].present?)
+      end
+
+      def authenticate!
+        # params["assertion"] is checked for presence in valid? method.
+        jws = params["assertion"]
+        if jws
+          begin
+
+            config = YAML.load(ERB.new(File.read(::Devise.aaf_rc_config || "#{Rails.root}/config/aaf_rc.yml")).result)[Rails.env]
+
+            jwt = JSON::JWT.decode(jws.to_s, config['secret_token'])
+            aaf_host = config['aaf_rc_login_url'][/^https:\/\/[\w\.]+/] if config['aaf_rc_login_url']
+            aaf_host ||= "https://rapid.aaf.edu.au"
+
+            # In a complete app we'd also store and validate the jti value to ensure there is no replay attack
+            if jwt['iss'] == aaf_host && jwt['aud'] == config['hostname']
+              current_time = Time.now
+              if current_time > Time.at(jwt['nbf']) && current_time < Time.at(jwt['exp'])
+                session[:attributes] = jwt['https://aaf.edu.au/attributes']
+                session[:jwt] = jwt
+              else
+                logger.error(" Timing is invalid. #{current_time} out of range of #{Time.at(jwt['nbf'])} to #{Time.at(jwt['exp'])}")
+                return fail(:invalid_timing)
+              end
+            else
+              logger.error(" Audience is invalid. #{jwt['aud']} vs #{config['hostname']}")
+              return fail(:invalid_audience)
+            end
+          rescue Exception => e
+            logger.error(" Signature was invalid or JWT was otherwise erroneous. #{e.message}")
+            return fail(:invalid_jwt)
+          end
+        end
+
+        resource = mapping.to.authenticate_with_aaf_rc(session[:attributes])
+
+        if validate(resource)
+          begin
+            resource.after_aaf_rc_authentication
+            session.delete(:jwt_unauthorized)
+          rescue Exception
+            session["jwt_unauthorized"] = 'Unauthorized'
+          end
+          success!(resource)
+        elsif !halted?
+          fail(:invalid)
+        end
+      end
+    end
+  end
+end
+
+Warden::Strategies.add(:aaf_rc_authenticatable, Devise::Strategies::AafRcAuthenticatable)

data/lib/devise_aaf_rc_authenticatable/version.rb

@@ -0,0 +1,4 @@
+module DeviseAafRcAuthenticatable
+  VERSION = "0.0.2"
+end
+

data/lib/generators/devise_aaf_rc_authenticatable/install_generator.rb

@@ -0,0 +1,60 @@
+module DeviseAafRcAuthenticatable
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    
+    class_option :user_model, :type => :string, :default => "user", :desc => "Model to update"
+    class_option :update_model, :type => :boolean, :default => false, :desc => "Update model to change from database_authenticatable to aaf_rc_authenticatable"
+    class_option :add_rescue, :type => :boolean, :default => true, :desc => "Update Application Controller with resuce_from for DeviseAafRcAuthenticatable::AafRcException"
+    class_option :advanced, :type => :boolean, :desc => "Add advanced config options to the devise initializer"
+    
+    
+    def create_aaf_rc_config
+      copy_file "aaf_rc.yml", "config/aaf_rc.yml"
+    end
+
+    def copy_locale
+      copy_file "../../../../config/locales/en.yml", "config/locales/devise_aaf_rc.en.yml"
+    end
+    
+    def create_default_devise_settings
+      inject_into_file "config/initializers/devise.rb", default_devise_settings, :after => "Devise.setup do |config|\n"   
+    end
+    
+    def update_user_model
+      gsub_file "app/models/#{options.user_model}.rb", /:database_authenticatable/, ":aaf_rc_authenticatable" if options.update_model?
+    end
+    
+    def update_application_controller
+      inject_into_class "app/controllers/application_controller.rb", ApplicationController, rescue_from_exception if options.add_rescue?
+    end
+    
+    private
+    
+    def default_devise_settings
+      settings = <<-eof
+  # ==> AAF Rapid Connect Configuration
+  # config.aaf_rc_logger = true
+  # config.aaf_rc_create_user = false
+  # config.aaf_rc_config = "\#{Rails.root}/config/aaf_rc.yml"
+
+      eof
+      if options.advanced?  
+        settings << <<-eof  
+  # ==> Advanced AAF Rapid Connect Configuration
+  
+        eof
+      end
+      
+      settings
+    end
+    
+    def rescue_from_exception
+      <<-eof
+  rescue_from DeviseAafRcAuthenticatable::AafRcException do |exception|
+    render :text => exception, :status => 500
+  end
+      eof
+    end
+    
+  end
+end

data/lib/generators/devise_aaf_rc_authenticatable/templates/aaf_rc.yml

@@ -0,0 +1,43 @@
+common: &common
+  # this is to map attributes as described in http://aaf.edu.au/technical/aaf-core-attributes/
+  # to their respective field in the database
+  # uncomment them if need be
+  user-mapping:
+    cn: ""
+    displayname: ""
+    edupersontargetedid: ""
+    edupersonscopedaffiliation: ""
+    edupersonprincipalname: ""
+    mail: email
+    givenname: first_name
+    surname: last_name
+
+development:
+  <<: *common
+  hostname: hostname.com
+  secret_token: REPLACE_ME
+  aaf_rc_login_url: https://rapid.test.aaf.edu.au/jwt/authnrequest/research/REPLACE_ME
+
+qa:
+  <<: *common
+  hostname: hostname.com
+  secret_token: REPLACE_ME
+  aaf_rc_login_url: https://rapid.test.aaf.edu.au/jwt/authnrequest/research/REPLACE_ME
+
+staging:
+  <<: *common
+  hostname: hostname.com
+  secret_token: REPLACE_ME
+  aaf_rc_login_url: https://rapid.test.aaf.edu.au/jwt/authnrequest/research/REPLACE_ME
+
+test:
+  <<: *common
+  hostname: hostname.com
+  secret_token: REPLACE_ME
+  aaf_rc_login_url: https://rapid.test.aaf.edu.au/jwt/authnrequest/research/REPLACE_ME
+
+production:
+  <<: *common
+  hostname: hostname.com
+  secret_token: REPLACE_ME
+  aaf_rc_login_url: https://rapid.aaf.edu.au/jwt/authnrequest/research/REPLACE_ME

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'devise_aaf_rc_authenticatable'

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: devise_aaf_rc_authenticatable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Gabriel Gasser Noblia
+- Shuqian Hon
+- Daniel Theodosius
+- Jake Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+description: Devise AAF Rapid Connect Authenticatable is an authentication strategy
+  for the Devise[http://github.com/plataformatec/devise] authentication framework.
+email:
+- gabriel@intersect.org.au
+- shuqian@intersect.org.au
+- danielt@intersect.org.au
+- jake@intersect.org.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- app/controllers/devise/aaf_rc_sessions_controller.rb
+- config/locales/en.yml
+- devise_aaf_rc_authenticatable.gemspec
+- lib/devise_aaf_rc_authenticatable.rb
+- lib/devise_aaf_rc_authenticatable/exception.rb
+- lib/devise_aaf_rc_authenticatable/logger.rb
+- lib/devise_aaf_rc_authenticatable/model.rb
+- lib/devise_aaf_rc_authenticatable/routes.rb
+- lib/devise_aaf_rc_authenticatable/schema.rb
+- lib/devise_aaf_rc_authenticatable/strategy.rb
+- lib/devise_aaf_rc_authenticatable/version.rb
+- lib/generators/devise_aaf_rc_authenticatable/install_generator.rb
+- lib/generators/devise_aaf_rc_authenticatable/templates/aaf_rc.yml
+- rails/init.rb
+homepage: http://github.com/IntersectAustralia/devise_aaf_rc_authenticatable
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: AAF Rapid Connect authentication module for Devise
+test_files: []