devise 0.1.0

data/lib/devise/models/rememberable.rb

@@ -0,0 +1,71 @@
+require 'digest/sha1'
+
+module Devise
+  module Models
+
+    # Rememberable manages generating and clearing token for remember the user
+    # from a saved cookie. Rememberable also has utility methods for dealing
+    # with serializing the user into the cookie and back from the cookie, trying
+    # to lookup the record based on the saved information.
+    # You probably wouldn't use rememberable methods directly, they are used
+    # mostly internally for handling the remember token.
+    # Examples:
+    #
+    #   User.find(1).remember_me!  # regenerating the token
+    #   User.find(1).forget_me!    # clearing the token
+    #
+    #   # generating info to put into cookies
+    #   User.serialize_into_cookie(user)
+    #
+    #   # lookup the user based on the incoming cookie information
+    #   User.serialize_from_cookie(cookie_string)
+    module Rememberable
+
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+
+          # Remember me option available in after_authentication hook.
+          attr_accessor :remember_me
+          attr_accessible :remember_me
+        end
+      end
+
+      # Generate a new remember token and save the record without validations.
+      def remember_me!
+        self.remember_token = friendly_token
+        save(false)
+      end
+
+      # Removes the remember token only if it exists, and save the record
+      # without validations.
+      def forget_me!
+        if remember_token?
+          self.remember_token = nil
+          save(false)
+        end
+      end
+
+      # Checks whether the incoming token matches or not with the record token.
+      def valid_remember_token?(token)
+        remember_token.present? && remember_token == token
+      end
+
+      module ClassMethods
+
+        # Create the cookie key using the record id and remember_token
+        def serialize_into_cookie(record)
+          "#{record.id}::#{record.remember_token}"
+        end
+
+        # Recreate the user based on the stored cookie
+        def serialize_from_cookie(cookie)
+          record_id, remember_token = cookie.split('::')
+          record = find_by_id(record_id)
+          record if record.try(:valid_remember_token?, remember_token)
+        end
+
+      end
+    end
+  end
+end

data/lib/devise/models/validatable.rb

@@ -0,0 +1,36 @@
+module Devise
+  module Models
+
+    # Validatable creates all needed validations for a user email and password.
+    # It's optional, given you may want to create the validations by yourself.
+    # Automatically validate if the email is present, unique and it's format is
+    # valid. Also tests presence of password, confirmation and length
+    module Validatable
+
+      # Email regex used to validate email formats. Retrieved from authlogic.
+      EMAIL_REGEX = /\A[\w\.%\+\-]+@(?:[A-Z0-9\-]+\.)+(?:[A-Z]{2,4}|museum|travel)\z/i
+
+      def self.included(base)
+        base.class_eval do
+
+          validates_presence_of     :email
+          validates_uniqueness_of   :email, :allow_blank => true
+          validates_format_of       :email, :with => EMAIL_REGEX, :allow_blank => true
+
+          validates_presence_of     :password, :if => :password_required?
+          validates_confirmation_of :password, :if => :password_required?
+          validates_length_of       :password, :within => 6..20, :allow_blank => true, :if => :password_required?
+        end
+      end
+
+      protected
+
+        # Checks whether a password is needed or not. For validations only.
+        # Passwords are always required if it's a new record, or if the password
+        # or confirmation are being set somewhere.
+        def password_required?
+          new_record? || !password.nil? || !password_confirmation.nil?
+        end
+    end
+  end
+end

data/lib/devise/routes.rb

