omniauth-identity 1.1.1 → 3.0.3

data/lib/omniauth-identity.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'omniauth-identity/version'
 require 'omniauth/identity'

data/lib/omniauth-identity/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module Identity
-    VERSION = '1.1.1'
+    VERSION = '3.0.3'
   end
 end

data/lib/omniauth/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'omniauth'
 
 module OmniAuth
@@ -10,10 +12,9 @@ module OmniAuth
     autoload :SecurePassword,      'omniauth/identity/secure_password'
     module Models
       autoload :ActiveRecord,      'omniauth/identity/models/active_record'
-      autoload :MongoMapper,       'omniauth/identity/models/mongo_mapper'
       autoload :Mongoid,           'omniauth/identity/models/mongoid'
-      autoload :DataMapper,        'omniauth/identity/models/data_mapper'
       autoload :CouchPotatoModule, 'omniauth/identity/models/couch_potato'
+      autoload :NoBrainer,         'omniauth/identity/models/no_brainer'
     end
   end
 end

data/lib/omniauth/identity/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module Identity
     # This module provides an includable interface for implementing the
@@ -28,6 +30,7 @@ module OmniAuth
         def authenticate(conditions, password)
           instance = locate(conditions)
           return false unless instance
+
           instance.authenticate(password)
         end
 
@@ -36,7 +39,7 @@ module OmniAuth
         # @return [String] The method name.
         def auth_key(method = false)
           @auth_key = method.to_s unless method == false
-          @auth_key = nil if @auth_key == ''
+          @auth_key = nil if !defined?(@auth_key) || @auth_key == ''
 
           @auth_key || 'email'
         end
@@ -52,22 +55,20 @@ module OmniAuth
         raise NotImplementedError
       end
 
-      SCHEMA_ATTRIBUTES = %w(name email nickname first_name last_name location description image phone)
+      SCHEMA_ATTRIBUTES = %w[name email nickname first_name last_name location description image phone].freeze
       # A hash of as much of the standard OmniAuth schema as is stored
       # in this particular model. By default, this will call instance
       # methods for each of the attributes it needs in turn, ignoring
       # any for which `#respond_to?` is `false`.
       #
-      # If `first_name`, `nickname`, and/or `last_name` is provided but 
+      # If `first_name`, `nickname`, and/or `last_name` is provided but
       # `name` is not, it will be automatically calculated.
       #
       # @return [Hash] A string-keyed hash of user information.
       def info
-        info = SCHEMA_ATTRIBUTES.inject({}) do |hash,attribute|
+        SCHEMA_ATTRIBUTES.each_with_object({}) do |attribute, hash|
           hash[attribute] = send(attribute) if respond_to?(attribute)
-          hash
         end
-        info
       end
 
       # An identifying string that must be globally unique to the
@@ -75,22 +76,23 @@ module OmniAuth
       #
       # @return [String] An identifier string unique to this identity.
       def uid
-        if respond_to?('id')
-          return nil if self.id.nil?
-          self.id.to_s
+        if respond_to?(:id)
+          return nil if id.nil?
+
+          id.to_s
         else
-          raise NotImplementedError 
+          raise NotImplementedError
         end
       end
 
       # Used to retrieve the user-supplied authentication key (e.g. a
       # username or email). Determined using the class method of the same name,
-      # defaults to `:email`. 
+      # defaults to `:email`.
       #
       # @return [String] An identifying string that will be entered by
       #   users upon sign in.
       def auth_key
-        if respond_to?(self.class.auth_key)
+        if respond_to?(self.class.auth_key.to_sym)
           send(self.class.auth_key)
         else
           raise NotImplementedError
@@ -104,8 +106,9 @@ module OmniAuth
       # @param [String] value The value to which the auth key should be
       #   set.
       def auth_key=(value)
-        if respond_to?(self.class.auth_key + '=')
-          send(self.class.auth_key + '=', value)
+        auth_key_setter = "#{self.class.auth_key}=".to_sym
+        if respond_to?(auth_key_setter)
+          send(auth_key_setter, value)
         else
           raise NotImplementedError
         end

data/lib/omniauth/identity/models/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 module OmniAuth
@@ -12,10 +14,11 @@ module OmniAuth
 
         def self.auth_key=(key)
           super
-          validates_uniqueness_of key, :case_sensitive => false
+          validates_uniqueness_of key, case_sensitive: false
         end
 
         def self.locate(search_hash)
+          search_hash = search_hash.reverse_merge!('provider' => 'identity') if column_names.include?('provider')
           where(search_hash).first
         end
       end

data/lib/omniauth/identity/models/couch_potato.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'couch_potato'
 
 module OmniAuth
