devise_autosigninable 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+devise_autosigninable/.idea/.name
+devise_autosigninable/.idea/devise_autosigninable.iml
+devise_autosigninable/.idea/encodings.xml
+devise_autosigninable/.idea/misc.xml
+devise_autosigninable/.idea/modules.xml
+devise_autosigninable/.idea/vcs.xml
+devise_autosigninable/.idea/workspace.xml
+test/rails2/.idea/.generators
+test/rails2/.idea/.name
+test/rails2/.idea/.rakeTasks
+test/rails2/.idea/dataSources.ids
+test/rails2/.idea/dataSources.xml
+test/rails2/.idea/encodings.xml
+test/rails2/.idea/misc.xml
+test/rails2/.idea/modules.xml
+test/rails2/.idea/rails_app.iml
+test/rails2/.idea/vcs.xml
+test/rails2/.idea/workspace.xml

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/rails2/vendor/plugins/devise_autosigninable"]
+	path = test/rails2/vendor/plugins/devise_autosigninable
+	url = git@github.com:aderyabin/devise_autosigninable.git

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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,78 @@
+Devise Autosigninable
+=============
+Devise Autosigninable adds functionality of auto sign in to your [devise][1] app.
+Devise Autosigninable is compatibile with all default Devise modules.
+If Lockable module is activated Devise Autosigninable uses Lockable functionality for failed attempts.
+If user is blocked or not confirmed he can't sign in with Devise Autosigninable too.
+
+Devise Autosigninable signs in a user based on an autosignin token (random hash with length 32).
+If signed in user try to sign in with Devise Autosigninable he will be sign out firstly and than go to sign in.
+So if token is incorrect user will be signed out anyway.
+
+Devise Autosigninable compatible with Rails 2 and Rails 3.
+
+Installation
+-----------
+* Add devise_autosigninable to Gemfile:
+
+    `gem 'devise_autosigninable', '1.0.0'`
+
+* Add :autosigninable to your Devise modules in model, for example:
+
+    `devise :registerable, :authenticatable, :recoverable, :rememberable, :trackable, :validatable, :lockable, :autosigninable`
+
+* Generate migration for autosigninable. It creates neccessary fields and fill already existed records.
+
+    `rails g devise_autosigninable MODEL`
+
+Replace MODEL by the class name you want to add devise, like User, Admin, etc
+
+* Run rake command for generation autosignin tokens
+
+   `rake devise:autosigninable:ensure[MODEL]`
+
+Route and Helpers
+-----------
+Devise Autosigninable has two methods which help to generate url and link to auto sign in
+
+    auto_signin_url_for(object)
+
+and
+
+    link_to_autosignin(object, title, options)
+
+
+By default Devise Autosigninable uses `'/:object_id/autosignin/:autosignin_token'` route. For example, for User model:
+
+    /users/1/autosignin/c6718d1a2ebea0f716cb62ad2375af64
+
+Also route understand optional parameter "return_to" to redirect after sign in.
+
+Rake tasks
+-----------
+Devise Autosigninable has two rake task which help to reset all autosignin_tokens
+
+    rake devise:autosigninable:reset[User]
+
+and generate all missed autosigninable tokens
+
+    rake devise:autosigninable:ensure[User]
+
+
+Features
+-----------
+
+Devise Autosigninable has functionality of exipering token after sign in. To use it add this to the end of devise determing in model:
+
+    :autosignin_expire => true
+
+For example:
+
+    devise :authenticatable, :confirmable, :recoverable, :validatable, :autosigninable, :autosignin_expire => true
+
+
+
+Devise Autosigninable add method `autosigninable?` which detect need of generation autosignin token for record. It may be useful you don't want add
+autosignin functionality for some records.
+
+[1]:http://github.com/plataformatec/devise

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the devise_autosigninable 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_autosigninable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DeviseAutosigninable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/devise/autosignin_controller.rb

