sorcery 0.2.1 → 0.4.2

data/lib/sorcery/model/submodules/activity_logging.rb

@@ -20,7 +20,7 @@ module Sorcery
             @defaults.merge!(:@last_login_at_attribute_name                => :last_login_at,
                              :@last_logout_at_attribute_name               => :last_logout_at,
                              :@last_activity_at_attribute_name             => :last_activity_at,
-                             :@activity_timeout                            => 10.minutes)
+                             :@activity_timeout                            => 10 * 60)
             reset!
           end
         end
@@ -31,7 +31,7 @@ module Sorcery
             config = sorcery_config
             where("#{config.last_activity_at_attribute_name} IS NOT NULL") \
             .where("#{config.last_logout_at_attribute_name} IS NULL OR #{config.last_activity_at_attribute_name} > #{config.last_logout_at_attribute_name}") \
-            .where("#{config.last_activity_at_attribute_name} > ? ", config.activity_timeout.seconds.ago)
+            .where("#{config.last_activity_at_attribute_name} > ? ", config.activity_timeout.seconds.ago.utc.to_s(:db))
           end
         end
       end

data/lib/sorcery/model/submodules/brute_force_protection.rb

@@ -16,14 +16,10 @@ module Sorcery
             @defaults.merge!(:@failed_logins_count_attribute_name              => :failed_logins_count,
                              :@lock_expires_at_attribute_name                  => :lock_expires_at,
                              :@consecutive_login_retries_amount_limit          => 50,
-                             :@login_lock_time_period                          => 3600)
+                             :@login_lock_time_period                          => 60 * 60)
             reset!
           end
           
-          base.class_eval do
-
-          end
-          
           base.sorcery_config.before_authenticate << :prevent_locked_user_login
           base.extend(ClassMethods)
           base.send(:include, InstanceMethods)

data/lib/sorcery/model/submodules/{oauth.rb → external.rb}

@@ -1,9 +1,9 @@
 module Sorcery
   module Model
     module Submodules
-      # This submodule helps you login users from OAuth providers such as Twitter.
+      # This submodule helps you login users from external providers such as Twitter.
       # This is the model part which handles finding the user using access tokens.
-      # For the controller options see Sorcery::Controller::Oauth.
+      # For the controller options see Sorcery::Controller::External.
       #
       # Socery assumes (read: requires) you will create external users in the same table where you keep your regular users,
       # but that you will have a separate table for keeping their external authentication data,
@@ -11,7 +11,7 @@ module Sorcery
       #
       # External users will have a null crypted_password field, since we do not hold their password.
       # They will not be sent activation emails on creation.
-      module Oauth
+      module External
         def self.included(base)
           base.sorcery_config.class_eval do
             attr_accessor :authentications_class,

data/lib/sorcery/model/submodules/reset_password.rb

@@ -28,7 +28,7 @@ module Sorcery
                              :@reset_password_mailer                          => nil,
                              :@reset_password_email_method_name               => :reset_password_email,
                              :@reset_password_expiration_period               => nil,
-                             :@reset_password_time_between_emails             => 5.minutes )
+                             :@reset_password_time_between_emails             => 5 * 60 )
 
             reset!
           end

data/lib/sorcery/model.rb

@@ -9,30 +9,36 @@ module Sorcery
     def self.included(klass)
       klass.class_eval do
         class << self
-          def activate_sorcery!
+          def authenticates_with_sorcery!
             @sorcery_config = Config.new
             self.class_eval do
               extend ClassMethods # included here, before submodules, so they can be overriden by them.
               include InstanceMethods
+              
+              # set the user_class for the controller methods which call it
               ::Sorcery::Controller::Config.user_class = self
               @sorcery_config.submodules = ::Sorcery::Controller::Config.submodules
               @sorcery_config.submodules.each do |mod|
                 begin
                   include Submodules.const_get(mod.to_s.split("_").map {|p| p.capitalize}.join("")) 
                 rescue NameError
