challah 1.5.0 → 2.0.0.beta2

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

@@ -1,12 +1,13 @@
 module Challah
   module UserStatusable
+
     extend ActiveSupport::Concern
 
     included do
       begin
         if columns.map(&:name).include?("status")
           additional_statuses = Array(Challah.options[:additional_statuses])
-          enum status: [:active, :inactive, *additional_statuses]
+          enum status: [ :active, :inactive, *additional_statuses ].map(&:to_sym)
         end
       rescue ActiveRecord::StatementInvalid => exception
         raise exception unless exception.message =~ /could not find table/i ||
@@ -14,26 +15,6 @@ module Challah
       end
     end
 
-    # Fallback to pre-enum active column (pre challah 1.4)
-    def active=(enabled)
-      if self.class.columns.map(&:name).include?("status")
-        self.status = (!!enabled ? :active : :inactive)
-      else
-        write_attribute(:active, !!enabled)
-      end
-    end
-
-    def active?
-      # enum-based status
-      if self.class.columns.map(&:name).include?("status")
-        read_attribute(:status).to_s == "active"
-
-      # support for non-enum status column (pre challah 1.4)
-      else
-        !!read_attribute(:active)
-      end
-    end
-
     def active
       active?
     end
@@ -41,5 +22,6 @@ module Challah
     def valid_session?
       active?
     end
+
   end
 end

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

@@ -1,5 +1,6 @@
 module Challah
   module UserValidateable
+
     extend ActiveSupport::Concern
 
     included do
@@ -17,5 +18,6 @@ module Challah
 
       validates_with Challah.options[:password_validator], force: false
     end
+
   end
-end
+end

data/lib/challah/concerns/userable.rb

@@ -1,5 +1,6 @@
 module Challah
   module Userable
+
     extend ActiveSupport::Concern
 
     include UserAttributeable
@@ -14,8 +15,5 @@ module Challah
       include UserValidateable
     end
 
-    included do
-      Challah.include_user_plugins!
-    end
   end
 end

data/lib/challah/controller.rb

@@ -2,6 +2,7 @@ module Challah
   # These methods are added into ActionController::Base and are available in all
   # of your app's controllers.
   module Controller
+
     extend ActiveSupport::Concern
 
     included do
@@ -9,6 +10,7 @@ module Challah
     end
 
     module ClassMethods
+
       # Restrict the current controller to only users that have authenticated. All actions
       # in the controller will be restricted unless otherwise stated. All normal options
       # for a before_action are observed.
@@ -39,80 +41,82 @@ module Challah
         restrict_to_authenticated(*args)
       end
       alias_method :login_required, :signin_required
+
     end
 
     protected
 
-    # Is there currently a logged in user? Returns true if it is safe to use
-    # the {#current_user current_user} method.
-    #
-    # @note This method is also available as a helper in your views.
-    #
-    # @see #current_user current_user
-    #
-    # @return [Boolean] Is there a user logged in?
-    def current_user?
-      !!current_user
-    end
+      # Is there currently a logged in user? Returns true if it is safe to use
+      # the {#current_user current_user} method.
+      #
+      # @note This method is also available as a helper in your views.
+      #
+      # @see #current_user current_user
+      #
+      # @return [Boolean] Is there a user logged in?
+      def current_user?
+        !!current_user
+      end
 
-    # Alias for current_user?
-    def signed_in?
-      current_user?
-    end
-    alias_method :logged_in?, :signed_in?
+      # Alias for current_user?
+      def signed_in?
+        current_user?
+      end
+      alias_method :logged_in?, :signed_in?
 
-    # The user that is currently logged into this session. If there is no
-    # user logged in, nil will be returned.
-    #
-    # @note This method is also available as a helper in your views.
-    #
-    # @return [User, nil] The current authenticated user.
-    def current_user
-      @current_user ||= current_user_session.user
-    end
+      # The user that is currently logged into this session. If there is no
+      # user logged in, nil will be returned.
+      #
+      # @note This method is also available as a helper in your views.
+      #
+      # @return [User, nil] The current authenticated user.
+      def current_user
+        @current_user ||= current_user_session.user
+      end
 