@@ -0,0 +1,15 @@
+class Devise::AutosigninController < ApplicationController
+  
+  include Devise::Controllers::InternalHelpers
+  include Devise::Autosigninable::Helpers
+  
+  def create
+    sign_out(resource_name)
+    if resource = warden.authenticate!(:scope => resource_name)
+      set_flash_message :notice, :signed_in
+    else
+      set_now_flash_message :alert, (warden.message || :invalid)
+    end
+    sign_in_and_redirect_to_url(resource, params[:return_to])    
+  end
+end

data/config/locales/devise.en.yml

@@ -0,0 +1,4 @@
+ru:
+  devise:
+    autosignin:
+      signed_in: "You have signed in successfully"

data/config/locales/devise.ru.yml

@@ -0,0 +1,4 @@
+ru:
+  devise:
+    autosignin:
+      signed_in: 'Вы вошли'

data/devise_autosigninable.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devise_autosigninable/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{devise_autosigninable}
+  s.version = DeviseAutosigninable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors = ["Andrey Deryabin"]
+  s.date = Date.today
+  s.description = %q{It adds support to be logged in by uniq link.}
+  s.summary = %q{It adds support to be logged in by uniq link. It useful for mailing and access from admin panel.}
+  s.email = %q{deriabin@gmail.com}
+  s.homepage = %q{http://github.com/evilmartians/devise_autosigninable}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/generators/devise_autosigninable/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    ./script/generate devise_autosigninable Thing
+
+    This will create:
+        what/will/it/create

data/generators/devise_autosigninable/devise_autosigninable_generator.rb

@@ -0,0 +1,7 @@
+class DeviseAutosigninableGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "add_autosigninable_to_#{table_name}"      
+    end
+  end
+end

data/generators/devise_autosigninable/templates/migration.rb

@@ -0,0 +1,12 @@
+class AddAutosigninableTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table :<%= table_name %> do |t|
+      t.autosigninable
+    end
+    add_index :<%= table_name %>, :autosignin_token, :unique => true
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :autosignin_token
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/devise_autosigninable/model.rb

@@ -0,0 +1,118 @@
+module Devise
+  module Models
+    module Autosigninable
+#      include Devise::Models::Lockable
+
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.class_eval do
+          before_create :reset_autosignin_token
+
+#         indicator to expire autosignin token
+        mattr_accessor :autosignin_expire
+        @@autosignin_expire = false
+          
+        end
+      end
+
+      def autosigninable?
+        true
+      end
+
+      def autosigninable_ready?
+        !self.autosignin_token.blank?
+      end
+
+      # Generate new autosignin token
+      def reset_autosignin_token
+        self.autosignin_token  = self.autosigninable? ? self.class.autosignin_token : nil
+      end
+
+      # Generate new autosignin token and save the record.
+      def reset_autosignin_token!
+        reset_autosignin_token
+        self.save
+      end
+
+      # Generate autosignin token unless already exists.
+      def ensure_autosignin_token
+        self.reset_autosignin_token unless self.autosigninable_ready?
+      end
+
+      # Generate autosignin token unless already exists and save the record.
+      def ensure_autosignin_token!
+        self.reset_autosignin_token! unless self.autosigninable_ready?
+      end
+
+      # Verifies whether an +incoming_autosignin_token
+      # is the user authentication token.
+      def valid_autosignin_token?(incoming_autosignin_token)
+        incoming_autosignin_token == self.autosignin_token
+      end
+
+      # Checks if a resource is valid upon authentication.
+      # for verifying whether an user is allowed to sign in or not. If the user
+      # is locked, it should never be allowed.
+      def valid_for_autosignin_token_authentication?(attributes)
+        if (result = valid_autosignin_token?(attributes[:autosignin_token])) && self.class.devise_modules.include?(:lockable)
+          self.failed_attempts = 0 if self.class.devise_modules.include?(:lockable)
+        else
+          if self.class.devise_modules.include?(:lockable)
+            self.failed_attempts += 1
+            lock_access! if failed_attempts > self.class.maximum_attempts
+          end
+        end
+        reset_autosignin_token! if self.class.autosignin_expire
+        save(false) if changed?
+        result
+      end
+
+
+      module ClassMethods
+        
+        RETRY_COUNT = 20
+
+        # Generate autosignin tokens unless already exists and save the records.
+        def ensure_all_autosignin_tokens(batch_size=500)
+          user_count = count( :conditions=>{:autosignin_token => nil})
+          find_in_batches(:batch_size =>batch_size, :conditions=>{:autosignin_token => nil}) do |group|
+            group.each { |user| user.ensure_autosignin_token! }
+          end
+        end
+
+        # Generate autosignin tokens and save the records.
+        def reset_all_autosignin_tokens(batch_size=500)
+          user_count = count
+          find_in_batches(:batch_size =>batch_size) do |group|
+            group.each { |user| user.reset_autosignin_token! }
+          end
+        end
+
+        # generation random autosignin token
+        def autosignin_token(uniq = false, field = 'autosignin_token')
+          if uniq
+            RETRY_COUNT.times do
+              token = Digest::SHA1.hexdigest("--#{Time.now.utc}--#{rand}--")
+              return token unless exists? field => token
+            end
+            raise Exception.new("Couldn't generate #{self.class}:#{field} for #{RETRY_COUNT} times")
+          else
+            Digest::SHA1.hexdigest("--#{Time.now.utc}--#{rand}--")
+          end
+        end
+
+        # Authenticate a user based on authentication token.
+        def authenticate_with_autosignin_token(attributes={})
+          resource = find_by_id(attributes[self.to_s.foreign_key.to_sym])
+          if resource.try(:valid_for_autosignin_token_authentication?, attributes)
+            resource
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/devise_autosigninable/routes.rb

@@ -0,0 +1,23 @@
+if ActionController::Routing.name =~ /ActionDispatch/
+  #RAILS 3
+  ActionDispatch::Routing::Mapper.class_eval do
+    protected
+
+    # Setup routes for +AutosigninController+.
+    def devise_autosigninable(mapping, controllers)
+      match "/:#{mapping.name}_id/autosignin/:autosignin_token" => 'devise/autosignin#create',
+      :as => "autosignin", :via => :get
+    end
+  end
+
+else
+  #RAILS 2
+  ActionController::Routing::RouteSet::Mapper.class_eval do
+    protected
+
+    # Setup routes for +AutosigninController+.
+    def autosigninable(routes, mapping)
+      routes.autosignin  "/:#{mapping.name.to_s}_id/autosignin/:autosignin_token", :controller => 'devise/autosignin', :action => 'create',  :conditions => { :method => :get }
+    end
+  end
+end

data/lib/devise_autosigninable/schema.rb

@@ -0,0 +1,7 @@
+Devise::Schema.class_eval do
+
+  # add to migration neccessary fields for autosignin
+  def autosigninable
+      apply_schema :autosignin_token, String, :limit=>40
+  end
+end

data/lib/devise_autosigninable/strategy.rb

@@ -0,0 +1,33 @@
+require 'devise/strategies/base'
+
+module Devise
+  module Strategies
+    class Autosigninable < Base
+      
+      def valid?
+        valid_controller? && valid_params? && mapping.to.respond_to?('authenticate_with_autosignin_token')
+      end
+
+      def authenticate!
+        if resource = mapping.to.authenticate_with_autosignin_token(params)
+          success!(resource)
+        else
+          fail!(:invalid)
+        end
+      end
+
+      protected
+
+      def valid_controller?
+        'devise/autosignin' == params[:controller]
+      end
+
+      def valid_params?
+        params[:autosignin_token].present?
+      end
+
+    end
+  end
+end
+
+Warden::Strategies.add(:autosigninable, Devise::Strategies::Autosigninable)

data/lib/devise_autosigninable/version.rb

@@ -0,0 +1,3 @@
+module DeviseAutosigninable
+  VERSION = "1.0.0"
+end

data/lib/devise_autosigninable/view_helpers.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require 'devise/mapping'
+
+module Devise #:nodoc:
+  module Autosigninable #:nodoc:
+
+    module Helpers
+
+      # Create the link to autosignin url based on resource with given link_text
+      # example: link_to_autosignin(user, user.email)
+      def link_to_autosignin(resource, link_text, options={})
+        link_to link_text, auto_signin_url_for(resource) , options
+      end
+
+
+       # return autosignin url for given resource 
+      def auto_signin_url_for(resource)
+        resource_name = resource.class.to_s.downcase
+        send("#{resource_name}_autosignin_url",
+            {:"#{resource_name}_id" => resource.id,
+            :autosignin_token => resource.autosignin_token}
+          )
+      end
+
+      # Sign in and tries to redirect first to given url and
+      # then to the url specified by after_sign_in_path_for.
+      #
+      # If resource is blank than tries redirect to given url
+      # or root url
+      def sign_in_and_redirect_to_url(resource = nil, url=nil)
+        if resource
+          sign_out(resource)
+          sign_in(resource)
+          redirect_to url || after_sign_in_path_for(resource)
+        else
+          redirect_to url || root_url
+        end
+      end
+    end
+  end
+end
+
+::ActionView::Base.send :include, Devise::Autosigninable::Helpers

data/lib/devise_autosigninable.rb

@@ -0,0 +1,23 @@
+require 'devise'
+
+begin
+  Rails::Engine
+rescue
+else
+  module DeviseAutosigninable
+    class Engine < Rails::Engine
+    end
+  end
+  
+end
+
+Devise.add_module :autosigninable,
+  :strategy => true,
+  :controller => :autosignin,
+  :model => 'devise_autosigninable/model',
+  :route => :autosigninable
+
+require 'devise_autosigninable/routes'
+require 'devise_autosigninable/schema'
+require 'devise_autosigninable/view_helpers'
+require 'devise_autosigninable/strategy'

data/lib/tasks/devise_autosigninable.rake

@@ -0,0 +1,15 @@
+namespace :devise do
+  namespace :autosigninable do
+    desc 'Generate missed autosignin tokens, by default for User model'
+    task :ensure, :model, :needs => [:environment] do |t, args|
+      args.with_defaults(:model => "User")
+      args.model.camelize.constantize.ensure_all_autosignin_tokens
+    end
+
+    desc 'Reset all autosignin tokens, by default for User model'
+    task :reset, :model, :needs => [:environment] do |t, args|
+      args.with_defaults(:model => "User")
+      args.model.camelize.constantize.reset_all_autosignin_tokens
+    end
+  end
+end

data/rails/init.rb

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

data/test/devise_autosigninable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class DeviseAutosigninableTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'test/unit'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: devise_autosigninable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrey Deryabin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-14 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: It adds support to be logged in by uniq link.
+email: deriabin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .gitmodules
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/devise/autosignin_controller.rb
+- config/locales/devise.en.yml
+- config/locales/devise.ru.yml
+- devise_autosigninable.gemspec
+- generators/devise_autosigninable/USAGE
+- generators/devise_autosigninable/devise_autosigninable_generator.rb
+- generators/devise_autosigninable/templates/migration.rb
+- init.rb
+- install.rb
+- lib/devise_autosigninable.rb
+- lib/devise_autosigninable/model.rb
+- lib/devise_autosigninable/routes.rb
+- lib/devise_autosigninable/schema.rb
+- lib/devise_autosigninable/strategy.rb
+- lib/devise_autosigninable/version.rb
+- lib/devise_autosigninable/view_helpers.rb
+- lib/tasks/devise_autosigninable.rake
+- rails/init.rb
+- test/devise_autosigninable_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/evilmartians/devise_autosigninable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: It adds support to be logged in by uniq link. It useful for mailing and access from admin panel.
+test_files: 
+- test/devise_autosigninable_test.rb
+- test/test_helper.rb