challah 1.1.1 → 1.2.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a04a0045083c40526c41b4bb5e55606a99fb380c
-  data.tar.gz: 192237d8884a972ac4a9fcdc97bf413814d8a378
+  metadata.gz: 7f5f10d1f9752cdc2f931499b2fe600a8ba6486a
+  data.tar.gz: b017bd1018d5e4cebe7d21074d718c0d41653eab
 SHA512:
-  metadata.gz: 99461c5009e3db27fa353fb0abb551b1a25e0012c0622144f5c1a9f45fc30334e651c8820d8efdfc423021407a9aa809f90b238d3ff0b32ace267f7c63e63bdf
-  data.tar.gz: a5b91063515c94e25d33189fbaa94866e66592eadcbd50cbc5459267ab499145f83c5b6366c259367348f0dc2c1903635e8891e5ad275cb66ff6368427f125f4
+  metadata.gz: f6a938dda2a821281f14832ba8225f5e3a711bec8b2fe8e62eae2564304d214d4dd78fd36e192cea36ff90abda58fbc002bb78b071a2fa9fb25fdf065a8b3ade
+  data.tar.gz: d73118e85864d9112c865b926b69e35324ee489ce7aa55ee667c3222d198d538b6bc2a204fb59daf22beef4c01d7b4f5726f6b3f54888fe1143dd78476ac4317

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## Challah (Not Released)
+
+* Convert tests to RSpec
+* Remove use of `challah_user` and replace with concerns
+* Internal clean up of included modules
+
+## Challah 1.1.1
+
+* Internal clean up of tests and gem dependencies
+* Enable compatibility with Rails 4.1.0.rc1
+
 ## Challah 1.1.0
 
 * Allow challah to authenticate with User and Authorization tables that using namespaces
@@ -131,4 +142,4 @@
 
 ## Challah 0.2.0
 
-* Initial build. Basic functionality for session persistence and authentication.
+* Initial build. Basic functionality for session persistence and authentication.

data/README.md

@@ -1,6 +1,6 @@
 # Challah
 