-    # The current authentication session, if one exists. A {Session} object will be
-    # returned regardless of its valid status. If an invalid session is returned, the
-    # {Session#user user} attribute will be nil.
-    #
-    # @return [Session] The current browser session.
-    def current_user_session
-      @current_user_session ||= Challah::Session.find(request, params, user_model)
-    end
+      # The current authentication session, if one exists. A {Session} object will be
+      # returned regardless of its valid status. If an invalid session is returned, the
+      # {Session#user user} attribute will be nil.
+      #
+      # @return [Session] The current browser session.
+      def current_user_session
+        @current_user_session ||= Challah::Session.find(request, params, user_model)
+      end
 
-    # Restrict a controller to only authenticated users. If someone tries to access
-    # a restricted action and is not logged in, they will be redirected to the
-    # login page.
-    #
-    # This method is an alias for:
-    #
-    #   restrict_to_authenticated
-    #
-    # @example
-    #   class YourController < ApplicationController
-    #     before_action :login_required
-    #
-    #     # ...
-    #   end
-    #
-    # @example Specifing certain actions.
-    #   class YourOtherController < ApplicationController
-    #     before_action :login_required, :only => [ :create, :update, :destroy ]
-    #
-    #     # ...
-    #   end
-    #
-    # @see Controller::ClassMethods#restrict_to_authenticated restrict_to_authenticated
-    def signin_required
-      unless signed_in?
-        session[:return_to] = request.url
-        redirect_to signin_path and return
+      # Restrict a controller to only authenticated users. If someone tries to access
+      # a restricted action and is not logged in, they will be redirected to the
+      # login page.
+      #
+      # This method is an alias for:
+      #
+      #   restrict_to_authenticated
+      #
+      # @example
+      #   class YourController < ApplicationController
+      #     before_action :login_required
+      #
+      #     # ...
+      #   end
+      #
+      # @example Specifing certain actions.
+      #   class YourOtherController < ApplicationController
+      #     before_action :login_required, :only => [ :create, :update, :destroy ]
+      #
+      #     # ...
+      #   end
+      #
+      # @see Controller::ClassMethods#restrict_to_authenticated restrict_to_authenticated
+      def signin_required
+        unless signed_in?
+          session[:return_to] = request.url
+          redirect_to(signin_path) && (return)
+        end
+      end
+      alias_method :login_required, :signin_required
+
+      def user_model
+        @_challah_user_model ||= Challah.user
       end
-    end
-    alias_method :login_required, :signin_required
 
-    def user_model
-      @_challah_user_model ||= Challah.user
-    end
   end
 end

data/lib/challah/cookie_store.rb

@@ -9,15 +9,17 @@ module Challah
   # a new class that responds to +read+, +save+ and +destroy+
   #
   class CookieStore < SimpleCookieStore
+
     def inspect
-      "#<CookieStore:0x#{object_id.to_s(16)} valid=#{existing?}>"
+      "#<CookieStore:0x#{ object_id.to_s(16) } valid=#{ existing? }>"
     end
 
     protected
 
-    def validation_cookie_value(value = nil)
-      value = session_cookie_value unless value
-      Encrypter.md5(value, request.user_agent, request.remote_ip)
-    end
+      def validation_cookie_value(value = nil)
+        value = session_cookie_value unless value
+        Encrypter.md5(value, request.user_agent, request.remote_ip)
+      end
+
   end
 end

data/lib/challah/encrypter.rb

@@ -1,9 +1,10 @@
-require 'digest/sha2'
-require 'bcrypt'
+require "digest/sha2"
+require "bcrypt"
 
 module Challah
   # Handles all encryption, hashing and comparison necessary for tokens and passwords.
   class Encrypter
+
     attr_accessor :cost, :joiner
 
     # The number of times to hash the given password.
@@ -54,5 +55,6 @@ module Challah
     def self.md5(*args)
       new().md5(*args)
     end
+
   end
 end

data/lib/challah/engine.rb

@@ -1,17 +1,17 @@
 module Challah
   class Engine < ::Rails::Engine
 
-    initializer 'challah.router' do |app|
-      app.routes_reloader.paths.insert(0, File.expand_path(File.join(File.dirname(__FILE__), 'routes.rb')))
+    initializer "challah.router" do |app|
+      app.routes_reloader.paths.insert(0, File.expand_path(File.join(File.dirname(__FILE__), "routes.rb")))
     end
 
-    initializer 'challah.active_record' do
+    initializer "challah.active_record" do
       ActiveSupport.on_load :active_record do
         Challah::Engine.setup_active_record!
       end
     end
 
