challah 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de60f1578f04cfcff49e06a36dacdf94601198bd
-  data.tar.gz: c733d09838206401b8328635a7ecbea2f09ebc44
+  metadata.gz: 423eb79c0c05bec91678bfa15b4d441ba864486c
+  data.tar.gz: 6832a5c3fad39811589b9132017bff60ee77d032
 SHA512:
-  metadata.gz: d430ba2a8af1d847de71b1ce169e691bb9d8c7602dd99708d8db83f296b9b651637ae071a938e251a158a2d4462610d151dde4a8a195ceebb93303e73fed21c6
-  data.tar.gz: 0928d0c628b46a3e569650a931a92a713bb558da79d0c9595158440bbfb68504992eeda7637cc6726b5518579f939036ee384a583f0070ed15840e12dda06935
+  metadata.gz: f4c6300e497cb4a56885519a316bd3c18b32dc97d2d105da152746b69a61404ed8f2001e32388d886bc5c06bd199a4f1310e863fa59a93dcb8a2722038ce0273
+  data.tar.gz: a678b9d6df924c9a6feb687ffe0cb0cf1d3f6559712a39194a4313d5d6ff8df70777570f399e0a53b14256c664b4009e86c03f4a179b3ac90e23466e653aa739

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Challah 1.1.0
+
+* Allow challah to authenticate with User and Authorization tables that using namespaces
+* Multiple accounts can be signed in at once using multiple user tables
+
 ## Challah 1.0.0
 
 * Ruby 2.0 compatibility

data/README.md

@@ -10,7 +10,7 @@ Challah doesn’t provide any fancy controllers or views that clutter your app o
 
 * Ruby 1.9.3+
 * Bundler
-* Rails 3.1+
+* Rails 4.0+
 
 ## Installation
 
@@ -53,10 +53,6 @@ A user is anyone that needs to be able to authenticate (sign in) to the applicat
 
 By default a user is marked as “active” and is able to log in to your application. If the active status column is toggled to false, then this user is no longer able to log in. The active status column can be used as a soft-delete function for users.
 
-### Permissions and Roles
-
-As of version 0.7.0 of Challah, permissions and roles have been moved to their own gem in [Challah Rolls](https://github.com/jdtornow/challah-rolls). Add this gem to your project to get additional functionality for permissions and role based restrictions.
-
 ## Checking for a current user
 
 The basic way to restrict functionality within your app is to require that someone authenticate (log in) before they can see it. From within your controllers and views you can call the `current_user?` method to determine if someone has authenticated. This method doesn’t care about who the user is, or what it has access to, just that it has successfully authenticated and is a valid user.

data/app/controllers/sessions_controller.rb

@@ -29,13 +29,14 @@ class SessionsController < ApplicationController
   end
 
   protected
-    def destroy_session
-      current_user_session.destroy
-    end
 
-    def return_to_path(default_path = '/')
-      result = session[:return_to]
-      result = nil if result and result == "http://#{request.domain}/"
-      result || default_path
-    end
+  def destroy_session
+    current_user_session.destroy
+  end
+
+  def return_to_path(default_path = '/')
+    result = session[:return_to]
+    result = nil if result and result == "http://#{request.domain}/"
+    result || default_path
+  end
 end

data/lib/challah/authorization.rb

@@ -1,5 +1,6 @@
 module Challah
   module Authorization
+
     def challah_authorization
       unless included_modules.include?(InstanceMethods)
         include InstanceMethods
@@ -10,13 +11,14 @@ module Challah
     module InstanceMethods
       def user
         return nil unless self.user_id
-        @user ||= ::User.where(id: self.user_id).first
+        @user ||= self.class.user_model.where(id: self.user_id).first
       end
     end
 
     module ClassMethods
       def hashable_attributes
-        @hashable_attributes ||= self.columns.map(&:name) - %w( user_id provider last_session_at last_session_ip session_count created_at updated_at )
+        protected_attributes = %w( user_id provider last_session_at last_session_ip session_count created_at updated_at )
+        @hashable_attributes ||= self.columns.map(&:name) - protected_attributes
       end
 
       # Remove an authorization
@@ -58,5 +60,14 @@ module Challah
         record
       end
     end
+
+    def users_table_name
+      @users_table_name ||= user_model.table_name
+    end
+
+    def user_model
+      @user_model ||= Challah.user
+    end
+
   end
 end

data/lib/challah/controller.rb

@@ -77,7 +77,7 @@ module Challah
         #
         # @return [Session] The current browser session.
         def current_user_session
-          @current_user_session ||= Challah::Session.find(request, params)
+          @current_user_session ||= Challah::Session.find(request, params, user_model)
         end
 
         # Restrict a controller to only authenticated users. If someone tries to access
@@ -110,6 +110,10 @@ module Challah
           end
         end
         alias_method :login_required, :signin_required
+
+        def user_model
+          @_user_model ||= Challah.user
+        end
     end
   end
 end

data/lib/challah/{railtie.rb → engine.rb}

@@ -1,7 +1,9 @@
+require 'abstract_controller/rendering'
+
 module Challah
-  require 'abstract_controller/rendering'
 
-  class Engine < Rails::Engine
+  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')))
     end
@@ -59,4 +61,5 @@ module Challah
       end
     end
   end
+
 end

data/lib/challah/plugins.rb

@@ -43,11 +43,11 @@ module Challah
   def self.include_user_plugins!
     Challah.plugins.values.each do |plugin|
       plugin.user_extensions.each do |mod|
-        ::User.send(:extend, mod)
+        Challah.user.send(:extend, mod)
       end
 
       plugin.user_init_methods.each do |method_name|
-        ::User.send(method_name)
+        Challah.user.send(method_name)
       end
     end
   end

data/lib/challah/providers/password_provider.rb

@@ -1,16 +1,17 @@
 module Challah
   class PasswordProvider
     def self.save(user)
-      set(uid: user.username, token: user.password, user_id: user.id)
+      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, '')
+      user_id     = options.fetch(:user_id)
+      uid         = options.fetch(:uid, '')
+      token       = options.fetch(:token, '')
+      auth_model  = options.fetch(:authorization, ::Authorization)
 
       if token.to_s.blank?