-                  # don't stop on a missing submodule.
+                  # don't stop on a missing submodule. Needed because some submodules are only defined in the controller side.
                 end
               end
             end
             
-            yield @sorcery_config if block_given?
+            # This runs the options block set in the initializer on the model class.
+            ::Sorcery::Controller::Config.user_config.tap{|blk| blk.call(@sorcery_config) if blk}
             
+            # add virtual password accessor and ORM callbacks
             self.class_eval do
               attr_accessor @sorcery_config.password_attribute_name
               attr_protected @sorcery_config.crypted_password_attribute_name, @sorcery_config.salt_attribute_name
               before_save :encrypt_password, :if => Proc.new { |record| record.send(sorcery_config.password_attribute_name).present? }
               after_save :clear_virtual_password, :if => Proc.new { |record| record.send(sorcery_config.password_attribute_name).present? }
             end
+            
+            @sorcery_config.after_config << :add_config_inheritence if @sorcery_config.subclasses_inherit_config
             @sorcery_config.after_config.each { |c| send(c) }
           end
         end
@@ -56,12 +62,6 @@ module Sorcery
         user if user && @sorcery_config.before_authenticate.all? {|c| user.send(c)} && credentials_match?(user.send(@sorcery_config.crypted_password_attribute_name),credentials[1],_salt)
       end
       
-      # Calls the configured encryption provider to compare the supplied password with the encrypted one.
-      def credentials_match?(crypted, *tokens)
-        return crypted == tokens.join if @sorcery_config.encryption_provider.nil?
-        @sorcery_config.encryption_provider.matches?(crypted, *tokens)
-      end
-      
       # encrypt tokens using current encryption_provider.
       def encrypt(*tokens)
         return tokens.first if @sorcery_config.encryption_provider.nil?
@@ -71,6 +71,29 @@ module Sorcery
         CryptoProviders::AES256.key = @sorcery_config.encryption_key if @sorcery_config.encryption_algorithm == :aes256
         @sorcery_config.encryption_provider.encrypt(*tokens)
       end
+      
+      protected
+      
+      # Calls the configured encryption provider to compare the supplied password with the encrypted one.
+      def credentials_match?(crypted, *tokens)
+        return crypted == tokens.join if @sorcery_config.encryption_provider.nil?
+        @sorcery_config.encryption_provider.matches?(crypted, *tokens)
+      end
+      
+      def add_config_inheritence
+        self.class_eval do
+          def self.inherited(subclass)
+            subclass.class_eval do
+              class << self
+                attr_accessor :sorcery_config
+              end
+            end
+            subclass.sorcery_config = sorcery_config
+            super
+          end
+        end
+      end
+      
     end
     
     module InstanceMethods
@@ -128,6 +151,7 @@ module Sorcery
                     :salt_attribute_name,               # change default salt attribute.
                     :stretches,                         # how many times to apply encryption to the password.
                     :encryption_key,                    # encryption key used to encrypt reversible encryptions such as AES256.
+                    :subclasses_inherit_config,         # make this configuration inheritable for subclasses. Useful for ActiveRecord's STI.
                     
                     :submodules,                        # configured in config/application.rb
                     :before_authenticate,               # an array of method names to call before authentication completes. used internally.
@@ -151,6 +175,7 @@ module Sorcery
           :@salt_join_token                      => "",
           :@salt_attribute_name                  => :salt,
           :@stretches                            => nil,
+          :@subclasses_inherit_config            => false,
           :@before_authenticate                  => [],
           :@after_config                         => []
         }

data/lib/sorcery/railties/tasks.rake

@@ -0,0 +1,10 @@
+require 'fileutils'
+
+namespace :sorcery do
+  desc "Adds sorcery's initializer file"
+  task :bootstrap do
+    src = File.join(File.dirname(__FILE__), '..', 'initializers', 'initializer.rb')
+    target = File.join(Rails.root, "config", "initializers", "sorcery.rb")
+    FileUtils.cp(src, target)
+  end
+end

