lperichon-devise_invitable 0.3.0

data/test/model_tests_helper.rb

@@ -0,0 +1,41 @@
+class ActiveSupport::TestCase
+  def setup_mailer
+    ActionMailer::Base.deliveries = []
+  end
+
+  def store_translations(locale, translations, &block)
+    begin
+      I18n.backend.store_translations locale, translations
+      yield
+    ensure
+      I18n.reload!
+    end
+  end
+
+  # Helpers for creating new users
+  #
+  def generate_unique_email
+    @@email_count ||= 0
+    @@email_count += 1
+    "test#{@@email_count}@email.com"
+  end
+
+  def valid_attributes(attributes={})
+    { :email => generate_unique_email,
+      :password => '123456',
+      :password_confirmation => '123456' }.update(attributes)
+  end
+
+  def new_user(attributes={})
+    User.new(valid_attributes(attributes))
+  end
+
+  def create_user_with_invitation(invitation_token, attributes={})
+    user = new_user({:password => nil, :password_confirmation => nil}.update(attributes))
+    user.skip_confirmation!
+    user.invitation_token = invitation_token
+    user.invitation_sent_at = Time.now.utc
+    user.save(false)
+    user
+  end
+end

data/test/models/invitable_test.rb

@@ -0,0 +1,172 @@
+require 'test/test_helper'
+require 'test/model_tests_helper'
+
+class InvitableTest < ActiveSupport::TestCase
+
+  def setup
+    setup_mailer
+  end
+
+  test 'should not generate invitation token after creating a record' do
+    assert_nil new_user.invitation_token
+  end
+
+  test 'should regenerate invitation token each time' do
+    user = new_user
+    3.times do
+      token = user.invitation_token
+      user.resend_invitation!
+      assert_not_equal token, user.invitation_token
+    end
+  end
+
+  test 'should test invitation sent at with invite_for configuration value' do
+    user = create_user_with_invitation('')
+    
+    User.stubs(:invite_for).returns(nil)
+    user.invitation_sent_at = Time.now.utc
+    assert user.valid_invitation?
+
+    User.stubs(:invite_for).returns(nil)
+    user.invitation_sent_at = 1.year.ago
+    assert user.valid_invitation?
+
+    User.stubs(:invite_for).returns(0)
+    user.invitation_sent_at = Time.now.utc
+    assert user.valid_invitation?
+
+    User.stubs(:invite_for).returns(0)
+    user.invitation_sent_at = 1.day.ago
+    assert user.valid_invitation?
+
+    User.stubs(:invite_for).returns(1.day)
+    user.invitation_sent_at = Time.now.utc
+    assert user.valid_invitation?
+
+    User.stubs(:invite_for).returns(1.day)
+    user.invitation_sent_at = 1.day.ago
+    assert_not user.valid_invitation?
+  end
+
+  test 'should never generate the same invitation token for different users' do
+    invitation_tokens = []
+    3.times do
+      user = new_user
+      user.resend_invitation!
+      token = user.invitation_token
+      assert !invitation_tokens.include?(token)
+      invitation_tokens << token
+    end
+  end
+
+  test 'should set password and password confirmation from params' do
+    create_user_with_invitation('valid_token', :password => nil, :password_confirmation => nil)
+    user = User.accept_invitation!(:invitation_token => 'valid_token', :password => '123456789', :password_confirmation => '123456789')
+    assert user.valid_password?('123456789')
+  end
+
+  test 'should set password and save the record' do
+    user = create_user_with_invitation('valid_token', :password => nil, :password_confirmation => nil)
+    old_encrypted_password = user.encrypted_password
+    user = User.accept_invitation!(:invitation_token => 'valid_token', :password => '123456789', :password_confirmation => '123456789')
+    assert_not_equal old_encrypted_password, user.encrypted_password
+  end
+
+  test 'should clear invitation token while setting the password' do
+    user = new_user
+    user.skip_confirmation!
+    user.update_attribute(:invitation_token, 'valid_token')
+    assert_present user.invitation_token
+    assert user.accept_invitation!
+    assert_nil user.invitation_token
+  end
+
+  test 'should not clear invitation token if record is invalid' do
+    user = new_user
+    user.skip_confirmation!
+    user.update_attribute(:invitation_token, 'valid_token')
+    assert_present user.invitation_token
+    User.any_instance.stubs(:valid?).returns(false)
+    User.accept_invitation!(:invitation_token => 'valid_token', :password => '123456789', :password_confirmation => '987654321')
+    user.reload
+    assert_present user.invitation_token
+  end
+
+  test 'should reset invitation token and send invitation by email' do
+    user = new_user
+    assert_difference('ActionMailer::Base.deliveries.size') do
+      token = user.invitation_token
+      user.resend_invitation!
+      assert_not_equal token, user.invitation_token
+    end
+  end
+
+  test 'should return a record with invitation token and no errors to send invitation by email' do
+    invited_user = User.send_invitation(:email => "valid@email.com")
+    assert invited_user.errors.blank?
+    assert_present invited_user.invitation_token
+  end
+
+  test 'should return a record with errors if user was found by e-mail' do
+    user = create_user_with_invitation('')
+    user.update_attribute(:invitation_token, nil)
+    invited_user = User.send_invitation(:email => user.email)
+    assert_equal invited_user, user
+    assert_equal 'has already been taken', invited_user.errors[:email]
+  end
+
+  test 'should return a new record with errors if e-mail is blank' do
+    invited_user = User.send_invitation(:email => '')
+    assert invited_user.new_record?
+    assert_equal ["can't be blank", "is invalid"], invited_user.errors[:email]
+  end
+
+  test 'should return a new record with errors if e-mail is invalid' do
+    invited_user = User.send_invitation(:email => 'invalid_email')
+    assert invited_user.new_record?
+    assert_equal "is invalid", invited_user.errors[:email]
+  end
+
+  test 'should find a user to set his password based on invitation_token' do
+    user = new_user
+    user.resend_invitation!
+
+    invited_user = User.accept_invitation!(:invitation_token => user.invitation_token)
+    assert_equal invited_user, user
+  end
+
+  test 'should return a new record with errors if no invitation_token is found' do
+    invited_user = User.accept_invitation!(:invitation_token => 'invalid_token')
+    assert invited_user.new_record?
+    assert_equal 'is invalid', invited_user.errors[:invitation_token]
+  end
+
+  test 'should return a new record with errors if invitation_token is blank' do
+    invited_user = User.accept_invitation!(:invitation_token => '')
+    assert invited_user.new_record?
+    assert_equal "can't be blank", invited_user.errors[:invitation_token]
+  end
+
+  test 'should return record with errors if invitation_token has expired' do
+    user = create_user_with_invitation('valid_token')
+    user.update_attribute(:invitation_sent_at, 1.day.ago)
+    User.stubs(:invite_for).returns(10.hours)
+    invited_user = User.accept_invitation!(:invitation_token => 'valid_token')
+    assert_equal user, invited_user
+    assert_equal "is invalid", invited_user.errors[:invitation_token]
+  end
+
+  test 'should set successfully user password given the new password and confirmation' do
+    user = new_user(:password => nil, :password_confirmation => nil)
+    user.resend_invitation!
+
+    invited_user = User.accept_invitation!(
+      :invitation_token => user.invitation_token,
+      :password => 'new_password',
+      :password_confirmation => 'new_password'
+    )
+    user.reload
+
+    assert user.valid_password?('new_password')
+  end
+end

