wulffeld_authlogic 2.1.3

data/lib/authlogic/test_case.rb

@@ -0,0 +1,120 @@
+require File.dirname(__FILE__) + "/test_case/rails_request_adapter"
+require File.dirname(__FILE__) + "/test_case/mock_cookie_jar"
+require File.dirname(__FILE__) + "/test_case/mock_controller"
+require File.dirname(__FILE__) + "/test_case/mock_logger"
+require File.dirname(__FILE__) + "/test_case/mock_request"
+
+module Authlogic
+  # This module is a collection of methods and classes that help you easily test Authlogic. In fact,
+  # I use these same tools to test the internals of Authlogic.
+  #
+  # === The quick and dirty
+  #
+  #   require "authlogic/test_case" # include at the top of test_helper.rb
+  #   setup :activate_authlogic # run before tests are executed
+  #   UserSession.create(users(:whomever)) # logs a user in
+  #
+  # For a more detailed explanation, see below.
+  #
+  # === Setting up
+  #
+  # Authlogic comes with some simple testing tools. To get these, you need to first require Authlogic's TestCase. If
+  # you are doing this in a rails app, you would require this file at the top of your test_helper.rb file:
+  #
+  #   require "authlogic/test_case"
+  #
+  # If you are using Test::Unit::TestCase, the standard testing library that comes with ruby, then you can skip this next part.
+  # If you are not, you need to include the Authlogic::TestCase into your testing suite as follows:
+  #
+  #   include Authlogic::TestCase
+  #
+  # Now that everything is ready to go, let's move onto actually testing. Here is the basic idea behind testing:
+  #
+  # Authlogic requires a "connection" to your controller to activate it. In the same manner that ActiveRecord requires a connection to
+  # your database. It can't do anything until it gets connnected. That being said, Authlogic will raise an
+  # Authlogic::Session::Activation::NotActivatedError any time you try to instantiate an object without a "connection".
+  # So before you do anything with Authlogic, you need to activate / connect Authlogic. Let's walk through how to do this in tests:
+  #
+  # === Fixtures / Factories
+  #
+  # Creating users via fixtures / factories is easy. Here's an example of a fixture:
+  #
+  #   ben:
+  #     email: whatever@whatever.com
+  #     password_salt: <%= salt = Authlogic::Random.hex_token %>
+  #     crypted_password: <%= Authlogic::CryptoProviders::Sha512.encrypt("benrocks" + salt) %>
+  #     persistence_token: <%= Authlogic::Random.hex_token %>
+  #     single_access_token: <%= Authlogic::Random.friendly_token %>
+  #     perishable_token: <%= Authlogic::Random.friendly_token %>
+  #
+  # Notice the crypted_password value. Just supplement that with whatever crypto provider you are using, if you are not using the default.
+  #
+  # === Functional tests
+  #
+  # Activating Authlogic isn't a problem here, because making a request will activate Authlogic for you. The problem is
+  # logging users in so they can access restricted areas. Solving this is simple, just do this:
+  #
+  #   setup :activate_authlogic
+  #
+  # For those of you unfamiliar with TestUnit, the setup method bascially just executes a method before any test is ran.
+  # It is essentially "setting up" your tests.
+  #
+  # Once you have done this, just log users in like usual:
+  #
+  #   UserSession.create(users(:whomever))
+  #   # access my restricted area here
+  #
+  # Do this before you make your request and it will act as if that user is logged in.
+  #
+  # === Integration tests
+  #
+  # Again, just like functional tests, you don't have to do anything. As soon as you make a request, Authlogic will be
+  # conntected. If you want to activate Authlogic before making a request follow the same steps described in the
+  # "functional tests" section above. It works in the same manner.
+  #
+  # === Unit tests
+  #
+  # The only time you need to do any trickiness here is if you want to test Authlogic models. Maybe you added some custom
+  # code or methods in your Authlogic models. Maybe you are writing a plugin or a library that extends Authlogic.
+  #
+  # That being said, in this environment there is no controller. So you need to use a "mock" controller. Something
+  # that looks like a controller, acts like a controller, but isn't a "real" controller. You are essentially connecting
+  # Authlogic to your "mock" controller, then you can test off of the mock controller to make sure everything is functioning
+  # properly.
+  # 
+  # I use a mock controller to test Authlogic myself. It's part of the Authlogic library that you can easily use. It's as simple
+  # as functional and integration tests. Just do the following:
+  #
+  #   setup :activate_authlogic
+  #
+  # You also get a controller method that you can test off of. For example:
+  #
+  #   ben = users(:ben)
+  #   assert_nil controller.session["user_credentials"]
+  #   assert UserSession.create(ben)
+  #   assert_equal controller.session["user_credentials"], ben.persistence_token
+  #
+  # See how I am checking that Authlogic is interacting with the controller properly? That's the idea here.
+  module TestCase
+    # Activates authlogic so that you can use it in your tests. You should call this method in your test's setup. Ex:
+    #
+    #   setup :activate_authlogic
+    def activate_authlogic
+      if @request && ! @request.respond_to?(:params)
+        class <<@request
+          alias_method :params, :parameters
+        end
+      end
+
+      Authlogic::Session::Base.controller = (@request && Authlogic::TestCase::RailsRequestAdapter.new(@request)) || controller
+    end
+    
+    # The Authlogic::TestCase::MockController object passed to Authlogic to activate it. You can access this in your test.
+    # See the module description for an example.
+    def controller
+      @controller ||= Authlogic::TestCase::MockController.new
+    end
+  end
+  
+  ::Test::Unit::TestCase.send(:include, TestCase) if defined?(::Test::Unit::TestCase)
+end