-    initializer 'challah.action_controller' do
+    initializer "challah.action_controller" do
       ActiveSupport.on_load :action_controller do
         Challah::Engine.setup_action_controller!
       end
@@ -33,13 +33,6 @@ module Challah
         if defined?(ActionController::API)
           ActionController::API.send(:include, Challah::Controller)
         end
-
-        # Load any ActionController/Challah plugins
-        Challah.plugins.values.each do |plugin|
-          plugin.action_controller.each do |proc|
-            proc.call
-          end
-        end
       end
     end
 
@@ -49,14 +42,8 @@ module Challah
         Challah.options[:logger] = ActiveRecord::Base.logger
 
         ActiveRecord::Base.send(:include, Challah::Audit)
-
-        # Load any ActiveRecord/Challah plugins
-        Challah.plugins.values.each do |plugin|
-          plugin.active_record.each do |proc|
-            proc.call
-          end
-        end
       end
     end
+
   end
 end

data/lib/challah/providers/password_provider.rb

@@ -1,20 +1,21 @@
 module Challah
   class PasswordProvider
+
     def self.save(user)
       set(uid: user.username, token: user.password, user_id: user.id, authorization: user.class.authorization_model)
     end
 
     def self.set(options = {})
       user_id     = options.fetch(:user_id)
-      uid         = options.fetch(:uid, '')
-      token       = options.fetch(:token, '')
+      uid         = options.fetch(:uid, "")
+      token       = options.fetch(:token, "")
       auth_model  = options.fetch(:authorization, ::Authorization)
 
       if token.to_s.blank?
-        authorization = auth_model.get({
+        authorization = auth_model.get(
           user_id:  user_id,
           provider: :password
-        })
+        )
 
         if authorization
           token = authorization.token
@@ -23,12 +24,12 @@ module Challah
         token = Challah::Encrypter.encrypt(token)
       end
 
-      auth_model.set({
+      auth_model.set(
         provider: :password,
         user_id:  user_id,
         uid:      uid,
         token:    token
-      })
+      )
     end
 
     def self.valid?(record)
@@ -36,5 +37,6 @@ module Challah
       password_validator.new(force: true).validate(record)
       record.errors[:password].size.zero?
     end
+
   end
-end
+end

data/lib/challah/providers.rb

@@ -1,5 +1,6 @@
 module Challah
   module Providers
+
     # Get a list of all authorization providers other than password provider
     def custom_providers
       providers.reject { |k, v| k == :password }
@@ -18,5 +19,6 @@ module Challah
     def providers
       @providers.dup
     end
+
   end
-end
+end

data/lib/challah/random.rb

@@ -2,17 +2,19 @@ module Challah
   # Random string class, uses ActiveSupport's SecureRandom if possible, otherwise gives a fairly
   # secure random string
   class Random
+
     # Returns a random string for use as a token at the given length.
     def self.token(length = 30)
-      return SecureRandom.hex(length/2) if secure_random?
+      return SecureRandom.hex(length / 2) if secure_random?
 
-      c = [(0..9),('a'..'z'),('A'..'Z')].map {|i| i.to_a }.flatten
-      (1..length).map{ c[rand(c.length)] }.join
+      c = [(0..9), ("a".."z"), ("A".."Z")].map { |i| i.to_a }.flatten
+      (1..length).map { c[rand(c.length)] }.join
     end
 
     # Is ActiveSupport::SecureRandom available. If so, we'll use it.
     def self.secure_random?
       defined?(::SecureRandom)
     end
+
   end
-end
+end

data/lib/challah/routes.rb

@@ -1,11 +1,11 @@
 Rails.application.routes.draw do
   unless Challah.options[:skip_routes]
-    post '/sign-in',    to: 'sessions#create',    as: 'authenticate'
-    get '/sign-in',     to: 'sessions#new',       as: 'signin'
-    get '/sign-out',    to: 'sessions#destroy',   as: 'signout'
+    post "/sign-in",    to: "sessions#create",    as: "authenticate"
+    get "/sign-in",     to: "sessions#new",       as: "signin"
+    get "/sign-out",    to: "sessions#destroy",   as: "signout"
 
-    post '/login',      to: 'sessions#create',    as: 'submit_login'
-    get '/login',       to: 'sessions#new',       as: 'login'
-    get '/logout',      to: 'sessions#destroy',   as: 'logout'
+    post "/login",      to: "sessions#create",    as: "submit_login"
+    get "/login",       to: "sessions#new",       as: "login"
+    get "/logout",      to: "sessions#destroy",   as: "logout"
   end
 end