data/test/models_test.rb

@@ -0,0 +1,35 @@
+require 'test/test_helper'
+
+class Invitable < User
+  devise :database_authenticatable, :invitable, :invite_for => 5.days
+end
+
+class ActiveRecordTest < ActiveSupport::TestCase
+  def include_module?(klass, mod)
+    klass.devise_modules.include?(mod) &&
+    klass.included_modules.include?(Devise::Models::const_get(mod.to_s.classify))
+  end
+
+  def assert_include_modules(klass, *modules)
+    modules.each do |mod|
+      assert include_module?(klass, mod), "#{klass} not include #{mod}"
+    end
+
+    (Devise::ALL - modules).each do |mod|
+      assert_not include_module?(klass, mod), "#{klass} include #{mod}"
+    end
+  end
+
+  test 'add invitable module only' do
+    assert_include_modules Invitable, :database_authenticatable, :invitable
+  end
+
+  test 'set a default value for invite_for' do
+    assert_equal 5.days, Invitable.invite_for
+  end
+
+  test 'invitable attributes' do
+    assert_not_nil Invitable.columns_hash['invitation_token']
+    assert_not_nil Invitable.columns_hash['invitation_sent_at']
+  end
+end

data/test/rails_app/app/controllers/admins_controller.rb

@@ -0,0 +1,6 @@
+class AdminsController < ApplicationController
+  before_filter :authenticate_admin!
+
+  def index
+  end
+end

data/test/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  filter_parameter_logging :password
+end

data/test/rails_app/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/test/rails_app/app/controllers/users_controller.rb

@@ -0,0 +1,12 @@
+class UsersController < ApplicationController
+  before_filter :authenticate_user!
+
+  def index
+    user_session[:cart] = "Cart"
+  end
+
+  def expire
+    user_session['last_request_at'] = 31.minutes.ago.utc
+    render :text => 'User will be expired on next request'
+  end
+end

data/test/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test/rails_app/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  devise :database_authenticatable, :confirmable, :recoverable, :rememberable, :validatable
+  attr_accessible :username, :email, :password, :password_confirmation
+end

data/test/rails_app/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/rails_app/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/rails_app/config/environment.rb

@@ -0,0 +1,44 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '~> 2.3.4' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+#  config.gem 'devise'
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+  #config.plugin_paths += %W( #{RAILS_ROOT}/../../.. )
+  #config.plugins = [:devise_invitable]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :en
+end