sorcery 0.9.0 → 0.10.0

data/lib/generators/sorcery/templates/initializer.rb

@@ -13,79 +13,67 @@ Rails.application.config.sorcery.configure do |config|
   #
   # config.not_authenticated_action =
 
-
   # 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, using 'redirect_back_or_to'.
   # Default: `true`
   #
   # config.save_return_to_url =
 
-
   # Set domain option for cookies; Useful for remember_me submodule.
   # Default: `nil`
   #
   # config.cookie_domain =
 
-
   # Allow the remember_me cookie to be set through AJAX
   # Default: `true`
   #
   # config.remember_me_httponly =
 
-
   # -- session timeout --
   # How long in seconds to keep the session alive.
   # Default: `3600`
   #
   # config.session_timeout =
 
-
   # Use the last action as the beginning of session timeout.
   # Default: `false`
   #
   # config.session_timeout_from_last_action =
 
-
   # -- http_basic_auth --
   # What realm to display for which controller name. For example {"My App" => "Application"}
   # Default: `{"application" => "Application"}`
   #
   # config.controller_to_realm_map =
 
-
   # -- activity logging --
   # will register the time of last user login, every login.
   # Default: `true`
   #
   # config.register_login_time =
 
-
   # will register the time of last user logout, every logout.
   # Default: `true`
   #
   # config.register_logout_time =
 
-
   # will register the time of last user action, every action.
   # Default: `true`
   #
   # config.register_last_activity_time =
 
-
   # -- external --
-  # What providers are supported by this app, i.e. [:twitter, :facebook, :github, :linkedin, :xing, :google, :liveid, :salesforce] .
+  # What providers are supported by this app, i.e. [:twitter, :facebook, :github, :linkedin, :xing, :google, :liveid, :salesforce, :slack] .
   # Default: `[]`
   #
   # config.external_providers =
 
-
   # You can change it by your local ca_file. i.e. '/etc/pki/tls/certs/ca-bundle.crt'
   # Path to ca_file. By default use a internal ca-bundle.crt.
   # Default: `'path/to/ca_file'`
   #
   # config.ca_file =
 
-
   # For information about LinkedIn API:
   # - user info fields go to https://developer.linkedin.com/documents/profile-fields
   # - access permissions go to https://developer.linkedin.com/documents/authentication#granting
@@ -119,24 +107,40 @@ Rails.application.config.sorcery.configure do |config|
   # config.facebook.secret = ""
   # config.facebook.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=facebook"
   # config.facebook.user_info_mapping = {:email => "name"}
-  # config.facebook.access_permissions = ["email", "publish_stream"]
+  # config.facebook.access_permissions = ["email", "publish_actions"]
   # config.facebook.display = "page"
+  # config.facebook.api_version = "v2.2"
   #
   # config.github.key = ""
   # config.github.secret = ""
   # config.github.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=github"
   # config.github.user_info_mapping = {:email => "name"}
   #
+  # config.paypal.key = ""
+  # config.paypal.secret = ""
+  # config.paypal.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=paypal"
+  # config.paypal.user_info_mapping = {:email => "email"}
+  #
+  # config.wechat.key = ""
+  # config.wechat.secret = ""
+  # config.wechat.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=wechat"
+  #
   # config.google.key = ""
   # config.google.secret = ""
   # config.google.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=google"
   # config.google.user_info_mapping = {:email => "email", :username => "name"}
+  # config.google.scope = "https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile"
   #
   # config.vk.key = ""
   # config.vk.secret = ""
   # config.vk.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=vk"
   # config.vk.user_info_mapping = {:login => "domain", :name => "full_name"}
   #
+  # config.slack.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=slack"
+  # config.slack.key = ''
+  # config.slack.secret = ''
+  # config.slack.user_info_mapping = {email: 'email'}
+  #
   # To use liveid in development mode you have to replace mydomain.com with
   # a valid domain even in development. To use a valid domain in development
   # simply add your domain in your /etc/hosts file in front of 127.0.0.1
@@ -178,80 +182,73 @@ Rails.application.config.sorcery.configure do |config|
     #
     # user.username_attribute_names =
 
-
     # change *virtual* password attribute, the one which is used until an encrypted one is generated.
     # Default: `:password`
     #
     # user.password_attribute_name =
 
-
     # downcase the username before trying to authenticate, default is false
     # Default: `false`
     #
     # user.downcase_username_before_authenticating =
 
-
     # change default email attribute.
     # Default: `:email`
     #
     # user.email_attribute_name =
 
-
     # change default crypted_password attribute.
     # Default: `:crypted_password`
     #
     # user.crypted_password_attribute_name =
 
-
     # what pattern to use to join the password with the salt
     # Default: `""`
     #
     # user.salt_join_token =
 