@@ -5,11 +7,8 @@ module OmniAuth
     module Models
       # can not be named CouchPotato since there is a class with that name
       module CouchPotatoModule
-
         def self.included(base)
-
           base.class_eval do
-
             include ::OmniAuth::Identity::Model
             include ::OmniAuth::Identity::SecurePassword
 
@@ -17,7 +16,7 @@ module OmniAuth
 
             def self.auth_key=(key)
               super
-              validates_uniqueness_of key, :case_sensitive => false
+              validates_uniqueness_of key, case_sensitive: false
             end
 
             def self.locate(search_hash)

data/lib/omniauth/identity/models/mongoid.rb

@@ -1,14 +1,13 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 
 module OmniAuth
   module Identity
     module Models
       module Mongoid
-
         def self.included(base)
-
           base.class_eval do
-
             include ::OmniAuth::Identity::Model
             include ::OmniAuth::Identity::SecurePassword
 
@@ -16,17 +15,14 @@ module OmniAuth
 
             def self.auth_key=(key)
               super
-              validates_uniqueness_of key, :case_sensitive => false
+              validates_uniqueness_of key, case_sensitive: false
             end
 
             def self.locate(search_hash)
               where(search_hash).first
             end
-
           end
-
         end
-
       end
     end
   end

data/lib/omniauth/identity/models/{mongo_mapper.rb → no_brainer.rb}

@@ -1,9 +1,12 @@
-require 'mongo_mapper'
+# frozen_string_literal: true
+
+require 'nobrainer'
 
 module OmniAuth
   module Identity
     module Models
-      module MongoMapper
+      # http://nobrainer.io/ an ORM for RethinkDB
+      module NoBrainer
         def self.included(base)
           base.class_eval do
             include ::OmniAuth::Identity::Model
@@ -13,7 +16,7 @@ module OmniAuth
 
             def self.auth_key=(key)
               super
-              validates_uniqueness_of key, :case_sensitive => false
+              validates_uniqueness_of key, case_sensitive: false
             end
 
             def self.locate(search_hash)
@@ -25,4 +28,3 @@ module OmniAuth
     end
   end
 end
-

data/lib/omniauth/identity/secure_password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bcrypt'
 
 module OmniAuth
@@ -9,9 +11,7 @@ module OmniAuth
     # a has_secure_password method.
     module SecurePassword
       def self.included(base)
-        unless base.respond_to?(:has_secure_password)
-          base.extend ClassMethods
-        end
+        base.extend ClassMethods unless base.respond_to?(:has_secure_password)
       end
 
       module ClassMethods
@@ -40,7 +40,7 @@ module OmniAuth
         #   User.find_by_name("david").try(:authenticate, "notright")      # => nil
         #   User.find_by_name("david").try(:authenticate, "mUc3m00RsqyRe") # => user
         def has_secure_password
-          attr_reader   :password
+          attr_reader :password
 
           validates_confirmation_of :password
           validates_presence_of     :password_digest

data/lib/omniauth/strategies/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module Strategies
     # The identity strategy allows you to provide simple internal
@@ -6,76 +8,91 @@ module OmniAuth
     class Identity
       include OmniAuth::Strategy
 
-      option :fields, [:name, :email]
-      option :on_login, nil
-      option :on_registration, nil
-      option :on_failed_registration, nil
-      option :locate_conditions, lambda{|req| {model.auth_key => req['auth_key']} }
+      option :fields, %i[name email]
+
+      # Primary Feature Switches:
+      option :enable_registration, true   # See #other_phase and #request_phase
+      option :enable_login, true          # See #other_phase
+
+      # Customization Options:
+      option :on_login, nil               # See #request_phase
+      option :on_validation, nil          # See #registration_phase
+      option :on_registration, nil        # See #registration_phase
+      option :on_failed_registration, nil # See #registration_phase
+      option :locate_conditions, ->(req) { { model.auth_key => req['auth_key'] } }
 
       def request_phase
         if options[:on_login]
-          options[:on_login].call(self.env)
+          options[:on_login].call(env)
         else
-          OmniAuth::Form.build(
-            :title => (options[:title] || "Identity Verification"),
-            :url => callback_path
-          ) do |f|
-            f.text_field 'Login', 'auth_key'
-            f.password_field 'Password', 'password'
-            f.html "<p align='center'><a href='#{registration_path}'>Create an Identity</a></p>"
-          end.to_response
+          build_omniauth_login_form.to_response
         end
       end
 
       def callback_phase
         return fail!(:invalid_credentials) unless identity
+
         super
       end
 
       def other_phase