-[![Build Status](https://secure.travis-ci.org/jdtornow/challah.png)](http://travis-ci.org/jdtornow/challah) [![Dependency Status](https://gemnasium.com/jdtornow/challah.png?travis)](https://gemnasium.com/jdtornow/challah)
+[![Build Status](https://secure.travis-ci.org/jdtornow/challah.png)](http://travis-ci.org/jdtornow/challah) [![Code Climate](https://codeclimate.com/github/jdtornow/challah.png)](https://codeclimate.com/github/jdtornow/challah) [![Dependency Status](https://gemnasium.com/jdtornow/challah.png?travis)](https://gemnasium.com/jdtornow/challah) [![Gem Version](https://badge.fury.io/rb/challah.png)](http://badge.fury.io/rb/challah)
 
 Challah (pronounced HAH-lah) is a simple Rails authentication gem that provides users a way to authenticate with your app. Most of the functionality within the gem lives within a Rails engine and tries to stay out of the way of your app.
 
@@ -144,9 +144,9 @@ If you have any issues or find bugs running Challah, please [report them on Gith
 
 ### Testing
 
-Challah is fully tested using Test Unit, Shoulda and Mocha. To run the test suite, `bundle install` then run:
+Challah is fully tested using RSpec. To run the test suite, `bundle install` then run:
 
-    rake test
+    rspec
 
 ## License
 

data/app/models/authorization.rb

@@ -1,3 +1,3 @@
 class Authorization < ActiveRecord::Base
-  challah_authorization
-end
+  include Challah::Authorizeable
+end

data/app/models/user.rb

@@ -11,5 +11,5 @@ class User < ActiveRecord::Base
   # For a list of all methods included into User, see:
   #
   # http://rubydoc.info/gems/challah
-  challah_user
-end
+  include Challah::Userable
+end

data/lib/challah.rb

@@ -1,59 +1,66 @@
-require 'challah/version'
+require "challah/version"
 
 module Challah
-  autoload :Audit,                            'challah/audit'
-
-  autoload :CookieStore,                      'challah/cookie_store'
-  autoload :SimpleCookieStore,                'challah/simple_cookie_store'
-
-  autoload :Authenticators,                   'challah/authenticators'
-  autoload :Controller,                       'challah/controller'
-  autoload :Encrypter,                        'challah/encrypter'
-  autoload :Plugins,                          'challah/plugins'
-  autoload :Providers,                        'challah/providers'
-  autoload :Random,                           'challah/random'
-  autoload :Session,                          'challah/session'
-  autoload :Signup,                           'challah/signup'
-  autoload :Techniques,                       'challah/techniques'
-  autoload :Techniques,                       'challah/techniques'
-
-  autoload :EmailValidator,                   'challah/validators/email_validator'
-  autoload :PasswordValidator,                'challah/validators/password_validator'
-
-  autoload :Authorization,                    'challah/authorization'
-  autoload :User,                             'challah/user'
-
-  autoload :PasswordProvider,                 'challah/providers/password_provider'
+  autoload :Audit,                            "challah/audit"
+
+  autoload :CookieStore,                      "challah/cookie_store"
+  autoload :SimpleCookieStore,                "challah/simple_cookie_store"
+
+  autoload :Authenticators,                   "challah/authenticators"
+  autoload :Controller,                       "challah/controller"
+  autoload :Encrypter,                        "challah/encrypter"
+  autoload :Plugins,                          "challah/plugins"
+  autoload :Providers,                        "challah/providers"
+  autoload :Random,                           "challah/random"
+  autoload :Session,                          "challah/session"
+  autoload :Signup,                           "challah/signup"
+  autoload :Techniques,                       "challah/techniques"
+  autoload :Techniques,                       "challah/techniques"
+
+  autoload :EmailValidator,                   "challah/validators/email_validator"
+  autoload :PasswordValidator,                "challah/validators/password_validator"
+
+  autoload :PasswordProvider,                 "challah/providers/password_provider"
+
+  autoload :ActiveRecordExtensions,           "challah/active_record_extensions"
+
+  autoload :Authorizeable,                    "challah/concerns/authorizeable"
+  autoload :Userable,                         "challah/concerns/userable"
+  autoload :UserAttributeable,                "challah/concerns/user/attributeable"
+  autoload :UserAuthenticateable,             "challah/concerns/user/authenticateable"
+  autoload :UserAuthorizable,                 "challah/concerns/user/authorizable"
+  autoload :UserFindable,                     "challah/concerns/user/findable"
+  autoload :UserPasswordable,                 "challah/concerns/user/passwordable"
+  autoload :UserProvideable,                  "challah/concerns/user/provideable"
+  autoload :UserValidateable,                 "challah/concerns/user/validateable"
 
   # Configuration options
-  class << self
-    # Get or set options for the current Challah instance. In most cases these should be
-    # changed within a config/initializers/ file in your app.
-    #
-    # @param [Hash] options The options to get or set
-    # @option options [String] :cookie_prefix ('challah') A prefix to put in the names of the cookies that will be set.
-    # @option options [String] :access_denied_view ('challah/sessions/access_denied')Relative path to the view that will be used to show access denied method.
-    # @option options [Class] :storage_class (SimpleCookieStore) The class to use for persistence of sessions.
-    # @option options [Boolean] :skip_routes (false) Pass in true to not add any routes into your Rails app by default.
-    # @option options [String] :email_validator ('challah/email') Pass in a string name of the class to use for email validation. Class should inherit from ActiveModel::EachValidator
-    # @option options [Class] :password_validator (Challah::PasswordValidator) Pass in a class to use for password validation.
-    def options
-      @options ||= {
-        access_denied_view:     'sessions/access_denied',
-        api_key_enabled:        false,
-        cookie_prefix:          'challah',
-        email_validator:        'challah/email',
-        password_validator:     PasswordValidator,
-        skip_routes:            false,
-        skip_user_validations:  false,
-        storage_class:          SimpleCookieStore,
-        user:                   :User
-      }
-    end
-
-    def user
-      @user ||= options[:user].to_s.safe_constantize
-    end
+  # Get or set options for the current Challah instance. In most cases these should be
+  # changed within a config/initializers/ file in your app.
+  #
+  # @param [Hash] options The options to get or set
+  # @option options [String] :cookie_prefix ("challah") A prefix to put in the names of the cookies that will be set.
+  # @option options [String] :access_denied_view ("challah/sessions/access_denied")Relative path to the view that will be used to show access denied method.
+  # @option options [Class] :storage_class (SimpleCookieStore) The class to use for persistence of sessions.
+  # @option options [Boolean] :skip_routes (false) Pass in true to not add any routes into your Rails app by default.
+  # @option options [String] :email_validator ("challah/email") Pass in a string name of the class to use for email validation. Class should inherit from ActiveModel::EachValidator
+  # @option options [Class] :password_validator (Challah::PasswordValidator) Pass in a class to use for password validation.
+  def self.options
+    @options ||= {
+      access_denied_view:     "sessions/access_denied",
+      api_key_enabled:        false,
+      cookie_prefix:          "challah",
+      email_validator:        "challah/email",
+      password_validator:     PasswordValidator,
+      skip_routes:            false,
+      skip_user_validations:  false,
+      storage_class:          SimpleCookieStore,
+      user:                   :User
+    }
+  end
+
+  def self.user
+    @user ||= options[:user].to_s.safe_constantize
   end
 
   # Set up techniques engines
@@ -83,4 +90,4 @@ module Challah
   register_provider :password, PasswordProvider
 end
 
-require 'challah/engine' if defined?(Rails)
+require "challah/engine" if defined?(Rails)

data/lib/challah/active_record_extensions.rb

@@ -0,0 +1,23 @@
+module Challah
+  # Included for backwards compatibility. These methods are deprecated
+  # and will be removed in future versions
+  module ActiveRecordExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+    end
+
+    module ClassMethods
+      def challah_authorization
+        ActiveSupport::Deprecation.warn("#{ self.to_s }.challah_authorization is deprecated and will be removed in future versions, use `include Challah::Authorizeable` instead")
+        self.send(:include, Challah::Authorizeable)
+      end
+
+      def challah_user
+        ActiveSupport::Deprecation.warn("#{ self.to_s }.challah_user is deprecated and will be removed in future versions, use `include Challah::Userable` instead")
+        self.send(:include, Challah::Userable)
+      end
+    end
+  end
+end

data/lib/challah/{authorization.rb → concerns/authorizeable.rb}

@@ -1,18 +1,14 @@
 module Challah
-  module Authorization
+  module Authorizeable
+    extend ActiveSupport::Concern
 
-    def challah_authorization
-      unless included_modules.include?(InstanceMethods)
-        include InstanceMethods
-        extend ClassMethods
-      end
+    included do
+      extend ClassMethods
     end
 
-    module InstanceMethods
-      def user
-        return nil unless self.user_id
-        @user ||= self.class.user_model.where(id: self.user_id).first
-      end
+    def user
+      return nil unless self.user_id
+      @user ||= self.class.user_model.where(id: self.user_id).first
     end
 
     module ClassMethods
@@ -59,15 +55,14 @@ module Challah
         record.save!
         record
       end
-    end
 
-    def users_table_name
-      @users_table_name ||= user_model.table_name
-    end
+      def users_table_name
+        @users_table_name ||= user_model.table_name
+      end
 
-    def user_model
-      @user_model ||= Challah.user
+      def user_model
+        @user_model ||= Challah.user
+      end
     end
-
   end
-end
+end

data/lib/challah/concerns/user/attributeable.rb

@@ -0,0 +1,73 @@
+module Challah
+  module UserAttributeable
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :password
+      attr_reader :password_confirmation
+      attr_reader :password_updated
+
+      before_save :ensure_user_tokens
+    end
+
+    # Returns true if this user is active, and should be able to log in. If
+    # the active column is false, the user will not be able to authenticate
+    def active?
+      !!self.active
+    end
+
+    # First name and last name together
+    def name
+      "#{ first_name } #{ last_name }".strip
+    end
+
+    # shortened name, just includes the first name and last initial
+    def small_name
+      "#{ first_name.to_s.titleize } #{ last_name.to_s.first.upcase }."
+    end
+
+    # Is this user valid and ready for a user session?
+    #
+    # Override this method if you need to check for a particular configuration on each page request.
+    def valid_session?
+      self.active?
+    end
+
+    protected
+
+    # Ensure that all system-generated columns aren't blank on each save
+    def ensure_user_tokens
+      ensure_api_key_presence
+      ensure_email_hash_presence
+      ensure_persistence_token_presence
+    end
+
+    # Store a random seed for this user's api key
+    def ensure_api_key_presence
+      if respond_to?("api_key=")
+        if self.api_key.to_s.blank?
+          self.api_key = Random.token(50)
+        end
+      end
+    end
+
+    # Store a hashed email if the column exists
+    def ensure_email_hash_presence
+      if respond_to?("email_hash=")
+        if email_changed?
+          self.email_hash = Encrypter.md5(email.to_s.downcase.strip)
+        end
+      end
+    end
+
+    # Store a random token to identify user in persisted objects
+    def ensure_persistence_token_presence
+      if respond_to?("persistence_token=")
+        if self.persistence_token.to_s.blank?
+          self.persistence_token = Random.token(125)
+        end
+      end
+    end
+
+  end
+end

data/lib/challah/{user/authentication.rb → concerns/user/authenticateable.rb}

@@ -1,5 +1,5 @@
-module Challah::User
-  module Authentication
+module Challah
+  module UserAuthenticateable
     # Generic authentication method. By default, this just checks to see if the password
     # given matches this user. You can also pass in the first parameter as the method
     # to use for a different type of authentication.

data/lib/challah/concerns/user/authorizable.rb

@@ -0,0 +1,32 @@
+module Challah
+  module UserAuthorizable
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+
+      before_destroy :clear_authorizations_before_destroy
+    end
+
+    protected
+
+    def authorizations
+      return [] if new_record?
+      self.class.authorization_model.where(user_id: self.id)
+    end
+
+    def clear_authorizations_before_destroy
+      authorizations.destroy_all
+    end
+
+    module ClassMethods
+      def authorizations_table_name
+        @authorizations_table_name ||= authorization_model.table_name
+      end
+
+      def authorization_model
+        @authorization_model ||= ::Authorization
+      end
+    end
+  end
+end

data/lib/challah/concerns/user/findable.rb

@@ -0,0 +1,45 @@
+module Challah
+  module UserFindable
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+    end
+
+    module ClassMethods
+      def active
+        where(active: true)
+      end
+
+      # Find a user instance by username first, or email address if needed.
+      # If no user is found matching, return nil
+      def find_for_session(username_or_email)
+        return nil if username_or_email.to_s.blank?
+
+        result = nil
+
+        if username_or_email.to_s.include?('@')
+          result = where(email: username_or_email).first
+        end
+
+        if !result
+          uid = username_or_email.to_s.downcase.strip
+
+          authorization = self.authorization_model
+          authorization = authorization.where(provider: :password, uid: uid)
+          authorization = authorization.first
+
+          if authorization
+            result = authorization.user
+          end
+        end
+
+        result
+      end
+
+      def inactive
+        where.not(active: true)
+      end
+    end
+  end
+end

data/lib/challah/{user/password.rb → concerns/user/passwordable.rb}

@@ -1,5 +1,5 @@
-module Challah::User
-  module Password
+module Challah
+  module UserPasswordable
     # Set the password and password_confirmation in one shortcut method.
     def password!(new_password)
       self.password = new_password

data/lib/challah/{user/providers.rb → concerns/user/provideable.rb}

@@ -1,9 +1,22 @@
-module Challah::User
-  module Providers
+module Challah
+  module UserProvideable
+    extend ActiveSupport::Concern
 
-    def authorizations
-      return [] if new_record?
-      self.class.authorization_model.where(user_id: self.id)
+    included do
+      after_save :update_modified_providers_after_save
+      after_save :clear_cached_providers_after_save
+    end
+
+    def method_missing(method, *args)
+      method_name = method.to_s
+
+      if method_name =~ /^([a-z]*)_provider\?$/
+        return provider?($1)
+      elsif method_name =~ /^([a-z]*)_provider$/
+        return provider($1)
+      end
+
+      super
     end
 
     def providers
@@ -60,6 +73,33 @@ module Challah::User
         false
       end
     end
-  end
 
+    protected
+
+    def clear_cached_providers_after_save
+      @providers = nil
+    end
+
+    # If password or username was changed, update the authorization record
+    def update_modified_providers_after_save
+      # Save password provider
+      if @password_updated or @username_updated
+        Challah.providers[:password].save(self)
+        @password_updated = false
+        @username_updated = false
+        @password = nil
+      end
+
+      # Save any other providers
+      Challah.custom_providers.each do |name, klass|
+        custom_provider_attributes = provider_attributes[name]
+
+        if custom_provider_attributes.respond_to?(:fetch)
+          if klass.valid?(self)
+            klass.save(self)
+          end
+        end
+      end
+    end
+  end
 end