sorcery 0.8.0 → 0.9.0

data/lib/sorcery/adapters/data_mapper_adapter.rb

@@ -0,0 +1,176 @@
+module Sorcery
+  module Adapters
+    class DataMapperAdapter < BaseAdapter
+      module Wrapper
+        extend ActiveSupport::Concern
+
+        included do
+          sorcery_adapter.verify_submodules_compatibility!
+        end
+
+        def sorcery_adapter
+          @sorcery_adapter ||= Sorcery::Adapters::DataMapperAdapter.new(self)
+        end
+
+        module ClassMethods
+          def sorcery_adapter
+            Sorcery::Adapters::DataMapperAdapter.from(self)
+          end
+        end
+      end
+
+      def increment(attr)
+        @model[attr] ||= 0
+        @model[attr] += 1
+        @model
+      end
+
+      def update_attributes(attrs)
+        attrs.each do |name, value|
+          value = value.utc if value.is_a?(ActiveSupport::TimeWithZone)
+          @model.send(:"#{name}=", value)
+        end
+        @model.class.get(@model.id).update(attrs)
+      end
+
+      def update_attribute(name, value)
+        update_attributes(name => value)
+      end
+
+      def save(options = {})
+        if options.key?(:validate) && !options[:validate]
+          @model.save!
+        else
+          @model.save
+        end
+      end
+
+      class << self
+        def define_field(name, type, options={})
+          @klass.property name, type, options.slice(:length, :default)
+
+          # Workaround local timezone retrieval problem NOTE dm-core issue #193
+          if type == Time
+            @klass.send(:alias_method, "orig_#{name}", name)
+            @klass.send :define_method, name do
+              t = send("orig_#{name}")
+              t && Time.new(t.year, t.month, t.day, t.hour, t.min, t.sec, 0)
+            end
+          end
+        end
+
+        def define_callback(time, event, method_name, options={})
+          event = :valid? if event == :validation
+          condition = options[:if]
+
+          user_klass = @klass
+
+          block = Proc.new do |record|
+            if condition.nil?
+              send(method_name)
+            elsif condition.respond_to?(:call)
+              send(method_name) if condition.call(self)
+            elsif condition.is_a? Symbol
+              send(method_name) if send(condition)
+            end
+          end
+
+          @klass.send(time, event, &block)
+        end
+
+        def find(id)
+          @klass.get(id)
+        end
+
+        def delete_all
+          @klass.destroy
+        end
+
+        # NOTE
+        # DM Adapter dependent
+        # DM creates MySQL tables case insensitive by default
+        # http://datamapper.lighthouseapp.com/projects/20609-datamapper/tickets/1105
+        def find_by_credentials(credentials)
+          credential = credentials[0].dup
+          credential.downcase! if @klass.sorcery_config.downcase_username_before_authenticating
+          @klass.sorcery_config.username_attribute_names.each do |name|
+            @user = @klass.first(name => credential)
+            break if @user
+          end
+          !!@user ? @klass.get(@user.id) : nil
+        end
+
+        def find_by_oauth_credentials(provider, uid)
+          @user_config = ::Sorcery::Controller::Config.user_class.to_s.constantize.sorcery_config
+          user = @klass.first(@user_config.provider_attribute_name => provider, @user_config.provider_uid_attribute_name => uid)
+          !!user ? @klass.get(user.id) : nil
+        end
+
+        def find_by_token(token_attr_name, token)
+          @klass.first(token_attr_name => token)
+        end
+
+        def find_by_id(id)
+          @klass.get(id)
+        rescue ::DataMapper::ObjectNotFoundError
+          nil
+        end
+
+        def find_by_activation_token(token)
+          user = @klass.first(@klass.sorcery_config.activation_token_attribute_name => token)
+          !!user ? @klass.get(user.id) : nil
+        end
+
+        def find_by_remember_me_token(token)
+          user = @klass.first(@klass.sorcery_config.remember_me_token_attribute_name => token)
+          !!user ? @klass.get(user.id) : nil
+        end
+
+        def find_by_username(username)
+          user = nil
+          @klass.sorcery_config.username_attribute_names.each do |name|
+            user = @klass.first(name => username)
+            break if user
+          end
+          !!user ? @klass.get(user.id) : nil
+        end
+
+        def transaction(&blk)
+          @klass.tap(&blk)
+        end
+
+        def find_by_sorcery_token(token_attr_name, token)
+          user = @klass.first(token_attr_name => token)
+          !!user ? @klass.get(user.id) : nil
+        end
+
+        def find_by_email(email)
+          user = @klass.first(@klass.sorcery_config.email_attribute_name => email)
+          !!user ? @klass.get(user.id) : nil
+        end
+
+        # NOTE
+        # DM Adapter dependent
+        def get_current_users
+          unless @klass.repository.adapter.is_a?(::DataMapper::Adapters::MysqlAdapter)
+            raise 'Unsupported DataMapper Adapter'
+          end
+          config = @klass.sorcery_config
+          ret = @klass.all(config.last_logout_at_attribute_name => nil) |
+                @klass.all(config.last_activity_at_attribute_name.gt => config.last_logout_at_attribute_name)
+          ret = ret.all(config.last_activity_at_attribute_name.not => nil)
+          ret = ret.all(config.last_activity_at_attribute_name.gt => config.activity_timeout.seconds.ago.utc)
+          ret
+        end
+
+        def verify_submodules_compatibility!
+          active_submodules = [::Sorcery::Controller::Config.submodules].flatten
+
+          if active_submodules.include?(:activity_logging) && !repository.adapter.is_a?(::DataMapper::Adapters::MysqlAdapter)
+            raise "DataMapper adapter compatibility error, please check documentation"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/adapters/mongo_mapper_adapter.rb