-        if on_registration_path?
+        if options[:enable_registration] && on_registration_path?
           if request.get?
             registration_form
           elsif request.post?
             registration_phase
+          else
+            call_app!
           end
+        elsif options[:enable_login] && on_request_path?
+          # OmniAuth, by default, disables "GET" requests for security reasons.
+          # This effectively disables omniauth-identity tool's login form feature.
+          # Because it is disabled by default, and because enabling it would desecuritize all the other
+          #   OmniAuth strategies that may be implemented, we do not ask users to modify that setting.
+          # Instead we hook in here in the "other_phase", with a config setting of our own: `enable_login`
+          request_phase
         else
           call_app!
         end
       end
 
-      def registration_form
+      def registration_form(validation_message = nil)
         if options[:on_registration]
-          options[:on_registration].call(self.env)
+          options[:on_registration].call(env)
         else
-          OmniAuth::Form.build(:title => 'Register Identity') do |f|
-            options[:fields].each do |field|
-              f.text_field field.to_s.capitalize, field.to_s
-            end
-            f.password_field 'Password', 'password'
-            f.password_field 'Confirm Password', 'password_confirmation'
-          end.to_response
+          build_omniauth_registration_form(validation_message).to_response
         end
       end
 
       def registration_phase
-        attributes = (options[:fields] + [:password, :password_confirmation]).inject({}){|h,k| h[k] = request[k.to_s]; h}
-        @identity = model.create(attributes)
-        if @identity.persisted?
-          env['PATH_INFO'] = callback_path
-          callback_phase
-        else
+        attributes = (options[:fields] + %i[password password_confirmation]).each_with_object({}) do |k, h|
+          h[k] = request[k.to_s]
+        end
+        if model.respond_to?(:column_names) && model.column_names.include?('provider')
+          attributes.reverse_merge!(provider: 'identity')
+        end
+        @identity = model.new(attributes)
+
+        # on_validation may run a Captcha or other validation mechanism
+        # Must return true when validation passes, false otherwise
+        if options[:on_validation] && !options[:on_validation].call(env: env)
           if options[:on_failed_registration]
-            self.env['omniauth.identity'] = @identity
-            options[:on_failed_registration].call(self.env)
+            env['omniauth.identity'] = @identity
+            options[:on_failed_registration].call(env)
           else
-            registration_form
+            validation_message = 'Validation failed'
+            registration_form(validation_message)
           end
+        elsif @identity.save && @identity.persisted?
+          env['PATH_INFO'] = callback_path
+          callback_phase
+        else
+          show_custom_options_or_default
         end
       end
 
-      uid{ identity.uid }
-      info{ identity.info }
+      uid { identity.uid }
+      info { identity.info }
 
       def registration_path
         options[:registration_path] || "#{path_prefix}/#{name}/register"
@@ -86,18 +103,54 @@ module OmniAuth
       end
 
       def identity
-        if options.locate_conditions.is_a? Proc
-          conditions = instance_exec(request, &options.locate_conditions)
+        if options[:locate_conditions].is_a? Proc
+          conditions = instance_exec(request, &options[:locate_conditions])
           conditions.to_hash
         else
-          conditions = options.locate_conditions.to_hash
+          conditions = options[:locate_conditions].to_hash
         end
-        @identity ||= model.authenticate(conditions, request['password'] )
+        @identity ||= model.authenticate(conditions, request['password'])
       end
 
       def model
         options[:model] || ::Identity
       end
+
+      private
+
+      def build_omniauth_login_form
+        OmniAuth::Form.build(
+          title: (options[:title] || 'Identity Verification'),
+          url: callback_path
+        ) do |f|
+          f.text_field 'Login', 'auth_key'
+          f.password_field 'Password', 'password'
+          if options[:enable_registration]
+            f.html "<p align='center'><a href='#{registration_path}'>Create an Identity</a></p>"
+          end
+        end
+      end
+
+      def build_omniauth_registration_form(validation_message)
+        OmniAuth::Form.build(title: 'Register Identity') do |f|
+          f.html "<p style='color:red'>#{validation_message}</p>" if validation_message
+          options[:fields].each do |field|
+            f.text_field field.to_s.capitalize, field.to_s
+          end
+          f.password_field 'Password', 'password'
+          f.password_field 'Confirm Password', 'password_confirmation'
+        end
+      end
+
+      def show_custom_options_or_default
+        if options[:on_failed_registration]
+          env['omniauth.identity'] = @identity
+          options[:on_failed_registration].call(env)
+        else
+          validation_message = 'One or more fields were invalid'
+          registration_form(validation_message)
+        end
+      end
     end
   end
 end