devise-basecamper 0.4.5 → 0.5.0

data/lib/devise-basecamper/authentication.rb

@@ -0,0 +1,95 @@
+# lib/devise-basecamper/authentication.rb
+
+module DeviseBasecamper
+  module Authentication
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      ## Override the find_for_authentication finder
+      ##
+      ## We will clean the conditions provided to make sure that the proper
+      ## resource can/will be found.
+      ##
+      ##
+      def find_for_authentication(conditions={})
+        conditions = clean_conditions_for_subdomain(conditions)
+
+        ## Process if "login" key used instead of default (:email)
+        if authenticate_with_login?(conditions)
+          find_for_authentication_with_login( authentication_keys, conditions )
+        else
+          super ## Execute original find_for_authentication code
+        end
+      end
+
+      def authenticate_with_login?(conditions={})
+        if conditions.any?
+          authentication_keys.include?(basecamper[:login_attribute]) && conditions.include?(basecamper[:login_attribute])
+        else
+          authentication_keys.include? basecamper[:login_attribute]
+        end
+      end
+
+      private # -------------------------------------------
+
+      ## Search for the resource identified in the basecamper config and return it
+      ## to the caller
+      def find_resource_by_subdomain(conditions)
+        resource            = self.basecamper[:subdomain_class].to_s.camelize.constantize
+        subdomain_field     = self.basecamper[:subdomain_field]
+
+        return resource.to_adapter.find_first(subdomain_field => conditions[:subdomain])
+      end
+
+      ## We are going to look for the subdomain condition.  If present, we will translate
+      ## the subdomain to a valid "id", add the ID to the conditions for use in the DB
+      ## query built and remove thd field from the conditions to avoid issues down the
+      ## chain.
+      ##
+      def clean_conditions_for_subdomain(conditions={})
+        if conditions[:subdomain].present?
+          scope_field, subdomain_field  = [self.basecamper[:scope_field], self.basecamper[:subdomain_field]]
+          subdomain_resource            = find_resource_by_subdomain conditions
+          conditions[scope_field]       = (subdomain_resource.nil?) ? nil : subdomain_resource.id
+          conditions.delete(subdomain_field)
+        end
+
+        return conditions
+      end
+
+      ## If devise is configured to allow authentication using either a username
+      ## or email, as described in the wiki we will need to process the find
+      ## appropriately.
+      def find_for_authentication_with_login(required_attributes={}, attributes={}, error=:invalid)
+        resource    = nil
+        attributes  = devise_parameter_filter.filter(attributes)
+
+        basecamper[:login_fields].each do |field|
+          login_field = field.downcase.to_sym
+
+          resource    = to_adapter.find_first({
+            login_field               => attributes[ basecamper[:login_attribute] ],
+            basecamper[:scope_field]  => attributes[basecamper[:scope_field]]
+          })
+
+          break unless resource.nil?
+        end
+
+        unless resource
+          resource = new
+
+          required_attributes.each do |key|
+            unless key == basecamper[:subdomain_field]
+              resource.send("#{ key }=", attributes[key])
+              resource.errors.add(key, attributes[key].present? ? error : :blank)
+            end
+          end
+        end
+
+        return resource
+      end
+
+      ## --------------------------------------------------
+    end
+  end
+end

data/lib/devise-basecamper/basecamper.rb

@@ -0,0 +1,32 @@
+# lib/devise-basecamper/basecamper.rb
+
+module DeviseBasecamper
+  module Basecamper
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      ## Helper method for configuration options on the model
+      ##
+      def devise_basecamper(opts={})
+        defaults = {
+          subdomain_class:  :account,
+          subdomain_field:  :subdomain,
+          scope_field:      :account_id,
+          login_fields:     [:username, :email],
+          login_attribute:  :login
+        }
+
+        @devise_basecamper_settings = defaults.merge(opts)
+      end
+
+      ## Quick access to the models configuration ---------
+      ##
+      def basecamper
+        self.devise_basecamper if @devise_basecamper_settings.nil?
+        return @devise_basecamper_settings
+      end
+    end
+
+    ## ----------------------------------------------------
+  end
+end

data/lib/devise-basecamper/confirmable.rb

