easy_auth 0.1.0 → 0.2.0

data/app/helpers/easy_auth_helper.rb

@@ -5,6 +5,9 @@ module EasyAuthHelper
     end
   end
 
+  # Access the current account the users is authenticated with
+  #
+  # @return [Account] instance
   def current_account
     if session[:session_token] && session[:account_class]
       begin
@@ -29,11 +32,13 @@ module EasyAuthHelper
   end
   alias :current_user :current_account
 
+  # Should be used to test if user is authenticated
   def account_signed_in?
     current_account
   end
   alias :user_signed_in? :account_signed_in?
 
+  # Should be used to test if user is not authenticated
   def account_not_signed_in?
     !account_signed_in?
   end

data/app/models/identity.rb

@@ -0,0 +1,3 @@
+class Identity < ActiveRecord::Base
+  include EasyAuth::Models::Identity
+end

data/lib/easy_auth/controllers/sessions.rb

@@ -14,7 +14,7 @@ module EasyAuth::Controllers::Sessions
       end
       after_successful_sign_in(identity)
     else
-      @identity = EasyAuth.find_identity_model(self).new(params[params[:identity]])
+      @identity = EasyAuth.find_identity_model(params).new(params[params[:identity]])
       after_failed_sign_in(@identity)
     end
   end
@@ -73,13 +73,13 @@ module EasyAuth::Controllers::Sessions
 
   def method_missing(method_name, *args)
     # Swallow exceptions for identity callbacks
-    unless method_name =~ /after_\w+_with_\w+/
+    unless method_name.to_s =~ /after_\w+_with_\w+/
       super
     end
   end
 
   def set_remember(identity)
-    if identity_attributes = params[ActiveModel::Naming.param_key(EasyAuth.find_identity_model(self).new)]
+    if identity_attributes = params[ActiveModel::Naming.param_key(EasyAuth.find_identity_model(params).new)]
       identity.remember = identity_attributes[:remember]
     end
   end

data/lib/easy_auth/models/account.rb

@@ -5,7 +5,7 @@ module EasyAuth::Models::Account
 
   reverse_included do
     # Relationships
-    has_many :identities, :class_name => 'EasyAuth::Identity', :as => :account, :dependent => :destroy
+    has_many :identities, :class_name => 'Identity', :as => :account, :dependent => :destroy
 
     def identity_username_attribute
       self.send(self.class.identity_username_attribute)
@@ -13,6 +13,14 @@ module EasyAuth::Models::Account
   end
 
   module ClassMethods
+    # Will attempt to find the username attribute
+    #
+    # First will check to see if #identity_username_attribute is already defined in the model.
+    #
+    # If not, will check to see if `username` exists as a column on the record
+    # If not, will check to see if `email` exists as a column on the record
+    #
+    # @return [Symbol]
     def identity_username_attribute
       if respond_to?(:super)
         super
@@ -26,11 +34,17 @@ module EasyAuth::Models::Account
     end
   end
 
+  # Generates a new session token and updates the record
+  #
+  # @return [String]
   def generate_session_token!
     self.update_column(:session_token, _generate_token(:session))
     self.session_token
   end
 
+  # Used to set the session for the authenticated account
+  #
+  # @param [Rack::Session::Abstract::SessionHash] session controller session
   def set_session(session)
     session[:session_token] = generate_session_token!
     session[:account_class] = self.class.to_s

data/lib/easy_auth/models/identity.rb

@@ -4,39 +4,59 @@ module EasyAuth::Models::Identity
 
   def self.included(base)
     base.class_eval do
-      self.table_name = :identities
       belongs_to :account, :polymorphic => true
       extend ClassMethods
     end
   end
 
   module ClassMethods
+    # Base authentication method, should be implemented by child identities
+    #
+    # @param [ActionController::Base] controller instance of the controller
     def authenticate(controller = nil)
       raise NotImplementedError
     end
 
+    # Base assumption for new sessions on the controller, will set `@identity` to a new instance of the identity
+    #
+    # @param [ActionController::Base] controller instance of the controller
     def new_session(controller)
       controller.instance_variable_set(:@identity, self.new)
     end
   end
 
+  # Sets the session for the association account
+  #
+  # @param [Rack::Session::Abstract::SessionHash] session controller session
   def set_account_session(session)
     account.set_session(session)
   end
 
+  # Getter for the remember flag
   def remember
     @remember
   end
 
+  # Setter for the remember flag
+  #
+  # @param [Boolean] value
   def remember=(value)
     @remember = ::ActiveRecord::ConnectionAdapters::Column.value_to_boolean(value)
   end
 
