sorcery 0.9.1 → 0.10.0

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/gemfiles/{mongoid-rails40.gemfile → active_record-rails42.gemfile}

@@ -1,9 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 4.0.0'
-
-gem 'mongoid', '~> 4.0.0'
 gem 'sqlite3', platform: :mri
 gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+gem 'rails', '~> 4.2.0'
 
 gemspec path: '..'

data/lib/generators/sorcery/helpers.rb

@@ -4,16 +4,16 @@ module Sorcery
       private
 
       def sorcery_config_path
-        "config/initializers/sorcery.rb"
+        'config/initializers/sorcery.rb'
       end
 
       # Either return the model passed in a classified form or return the default "User".
       def model_class_name
-        options[:model] ? options[:model].classify : "User"
+        options[:model] ? options[:model].classify : 'User'
       end
 
       def model_path
-        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+        @model_path ||= File.join('app', 'models', "#{file_path}.rb")
       end
 
       def file_path
@@ -33,7 +33,7 @@ module Sorcery
           [namespace.to_s] + [model_class_name]
         else
           [model_class_name]
-        end.join("::")
+        end.join('::')
       end
     end
   end

data/lib/generators/sorcery/install_generator.rb

@@ -9,36 +9,35 @@ module Sorcery
 
       source_root File.expand_path('../templates', __FILE__)
 
-      argument :submodules, :optional => true, :type => :array, :banner => "submodules"
+      argument :submodules, optional: true, type: :array, banner: 'submodules'
 
-      class_option :model, :optional => true, :type => :string, :banner => "model",
-                   :desc => "Specify the model class name if you will use anything other than 'User'"
+      class_option :model, optional: true, type: :string, banner: 'model',
+                           desc: "Specify the model class name if you will use anything other than 'User'"
 
-      class_option :migrations, :optional => true, :type => :boolean, :banner => "migrations",
-                   :desc => "[DEPRECATED] Please use --only-submodules option instead"
-
-      class_option :only_submodules, :optional => true, :type => :boolean, :banner => "only-submodules",
-                   :desc => "Specify if you want to add submodules to an existing model\n\t\t\t     # (will generate migrations files, and add submodules to config file)"
+      class_option :migrations, optional: true, type: :boolean, banner: 'migrations',
+                                desc: '[DEPRECATED] Please use --only-submodules option instead'
 
+      class_option :only_submodules, optional: true, type: :boolean, banner: 'only-submodules',
+                                     desc: "Specify if you want to add submodules to an existing model\n\t\t\t     # (will generate migrations files, and add submodules to config file)"
 
       def check_deprecated_options
         if options[:migrations]
-          warn("[DEPRECATED] `--migrations` option is deprecated, please use `--only-submodules` instead")
+          warn('[DEPRECATED] `--migrations` option is deprecated, please use `--only-submodules` instead')
         end
       end
 
       # Copy the initializer file to config/initializers folder.
       def copy_initializer_file
-        template "initializer.rb", sorcery_config_path unless only_submodules?
+        template 'initializer.rb', sorcery_config_path unless only_submodules?
       end
 
       def configure_initializer_file
         # Add submodules to the initializer file.
         if submodules
-          submodule_names = submodules.collect{ |submodule| ':' + submodule }
+          submodule_names = submodules.collect { |submodule| ':' + submodule }
 
           gsub_file sorcery_config_path, /submodules = \[.*\]/ do |str|
-            current_submodule_names = (str =~ /\[(.*)\]/ ? $1 : '').delete(' ').split(',')
+            current_submodule_names = (str =~ /\[(.*)\]/ ? Regexp.last_match(1) : '').delete(' ').split(',')
             "submodules = [#{(current_submodule_names | submodule_names).join(', ')}]"
           end
         end
@@ -54,7 +53,7 @@ module Sorcery
       end
 
       def inject_sorcery_to_model
-        indents = "  " * (namespaced? ? 2 : 1)
+        indents = '  ' * (namespaced? ? 2 : 1)
 
         inject_into_class(model_path, model_class_name, "#{indents}authenticates_with_sorcery!\n")
       end
@@ -63,33 +62,40 @@ module Sorcery
       def copy_migration_files
         # Copy core migration file in all cases except when you pass --only-submodules.
         return unless defined?(Sorcery::Generators::InstallGenerator::ActiveRecord)
-        migration_template "migration/core.rb", "db/migrate/sorcery_core.rb" unless only_submodules?
+        migration_template 'migration/core.rb', 'db/migrate/sorcery_core.rb', migration_class_name: migration_class_name unless only_submodules?
 
         if submodules
           submodules.each do |submodule|
-            unless submodule == "http_basic_auth" || submodule == "session_timeout" || submodule == "core"
-              migration_template "migration/#{submodule}.rb", "db/migrate/sorcery_#{submodule}.rb"
+            unless submodule == 'http_basic_auth' || submodule == 'session_timeout' || submodule == 'core'
+              migration_template "migration/#{submodule}.rb", "db/migrate/sorcery_#{submodule}.rb", migration_class_name: migration_class_name
             end
           end
         end
-
       end
 
       # Define the next_migration_number method (necessary for the migration_template method to work)
       def self.next_migration_number(dirname)
         if ActiveRecord::Base.timestamped_migrations
           sleep 1 # make sure each time we get a different timestamp
-          Time.new.utc.strftime("%Y%m%d%H%M%S")
+          Time.new.utc.strftime('%Y%m%d%H%M%S')
         else
-          "%.3d" % (current_migration_number(dirname) + 1)
+          '%.3d' % (current_migration_number(dirname) + 1)
         end
       end
 
       private
+
       def only_submodules?
         options[:migrations] || options[:only_submodules]
       end
 
+      def migration_class_name
+        if Rails::VERSION::MAJOR >= 5
+          "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        else
+          'ActiveRecord::Migration'
+        end
+      end
     end
   end
 end

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
@@ -128,16 +116,31 @@ Rails.application.config.sorcery.configure do |config|
   # 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
@@ -179,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).
@@ -260,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.
@@ -292,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
@@ -349,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`
     #
@@ -413,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`
     #
@@ -459,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