@@ -0,0 +1,32 @@
+module DeviseBasecamper
+  module Confirmable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      ## Override for password resets -------------------
+      def send_confirmation_instructions(attributes={})
+        if confirm_with_login?
+          subdomain_resource                      = find_resource_by_subdomain(attributes)
+          attributes[ basecamper[:scope_field] ]  = subdomain_resource.nil? ? nil : subdomain_resource.id
+          recoverable                             = find_for_authentication_with_login(reset_password_keys, attributes, :not_found)
+        else
+          recoverable = find_or_initialize_with_errors(reset_password_keys, attributes, :not_found)
+        end
+
+        ## Now that we have found the recoverable, we are going to call the
+        ## send_reset_password_instructions on the specific recoverable
+        ##
+        recoverable.send_confirmation_instructions if recoverable.persisted?
+        recoverable
+      end
+
+      def confirm_with_login?(attributes={})
+        if attributes.any?
+          attributes.include?( basecamper[:login_attribute] ) && confirmation_keys.include?( basecamper[:login_attribute] )
+        else
+          reset_password_keys.include?( basecamper[:login_attribute] )
+        end
+      end
+    end
+  end
+end

data/lib/devise-basecamper/devise/models/authenticatable.rb

@@ -1,3 +1,10 @@
+# lib/devise-basecamper/devise/models/authenticatable.rb
+#
+# This module will make sure to remove the subdomain field by default
+# from devise models that are NOT using basecamper.  That way the
+# finders will try searching on fields in your database that may not
+# exist.
+##
 module Devise
   module Models
     module Authenticatable

data/lib/devise-basecamper/model.rb

@@ -3,139 +3,11 @@ module Devise
     module Basecamper
       extend ActiveSupport::Concern
 
-      module ClassMethods
-        def devise_basecamper(opts={})
-          defaults = {
-            :subdomain_class  => :account,
-            :subdomain_field  => :subdomain,
-            :scope_field      => :account_id,
-            :login_fields     => [:username, :email]
-          }
-          @devise_basecamper_settings = defaults.merge(opts)
-        end
-
-        def basecamper
-          self.devise_basecamper if @devise_basecamper_settings.nil?
-          return @devise_basecamper_settings
-        end
-
-        ## Methods ------------------------------------------------------------
-
-        def find_for_authentication(conditions={})
-          authentication_keys = Devise.authentication_keys
-
-          ## Process subdomain info by finding the parent resource id into the conditions
-          conditions = clean_conditions_for_subdomain(conditions)
-
-          ## Process if "login" key used instead of default (:email)
-          if conditions[:login].present? && authentication_keys.include?(:login)
-            resource = find_with_login_instead_of_default( authentication_keys, conditions )
-            return resource
-          end
-
-          ## Execute original find_for_authentication code
-          super
-        end
-
-        # TODO: Probably should break this out or atleast put some conditions in place
-        # so that this method is only included when "RECOVERABLE" is a specified option
-        # for the resource.
-        #
-        # We want to override this method to find our users within the scope
-        # of our subdomain.
-        def send_reset_password_instructions(attributes={})
-          send_instructions_for(:reset_password, attributes)
-        end
-
-        def send_confirmation_instructions(attributes={})
-          send_instructions_for(:confirmation, attributes)
-        end
-
-        private
-
-        def send_instructions_for(action_method, attributes={})
-          scope_field           = self.basecamper[:scope_field].downcase.to_sym
-          subdomain_resource    = find_subdomain_resource(attributes[:subdomain])
-          subdomain_resource_id = subdomain_resource.nil? ? nil : subdomain_resource.id
-          required_keys         = Devise.send "#{action_method.to_s}_keys".to_sym
-
-          ## Find our resource for sending the email
-          if attributes[:login].present? && reset_password_keys.include?(:login)
-            attributes[scope_field] = subdomain_resource_id
-            resource = find_with_login_instead_of_default(required_keys, attributes)
-          else
-            resource = find_or_initialize_with_errors(reset_password_keys,{
-              :email => attributes[:email], scope_field => subdomain_resource_id
-            })
-          end
-
-          resource.send("send_#{action_method.to_s}_instructions") if !resource.nil? && resource.persisted?
-          return resource
-        end
-
-        private # -------------------------------------------------------------
-
-        ## If devise is configured to allow authentication using either a username
-        ## or email, as described in the wiki we will need to process the find
-        ## appropriately.
-        def find_with_login_instead_of_default(required_attributes={}, attributes={}, error=:invalid)
-          resource      = nil
-          scope_field   = self.basecamper[:scope_field]
-          login_fields  = self.basecamper[:login_fields]
-
-          attributes    = devise_parameter_filter.filter(attributes)
-
-          login_fields.each do |login_field|
-            login_field = login_field.downcase.to_sym
-
-            resource    = to_adapter.find_first({
-              login_field => attributes[:login],
-              scope_field => attributes[scope_field]
-            })
-
-            break unless resource.nil?
-          end
-
-          unless resource
-            resource = new
-
-            required_attributes.each do |key|
-              unless key == self.basecamper[:subdomain_field]
-                value = attributes[key]
-                resource.send("#{key}=", value)
-                resource.errors.add(key, value.present? ? error : :blank)
-              end
-            end
-          end
-
-          return resource
-        end
-
-        ## Clean the conditions and set them appropriately for finding the resource
-        ## with proper scoping.
-        def clean_conditions_for_subdomain(conditions={})
-          if conditions[:subdomain].present?
-            subdomain               = conditions[:subdomain]
-            scope_field             = self.basecamper[:scope_field]
-            subdomain_field         = self.basecamper[:subdomain_field]
-            subdomain_resource      = find_subdomain_resource(subdomain)
-            conditions[scope_field] = (subdomain_resource.nil?) ? nil : subdomain_resource.id
-
-            ## Remove the subdomain_field from the conditions - it is not needed
-            conditions.delete(subdomain_field)
-          end
-
-          return conditions
-        end
-
-        ## Search for the resource identified in the basecamper config and return it
-        ## to the caller
-        def find_subdomain_resource(subdomain)
-          resource            = self.basecamper[:subdomain_class].to_s.camelize.constantize
-          subdomain_field     = self.basecamper[:subdomain_field]
-
-          return resource.to_adapter.find_first(subdomain_field => subdomain)
-        end
+      included do
+        include DeviseBasecamper::Basecamper
+        include DeviseBasecamper::Authentication
+        include DeviseBasecamper::Recoverable
+        include DeviseBasecamper::Confirmable
       end
     end
   end