-
     # change default salt attribute.
     # Default: `:salt`
     #
     # user.salt_attribute_name =
 
-
     # how many times to apply encryption to the password.
     # Default: `nil`
     #
     # user.stretches =
 
-
     # encryption key used to encrypt reversible encryptions such as AES256.
     # WARNING: If used for users' passwords, changing this key will leave passwords undecryptable!
     # Default: `nil`
     #
     # user.encryption_key =
 
-
     # use an external encryption class.
     # Default: `nil`
     #
     # user.custom_encryption_provider =
 
-
     # encryption algorithm name. See 'encryption_algorithm=' for available options.
     # Default: `:bcrypt`
     #
     # user.encryption_algorithm =
 
-
     # make this configuration inheritable for subclasses. Useful for ActiveRecord's STI.
     # Default: `false`
     #
     # user.subclasses_inherit_config =
 
-
     # -- remember_me --
     # How long in seconds the session length will be
     # Default: `604800`
     #
     # user.remember_me_for =
 
+    # when true sorcery will persist a single remember me token for all
+    # logins/logouts (supporting remembering on multiple browsers simultaneously).
+    # Default: false
+    #
+    # user.remember_me_token_persist_globally =
 
     # -- user_activation --
     # the attribute name to hold activation state (active/pending).
@@ -259,31 +256,26 @@ Rails.application.config.sorcery.configure do |config|
     #
     # user.activation_state_attribute_name =
 
-
     # the attribute name to hold activation code (sent by email).
     # Default: `:activation_token`
     #
     # user.activation_token_attribute_name =
 
-
     # the attribute name to hold activation code expiration date.
     # Default: `:activation_token_expires_at`
     #
     # user.activation_token_expires_at_attribute_name =
 
-
     # how many seconds before the activation code expires. nil for never expires.
     # Default: `nil`
     #
     # user.activation_token_expiration_period =
 
-
     # your mailer class. Required.
     # Default: `nil`
     #
     # user.user_activation_mailer =
 
-
     # when true sorcery will not automatically
     # email activation details and allow you to
     # manually handle how and when email is sent.
@@ -291,56 +283,53 @@ Rails.application.config.sorcery.configure do |config|
     #
     # user.activation_mailer_disabled =
 
+    # method to send email related
+    # options: `:deliver_later`, `:deliver_now`, `:deliver`
+    # Default: :deliver (Rails version < 4.2) or :deliver_now (Rails version 4.2+)
+    #
+    # user.email_delivery_method =
 
     # activation needed email method on your mailer class.
     # Default: `:activation_needed_email`
     #
     # user.activation_needed_email_method_name =
 
-
     # activation success email method on your mailer class.
     # Default: `:activation_success_email`
     #
     # user.activation_success_email_method_name =
 
-
     # do you want to prevent or allow users that did not activate by email to login?
     # Default: `true`
     #
     # user.prevent_non_active_users_to_login =
 
-
     # -- reset_password --
     # reset password code attribute name.
     # Default: `:reset_password_token`
     #
     # user.reset_password_token_attribute_name =
 
-
     # expires at attribute name.
     # Default: `:reset_password_token_expires_at`
     #
     # user.reset_password_token_expires_at_attribute_name =
 
-
     # when was email sent, used for hammering protection.
     # Default: `:reset_password_email_sent_at`
     #
     # user.reset_password_email_sent_at_attribute_name =
 
-
     # mailer class. Needed.
     # Default: `nil`
     #
     # user.reset_password_mailer =
 
-
     # reset password email method on your mailer class.
     # Default: `:reset_password_email`
     #
     # user.reset_password_email_method_name =
 
-
     # when true sorcery will not automatically
     # email password reset details and allow you to
     # manually handle how and when email is sent
@@ -348,38 +337,32 @@ Rails.application.config.sorcery.configure do |config|
     #
     # user.reset_password_mailer_disabled =
 
-
     # how many seconds before the reset request expires. nil for never expires.
     # Default: `nil`
     #
     # user.reset_password_expiration_period =
 
-
     # hammering protection, how long in seconds to wait before allowing another email to be sent.
     # Default: `5 * 60`
     #
     # user.reset_password_time_between_emails =
 
-
     # -- brute_force_protection --
     # Failed logins attribute name.
     # Default: `:failed_logins_count`
     #
     # user.failed_logins_count_attribute_name =
 
-
     # This field indicates whether user is banned and when it will be active again.
     # Default: `:lock_expires_at`
     #
     # user.lock_expires_at_attribute_name =
 
-
     # How many failed logins allowed.
     # Default: `50`
     #
     # user.consecutive_login_retries_amount_limit =
 