data/lib/sorcery/sinatra.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Base.send(:include, Sorcery::Model) if defined?(ActiveRecord)
+if defined?(Sinatra::Base)
+  Sinatra::Base.send(:include, Sorcery::Controller::Adapters::Sinatra)
+  Sinatra::Base.send(:include, Sorcery::Controller)
+end

data/lib/sorcery/test_helpers/internal/rails.rb

@@ -0,0 +1,52 @@
+module Sorcery
+  module TestHelpers
+    module Internal
+      module Rails
+        include ::Sorcery::TestHelpers::Rails
+
+        SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS = [:register_last_activity_time_to_db, :deny_banned_user, :validate_session]
+
+        def sorcery_reload!(submodules = [], options = {})
+          reload_user_class
+
+          # return to no-module configuration
+          ::Sorcery::Controller::Config.init!
+          ::Sorcery::Controller::Config.reset!
+
+          # remove all plugin before_filters so they won't fail other tests.
+          # I don't like this way, but I didn't find another.
+          # hopefully it won't break until Rails 4.
+          ApplicationController._process_action_callbacks.delete_if {|c| SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS.include?(c.filter) }
+
+          # configure
+          ::Sorcery::Controller::Config.submodules = submodules
+          ::Sorcery::Controller::Config.user_class = nil
+          ActionController::Base.send(:include,::Sorcery::Controller)
+
+          ::Sorcery::Controller::Config.user_config do |user|
+            options.each do |property,value|
+              user.send(:"#{property}=", value)
+            end
+          end
+          User.authenticates_with_sorcery!
+        end
+
+        def sorcery_controller_property_set(property, value)
+          ::Sorcery::Controller::Config.send(:"#{property}=", value)
+        end
+
+        def sorcery_controller_external_property_set(provider, property, value)
+          ::Sorcery::Controller::Config.send(provider).send(:"#{property}=", value)
+        end
+
+        # This helper is used to fake multiple users signing in in tests.
+        # It does so by clearing @current_user, thus allowing a new user to login,
+        # all this without calling the :logout action explicitly.
+        # A dirty dirty hack.
+        def clear_user_without_logout
+          subject.instance_variable_set(:@current_user,nil)
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/test_helpers/internal/sinatra.rb