data/lib/devise-basecamper/recoverable.rb

@@ -0,0 +1,32 @@
+module DeviseBasecamper
+  module Recoverable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      ## Override for password resets -------------------
+      def send_reset_password_instructions(attributes={})
+        if recover_with_login?
+          subdomain_resource                      = find_resource_by_subdomain(attributes)
+          attributes[ basecamper[:scope_field] ]  = subdomain_resource.nil? ? nil : subdomain_resource.id
+          recoverable                             = find_for_authentication_with_login(reset_password_keys, attributes, :not_found)
+        else
+          recoverable = find_or_initialize_with_errors(reset_password_keys, attributes, :not_found)
+        end
+
+        ## Now that we have found the recoverable, we are going to call the
+        ## send_reset_password_instructions on the specific recoverable
+        ##
+        recoverable.send_reset_password_instructions if recoverable.persisted?
+        recoverable
+      end
+
+      def recover_with_login?(attributes={})
+        if attributes.any?
+          attributes.include?( basecamper[:login_attribute] ) && reset_password_keys.include?( basecamper[:login_attribute] )
+        else
+          reset_password_keys.include?( basecamper[:login_attribute] )
+        end
+      end
+    end
+  end
+end

data/lib/devise-basecamper/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Basecamper
-    VERSION = "0.4.5"
+    VERSION = "0.5.0"
   end
 end

data/lib/devise-basecamper.rb

@@ -1,7 +1,16 @@
 require 'devise'
 require 'devise-basecamper/version'
 require 'devise-basecamper/devise/models/authenticatable'
+require 'devise-basecamper/basecamper'
+require 'devise-basecamper/authentication'
+require 'devise-basecamper/recoverable'
+require 'devise-basecamper/confirmable'
 
+## Establish the namespace --------------------------------
+module DeviseBasecamper
+end
+
+## Add the model to devise --------------------------------
 Devise.add_module(:basecamper,
   :strategy   => false,
   :route      => :session,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-basecamper
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-23 00:00:00.000000000 Z
+date: 2013-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter
@@ -60,8 +60,12 @@ files:
 - Rakefile
 - devise-basecamper.gemspec
 - lib/devise-basecamper.rb
+- lib/devise-basecamper/authentication.rb
+- lib/devise-basecamper/basecamper.rb
+- lib/devise-basecamper/confirmable.rb
 - lib/devise-basecamper/devise/models/authenticatable.rb
 - lib/devise-basecamper/model.rb
+- lib/devise-basecamper/recoverable.rb
 - lib/devise-basecamper/version.rb
 homepage: https://github.com/digitalopera/devise-basecamper
 licenses: