challah 0.7.0.pre → 0.7.0.pre2

data/README.md

@@ -6,8 +6,6 @@ Challah (pronounced HAH-lah) is a simple Rails authentication gem that provides
 
 Challah doesn’t provide any fancy controllers or views that clutter your app or force you to display information a certain way. That part is up to you. The functionality within Challah is designed to be a starting point for users and sign-ins you can tweak the rest to your app’s needs.
 
-** Note: As of challah v0.7.0, roles and permissions are maintained in a separate gem as part of [challah-rolls](http://github.com/jdtornow/challah). **
-
 ## Requirements
 
 * Ruby 1.9.2+
@@ -49,9 +47,9 @@ Use the following task to create a new user:
 
 ## Models
 
-Challah provides the core `User` model for your app, and a database migration to go along with it. You can customize the model to your app's specific needs, just leave the `authable_user` line intact.
+Challah provides the core `User` model for your app, and a database migration to go along with it. You can customize the model to your app's specific needs, just leave the `challah_user` line intact.
 
-A user is anyone that needs to be able to authenticate (log in) to the application. Each user requires a first name, last name, email address, username, role and password.
+A user is anyone that needs to be able to authenticate (sign in) to the application. Each user requires a first name, last name, email address, username, and password.
 
 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.
 
@@ -59,11 +57,7 @@ By default a user is marked as “active” and is able to log in to your applic
 
 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.
 
-## Restricted access
-
-One of the main reasons to use a user- and permission-based system is to restrict access to certain portions of your application. Challah provides basic restriction methods for your controllers, views and directly from any User instance.
-
-### Checking for a current user
+## 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.
 
@@ -131,7 +125,7 @@ If necessary, the sessions controller which handles creating new sessions and si
 
 ## Full documentation
 
-Documentation is available at: [http://rubydoc.info/gems/challah](http://rubydoc.info/gems/challah/frames)
+Documentation is available at: [http://rubydoc.info/gems/challah](http://rubydoc.info/gems/challah)
 
 ## Example App
 

data/app/models/user.rb

@@ -5,7 +5,7 @@ class User < ActiveRecord::Base
   # For a list of all methods included into User, see:
   #
   # http://rubydoc.info/gems/challah
-  authable_user
+  challah_user
 
   # Uncomment the following line to add additional attributes to protect using the
   # User#update_account_attributes(params) methods

data/lib/challah/railtie.rb

@@ -38,7 +38,7 @@ module Challah
         if defined?(ActiveRecord)
           Challah.options[:logger] = ActiveRecord::Base.logger
 
-          ActiveRecord::Base.send(:extend, Challah::AuthableUser)
+          ActiveRecord::Base.send(:extend, Challah::User)
           ActiveRecord::Base.send(:include, Challah::Audit)
         end
       end

data/lib/challah/session.rb

@@ -47,7 +47,7 @@ module Challah
       persistence_token, user_id = self.store.read
       return false if persistence_token.nil? or user_id.nil?
 
-      store_user = ::User.find_by_id(user_id)
+      store_user = Challah.user_model.find_by_id(user_id)
 
       if store_user and store_user.active? and store_user.persistence_token == persistence_token
         if store_user.valid_session?
@@ -103,7 +103,7 @@ 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)
+        user_record = Challah.user_model === user_or_user_id ? user_or_user_id : Challah.user_model.find_by_id(user_or_user_id)
 
         session = Session.new(request, params)
 

data/lib/challah/techniques/api_key_technique.rb

@@ -11,7 +11,7 @@ module Challah
       return nil unless Challah.options[:api_key_enabled]
 
       unless @key.to_s.blank?
-        user = ::User.find_by_api_key(@key)
+        user = Challah.user_model.find_by_api_key(@key)
 
         if user and user.active?
           return user

data/lib/challah/techniques/password_technique.rb

@@ -10,7 +10,7 @@ module Challah
     # if we can successfully authenticate, return a User instance, otherwise nil
     def authenticate
       if username? and password?
-        user = ::User.find_for_session(username)
+        user = Challah.user_model.find_for_session(username)
 
         if user
           if user.active?

data/lib/challah/{authable/user.rb → user.rb}

@@ -1,11 +1,14 @@
 module Challah
-  module AuthableUser
-    def authable_user
+  module User
+    def challah_user
       unless included_modules.include?(InstanceMethods)
         include InstanceMethods
         extend ClassMethods
       end
 
+      # Set the reference to the model name for challah_user
+      Challah.user_model = self
+
       class_eval do
         cattr_accessor :protected_attributes
 
@@ -87,7 +90,7 @@ module Challah
       end
     end
 
-    # Instance methods to be included once authable_user is set up.
+    # Instance methods to be included once challah_user is set up.
     module InstanceMethods
       # 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
@@ -216,7 +219,7 @@ module Challah
         # For backwards compatibilty, this column may not always exist, so just ignore
         # this if the column doesn't exist.
         def check_email_hash
-          if User.column_names.include?("email_hash")
+          if self.class.column_names.include?("email_hash")
             if email_changed?
               require 'digest/md5'
               self.email_hash = Digest::MD5.hexdigest(self.email.to_s.downcase.strip)

data/lib/challah/version.rb

@@ -1,3 +1,3 @@
 module Challah
-  VERSION = "0.7.0.pre" unless defined?(::Challah::VERSION)
+  VERSION = "0.7.0.pre2" unless defined?(::Challah::VERSION)
 end

data/lib/challah.rb

@@ -3,8 +3,6 @@ require 'challah/version'
 module Challah
   autoload :Audit,                            'challah/audit'
 
-  autoload :AuthableUser,                     'challah/authable/user'
-
   autoload :CookieStore,                      'challah/cookie_store'
   autoload :SimpleCookieStore,                'challah/simple_cookie_store'
 
@@ -14,8 +12,12 @@ module Challah
   autoload :Session,                          'challah/session'
   autoload :Techniques,                       'challah/techniques'
 
+  autoload :User,                             'challah/user'
+
   # Configuration options
   class << self
+    attr_accessor :user_model
+
     # Get or set options for the current Challah instance. In most cases these should be
     # changed within a config/initializers/ file in your app.
     #

data/lib/tasks/crud.rake

@@ -6,7 +6,7 @@ namespace :challah do
     task :create => :environment do
       check_for_tables
 
-      first_user = User.count == 0
+      first_user = ::User.count == 0
 
       banner('Creating a user')
 
@@ -40,7 +40,7 @@ namespace :challah do
         end
       end
 
-      user = User.new({
+      user = ::User.new({
         :first_name => first_name,
         :last_name => last_name,
         :email => email,
@@ -77,7 +77,7 @@ def check_for_roles
 end
 
 def check_for_tables
-  unless User.table_exists?
+  unless ::User.table_exists?
     puts "Oops, you need to run `rake challah:setup` before you create a user. The users table is required."
     exit 1
   end

data/test/session_test.rb

@@ -100,7 +100,7 @@ class SessionTest < ActiveSupport::TestCase
     should "validate with a password" do
       user = create(:user, :username => 'test-user')
 
-      User.stubs(:find_for_session).returns(user)
+      ::User.stubs(:find_for_session).returns(user)
 
       session = Session.new
       session.ip = '127.0.0.1'
@@ -116,7 +116,7 @@ class SessionTest < ActiveSupport::TestCase
       assert_equal true, session.persist?
       assert_equal true, session.save
 
-      User.unstub(:find_for_session)
+      ::User.unstub(:find_for_session)
     end
 
     should "validate with an api key" do
@@ -124,7 +124,7 @@ class SessionTest < ActiveSupport::TestCase
 
       user = create(:user, :api_key => '123456abcdefg')
 
-      User.stubs(:find_for_session).returns(user)
+      ::User.stubs(:find_for_session).returns(user)
 
       session = Session.new
       session.ip = '127.0.0.1'
@@ -139,7 +139,7 @@ class SessionTest < ActiveSupport::TestCase
       assert_equal false, session.persist?
       assert_equal false, session.save
 
-      User.unstub(:find_for_session)
+      ::User.unstub(:find_for_session)
 
       Challah.options[:api_key_enabled] = false
     end
@@ -147,7 +147,7 @@ class SessionTest < ActiveSupport::TestCase
     should "reject if password is incorrect" do
       user = create(:user, :username => 'test-user')
 
-      User.stubs(:find_for_session).returns(user)
+      ::User.stubs(:find_for_session).returns(user)
 
       session = Session.new
       session.username = 'test-user'
@@ -158,7 +158,7 @@ class SessionTest < ActiveSupport::TestCase
       assert_equal false, session.valid?
       assert_equal nil, session.user
 
-      User.unstub(:find_for_session)
+      ::User.unstub(:find_for_session)
     end
 
     should "have a default_path attribute" do

data/test/user_test.rb

@@ -20,20 +20,20 @@ class UserTest < ActiveSupport::TestCase
       user_one = create(:user, :username => 'test-user', :email => 'tester@example.com')
       user_two = create(:user, :username => 'test-user-2', :email => 'tester2@example.com')
 
-      assert_equal user_one, User.find_for_session('test-user')
-      assert_equal user_one, User.find_for_session('tester@example.com')
+      assert_equal user_one, ::User.find_for_session('test-user')
+      assert_equal user_one, ::User.find_for_session('tester@example.com')
 
-      assert_equal user_two, User.find_for_session('test-user-2')
-      assert_equal user_two, User.find_for_session('tester2@example.com')
+      assert_equal user_two, ::User.find_for_session('test-user-2')
+      assert_equal user_two, ::User.find_for_session('tester2@example.com')
 
-      assert_equal nil, User.find_for_session(' ')
-      assert_equal nil, User.find_for_session('not-existing')
+      assert_equal nil, ::User.find_for_session(' ')
+      assert_equal nil, ::User.find_for_session('not-existing')
     end
 
     should "have protected attributes" do
-      assert Array === User.protected_attributes
+      assert Array === ::User.protected_attributes
 
-      assert_difference 'User.protected_attributes.size', 1 do
+      assert_difference '::User.protected_attributes.size', 1 do
         User.protect_attributes(:blah)
       end
     end
@@ -41,7 +41,7 @@ class UserTest < ActiveSupport::TestCase
 
   context "A user instance" do
     should "have a name attribute that returns the full name" do
-      user = User.new
+      user = ::User.new
 
       user.stubs(:first_name).returns('Cal')
       user.stubs(:last_name).returns('Ripken')
@@ -51,12 +51,12 @@ class UserTest < ActiveSupport::TestCase
     end
 
     should "have a default_path where this user will be sent upon login" do
-      user = User.new
+      user = ::User.new
       assert_equal '/', user.default_path
     end
 
     should "have an active? user flag" do
-      user = User.new
+      user = ::User.new
 
       user.active = true
       assert_equal true, user.active

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: challah
 version: !ruby/object:Gem::Version
-  version: 0.7.0.pre
+  version: 0.7.0.pre2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-02 00:00:00.000000000Z
+date: 2012-08-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70218459155120 !ruby/object:Gem::Requirement
+  requirement: &70303020485460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70218459155120
+  version_requirements: *70303020485460
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70218459154600 !ruby/object:Gem::Requirement
+  requirement: &70303020484760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70218459154600
+  version_requirements: *70303020484760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70218459154040 !ruby/object:Gem::Requirement
+  requirement: &70303020483920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *70218459154040
+  version_requirements: *70303020483920
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
-  requirement: &70218459153580 !ruby/object:Gem::Requirement
+  requirement: &70303020483340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70218459153580
+  version_requirements: *70303020483340
 description: A simple Rails engine gem for authentication, authorization, users, roles
   and permissions.
 email:
@@ -84,7 +84,6 @@ files:
 - test/simple_cookie_store_test.rb
 - test/user_test.rb
 - lib/challah/audit.rb
-- lib/challah/authable/user.rb
 - lib/challah/controller.rb
 - lib/challah/cookie_store.rb
 - lib/challah/encrypter.rb
@@ -97,6 +96,7 @@ files:
 - lib/challah/techniques/password_technique.rb
 - lib/challah/techniques.rb
 - lib/challah/test.rb
+- lib/challah/user.rb
 - lib/challah/version.rb
 - lib/challah.rb
 - lib/tasks/crud.rake