data/lib/authlogic/test_case/mock_controller.rb

@@ -0,0 +1,45 @@
+module Authlogic
+  module TestCase
+    # Basically acts like a controller but doesn't do anything. Authlogic can interact with this, do it's thing and then you
+    # can look at the controller object to see if anything changed.
+    class MockController < ControllerAdapters::AbstractAdapter
+      attr_accessor :http_user, :http_password
+      attr_writer :request_content_type
+  
+      def initialize
+      end
+  
+      def authenticate_with_http_basic(&block)
+        yield http_user, http_password
+      end
+  
+      def cookies
+        @cookies ||= MockCookieJar.new
+      end
+  
+      def cookie_domain
+        nil
+      end
+      
+      def logger
+        @logger ||= MockLogger.new
+      end
+  
+      def params
+        @params ||= {}
+      end
+  
+      def request
+        @request ||= MockRequest.new(controller)
+      end
+  
+      def request_content_type
+        @request_content_type ||= "text/html"
+      end
+  
+      def session
+        @session ||= {}
+      end
+    end
+  end
+end

data/lib/authlogic/test_case/mock_cookie_jar.rb

@@ -0,0 +1,14 @@
+module Authlogic
+  module TestCase
+    class MockCookieJar < Hash # :nodoc:
+      def [](key)
+        hash = super
+        hash && hash[:value]
+      end
+  
+      def delete(key, options = {})
+        super(key)
+      end
+    end
+  end
+end

data/lib/authlogic/test_case/mock_logger.rb

@@ -0,0 +1,10 @@
+module Authlogic
+  module TestCase
+    # Simple class to replace real loggers, so that we can raise any errors being logged.
+    class MockLogger
+      def error(message)
+        raise message
+      end
+    end
+  end
+end

data/lib/authlogic/test_case/mock_request.rb

@@ -0,0 +1,19 @@
+module Authlogic
+  module TestCase
+    class MockRequest # :nodoc:
+      attr_accessor :controller
+      
+      def initialize(controller)
+        self.controller = controller
+      end
+      
+      def remote_ip
+        (controller && controller.respond_to?(:env) && controller.env.is_a?(Hash) && controller.env['REMOTE_ADDR']) || "1.1.1.1"
+      end
+      
+      private
+        def method_missing(*args, &block)
+        end
+    end
+  end
+end

data/lib/authlogic/test_case/rails_request_adapter.rb

@@ -0,0 +1,30 @@
+module Authlogic
+  module TestCase
+    # Adapts authlogic to work with the @request object when testing. This way Authlogic can set cookies and what not before
+    # a request is made, ultimately letting you log in users in functional tests.
+    class RailsRequestAdapter < ControllerAdapters::AbstractAdapter
+      def authenticate_with_http_basic(&block)
+      end
+      
+      def cookies
+        new_cookies = MockCookieJar.new
+        super.each do |key, value|
+          new_cookies[key] = value[:value]
+        end
+        new_cookies
+      end
+      
+      def cookie_domain
+        nil
+      end
+      
+      def request
+        @request ||= MockRequest.new(controller)
+      end
+      
+      def request_content_type
+        request.format.to_s
+      end
+    end
+  end
+end

data/lib/generators/authlogic/session/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Creates a session model for use with Authlogic
+
+Usage:
+  rails generate authlogic:session NAME

data/lib/generators/authlogic/session/session_generator.rb

@@ -0,0 +1,14 @@
+module Authlogic
+  class SessionGenerator < Rails::Generators::NamedBase
+    desc "Description:\n  Creates a session model for use with Authlogic"
+
+    def self.source_root
+      @_auth_source ||= File.expand_path("../templates", __FILE__)
+    end
+
+    def copy_initializer
+      class_collisions class_name
+      template 'session.rb', File.join('app/models', class_path, "#{file_name}.rb")
+    end
+  end
+end

data/lib/generators/authlogic/session/templates/session.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < Authlogic::Session::Base
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "authlogic"

data/shoulda_macros/authlogic.rb