-
     # How long the user should be banned. in seconds. 0 for permanent.
     # Default: `60 * 60`
     #
@@ -412,44 +395,37 @@ Rails.application.config.sorcery.configure do |config|
     #
     # user.last_login_at_attribute_name =
 
-
     # Last logout attribute name.
     # Default: `:last_logout_at`
     #
     # user.last_logout_at_attribute_name =
 
-
     # Last activity attribute name.
     # Default: `:last_activity_at`
     #
     # user.last_activity_at_attribute_name =
 
-
     # How long since last activity is the user defined logged out?
     # Default: `10 * 60`
     #
     # user.activity_timeout =
 
-
     # -- external --
     # Class which holds the various external provider data for this user.
     # Default: `nil`
     #
     # user.authentications_class =
 
-
     # User's identifier in authentications class.
     # Default: `:user_id`
     #
     # user.authentications_user_id_attribute_name =
 
-
     # Provider's identifier in authentications class.
     # Default: `:provider`
     #
     # user.provider_attribute_name =
 
-
     # User's external unique identifier in authentications class.
     # Default: `:uid`
     #
@@ -458,5 +434,5 @@ Rails.application.config.sorcery.configure do |config|
 
   # This line must come after the 'user config' block.
   # Define which model authenticates with sorcery.
-  config.user_class = "<%= model_class_name %>"
+  config.user_class = '<%= model_class_name %>'
 end

data/lib/generators/sorcery/templates/migration/activity_logging.rb

@@ -1,4 +1,4 @@
-class SorceryActivityLogging < ActiveRecord::Migration
+class SorceryActivityLogging < <%= migration_class_name %>
   def change
     add_column :<%= model_class_name.tableize %>, :last_login_at,     :datetime, :default => nil
     add_column :<%= model_class_name.tableize %>, :last_logout_at,    :datetime, :default => nil
@@ -7,4 +7,4 @@ class SorceryActivityLogging < ActiveRecord::Migration
 
     add_index :<%= model_class_name.tableize %>, [:last_logout_at, :last_activity_at]
   end
-end
+end

data/lib/generators/sorcery/templates/migration/brute_force_protection.rb

@@ -1,4 +1,4 @@
-class SorceryBruteForceProtection < ActiveRecord::Migration
+class SorceryBruteForceProtection < <%= migration_class_name %>
   def change
     add_column :<%= model_class_name.tableize %>, :failed_logins_count, :integer, :default => 0
     add_column :<%= model_class_name.tableize %>, :lock_expires_at, :datetime, :default => nil

data/lib/generators/sorcery/templates/migration/core.rb

@@ -1,13 +1,13 @@
-class SorceryCore < ActiveRecord::Migration
+class SorceryCore < <%= migration_class_name %>
   def change
     create_table :<%= model_class_name.tableize %> do |t|
       t.string :email,            :null => false
       t.string :crypted_password
       t.string :salt
 
-      t.timestamps
+      t.timestamps                :null => false
     end
 
     add_index :<%= model_class_name.tableize %>, :email, unique: true
   end
-end
+end

data/lib/generators/sorcery/templates/migration/external.rb

@@ -1,12 +1,12 @@
-class SorceryExternal < ActiveRecord::Migration
+class SorceryExternal < <%= migration_class_name %>
   def change
     create_table :authentications do |t|
       t.integer :<%= model_class_name.tableize.singularize %>_id, :null => false
       t.string :provider, :uid, :null => false
 
-      t.timestamps
+      t.timestamps              :null => false
     end
 
-    add_index :<%= model_class_name.tableize %>, [:provider, :uid]
+    add_index :authentications, [:provider, :uid]
   end
 end

data/lib/generators/sorcery/templates/migration/remember_me.rb

@@ -1,8 +1,8 @@
-class SorceryRememberMe < ActiveRecord::Migration
+class SorceryRememberMe < <%= migration_class_name %>
   def change
     add_column :<%= model_class_name.tableize %>, :remember_me_token, :string, :default => nil
     add_column :<%= model_class_name.tableize %>, :remember_me_token_expires_at, :datetime, :default => nil
 
     add_index :<%= model_class_name.tableize %>, :remember_me_token
   end
-end
+end

data/lib/generators/sorcery/templates/migration/reset_password.rb

@@ -1,4 +1,4 @@
-class SorceryResetPassword < ActiveRecord::Migration
+class SorceryResetPassword < <%= migration_class_name %>
   def change
     add_column :<%= model_class_name.tableize %>, :reset_password_token, :string, :default => nil
     add_column :<%= model_class_name.tableize %>, :reset_password_token_expires_at, :datetime, :default => nil
@@ -6,4 +6,4 @@ class SorceryResetPassword < ActiveRecord::Migration
 
     add_index :<%= model_class_name.tableize %>, :reset_password_token
   end