@@ -0,0 +1,122 @@
+module Sorcery
+  module TestHelpers
+    module Internal
+      module Sinatra
+
+        class ::Sinatra::Application
+          class << self
+            attr_accessor :sorcery_vars
+          end
+          @sorcery_vars = {}
+
+          # NOTE: see before and after test filters in filters.rb
+
+          def save_instance_vars
+            instance_variables.each do |var|
+              self.class.sorcery_vars[:"#{var.to_s.delete("@")}"] = instance_variable_get(var)
+            end
+          end
+        end
+
+        ::RSpec::Matchers.define :redirect_to do |expected|
+          match do |actual|
+            actual.status == 302 && actual.location == expected
+          end
+        end
+
+        def get_sinatra_app(app)
+          while app.class != ::Sinatra::Application do
+            app = app.instance_variable_get(:@app)
+          end
+          app
+        end
+
+        def login_user(user=nil)
+          user ||= @user
+          get_sinatra_app(subject).send(:login_user,user)
+          get_sinatra_app(subject).send(:after_login!,user,[user.username,'secret'])
+        end
+
+        def logout_user
+          get_sinatra_app(subject).send(:logout)
+        end
+
+        def clear_user_without_logout
+          get_sinatra_app(subject).instance_variable_set(:@current_user,nil)
+        end
+
+        def assigns
+          ::Sinatra::Application.sorcery_vars
+        end
+
+        class SessionData
+          def initialize(cookies)
+            @cookies = cookies
+            @data = cookies['rack.session']
+            if @data
+              @data = @data.unpack("m*").first
+              @data = Marshal.load(@data)
+            else
+              @data = {}
+            end
+          end
+
+          def [](key)
+            @data[key]
+          end
+
+          def []=(key, value)
+            @data[key] = value
+            session_data = Marshal.dump(@data)
+            session_data = [session_data].pack("m*")
+            @cookies.merge("rack.session=#{Rack::Utils.escape(session_data)}", URI.parse("//example.org//"))
+            raise "session variable not set" unless @cookies['rack.session'] == session_data
+          end
+        end
+
+        def session
+          SessionData.new(rack_test_session.instance_variable_get(:@rack_mock_session).cookie_jar)
+        end
+
+        def cookies
+          rack_test_session.instance_variable_get(:@rack_mock_session).cookie_jar
+        end
+
+        def sorcery_reload!(submodules = [], options = {})
+          reload_user_class
+
+          # return to no-module configuration
+          ::Sorcery::Controller::Config.init!
+          ::Sorcery::Controller::Config.reset!
+
+          # clear all filters
+          ::Sinatra::Application.instance_variable_set(:@filters,{:before => [],:after => []})
+          ::Sinatra::Application.class_eval do
+            load File.join(File.dirname(__FILE__),'..','..','..','..','spec','sinatra','filters.rb')
+          end
+
+          # configure
+          ::Sorcery::Controller::Config.submodules = submodules
+          ::Sorcery::Controller::Config.user_class = nil
+          ::Sinatra::Application.send(:include, Sorcery::Controller::Adapters::Sinatra)
+          ::Sinatra::Application.send(:include, Sorcery::Controller)
+
+          ::Sorcery::Controller::Config.user_config do |user|
+            options.each do |property,value|
+              user.send(:"#{property}=", value)
+            end
+          end
+          User.authenticates_with_sorcery!
+        end
+
+        def sorcery_controller_property_set(property, value)
+          ::Sorcery::Controller::Config.send(:"#{property}=", value)
+        end
+
+        def sorcery_controller_external_property_set(provider, property, value)
+          ::Sorcery::Controller::Config.send(provider).send(:"#{property}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/test_helpers/internal.rb

@@ -0,0 +1,55 @@
+module Sorcery
+  module TestHelpers
+    # Internal TestHelpers are used to test the gem, internally, and should not be used to test apps *using* sorcery.
+    # This file will be included in the spec_helper file.
+    module Internal
+      def self.included(base)
+        # reducing default cost for specs speed
+        CryptoProviders::BCrypt.class_eval do
+          class << self
+            def cost
+              1
+            end
+          end
+        end
+      end
+
+      # a patch to fix a bug in testing that happens when you 'destroy' a session twice.
+      # After the first destroy, the session is an ordinary hash, and then when destroy is called again there's an exception.
+      class ::Hash
+        def destroy
+          clear
+        end
+      end
+
+      def create_new_user(attributes_hash = nil)
+        user_attributes_hash = attributes_hash || {:username => 'gizmo', :email => "bla@bla.com", :password => 'secret'}
+        @user = User.new(user_attributes_hash)
+        @user.save!
+        @user
+      end
+
+      def create_new_external_user(provider, attributes_hash = nil)
+        user_attributes_hash = attributes_hash || {:username => 'gizmo', :authentications_attributes => [{:provider => provider, :uid => 123}]}
+        @user = User.new(user_attributes_hash)
+        @user.save!
+        @user
+      end
+
+      def sorcery_model_property_set(property, *values)
+        User.class_eval do
+          sorcery_config.send(:"#{property}=", *values)
+        end
+      end
+
+      private
+
+      # reload user class between specs
+      # so it will be possible to test the different submodules in isolation
+      def reload_user_class
+        Object.send(:remove_const,:User)
+        load 'user.rb'
+      end
+    end
+  end
+end

data/lib/sorcery/test_helpers/rails.rb

@@ -0,0 +1,16 @@
+module Sorcery
+  module TestHelpers
+    module Rails
+      # logins a user and calls all callbacks
+      def login_user(user = nil)
+        user ||= @user
+        @controller.send(:login_user,user)
+        @controller.send(:after_login!,user,[user.send(user.sorcery_config.username_attribute_name),'secret'])
+      end
+
+      def logout_user
+        @controller.send(:logout)
+      end
+    end
+  end
+end

data/lib/sorcery/test_helpers/sinatra.rb

@@ -0,0 +1,85 @@
+module Sorcery
+  module TestHelpers
+    module Sinatra
+      def self.included(base)
+        base.send(:include, InstanceMethods)
+        base.send(:include, CookieSessionMethods)
+        ::Sinatra::Base.class_eval do
+          class << self
+            attr_accessor :rack_test_session
+          end
+
+          def self.inherited(subclass)
+            super
+            subclass.class_eval do
+              class << self
+                attr_accessor :rack_test_session
+              end
+            end
+          end
+
+          include CookieSessionMethods
+
+          def rack_test_session
+            self.class.rack_test_session
+          end
+        end
+      end
+
+      module InstanceMethods
+        def get_sinatra_app(app)
+          while !app.kind_of? ::Sinatra::Base do
+            app = app.instance_variable_get(:@app)
+          end
+          app
+        end
+
+        def login_user(user=nil)
+          user ||= @user
+          get_sinatra_app(app).send(:login_user, user)
+          get_sinatra_app(app).send(:after_login!, user, [user.send(user.sorcery_config.username_attribute_name), 'secret'])
+        end
+
+        def logout_user
+          get_sinatra_app(app).send(:logout)
+        end
+      end
+
+      module CookieSessionMethods
+        class SessionData
+          def initialize(cookies)
+            @cookies = cookies
+            @data = cookies['rack.session']
+            if @data
+              @data = @data.unpack("m*").first
+              @data = Marshal.load(@data)
+            else
+              @data = {}
+            end
+          end
+
+          def [](key)
+            @data[key]
+          end
+
+          def []=(key, value)
+            @data[key] = value
+            session_data = Marshal.dump(@data)
+            session_data = [session_data].pack("m*")
+            @cookies.merge("rack.session=#{Rack::Utils.escape(session_data)}", URI.parse("//example.org//"))
+            raise "session variable not set" unless @cookies['rack.session'] == session_data
+          end
+
+          def clear
+            @data = {}
+          end
+        end
+
+        def session
+          SessionData.new(rack_test_session.instance_variable_get(:@rack_mock_session).cookie_jar)
+        end
+
+      end
+    end
+  end
+end

data/lib/sorcery/test_helpers.rb

@@ -1,84 +1,5 @@
 module Sorcery
   module TestHelpers
-    SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS = [:register_last_activity_time_to_db, :deny_banned_user, :validate_session]
 
-    def create_new_user(attributes_hash = nil)
-      user_attributes_hash = attributes_hash || {:username => 'gizmo', :email => "bla@bla.com", :password => 'secret'}
-      @user = User.new(user_attributes_hash)
-      @user.save!
-      @user
-    end
-
-    def create_new_external_user(provider, attributes_hash = nil)
-      user_attributes_hash = attributes_hash || {:username => 'gizmo', :authentications_attributes => [{:provider => provider, :uid => 123}]}
-      @user = User.new(user_attributes_hash)
-      @user.save!
-      @user
-    end
-    
-    def login_user(user = nil)
-      user ||= @user
-      subject.send(:login_user,user)
-      subject.send(:after_login!,user,[user.username,'secret'])
-    end
-
-    def logout_user
-      subject.send(:logout)
-    end
-
-    def clear_user_without_logout
-      subject.instance_variable_set(:@current_user,nil)
-    end
-
-    def sorcery_reload!(submodules = [], options = {})
-      reload_user_class
-
-      # return to no-module configuration
-      ::Sorcery::Controller::Config.init!
-      ::Sorcery::Controller::Config.reset!
-
-      # remove all plugin before_filters so they won't fail other tests.
-      # I don't like this way, but I didn't find another.
-      # hopefully it won't break until Rails 4.
-      ApplicationController._process_action_callbacks.delete_if {|c| SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS.include?(c.filter) }
-
-      # configure
-      ::Sorcery::Controller::Config.submodules = submodules
-      ::Sorcery::Controller::Config.user_class = nil
-      ActionController::Base.send(:include,::Sorcery::Controller)
-
-      User.activate_sorcery! do |config|
-        options.each do |property,value|
-          config.send(:"#{property}=", value)
-        end
-      end
-    end
-
-    def sorcery_model_property_set(property, *values)
-      User.class_eval do
-        sorcery_config.send(:"#{property}=", *values)
-      end
-    end
-
-    def sorcery_controller_property_set(property, value)
-      ApplicationController.activate_sorcery! do |config|
-        config.send(:"#{property}=", value)
-      end
-    end
-    
-    def sorcery_controller_oauth_property_set(provider, property, value)
-      ApplicationController.activate_sorcery! do |config|
-        config.send(provider).send(:"#{property}=", value)
-      end
-    end
-
-    private
-
-    # reload user class between specs
-    # so it will be possible to test the different submodules in isolation
-    def reload_user_class
-      Object.send(:remove_const,:User)
-      load 'user.rb'
-    end
   end
 end

data/lib/sorcery.rb

@@ -8,7 +8,7 @@ module Sorcery
       autoload :RememberMe, 'sorcery/model/submodules/remember_me'
       autoload :ActivityLogging, 'sorcery/model/submodules/activity_logging'
       autoload :BruteForceProtection, 'sorcery/model/submodules/brute_force_protection'
-      autoload :Oauth, 'sorcery/model/submodules/oauth'
+      autoload :External, 'sorcery/model/submodules/external'
     end
   end
   autoload :Controller, 'sorcery/controller'
@@ -19,18 +19,24 @@ module Sorcery
       autoload :BruteForceProtection, 'sorcery/controller/submodules/brute_force_protection'
       autoload :HttpBasicAuth, 'sorcery/controller/submodules/http_basic_auth'
       autoload :ActivityLogging, 'sorcery/controller/submodules/activity_logging'
-      autoload :Oauth, 'sorcery/controller/submodules/oauth'
-      module Oauth
-        autoload :Oauth1, 'sorcery/controller/submodules/oauth/oauth1'
-        autoload :Oauth2, 'sorcery/controller/submodules/oauth/oauth2'
+      autoload :External, 'sorcery/controller/submodules/external'
+      module External
+        module Protocols
+          autoload :Oauth1, 'sorcery/controller/submodules/external/protocols/oauth1'
+          autoload :Oauth2, 'sorcery/controller/submodules/external/protocols/oauth2'
+        end
         module Providers
-          autoload :Twitter, 'sorcery/controller/submodules/oauth/providers/twitter'
-          autoload :Facebook, 'sorcery/controller/submodules/oauth/providers/facebook'
+          autoload :Twitter, 'sorcery/controller/submodules/external/providers/twitter'
+          autoload :Facebook, 'sorcery/controller/submodules/external/providers/facebook'
         end
       end
     end
+    module Adapters
+      autoload :Sinatra, 'sorcery/controller/adapters/sinatra'
+    end
   end
   module CryptoProviders
+    autoload :Common, 'sorcery/crypto_providers/common'
     autoload :AES256, 'sorcery/crypto_providers/aes256'
     autoload :BCrypt, 'sorcery/crypto_providers/bcrypt'
     autoload :MD5,    'sorcery/crypto_providers/md5'
@@ -39,6 +45,18 @@ module Sorcery
     autoload :SHA512, 'sorcery/crypto_providers/sha512'
   end
   autoload :TestHelpers, 'sorcery/test_helpers'
+  module TestHelpers
+    autoload :Rails, 'sorcery/test_helpers/rails'
+    autoload :Sinatra, 'sorcery/test_helpers/sinatra'
+    autoload :Internal, 'sorcery/test_helpers/internal'
+    module Internal
+      autoload :Rails, 'sorcery/test_helpers/internal/rails'
+      autoload :Sinatra, 'sorcery/test_helpers/internal/sinatra'
+    end
+
+  end
+
   
   require 'sorcery/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'sorcery/sinatra' if defined?(Sinatra)
 end