sorcery 0.4.1 → 0.5.2

data/lib/sorcery/model.rb

@@ -14,27 +14,38 @@ module Sorcery
             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
-            
+
+            # 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}
-            
+
+            # Mongoid support
+            self.class_eval do
+              field sorcery_config.username_attribute_name, type: String
+              #field sorcery_config.password_attribute_name, type: String
+              field sorcery_config.email_attribute_name, type: String unless sorcery_config.username_attribute_name == sorcery_config.email_attribute_name
+              field sorcery_config.crypted_password_attribute_name, type: String
+              field sorcery_config.salt_attribute_name, type: String
+            end if defined?(Mongoid) and self.ancestors.include?(Mongoid::Document)
+
+            # 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_inheritance if @sorcery_config.subclasses_inherit_config
             @sorcery_config.after_config.each { |c| send(c) }
           end
         end
@@ -53,7 +64,7 @@ module Sorcery
       # returns the user if success, nil otherwise.
       def authenticate(*credentials)
         raise ArgumentError, "at least 2 arguments required" if credentials.size < 2
-        user = where("#{@sorcery_config.username_attribute_name} = ?", credentials[0]).first
+        user = find_by_credentials(credentials)
         _salt = user.send(@sorcery_config.salt_attribute_name) if user && !@sorcery_config.salt_attribute_name.nil? && !@sorcery_config.encryption_provider.nil?
         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
@@ -76,6 +87,20 @@ module Sorcery
         @sorcery_config.encryption_provider.matches?(crypted, *tokens)
       end
       
+      def add_config_inheritance
+        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
@@ -93,10 +118,10 @@ module Sorcery
       protected
       
       # creates new salt and saves it.
-      # encrypts password with salt and save it.
+      # encrypts password with salt and saves it.
       def encrypt_password
         config = sorcery_config
-        new_salt = self.send(:"#{config.salt_attribute_name}=", generate_random_token) if !config.salt_attribute_name.nil?
+        self.send(:"#{config.salt_attribute_name}=", new_salt = generate_random_token) if !config.salt_attribute_name.nil?
         self.send(:"#{config.crypted_password_attribute_name}=", self.class.encrypt(self.send(config.password_attribute_name),new_salt))
       end
 
@@ -117,7 +142,7 @@ module Sorcery
       
       # Random code, used for salt and temporary tokens.
       def generate_random_token
-        return Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join )
+        Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join )
       end
     end
 
@@ -133,6 +158,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.
@@ -156,6 +182,7 @@ module Sorcery
           :@salt_join_token                      => "",
           :@salt_attribute_name                  => :salt,
           :@stretches                            => nil,
+          :@subclasses_inherit_config            => false,
           :@before_authenticate                  => [],
           :@after_config                         => []
         }

data/lib/sorcery/sinatra.rb

@@ -1,4 +1,3 @@
-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)

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

@@ -0,0 +1,53 @@
+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_class = User
+
+          ::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,74 @@
+module Sorcery
+  module TestHelpers
+    module Internal
+      module Sinatra
+        include ::Sorcery::TestHelpers::Sinatra::CookieSessionMethods
+        include ::Sorcery::TestHelpers::Sinatra::InstanceMethods
+
+        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 clear_user_without_logout
+          get_sinatra_app(subject).instance_variable_set(:@current_user, nil)
+        end
+
+        def assigns
+          ::Sinatra::Application.sorcery_vars
+        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 => []})
+          load File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'spec', 'sinatra', 'filters.rb')
+          ::Sinatra::Application.send(:include, ::Filters)
+
+          # 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_class = User
+
+          ::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/sinatra_modular.rb

@@ -0,0 +1,74 @@
+module Sorcery
+  module TestHelpers
+    module Internal
+      module SinatraModular
+        include ::Sorcery::TestHelpers::Sinatra::CookieSessionMethods
+        include ::Sorcery::TestHelpers::Sinatra::InstanceMethods
+
+        class ::Modular
+          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 clear_user_without_logout
+          get_sinatra_app(subject).instance_variable_set(:@current_user, nil)
+        end
+
+        def assigns
+          ::Modular.sorcery_vars
+        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::Base.instance_variable_set(:@filters, {:before => [], :after => []})
+          require File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'spec', 'sinatra', 'filters')
+          ::Sinatra::Base.send(:include, ::Filters)
+
+          # configure
+          ::Sorcery::Controller::Config.submodules = submodules
+          ::Sorcery::Controller::Config.user_class = nil
+          ::Sinatra::Base.send(:include, Sorcery::Controller::Adapters::Sinatra)
+          ::Sinatra::Base.send(:include, Sorcery::Controller)
+          ::Sorcery::Controller::Config.user_class = User
+
+          ::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,56 @@
+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'}
+        @user = User.new(user_attributes_hash)
+        @user.save!
+        @user.authentications.create!({:provider => provider, :uid => 123})
+        @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

@@ -1,54 +1,16 @@
 module Sorcery
   module TestHelpers
     module 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
-      
+      # logins a user and calls all callbacks
       def login_user(user = nil)
         user ||= @user
-        subject.send(:login_user,user)
-        subject.send(:after_login!,user,[user.username,'secret'])
+        @controller.send(:login_user,user)
+        @controller.send(:after_login!,user,[user.send(user.sorcery_config.username_attribute_name),'secret'])
       end
 
       def logout_user
-        subject.send(:logout)
-      end
-
-      def clear_user_without_logout
-        subject.instance_variable_set(:@current_user,nil)
+        @controller.send(:logout)
       end
     end
   end
-end
+end

data/lib/sorcery/test_helpers/sinatra.rb

@@ -1,127 +1,87 @@
 module Sorcery
   module TestHelpers
     module Sinatra
-      
-      class MyApp
-        class << self
-          def new
-            return this
+      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
-        end
-      end
-      
-      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)
+          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
-                    
-      ::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 = {}
+      module InstanceMethods
+        def get_sinatra_app(app)
+          while !app.kind_of? ::Sinatra::Base do
+            app = app.instance_variable_get(:@app)
           end
+          app
         end
 
-        def [](key)
-          @data[key]
+        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 []=(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
+        def logout_user
+          get_sinatra_app(app).send(:logout)
         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
+      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
 
-        # return to no-module configuration
-        ::Sorcery::Controller::Config.init!
-        ::Sorcery::Controller::Config.reset!
+          def [](key)
+            @data[key]
+          end
 
-        # 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)
+          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
-        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)
+        def session
+          SessionData.new(cookies)
+        end
+
+        def cookies
+          rack_test_session.instance_variable_get(:@rack_mock_session).cookie_jar
+        end
       end
     end
   end

data/lib/sorcery/test_helpers.rb

@@ -1,52 +1,5 @@
 module Sorcery
-  # This file will be included in the spec_helper file.
   module TestHelpers
-    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