-end
+end

data/lib/generators/sorcery/templates/migration/user_activation.rb

@@ -1,4 +1,4 @@
-class SorceryUserActivation < ActiveRecord::Migration
+class SorceryUserActivation < <%= migration_class_name %>
   def change
     add_column :<%= model_class_name.tableize %>, :activation_state, :string, :default => nil
     add_column :<%= model_class_name.tableize %>, :activation_token, :string, :default => nil
@@ -6,4 +6,4 @@ class SorceryUserActivation < ActiveRecord::Migration
 
     add_index :<%= model_class_name.tableize %>, :activation_token
   end
-end
+end

data/lib/sorcery/adapters/active_record_adapter.rb

@@ -29,11 +29,11 @@ module Sorcery
       end
 
       class << self
-        def define_field(name, type, options={})
+        def define_field(name, type, options = {})
           # AR fields are defined through migrations, only validator here
         end
 
-        def define_callback(time, event, method_name, options={})
+        def define_callback(time, event, method_name, options = {})
           @klass.send "#{time}_#{event}", method_name, options.slice(:if)
         end
 
@@ -61,11 +61,11 @@ module Sorcery
               condition = @klass.arel_table[attribute].eq(credentials[0])
             end
 
-            if relation.nil?
-              relation = condition
-            else
-              relation = relation.or(condition)
-            end
+            relation = if relation.nil?
+                         condition
+                       else
+                         relation.or(condition)
+                       end
           end
 
           @klass.where(relation).first
@@ -100,21 +100,10 @@ module Sorcery
           @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} 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.utc.to_s(:db))
-        end
-
         def transaction(&blk)
           @klass.tap(&blk)
         end
       end
     end
-
-
   end
 end

data/lib/sorcery/controller/config.rb

@@ -2,21 +2,22 @@ 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.
+        attr_accessor :submodules
+        # what class to use as the user class.
+        attr_accessor :user_class
+        # what controller action to call for non-authenticated users.
+        attr_accessor :not_authenticated_action
+        # 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.
+        attr_accessor :save_return_to_url
+        # set domain option for cookies
+        attr_accessor :cookie_domain
 
-                      :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
+        attr_accessor :login_sources
+        attr_accessor :after_login
+        attr_accessor :after_failed_login
+        attr_accessor :before_logout
+        attr_accessor :after_logout
 
         def init!
           @defaults = {
@@ -35,14 +36,14 @@ module Sorcery
 
         # Resets all configuration options to their default values.
         def reset!
-          @defaults.each do |k,v|
-            instance_variable_set(k,v)
+          @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)
+          @defaults.each do |k, v|
+            instance_variable_set(k, v) unless instance_variable_defined?(k)
           end
         end
 
@@ -58,6 +59,7 @@ module Sorcery
           @configure_blk.call(self) if @configure_blk
         end
       end
+
       init!
       reset!
     end

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

@@ -25,8 +25,7 @@ module Sorcery
                 @defaults.merge!(:@register_login_time         => true,
                                  :@register_logout_time        => true,
                                  :@register_last_activity_time => true,
-                                 :@register_last_ip_address    => true
-                                 )
+                                 :@register_last_ip_address    => true)
               end
             end
             merge_activity_logging_defaults!
@@ -34,31 +33,24 @@ module Sorcery
           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
+          base.after_action :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
-          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)
+          def register_login_time_to_db(user, _credentials)
             return unless Config.register_login_time
             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)
+          def register_logout_time_to_db
             return unless Config.register_logout_time
-            user.set_last_logout_at(Time.now.in_time_zone)
+            current_user.set_last_logout_at(Time.now.in_time_zone)
           end
 
           # Updates last activity time on every request.
@@ -71,9 +63,9 @@ module Sorcery
 
           # Updates IP address on every login.
           # This runs as a hook just after a successful login.
-          def register_last_ip_address(user, credentials)
+          def register_last_ip_address(_user, _credentials)
             return unless Config.register_last_ip_address
-            current_user.set_last_ip_addess(request.remote_ip)
+            current_user.set_last_ip_address(request.remote_ip)
           end
         end
       end

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

@@ -16,7 +16,6 @@ module Sorcery
         end
 
         module InstanceMethods
-
           protected
 
           # Increments the failed logins counter on every failed login.
@@ -28,7 +27,7 @@ module Sorcery
 
           # Resets the failed logins counter.
           # Runs as a hook after a successful login.
-          def reset_failed_logins_count!(user, credentials)
+          def reset_failed_logins_count!(user, _credentials)
             user.sorcery_adapter.update_attribute(user_class.sorcery_config.failed_logins_count_attribute_name, 0)
           end
         end