data/lib/challah/session.rb

@@ -1,5 +1,6 @@
 module Challah
   class Session
+
     extend ActiveModel::Naming
     include ActiveModel::Conversion
 
@@ -34,7 +35,7 @@ module Challah
     end
 
     def inspect
-      "#<Session:0x#{object_id.to_s(16)} valid=#{valid?} store=#{self.store.inspect} user=#{user_id || 'nil'}>"
+      "#<Session:0x#{ object_id.to_s(16) } valid=#{ valid? } store=#{ self.store.inspect } user=#{ user_id || 'nil' }>"
     end
 
     def persist?
@@ -43,7 +44,7 @@ module Challah
 
     def read
       persistence_token, user_id = self.store.read
-      return false if persistence_token.nil? or user_id.nil?
+      return false if persistence_token.nil? || user_id.nil?
 
       store_user = nil
 
@@ -53,7 +54,7 @@ module Challah
         nil
       end
 
-      if store_user and store_user.valid_session? and store_user.persistence_token == persistence_token
+      if store_user && store_user.valid_session? && (store_user.persistence_token == persistence_token)
         if store_user.valid_session?
           self.user = store_user
           @valid = true
@@ -66,7 +67,7 @@ module Challah
     def save
       return false unless valid?
 
-      if self.user and persist?
+      if self.user && persist?
         self.store.save(self.user.persistence_token, user_id)
         return true
       end
@@ -90,7 +91,7 @@ module Challah
     # Returns true if this session has been authenticated and is ready to save.
     def valid?
       return @valid if @valid != nil
-      return true if self.user and self.user.valid_session?
+      return true if self.user && self.user.valid_session?
       authenticate!
     end
 
@@ -126,7 +127,7 @@ module Challah
         end
       end
 
-      if user_record and user_record.valid_session?
+      if user_record && user_record.valid_session?
         session.user = user_record
         session.persist = true
       end
@@ -157,32 +158,33 @@ module Challah
 
     protected
 
-    # Try and authenticate against the various auth techniques. If one
-    # technique works, then just exit and make the session active.
-    def authenticate!
-      Challah.techniques.values.each do |klass|
-        technique = klass.new(self)
-        technique.user_model = user_model if technique.respond_to?(:"user_model=")
+      # Try and authenticate against the various auth techniques. If one
+      # technique works, then just exit and make the session active.
+      def authenticate!
+        Challah.techniques.values.each do |klass|
+          technique = klass.new(self)
+          technique.user_model = user_model if technique.respond_to?(:"user_model=")
 
-        @user = technique.authenticate
+          @user = technique.authenticate
 
-        if @user
-          @persist = technique.respond_to?(:persist?) ? technique.persist? : false
-          break
+          if @user
+            @persist = technique.respond_to?(:persist?) ? technique.persist? : false
+            break
+          end
         end
-      end
 
-      if @user
-        # Only update user record if persistence is on for the technique.
-        # Otherwise this builds up quick (one session for each API call)
-        if @persist
-          @user.successful_authentication!(ip)
+        if @user
+          # Only update user record if persistence is on for the technique.
+          # Otherwise this builds up quick (one session for each API call)
+          if @persist
+            @user.successful_authentication!(ip)
+          end
+
+          return @valid = true
         end
 
-        return @valid = true
+        @valid = false
       end
 
-      @valid = false
-    end
   end
 end

data/lib/challah/signup.rb

@@ -1,5 +1,6 @@
 module Challah
   class Signup
+
     extend ActiveModel::Naming
     include ActiveModel::Conversion
 
@@ -17,7 +18,7 @@ module Challah
       return unless Hash === value
 
       value.each do |key, value|
-        self.send("#{key}=", value)
+        self.send("#{ key }=", value)
       end
     end
 
@@ -60,7 +61,7 @@ module Challah
         user.errors.each { |a, e| @errors.add(a, e) }
       end
 
-      if !provider or !valid_provider?
+      if !provider || !valid_provider?
         result = false
         user.errors.each { |a, e| @errors.add(a, e) unless @errors.added?(a, e) }
       end
@@ -71,5 +72,6 @@ module Challah
     def self.model_name
       ActiveModel::Name.new(Challah::Signup, Challah, "Signup")
     end
+
   end
-end
+end