-        authorization = ::Authorization.get({
+        authorization = auth_model.get({
           user_id:  user_id,
           provider: :password
         })
@@ -22,7 +23,7 @@ module Challah
         token = Challah::Encrypter.encrypt(token)
       end
 
-      ::Authorization.set({
+      auth_model.set({
         provider: :password,
         user_id:  user_id,
         uid:      uid,

data/lib/challah/session.rb

@@ -4,11 +4,12 @@ module Challah
     include ActiveModel::Conversion
 
     attr_accessor :return_to, :ip, :user, :store, :persist
-    attr_reader :params, :request
+    attr_reader :params, :request, :user_model
 
-    def initialize(request = nil, params = {})
+    def initialize(request = nil, params = {}, user_model = nil)
       @request = request
       @params = params || {}
+      @user_model = user_model || Challah.user
       @store = Challah.options[:storage_class].new(self)
     end
 
@@ -42,7 +43,7 @@ module Challah
       persistence_token, user_id = self.store.read
       return false if persistence_token.nil? or user_id.nil?
 
-      store_user = ::User.unscoped.where(id: user_id).first
+      store_user = user_model.unscoped.where(id: user_id).first
 
       if store_user and store_user.active? and store_user.persistence_token == persistence_token
         if store_user.valid_session?
@@ -97,10 +98,12 @@ module Challah
 
     class << self
       # Manually create a new Session
-      def create(user_or_user_id, request = nil, params = nil)
-        user_record = ::User === user_or_user_id ? user_or_user_id : ::User.find_by_id(user_or_user_id)
+      def create(user_or_user_id, request = nil, params = nil, user_model = nil)
+        user_model = Challah.user if user_model.nil?
 
-        session = Session.new(request, params)
+        user_record = user_model === user_or_user_id ? user_or_user_id : user_model.find_by_id(user_or_user_id)
+
+        session = Session.new(request, params, user_model)
 
         if user_record and user_record.active?
           session.user = user_record
@@ -111,8 +114,8 @@ module Challah
       end
 
       # Manually create a session, and save it.
-      def create!(user_or_user_id, request = nil, params = nil)
-        session = create(user_or_user_id, request, params)
+      def create!(user_or_user_id, request = nil, params = nil, user_model = nil)
+        session = create(user_or_user_id, request, params, user_model)
         session.save
         session
       end
@@ -138,6 +141,8 @@ module Challah
       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
 
           if @user

data/lib/challah/signup.rb

@@ -7,7 +7,7 @@ module Challah
     attr_accessor :provider, :user
 
     def initialize(attributes = {})
-      self.user = ::User.new
+      self.user = Challah.user.new
       self.provider = :password
       self.attributes = attributes
       @errors = []

data/lib/challah/simple_cookie_store.rb

@@ -41,6 +41,10 @@ module Challah
         request.cookie_jar
       end
 
+      def default_cookie_prefix
+        Challah.options[:cookie_prefix]
+      end
+
       def domain
         request.session_options[:domain]
       end
@@ -70,7 +74,7 @@ module Challah
       end
 
       def prefix
-        @prefix ||= Challah.options[:cookie_prefix]
+        @prefix ||= [ default_cookie_prefix, user_model_id ].compact.join('-')
       end
 
       def request
@@ -90,6 +94,12 @@ module Challah
         "#@token#{joiner}#@user_id"
       end
 
+      def user_model_id
+        if @session && @session.user_model && @session.user_model.table_name != 'users'
+          Encrypter.md5(@session.user_model.table_name).slice(0..5)
+        end
+      end
+
       def validation_cookie
         cookies[validation_cookie_name]
       end

data/lib/challah/techniques/api_key_technique.rb

@@ -1,8 +1,11 @@
 module Challah
   # Allows authentication with an api_key URL parameter.
   class ApiKeyTechnique
+
+    attr_accessor :user_model
+
     def initialize(session)
-      @key = session.key? ? session.key : nil
+      @key        = session.key? ? session.key : nil
     end
 
     def authenticate
@@ -11,7 +14,7 @@ module Challah
       return nil unless Challah.options[:api_key_enabled]
 
       unless @key.to_s.blank?
-        user = ::User.find_by_api_key(@key)
+        user = user_model.find_by_api_key(@key)
 
         if user and user.active?
           return user
@@ -24,5 +27,10 @@ module Challah
     def persist?
       false
     end
+
+    def user_model
+      @user_model ||= Challah.user
+    end
+
   end
 end

data/lib/challah/techniques/password_technique.rb

@@ -1,16 +1,20 @@
 module Challah
+
   # Allows authentication by username and password.
   class PasswordTechnique
+
+    attr_accessor :user_model
+
     # grab the params we want from this request
     def initialize(session)
-      @username = session.username? ? session.username : nil
-      @password = session.password? ? session.password : nil
+      @username   = session.username? ? session.username : nil
+      @password   = session.password? ? session.password : nil
     end
 
     # if we can successfully authenticate, return a User instance, otherwise nil
     def authenticate
       if username? and password?
-        user = ::User.find_for_session(username)
+        user = user_model.find_for_session(username)
 
         if user
           if user.active?
@@ -35,6 +39,10 @@ module Challah
       true
     end
 
+    def user_model
+      @user_model ||= Challah.user
+    end
+
     def username?
       !!@username
     end
@@ -43,4 +51,5 @@ module Challah
       @username
     end
   end
+
 end

data/lib/challah/user/attributes.rb

@@ -1,4 +1,5 @@
 module Challah::User
+
   module Attributes
     # 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
@@ -23,4 +24,5 @@ module Challah::User
       self.active?
     end
   end
+
 end

data/lib/challah/user/finders.rb

@@ -1,4 +1,5 @@
 module Challah::User
+
   module Finders
     # Find a user instance by username first, or email address if needed.
     # If no user is found matching, return nil
@@ -12,7 +13,11 @@ module Challah::User
       end
 
       if !result
-        authorization = ::Authorization.where(provider: :password, uid: username_or_email.to_s.downcase.strip).first
+        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
@@ -22,4 +27,5 @@ module Challah::User
       result
     end
   end
+
 end

data/lib/challah/user/providers.rb

@@ -1,8 +1,9 @@
 module Challah::User
   module Providers
+
     def authorizations
       return [] if new_record?
-      ::Authorization.where(user_id: self.id)
+      self.class.authorization_model.where(user_id: self.id)
     end
 
     def providers
@@ -10,7 +11,7 @@ module Challah::User
 
       @providers = {}
 
-      attributes = ::Authorization.hashable_attributes
+      attributes = self.class.authorization_model.hashable_attributes
 
       # Grab providers from existing authorization records
       @providers = authorizations.inject({}) do |hash, m|
@@ -60,4 +61,5 @@ module Challah::User
       end
     end
   end
+
 end

data/lib/challah/user/reflector.rb

@@ -0,0 +1,15 @@
+module Challah::User
+
+  module Reflector
+
+    def authorizations_table_name
+      @authorizations_table_name ||= authorization_model.table_name
+    end
+
+    def authorization_model
+      @authorization_model ||= ::Authorization
+    end
+
+  end
+
+end

data/lib/challah/user.rb

@@ -1,8 +1,9 @@
 require 'challah/user/attributes'
 require 'challah/user/authentication'
 require 'challah/user/finders'
-require 'challah/user/providers'
 require 'challah/user/password'
+require 'challah/user/providers'
+require 'challah/user/reflector'
 
 module Challah
   module User
@@ -14,6 +15,7 @@ module Challah
         include Providers
         include Password
         extend Finders
+        extend Reflector
       end
 
       email_validation_hash = {

data/lib/challah/version.rb

@@ -1,3 +1,3 @@
 module Challah
-  VERSION = "1.0.0" unless defined?(::Challah::VERSION)
+  VERSION = "1.1.0" unless defined?(::Challah::VERSION)
 end

data/lib/challah.rb

@@ -46,9 +46,14 @@ module Challah
         password_validator:     PasswordValidator,
         skip_routes:            false,
         skip_user_validations:  false,
-        storage_class:          SimpleCookieStore
+        storage_class:          SimpleCookieStore,
+        user:                   :User
       }
     end
+
+    def user
+      @user ||= options[:user].to_s.safe_constantize
+    end
   end
 
   # Set up techniques engines
@@ -78,4 +83,4 @@ module Challah
   register_provider :password, PasswordProvider
 end
 
-require 'challah/railtie' if defined?(Rails)
+require 'challah/engine' if defined?(Rails)

data/lib/tasks/setup.rake

@@ -28,8 +28,7 @@ namespace :challah do
   namespace :setup do
     task :migrations do
       puts "Copying migrations..."
-      ENV['FROM'] = 'challah_engine'
-      Rake::Task['railties:install:migrations'].invoke
+      Rake::Task['challah_engine:install:migrations'].invoke
     end
 
     task :seeds => :environment do

data/test/authorization_test.rb

@@ -10,6 +10,11 @@ class AuthorizationTest < ActiveSupport::TestCase
       assert_equal expected_columns, Authorization.hashable_attributes.sort
     end
 
+    should "have a reference to the users model" do
+      assert_equal User, Authorization.user_model
+      assert_equal 'users', Authorization.users_table_name
+    end
+
   end
 
 end

data/test/session_test.rb

@@ -3,6 +3,18 @@ require 'helper'
 class SessionTest < ActiveSupport::TestCase
   include Challah
 
+  class FakeUserModel
+
+    def id
+      999
+    end
+
+    def active?
+      true
+    end
+
+  end
+
   context "An Challah::Session class" do
     should "have an inspected view" do
       user = create(:user)
@@ -50,6 +62,16 @@ class SessionTest < ActiveSupport::TestCase
       assert_equal false, session_three.valid?
       assert_equal nil, session_three.user
     end
+
+    should "accept a user model" do
+      user = create(:user)
+      session = Session.create(user, {}, {}, ::User)
+      assert_equal ::User, session.user_model
+
+      user = FakeUserModel.new
+      session = Session.create(user, {}, {}, FakeUserModel)
+      assert_equal FakeUserModel, session.user_model
+    end
   end
 
   context "A Challah::Session instance" do

data/test/simple_cookie_store_test.rb

@@ -3,6 +3,14 @@ require 'helper'
 class SimpleCookieStoreTest < ActiveSupport::TestCase
   include Challah
 
+  class FakeUserModel
+
+    def self.table_name
+      'fake_user_peoples'
+    end
+
+  end
+
   context "The SimpleCookieStore class" do
     setup do
       @user = create(:user)
@@ -26,6 +34,23 @@ class SimpleCookieStoreTest < ActiveSupport::TestCase
       assert_equal "test.dev", @request.cookies['challah-v'][:domain]
     end
 
+    should "save session in a namespaced cookie store for non user tables" do
+      assert_equal [], @request.cookies.keys
+
+      session = Session.new(@request, {}, FakeUserModel)
+      session.store = SimpleCookieStore.new(session)
+      session.persist = true
+      session.user = @user
+      session.save
+
+      assert_equal %w( challah-d635fd-s challah-d635fd-v ), @request.cookies.keys.sort
+      assert_equal "#{@user.persistence_token}@#{@user.id}", @request.cookies['challah-d635fd-s'][:value]
+      assert_equal "test.dev", @request.cookies['challah-d635fd-s'][:domain]
+
+      assert_equal Encrypter.md5("#{@user.persistence_token}@#{@user.id}"), @request.cookies['challah-d635fd-v'][:value]
+      assert_equal "test.dev", @request.cookies['challah-d635fd-v'][:domain]
+    end
+
     should "be able to inspect the store" do
       session = Session.new(@request)
       session.store = SimpleCookieStore.new(session)

data/test/user_test.rb

@@ -14,6 +14,7 @@ class UserTest < ActiveSupport::TestCase
   end
 
   context "A User class" do
+
     should "find a user by username or email" do
       user_one = build(:user, :username => ' Test-user ', :email => 'tester@example.com')
       user_two = build(:user, :username => 'test-user-2  ', :email => 'tester2@example.com')
@@ -36,6 +37,12 @@ class UserTest < ActiveSupport::TestCase
       assert_equal nil, ::User.find_for_session(' ')
       assert_equal nil, ::User.find_for_session('not-existing')
     end
+
+    should "have a reference to the authorizations model" do
+      assert_equal Authorization, User.authorization_model
+      assert_equal 'authorizations', User.authorizations_table_name
+    end
+
   end
 
   context "A user instance" do