@@ -0,0 +1,95 @@
+module ActionController::Routing
+  class RouteSet #:nodoc:
+
+    # Ensure Devise modules are included only after loading routes, because we
+    # need devise_for mappings already declared to create magic filters and
+    # helpers.
+    def load_routes_with_devise!
+      load_routes_without_devise!
+
+      ActionController::Base.send :include, Devise::Controllers::Filters
+      ActionController::Base.send :include, Devise::Controllers::Helpers
+      ActionController::Base.send :include, Devise::Controllers::UrlHelpers
+
+      ActionView::Base.send :include, Devise::Controllers::UrlHelpers
+    end
+    alias_method_chain :load_routes!, :devise
+
+    class Mapper #:doc:
+      # Includes devise_for method for routes. This method is responsible to
+      # generate all needed routes for devise, based on what modules you have
+      # defined in your model.
+      # Examples: Let's say you have an User model configured to use
+      # authenticable, confirmable and recoverable modules. After creating this
+      # inside your routes:
+      #
+      #   map.devise_for :users
+      #
+      # this method is going to look inside your User model and create the
+      # needed routes:
+      #
+      #  # Session routes for Authenticable (default)
+      #       new_user_session GET  /users/sign_in                    {:controller=>"sessions", :action=>"new"}
+      #           user_session POST /users/sign_in                    {:controller=>"sessions", :action=>"create"}
+      #   destroy_user_session GET  /users/sign_out                   {:controller=>"sessions", :action=>"destroy"}
+      #
+      #  # Password routes for Recoverable, if User model has :recoverable configured
+      #      new_user_password GET  /users/password/new(.:format)     {:controller=>"passwords", :action=>"new"}
+      #     edit_user_password GET  /users/password/edit(.:format)    {:controller=>"passwords", :action=>"edit"}
+      #          user_password PUT  /users/password(.:format)         {:controller=>"passwords", :action=>"update"}
+      #                        POST /users/password(.:format)         {:controller=>"passwords", :action=>"create"}
+      #
+      #  # Confirmation routes for Confirmable, if User model has :confirmable configured
+      #  new_user_confirmation GET  /users/confirmation/new(.:format) {:controller=>"confirmations", :action=>"new"}
+      #      user_confirmation GET  /users/confirmation(.:format)     {:controller=>"confirmations", :action=>"show"}
+      #                        POST /users/confirmation(.:format)     {:controller=>"confirmations", :action=>"create"}
+      #
+      # You can configure your routes with some options:
+      #  * :class_name => setup a different class to be looked up by devise, if it cannot be correctly find by the route name.
+      #
+      #    map.devise_for :users, :class_name => 'Account'
+      #
+      #  * :as => allows you to setup path name that will be used, as rails routes does. The following route configuration would setup your route as /accounts instead of /users:
+      #
+      #    map.devise_for :users, :as => 'accounts'
+      #
+      #  * :singular => setup the name used to create named routes. By default, for a :users key, it is going to be the singularized version, :user. To configure a named route like account_session_path instead of user_session_path just do:
+      #
+      #    map.devise_for :users, :singular => :account
+      #
+      #  * :path_names => configure different path names to overwrite defaults :sign_in, :sign_out, :password and :confirmation.
+      #
+      #    map.devise_for :users, :path_names => { :sign_in => 'login', :sign_out => 'logout', :password => 'secret', :confirmation => 'verification' }
+      def devise_for(*resources)
+        options = resources.extract_options!
+
+        resources.map!(&:to_sym)
+        options.assert_valid_keys(:class_name, :as, :path_names, :singular)
+
+        resources.each do |resource|
+          mapping = Devise::Mapping.new(resource, options)
+          Devise.mappings[mapping.name] = mapping
+
+          if mapping.authenticable?
+            with_options(:controller => 'sessions', :path_prefix => mapping.as) do |session|
+              session.send(:"new_#{mapping.name}_session",     mapping.path_names[:sign_in],  :action => 'new',     :conditions => { :method => :get })
+              session.send(:"#{mapping.name}_session",         mapping.path_names[:sign_in],  :action => 'create',  :conditions => { :method => :post })
+              session.send(:"destroy_#{mapping.name}_session", mapping.path_names[:sign_out], :action => 'destroy', :conditions => { :method => :get })
+            end
+          end
+
+          namespace mapping.name, :namespace => nil, :path_prefix => mapping.as do |m|
+            if mapping.recoverable?
+              m.resource :password, :only => [:new, :create, :edit, :update], :as => mapping.path_names[:password]
+            end
+
+            if mapping.confirmable?
+              m.resource :confirmation, :only => [:new, :create, :show], :as => mapping.path_names[:confirmation]
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/devise/strategies/authenticable.rb