@@ -0,0 +1,110 @@
+module Sorcery
+  module Adapters
+    class MongoMapperAdapter < BaseAdapter
+      module Wrapper
+        extend ActiveSupport::Concern
+
+        included do
+          extend Sorcery::Model
+        end
+
+        def sorcery_adapter
+          @sorcery_adapter ||= Sorcery::Adapters::MongoMapperAdapter.new(self)
+        end
+
+        module ClassMethods
+          def sorcery_adapter
+            Sorcery::Adapters::MongoMapperAdapter.from(self)
+          end
+        end
+      end
+
+      def increment(attr)
+        @model[attr] ||= 0
+        @model[attr] += 1
+        @model.class.increment(@model.id, attr => 1)
+      end
+
+      def save(options = {})
+        if options.delete(:raise_on_failure) && options[:validate] != false
+          @model.save! options
+        else
+          @model.save options
+        end
+      end
+
+      def update_attributes(attrs)
+        @model.update_attributes(attrs)
+      end
+
+      class << self
+        def define_field(name, type, options={})
+          @klass.key name, type, options.slice(:default)
+        end
+
+        def define_callback(time, event, method_name, options={})
+          @klass.send "#{time}_#{event}", method_name, options.slice(:if)
+        end
+
+        def credential_regex(credential)
+          return { :$regex =>  /^#{Regexp.escape(credential)}$/i } if (@klass.sorcery_config.downcase_username_before_authenticating)
+          return credential
+        end
+
+        def find_by_credentials(credentials)
+          user = nil
+          @klass.sorcery_config.username_attribute_names.each do |attribute|
+            user = @klass.where(attribute => credential_regex(credentials[0])).first
+            break if user
+          end
+          user
+        end
+
+        def find_by_oauth_credentials(provider, uid)
+          @user_config ||= ::Sorcery::Controller::Config.user_class.to_s.constantize.sorcery_config
+          @klass.where(@user_config.provider_attribute_name => provider, @user_config.provider_uid_attribute_name => uid).first
+        end
+
+        def find_by_id(id)
+          @klass.find(id)
+        end
+
+        def find_by_username(username)
+          if @klass.sorcery_config.downcase_username_before_authenticating
+            username = username.downcase
+          end
+
+          @klass.sorcery_config.username_attribute_names.each do |attribute|
+            result = @klass.where(attribute => username).first
+            return result if result
+          end
+        end
+
+        def find_by_activation_token(token)
+          @klass.where(@klass.sorcery_config.activation_token_attribute_name => token).first
+        end
+
+        def find_by_email(email)
+          @klass.where(@klass.sorcery_config.email_attribute_name => email).first
+        end
+
+        def find_by_token(token_attr_name, token)
+          @klass.where(token_attr_name => token).first
+        end
+
+        def transaction(&blk)
+          @klass.tap(&blk)
+        end
+
+        def find_by_sorcery_token(token_attr_name, token)
+          @klass.where(token_attr_name => token).first
+        end
+
+        def get_current_users
+          raise "this method is unavailable for MongoMapper"
+        end
+
+      end
+    end
+  end
+end

data/lib/sorcery/adapters/mongoid_adapter.rb

@@ -0,0 +1,97 @@
+module Sorcery
+  module Adapters
+    class MongoidAdapter < BaseAdapter
+      def increment(attr)
+        mongoid_4? ? @model.inc(attr => 1) : @model.inc(attr, 1)
+      end
+
+      def update_attributes(attrs)
+        attrs.each do |name, value|
+          attrs[name] = value.utc if value.is_a?(ActiveSupport::TimeWithZone)
+          @model.send(:"#{name}=", value)
+        end
+        @model.class.where(:_id => @model.id).update_all(attrs)
+      end
+
+      def update_attribute(name, value)
+        update_attributes(name => value)
+      end
+
+      def save(options = {})
+        mthd = options.delete(:raise_on_failure) ? :save! : :save
+        @model.send(mthd, options)
+      end
+
+      def mongoid_4?
+        Gem::Version.new(::Mongoid::VERSION) >= Gem::Version.new("4.0.0.alpha")
+      end
+
+      class << self
+
+        def define_field(name, type, options={})
+          @klass.field name, options.slice(:default).merge(type: type)
+        end
+
+        def define_callback(time, event, method_name, options={})
+          @klass.send "#{time}_#{event}", method_name, options.slice(:if)
+        end
+
+        def credential_regex(credential)
+          return { :$regex =>  /^#{Regexp.escape(credential)}$/i  } if (@klass.sorcery_config.downcase_username_before_authenticating)
+          credential
+        end
+
+        def find_by_credentials(credentials)
+          @klass.sorcery_config.username_attribute_names.each do |attribute|
+            @user = @klass.where(attribute => credential_regex(credentials[0])).first
+            break if @user
+          end
+          @user
+        end
+
+        def find_by_oauth_credentials(provider, uid)
+          @user_config ||= ::Sorcery::Controller::Config.user_class.to_s.constantize.sorcery_config
+          @klass.where(@user_config.provider_attribute_name => provider, @user_config.provider_uid_attribute_name => uid).first
+        end
+
+        def find_by_activation_token(token)
+          @klass.where(@klass.sorcery_config.activation_token_attribute_name => token).first
+        end
+
+        def find_by_remember_me_token(token)
+          @klass.where(@klass.sorcery_config.remember_me_token_attribute_name => token).first
+        end
+
+        def transaction(&blk)
+          tap(&blk)
+        end
+
+        def find_by_id(id)
+          @klass.find(id)
+        rescue ::Mongoid::Errors::DocumentNotFound
+          nil
+        end
+
+        def find_by_username(username)
+          query = @klass.sorcery_config.username_attribute_names.map {|name| {name => username}}
+          @klass.any_of(*query).first
+        end
+
+        def find_by_token(token_attr_name, token)
+          @klass.where(token_attr_name => token).first
+        end
+
+        def find_by_email(email)
+          @klass.where(@klass.sorcery_config.email_attribute_name => email).first
+        end
+
+        def get_current_users
+          config = @klass.sorcery_config
+          @klass.where(config.last_activity_at_attribute_name.ne => nil) \
+          .where("this.#{config.last_logout_at_attribute_name} == null || this.#{config.last_activity_at_attribute_name} > this.#{config.last_logout_at_attribute_name}") \
+          .where(config.last_activity_at_attribute_name.gt => config.activity_timeout.seconds.ago.utc).order_by([:_id,:asc])
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/controller/config.rb

@@ -0,0 +1,65 @@
+module Sorcery
+  module Controller
+    module Config
+      class << self
+        attr_accessor :submodules,
+                      :user_class,                    # what class to use as the user class.
+                      :not_authenticated_action,      # what controller action to call for non-authenticated users.
+
+                      :save_return_to_url,            # when a non logged in user tries to enter a page that requires
+                                                      # login, save the URL he wanted to reach,
+                                                      # and send him there after login.
+
+                      :cookie_domain,                 # set domain option for cookies
+
+                      :login_sources,
+                      :after_login,
+                      :after_failed_login,
+                      :before_logout,
+                      :after_logout
+
+        def init!
+          @defaults = {
+            :@user_class                           => nil,
+            :@submodules                           => [],
+            :@not_authenticated_action             => :not_authenticated,
+            :@login_sources                        => [],
+            :@after_login                          => [],
+            :@after_failed_login                   => [],
+            :@before_logout                        => [],
+            :@after_logout                         => [],
+            :@save_return_to_url                   => true,
+            :@cookie_domain                        => nil
+          }
+        end
+
+        # Resets all configuration options to their default values.
+        def reset!
+          @defaults.each do |k,v|
+            instance_variable_set(k,v)
+          end
+        end
+
+        def update!
+          @defaults.each do |k,v|
+            instance_variable_set(k,v) if !instance_variable_defined?(k)
+          end
+        end
+
+        def user_config(&blk)
+          block_given? ? @user_config = blk : @user_config
+        end
+
+        def configure(&blk)
+          @configure_blk = blk
+        end
+
+        def configure!
+          @configure_blk.call(self) if @configure_blk
+        end
+      end
+      init!
+      reset!
+    end
+  end
+end

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

@@ -1,13 +1,13 @@
 module Sorcery
   module Controller
     module Submodules
-      # This submodule keeps track of events such as login, logout, 
+      # This submodule keeps track of events such as login, logout,
       # and last activity time, per user.
       # It helps in estimating which users are active now in the site.
-      # This cannot be determined absolutely because a user might be 
+      # This cannot be determined absolutely because a user might be
       # reading a page without clicking anything for a while.
-      # This is the controller part of the submodule, which adds hooks 
-      # to register user events, 
+      # This is the controller part of the submodule, which adds hooks
+      # to register user events,
       # and methods to collect active users data for use in the app.
       # see Socery::Model::Submodules::ActivityLogging for configuration
       # options.
@@ -19,55 +19,61 @@ module Sorcery
               attr_accessor :register_login_time
               attr_accessor :register_logout_time
               attr_accessor :register_last_activity_time
-            
+              attr_accessor :register_last_ip_address
+
               def merge_activity_logging_defaults!
                 @defaults.merge!(:@register_login_time         => true,
                                  :@register_logout_time        => true,
-                                 :@register_last_activity_time => true)
+                                 :@register_last_activity_time => true,
+                                 :@register_last_ip_address    => true
+                                 )
               end
             end
             merge_activity_logging_defaults!
           end
           Config.after_login    << :register_login_time_to_db
+          Config.after_login    << :register_last_ip_address
           Config.before_logout  << :register_logout_time_to_db
           base.after_filter :register_last_activity_time_to_db
         end
-        
+
         module InstanceMethods
           # Returns an array of the active users.
           def current_users
+            ActiveSupport::Deprecation.warn("Sorcery: `current_users` method is deprecated. Read more on Github: https://github.com/NoamB/sorcery/issues/602")
+
             user_class.current_users
-            # A possible patch here:
-            # we'll add the current_user to the users list if he's not in it
-            # (can happen when he was inactive for more than activity timeout):
-            #
-            #   users.unshift!(current_user) if logged_in? && users.find {|u| u.id == current_user.id}.nil?
-            #
-            # disadvantages: can hurt performance.
           end
-          
+
           protected
-          
+
           # registers last login time on every login.
           # This runs as a hook just after a successful login.
           def register_login_time_to_db(user, credentials)
             return unless Config.register_login_time
-            user.update_single_attribute(user.sorcery_config.last_login_at_attribute_name, Time.now.in_time_zone)
+            user.set_last_login_at(Time.now.in_time_zone)
           end
-          
+
           # registers last logout time on every logout.
           # This runs as a hook just before a logout.
           def register_logout_time_to_db(user)
             return unless Config.register_logout_time
-            user.update_single_attribute(user.sorcery_config.last_logout_at_attribute_name, Time.now.in_time_zone)
+            user.set_last_logout_at(Time.now.in_time_zone)
           end
-          
+
           # Updates last activity time on every request.
           # The only exception is logout - we do not update activity on logout
           def register_last_activity_time_to_db
             return unless Config.register_last_activity_time
             return unless logged_in?
-            current_user.update_single_attribute(current_user.sorcery_config.last_activity_at_attribute_name, Time.now.in_time_zone)
+            current_user.set_last_activity_at(Time.now.in_time_zone)
+          end
+
+          # Updates IP address on every login.
+          # This runs as a hook just after a successful login.
+          def register_last_ip_address(user, credentials)
+            return unless Config.register_last_ip_address
+            current_user.set_last_ip_addess(request.remote_ip)
           end
         end
       end

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

@@ -14,22 +14,22 @@ module Sorcery
           Config.after_login << :reset_failed_logins_count!
           Config.after_failed_login << :update_failed_logins_count!
         end
-        
+
         module InstanceMethods
-          
+
           protected
-          
+
           # Increments the failed logins counter on every failed login.
           # Runs as a hook after a failed login.
           def update_failed_logins_count!(credentials)
-            user = user_class.find_by_credentials(credentials)
+            user = user_class.sorcery_adapter.find_by_credentials(credentials)
             user.register_failed_login! if user
           end
-          
+
           # Resets the failed logins counter.
           # Runs as a hook after a successful login.
           def reset_failed_logins_count!(user, credentials)
-            user.update_many_attributes(user_class.sorcery_config.failed_logins_count_attribute_name => 0)
+            user.sorcery_adapter.update_attribute(user_class.sorcery_config.failed_logins_count_attribute_name, 0)
           end
         end
       end