+  # Generates a new remember token and updates it on the identity record
+  #
+  # @return [String]
   def generate_remember_token!
     update_column(:remember_token, _generate_token(:remember))
     remember_token
   end
 
+  # The time used for remembering how long to stay signed in
+  #
+  # Defaults to 1 year, override in the model to set your own custom remember time
+  #
+  # @return [DateTime]
   def remember_time
     1.year
   end

data/lib/easy_auth/version.rb

@@ -1,3 +1,3 @@
 module EasyAuth
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/easy_auth.rb

@@ -13,37 +13,66 @@ module EasyAuth
   autoload :Routes
   autoload :TokenGenerator
 
+  # The top-level model that should be inherited from to build EasyAuth identities
+  #
+  # @return [Class]
   def self.identity_model
-    EasyAuth::Identity
+    ::Identity
   end
 
+  # The assumed account class
+  #
+  # @return [Class]
   def self.account_model
     User
   end
 
+  # Main authenticate method to delegate to the proper identity's .authenticate method
+  # Should handle any redirects necessary
+  #
+  # @param [ActionController::Base] controller instance of the controller
   def self.authenticate(controller)
-    if identity_model = find_identity_model(controller)
+    if identity_model = find_identity_model(controller.params)
       identity_model.authenticate(controller)
     end
   end
 
+  # Main new_session method to delegate to the proper identity's .new_session method
+  # Should handle any redirects necessary
+  #
+  # @param [ActionController::Base] controller instance of the controller
   def self.new_session(controller)
-    identity_model = find_identity_model(controller)
+    identity_model = find_identity_model(controller.params)
     identity_model.new_session(controller)
   end
 
+  # EasyAuth config
+  #
+  # @param [&block] block
   def self.config(&block)
     yield self
   end
 
-  private
-
-  def self.find_identity_model(controller)
-    method_name = "#{controller.params[:identity]}_identity_model"
+  # Find the proper identity model
+  # Will use params[:identity] to first see if the identity's model method exists:
+  #
+  # i.e. password_identity_model
+  #
+  # If that method doesn't exist, will see if `Identities::#{camelcased_identity_name}` is defined
+  #
+  # If that fails will finally check to see if the camelcased identity name exists in the top-leve namespace
+  #
+  # @param [Hash] params must contain an `identity` key
+  # @return [Class]
+  def self.find_identity_model(params)
+    method_name = "#{params[:identity]}_identity_model"
+    camelcased_identity_name = params[:identity].to_s.camelcase
     if respond_to?(method_name)
-      send(method_name, controller)
+      send(method_name, params)
+    elsif eval("defined?(Identities::#{camelcased_identity_name})")
+      eval("Identities::#{camelcased_identity_name}")
     else
-      controller.params[:identity].to_s.camelcase.constantize
+      camelcased_identity_name.constantize
     end
   end
 end

data/lib/generators/easy_auth/setup_generator.rb

@@ -0,0 +1,16 @@
+module EasyAuth
+  class SetupGenerator < Rails::Generators::Base
+    def copy_initializer
+      source_paths << File.expand_path('../../templates/easy_auth', __FILE__)
+      copy_file 'initializer.rb', 'config/initializers/easy_auth.rb'
+    end
+
+    private
+
+    def self.installation_message
+      'Copies initializer into config/initializers'
+    end
+
+    desc installation_message
+  end
+end

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

@@ -0,0 +1,3 @@
+EasyAuth.config do |c|
+  # put your config options in here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,6 +188,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: EasyAuth
 email:
 - brian@dockyard.com
@@ -200,7 +216,7 @@ files:
 - app/controllers/authenticated_controller.rb
 - app/controllers/sessions_controller.rb
 - app/helpers/easy_auth_helper.rb
-- app/models/easy_auth/identity.rb
+- app/models/identity.rb
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20120227014023_create_easy_auth_identities.rb
@@ -218,7 +234,8 @@ files:
 - lib/easy_auth/token_generator.rb
 - lib/easy_auth/version.rb
 - lib/easy_auth.rb
-- lib/tasks/easy_auth_tasks.rake
+- lib/generators/easy_auth/setup_generator.rb
+- lib/generators/templates/easy_auth/initializer.rb
 - Rakefile
 - README.md
 homepage: https://github.com/dockyard/easy_auth
@@ -235,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3015113123042150927
+      hash: 2413348689923643998
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -244,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3015113123042150927
+      hash: 2413348689923643998
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/app/models/easy_auth/identity.rb

@@ -1,3 +0,0 @@
-class EasyAuth::Identity < ActiveRecord::Base
-  include EasyAuth::Models::Identity
-end

data/lib/tasks/easy_auth_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :easy_auth do
-#   # Task goes here
-# end