@@ -0,0 +1,45 @@
+module Devise
+  module Strategies
+    # Default strategy for signing in a user, based on his email and password.
+    # Redirects to sign_in page if it's not authenticated
+    class Authenticable < Devise::Strategies::Base
+
+      # Authenticate a user based on email and password params, returning to warden
+      # success and the authenticated user if everything is okay. Otherwise redirect
+      # to sign in page.
+      def authenticate!
+        if valid_attributes? && resource = mapping.to.authenticate(attributes)
+          success!(resource)
+        else
+          store_location
+          redirect!(sign_in_path, :unauthenticated => true)
+        end
+      end
+
+      private
+
+        # Find the attributes for the current mapping.
+        def attributes
+          @attributes ||= params[scope]
+        end
+
+        # Check for the right keys.
+        def valid_attributes?
+          attributes && attributes[:email].present? && attributes[:password].present?
+        end
+
+        # Stores requested uri to redirect the user after signing in. We cannot use
+        # scoped session provided by warden here, since the user is not authenticated
+        # yet, but we still need to store the uri based on scope, so different scopes
+        # would never use the same uri to redirect.
+        def store_location
+          session[:"#{mapping.name}.return_to"] = request.request_uri if request.get?
+        end
+
+        # Create path to sign in the resource
+        def sign_in_path
+          "/#{mapping.as}/#{mapping.path_names[:sign_in]}"
+        end
+    end
+  end
+end

data/lib/devise/strategies/base.rb

@@ -0,0 +1,24 @@
+module Devise
+  module Strategies
+    # Base strategy for Devise. Responsible for verifying correct scope and
+    # mapping.
+    class Base < Warden::Strategies::Base
+
+      # Validate strategy. By default will raise an error if no scope or an
+      # invalid mapping is found.
+      def valid?
+        mapping.for.include?(self.class.name.split("::").last.underscore.to_sym)
+      end
+
+      # Checks if a valid scope was given for devise and find mapping based on
+      # this scope.
+      def mapping
+        @mapping ||= begin
+          raise "You need to give a scope for Devise authentication" unless scope
+          raise "You need to give a valid Devise mapping"            unless mapping = Devise.mappings[scope]
+          mapping
+        end
+      end
+    end
+  end
+end

data/lib/devise/strategies/rememberable.rb

@@ -0,0 +1,33 @@
+module Devise
+  module Strategies
+    # Remember the user through the remember token. This strategy is responsible
+    # to verify whether there is a cookie with the remember token, and to
+    # recreate the user from this cookie if it exists.  Must be called *before*
+    # authenticable.
+    class Rememberable < Devise::Strategies::Base
+
+      # A valid strategy for rememberable needs a remember token in the cookies.
+      def valid?
+        super && remember_me_cookie.present?
+      end
+
+      # To authenticate a user we deserialize the cookie and attempt finding
+      # the record in the database. If the attempt fails, we pass to another
+      # strategy handle the authentication.
+      def authenticate!
+        if resource = mapping.to.serialize_from_cookie(remember_me_cookie)
+          success!(resource)
+        else
+          pass
+        end
+      end
+
+      private
+
+        # Accessor for remember cookie
+        def remember_me_cookie
+          cookies['remember_token']
+        end
+    end
+  end
+end

data/lib/devise/version.rb

@@ -0,0 +1,3 @@
+module Devise
+  VERSION = "0.1.0".freeze
+end

data/lib/devise/warden.rb