@@ -0,0 +1,69 @@
+# Test::Unit
+# Place this file into your test/shoulda_macros directory
+#
+# Example:
+# 
+# class UserTest
+#   should_have_authlogic
+# end
+#
+# Rspec
+# Place this file into your spec/support/shoulda directory
+#
+# Example:
+#
+# describe User do
+#   it { should have_authlogic }
+# end
+
+module Authlogic
+  module Shoulda
+
+    module Matchers
+      def have_authlogic
+        HaveAuthlogic.new
+      end
+      alias_method :be_authentic, :have_authlogic
+
+      class HaveAuthlogic
+
+        def matches?(subject)
+          subject.respond_to?(:password=) && subject.respond_to?(:valid_password?)
+        end
+
+        def failure_message
+          "Add the line 'acts_as_authentic' to your model"
+        end
+
+        def description
+          "have Authlogic"
+        end
+      end
+      
+    end
+    
+    module Macros
+      include Matchers
+      
+      def should_have_authlogic
+        klass = described_type rescue model_class
+        matcher = HaveAuthlogic.new
+        
+        should matcher.description do
+          assert matcher.matches?(klass.new), matcher.failure_message
+        end
+      end
+      alias_method :should_be_authentic, :should_have_authlogic
+      
+    end
+    
+  end
+end
+
+if defined? Spec
+  Spec::Runner.configure do |config|
+    config.include(Authlogic::Shoulda::Matchers)
+  end
+else
+  Test::Unit::TestCase.class_eval { extend Authlogic::Shoulda::Macros }
+end

data/test/acts_as_authentic_test/base_test.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+module ActsAsAuthenticTest
+  class BaseTest < ActiveSupport::TestCase
+    def test_acts_as_authentic
+      assert_nothing_raised do
+        User.acts_as_authentic do
+        end
+      end
+    end
+    
+    def test_acts_as_authentic_with_old_config
+      assert_raise(ArgumentError) do
+        User.acts_as_authentic({})
+      end
+    end
+  end
+end

data/test/acts_as_authentic_test/email_test.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+module ActsAsAuthenticTest
+  class EmailTest < ActiveSupport::TestCase
+    def test_email_field_config
+      assert_equal :email, User.email_field
+      assert_equal :email, Employee.email_field
+      
+      User.email_field = :nope
+      assert_equal :nope, User.email_field
+      User.email_field :email
+      assert_equal :email, User.email_field
+    end
+    
+    def test_validate_email_field_config
+      assert User.validate_email_field
+      assert Employee.validate_email_field
+      
+      User.validate_email_field = false
+      assert !User.validate_email_field
+      User.validate_email_field true
+      assert User.validate_email_field
+    end
+    
+    def test_validates_length_of_email_field_options_config
+      assert_equal({:within => 6..100}, User.validates_length_of_email_field_options)
+      assert_equal({:within => 6..100}, Employee.validates_length_of_email_field_options)
+      
+      User.validates_length_of_email_field_options = {:yes => "no"}
+      assert_equal({:yes => "no"}, User.validates_length_of_email_field_options)
+      User.validates_length_of_email_field_options({:within => 6..100})
+      assert_equal({:within => 6..100}, User.validates_length_of_email_field_options)
+    end
+    
+    def test_validates_format_of_email_field_options_config
+      default = {:with => Authlogic::Regex.email, :message => I18n.t('error_messages.email_invalid', :default => "should look like an email address.")}
+      assert_equal default, User.validates_format_of_email_field_options
+      assert_equal default, Employee.validates_format_of_email_field_options
+      
+      User.validates_format_of_email_field_options = {:yes => "no"}
+      assert_equal({:yes => "no"}, User.validates_format_of_email_field_options)
+      User.validates_format_of_email_field_options default
+      assert_equal default, User.validates_format_of_email_field_options
+    end
+    
+    def test_validates_uniqueness_of_email_field_options_config
+      default = {:case_sensitive => false, :scope => Employee.validations_scope, :if => "#{Employee.email_field}_changed?".to_sym}
+      assert_equal default, Employee.validates_uniqueness_of_email_field_options
+      
+      Employee.validates_uniqueness_of_email_field_options = {:yes => "no"}
+      assert_equal({:yes => "no"}, Employee.validates_uniqueness_of_email_field_options)
+      Employee.validates_uniqueness_of_email_field_options default
+      assert_equal default, Employee.validates_uniqueness_of_email_field_options
+    end
+    
+    def test_validates_length_of_email_field
+      u = User.new
+      u.email = "a@a.a"
+      assert !u.valid?
+      assert u.errors[:email].size > 0
+      
+      u.email = "a@a.com"
+      assert !u.valid?
+      assert u.errors[:email].size == 0
+    end
+    
+    def test_validates_format_of_email_field
+      u = User.new
+      u.email = "aaaaaaaaaaaaa"
+      u.valid?
+      assert u.errors[:email].size > 0 
+      
+      u.email = "a@a.com"
+      u.valid?
+      assert u.errors[:email].size == 0
+      
+      u.email = "dakota.dux+1@gmail.com"
+      u.valid?
+      assert u.errors[:email].size == 0
+    end
+    
+    def test_validates_uniqueness_of_email_field
+      u = User.new
+      u.email = "bjohnson@binarylogic.com"
+      assert !u.valid?
+      assert u.errors[:email].size > 0
+      
+      u.email = "BJOHNSON@binarylogic.com"
+      assert !u.valid?
+      assert u.errors[:email].size > 0
+      
+      u.email = "a@a.com"
+      assert !u.valid?
+      assert u.errors[:email].size == 0
+    end
+  end
+end