@@ -0,0 +1,64 @@
+begin
+  require 'warden'
+rescue
+  gem 'warden'
+  require 'warden'
+end
+
+# Taken from RailsWarden, thanks to Hassox. http://github.com/hassox/rails_warden
+module Warden::Mixins::Common
+  # Gets the rails request object by default if it's available
+  def request
+    return @request if @request
+    if env['action_controller.rescue.request']
+      @request = env['action_controller.rescue.request']
+    else
+      Rack::Request.new(env)
+    end
+  end
+
+  def raw_session
+    request.session
+  end
+
+  def reset_session!
+    raw_session.inspect # why do I have to inspect it to get it to clear?
+    raw_session.clear
+  end
+
+  # Proxy to request cookies
+  def cookies
+    request.cookies
+  end
+end
+
+# Session Serialization in. This block determines how the user will be stored
+# in the session. If you're using a complex object like an ActiveRecord model,
+# it is not a good idea to store the complete object. An ID is sufficient.
+Warden::Manager.serialize_into_session{ |user| [user.class, user.id] }
+
+# Session Serialization out. This block gets the user out of the session.
+# It should be the reverse of serializing the object into the session
+Warden::Manager.serialize_from_session do |klass, id|
+  klass.find(id)
+end
+
+# Be a good citizen and always set the controller action, even if Devise is
+# never calling the failure app through warden.
+Warden::Manager.before_failure do |env, opts|
+  env['warden'].request.params['action'] = 'new'
+end
+
+# Adds Warden Manager to Rails middleware stack, configuring default devise
+# strategy and also the controller who will manage not authenticated users.
+Rails.configuration.middleware.use Warden::Manager do |manager|
+  manager.default_strategies :rememberable, :authenticable
+  manager.failure_app = SessionsController
+end
+
+# Setup devise strategies for Warden
+Warden::Strategies.add(:rememberable, Devise::Strategies::Rememberable)
+Warden::Strategies.add(:authenticable, Devise::Strategies::Authenticable)
+
+# Require rememberable hooks
+require 'devise/hooks/rememberable'

data/test/active_record_test.rb

@@ -0,0 +1,96 @@
+require 'test/test_helper'
+
+class Authenticable < User
+  devise
+end
+
+class Confirmable < User
+  devise :confirmable
+end
+
+class Recoverable < User
+  devise :recoverable
+end
+
+class Rememberable < User
+  devise :rememberable
+end
+
+class Validatable < User
+  devise :validatable
+end
+
+class Devisable < User
+  devise :all
+end
+
+class Exceptable < User
+  devise :all, :except => [:recoverable, :rememberable, :validatable]
+end
+
+class Configurable < User
+  devise :all, :stretches => 15, :pepper => 'abcdef'
+end
+
+class ActiveRecordTest < ActiveSupport::TestCase
+
+  def include_module?(klass, mod)
+    klass.devise_modules.include?(mod) &&
+    klass.included_modules.include?(Devise::Models::const_get(mod.to_s.classify))
+  end
+
+  def assert_include_modules(klass, *modules)
+    modules.each do |mod|
+      assert include_module?(klass, mod)
+    end
+  end
+
+  def assert_not_include_modules(klass, *modules)
+    modules.each do |mod|
+      assert_not include_module?(klass, mod)
+    end
+  end
+
+  test 'include by default authenticable only' do
+    assert_include_modules Authenticable, :authenticable
+    assert_not_include_modules Authenticable, :confirmable, :recoverable, :rememberable, :validatable
+  end
+
+  test 'add confirmable module only' do
+    assert_include_modules Confirmable, :authenticable, :confirmable
+    assert_not_include_modules Confirmable, :recoverable, :rememberable, :validatable
+  end
+
+  test 'add recoverable module only' do
+    assert_include_modules Recoverable, :authenticable, :recoverable
+    assert_not_include_modules Recoverable, :confirmable, :rememberable, :validatable
+  end
+
+  test 'add rememberable module only' do
+    assert_include_modules Rememberable, :authenticable, :rememberable
+    assert_not_include_modules Rememberable, :confirmable, :recoverable, :validatable
+  end
+
+  test 'add validatable module only' do
+    assert_include_modules Validatable, :authenticable, :validatable
+    assert_not_include_modules Validatable, :confirmable, :recoverable, :rememberable
+  end
+
+  test 'add all modules' do
+    assert_include_modules Devisable,
+      :authenticable, :confirmable, :recoverable, :rememberable, :validatable
+  end
+
+  test 'configure modules with except option' do
+    assert_include_modules Exceptable, :authenticable, :confirmable
+    assert_not_include_modules Exceptable, :recoverable, :rememberable, :validatable
+  end
+
+  test 'set a default value for stretches' do
+    assert_equal 15, Configurable.new.send(:stretches)
+  end
+
+  test 'set a default value for pepper' do
+    assert_equal 'abcdef', Configurable.new.send(:pepper)
+  end
+end