sorcery 0.1.4 → 0.3.0

data/spec/sinatra/spec/controller_session_timeout_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Sinatra::Application do
+  
+  # ----------------- SESSION TIMEOUT -----------------------
+  describe Sinatra::Application, "with session timeout features" do
+    before(:all) do
+      sorcery_reload!([:session_timeout])
+      sorcery_controller_property_set(:session_timeout,0.5)
+      create_new_user
+    end
+    
+    it "should not reset session before session timeout" do
+      session[:user_id] = User.first.id
+      get "/test_should_be_logged_in"
+      last_response.should be_ok
+    end
+    
+    it "should reset session after session timeout" do
+      get "/test_login", :username => 'gizmo', :password => 'secret'
+      session[:user_id].should_not be_nil
+      sleep 0.6
+      get "/test_should_be_logged_in"
+      last_response.should be_a_redirect
+    end
+    
+    it "with 'session_timeout_from_last_action' should not logout if there was activity" do
+      session[:user_id] = nil
+      sorcery_controller_property_set(:session_timeout,2)
+      sorcery_controller_property_set(:session_timeout_from_last_action, true)
+      get "/test_login", :username => 'gizmo', :password => 'secret'
+      sleep 1
+      get "/test_should_be_logged_in"
+      session[:user_id].should_not be_nil
+      sleep 1
+      get "/test_should_be_logged_in"
+      session[:user_id].should_not be_nil
+      last_response.should be_ok
+    end
+    
+    it "with 'session_timeout_from_last_action' should logout if there was no activity" do
+      sorcery_controller_property_set(:session_timeout,0.5)
+      sorcery_controller_property_set(:session_timeout_from_last_action, true)
+      get "/test_login", :username => 'gizmo', :password => 'secret'
+      sleep 0.6
+      get "/test_should_be_logged_in"
+      session[:user_id].should be_nil
+      last_response.should be_a_redirect
+    end
+    
+  end
+end

data/spec/sinatra/spec/controller_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Sinatra::Application do
+ 
+  # ----------------- PLUGIN CONFIGURATION -----------------------
+  describe "plugin configuration" do
+    before(:all) do
+      sorcery_reload!
+    end
+    
+    after(:each) do
+      Sorcery::Controller::Config.reset!
+      sorcery_reload!
+    end
+    
+    it "should enable configuration option 'user_class'" do
+      sorcery_controller_property_set(:user_class, TestUser)
+      Sorcery::Controller::Config.user_class.should equal(TestUser)
+    end
+    
+    it "should enable configuration option 'not_authenticated_action'" do
+      sorcery_controller_property_set(:not_authenticated_action, :my_action)
+      Sorcery::Controller::Config.not_authenticated_action.should equal(:my_action)
+    end
+    
+  end
+
+  # ----------------- PLUGIN ACTIVATED -----------------------
+  describe Sinatra::Application, "when activated with sorcery" do
+    
+    before(:all) do
+      User.delete_all
+      create_new_user
+    end
+  
+    after(:each) do
+      Sorcery::Controller::Config.reset!
+      sorcery_controller_property_set(:user_class, User)
+    end
+    
+    it "should respond to the instance method login" do
+      get_sinatra_app(subject).should respond_to(:login)
+    end
+      
+    it "should respond to the instance method logout" do
+      get_sinatra_app(subject).should respond_to(:logout)
+    end
+      
+    it "should respond to the instance method logged_in?" do
+      get_sinatra_app(subject).should respond_to(:logged_in?)
+    end
+    
+    it "should respond to the instance method current_user" do
+      get_sinatra_app(subject).should respond_to(:current_user)
+    end
+  
+    it "login(username,password) should return the user when success and set the session with user.id" do
+      get "/test_login", :username => 'gizmo', :password => 'secret'
+      assigns[:user].should == @user
+      session[:user_id].should == @user.id
+    end
+  
+    it "login(username,password) should return nil and not set the session when failure" do
+      get "/test_login", :username => 'gizmo', :password => 'opensesame!'
+      assigns[:user].should be_nil
+      session[:user_id].should be_nil
+    end
+  
+    it "logout should clear the session" do
+      get "/test_logout"
+      session[:user_id].should be_nil
+    end
+  
+    it "logged_in? should return true if logged in" do
+      get "/test_login", :username => 'gizmo', :password => 'secret'
+      assigns[:logged_in].should be_true
+    end
+  
+    it "logged_in? should return false if not logged in" do
+      get "/test_login", :username => 'gizmo', :password => 'opensesame!'
+      assigns[:logged_in].should be_false
+    end
+    
+    it "current_user should return the user instance if logged in" do
+      create_new_user
+      get "/test_current_user", :id => @user.id
+      assigns[:current_user].should == @user
+    end
+    
+    it "current_user should return false if not logged in" do
+      get "/test_logout"
+      assigns[:current_user].should == false
+    end
+    
+    it "should respond to 'require_login'" do
+      get_sinatra_app(subject).should respond_to(:require_login)
+    end
+    
+    it "should call the configured 'not_authenticated_action' when authenticate before_filter fails" do
+      sorcery_controller_property_set(:not_authenticated_action, :test_not_authenticated_action)
+      get "/test_logout"
+      last_response.body.should == "test_not_authenticated_action"
+    end
+    
+    it "require_login before_filter should save the url that the user originally wanted" do
+      sorcery_controller_property_set(:not_authenticated_action, :not_authenticated2)
+      get "/some_action"
+      assigns[:session][:return_to_url].should == "http://example.org/some_action"
+      last_response.status.should == 302
+      last_response.should redirect_to("http://example.org/")
+    end
+    
+    it "on successful login the user should be redirected to the url he originally wanted" do
+      post "/test_return_to", :username => 'gizmo', :password => 'secret', :return_to_url => "http://example.org/blabla"
+      last_response.should redirect_to("http://example.org/blabla")
+    end
+    
+  end
+  
+end

data/spec/sinatra/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/sinatra/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), '..', 'myapp.rb')
+$: << APP_ROOT # for model reloading
+
+require 'rack/test'
+require 'rspec'
+
+# set test environment
+set :environment, :test
+set :run, false
+set :raise_errors, true
+set :logging, false
+
+module RSpecMixinExample
+  include Rack::Test::Methods
+  def app
+    @app ||= Sinatra::Application
+  end
+end
+
+Rspec.configure do |config|
+  config.send(:include, RSpecMixinExample)
+  config.send(:include, ::Sorcery::TestHelpers)
+  config.send(:include, ::Sorcery::TestHelpers::Sinatra)
+  config.before(:suite) do
+    ActiveRecord::Migrator.migrate("#{APP_ROOT}/db/migrate/core")
+  end
+
+  config.after(:suite) do
+    ActiveRecord::Migrator.rollback("#{APP_ROOT}/db/migrate/core")
+  end
+  
+end
+
+# needed when running individual specs
+require File.join(File.dirname(__FILE__), '..','user')
+require File.join(File.dirname(__FILE__), '..','authentication')
+
+class TestUser < ActiveRecord::Base
+  activate_sorcery!
+end
+
+class TestMailer < ActionMailer::Base
+
+end

data/spec/sinatra/spec/user_activation_spec.rb

@@ -0,0 +1,188 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../sorcery_mailer')
+
+describe "User with activation submodule" do
+  before(:all) do
+    ActiveRecord::Migrator.migrate("#{APP_ROOT}/db/migrate/activation")
+  end
+  
+  after(:all) do
+    ActiveRecord::Migrator.rollback("#{APP_ROOT}/db/migrate/activation")
+  end
+
+  # ----------------- PLUGIN CONFIGURATION -----------------------
+  describe User, "loaded plugin configuration" do
+    before(:all) do
+      sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
+    end
+  
+    after(:each) do
+      User.sorcery_config.reset!
+      sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
+    end
+    
+    it "should enable configuration option 'activation_state_attribute_name'" do
+      sorcery_model_property_set(:activation_state_attribute_name, :status)
+      User.sorcery_config.activation_state_attribute_name.should equal(:status)    
+    end
+    
+    it "should enable configuration option 'activation_token_attribute_name'" do
+      sorcery_model_property_set(:activation_token_attribute_name, :code)
+      User.sorcery_config.activation_token_attribute_name.should equal(:code)    
+    end
+    
+    it "should enable configuration option 'user_activation_mailer'" do
+      sorcery_model_property_set(:user_activation_mailer, TestMailer)
+      User.sorcery_config.user_activation_mailer.should equal(TestMailer)    
+    end
+    
+    it "should enable configuration option 'activation_needed_email_method_name'" do
+      sorcery_model_property_set(:activation_needed_email_method_name, :my_activation_email)
+      User.sorcery_config.activation_needed_email_method_name.should equal(:my_activation_email)
+    end
+    
+    it "should enable configuration option 'activation_success_email_method_name'" do
+      sorcery_model_property_set(:activation_success_email_method_name, :my_activation_email)
+      User.sorcery_config.activation_success_email_method_name.should equal(:my_activation_email)
+    end
+    
+    it "if mailer is nil on activation, throw exception!" do
+      expect{sorcery_reload!([:user_activation])}.to raise_error(ArgumentError)
+    end
+  end
+
+  # ----------------- ACTIVATION PROCESS -----------------------
+  describe User, "activation process" do
+    before(:all) do
+      sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
+    end
+    
+    it "should generate an activation code on registration" do
+      create_new_user
+      @user.activation_token.should_not be_nil
+    end
+    
+    it "should initialize user state to 'pending'" do
+      create_new_user
+      @user.activation_state.should == "pending"
+    end
+    
+    it "should respond to 'activate!'" do
+      create_new_user
+      @user.should respond_to(:activate!)
+    end
+    
+    it "should clear activation code and change state to 'active' on activation" do
+      create_new_user
+      activation_token = @user.activation_token
+      @user.activate!
+      @user2 = User.find(@user.id) # go to db to make sure it was saved and not just in memory
+      @user2.activation_token.should be_nil
+      @user2.activation_state.should == "active"
+      User.find_by_activation_token(activation_token).should be_nil
+    end
+    
+    it "should send the user an activation email" do
+      old_size = ActionMailer::Base.deliveries.size
+      create_new_user
+      ActionMailer::Base.deliveries.size.should == old_size + 1
+    end
+    
+    it "subsequent saves do not send activation email" do
+      create_new_user
+      old_size = ActionMailer::Base.deliveries.size
+      @user.username = "Shauli"
+      @user.save!
+      ActionMailer::Base.deliveries.size.should == old_size
+    end
+    
+    it "should send the user an activation success email on successful activation" do
+      create_new_user
+      old_size = ActionMailer::Base.deliveries.size
+      @user.activate!
+      ActionMailer::Base.deliveries.size.should == old_size + 1
+    end
+    
+    it "subsequent saves do not send activation success email" do
+      create_new_user
+      @user.activate!
+      old_size = ActionMailer::Base.deliveries.size
+      @user.username = "Shauli"
+      @user.save!
+      ActionMailer::Base.deliveries.size.should == old_size
+    end
+    
+    it "activation needed email is optional" do
+      sorcery_model_property_set(:activation_needed_email_method_name, nil)
+      old_size = ActionMailer::Base.deliveries.size
+      create_new_user
+      ActionMailer::Base.deliveries.size.should == old_size
+    end
+    
+    it "activation success email is optional" do
+      sorcery_model_property_set(:activation_success_email_method_name, nil)
+      create_new_user
+      old_size = ActionMailer::Base.deliveries.size
+      @user.activate!
+      ActionMailer::Base.deliveries.size.should == old_size
+    end
+  end
+
+  describe User, "prevent non-active login feature" do
+    before(:all) do
+      sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
+    end
+    
+    it "should not allow a non-active user to authenticate" do
+      create_new_user
+      User.authenticate(@user.username,'secret').should be_false
+    end
+    
+    it "should allow a non-active user to authenticate if configured so" do
+      create_new_user
+      sorcery_model_property_set(:prevent_non_active_users_to_login, false)
+      User.authenticate(@user.username,'secret').should be_true
+    end
+  end
+  
+  describe User, "load_from_activation_token" do
+    before(:all) do
+      sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
+    end
+    
+    it "load_from_activation_token should return user when token is found" do
+      create_new_user
+      User.load_from_activation_token(@user.activation_token).should == @user
+    end
+    
+    it "load_from_activation_token should NOT return user when token is NOT found" do
+      create_new_user
+      User.load_from_activation_token("a").should == nil
+    end
+    
+    it "load_from_activation_token should return user when token is found and not expired" do
+      sorcery_model_property_set(:activation_token_expiration_period, 500)
+      create_new_user
+      User.load_from_activation_token(@user.activation_token).should == @user
+    end
+    
+    it "load_from_activation_token should NOT return user when token is found and expired" do
+      sorcery_model_property_set(:activation_token_expiration_period, 0.1)
+      create_new_user
+      sleep 0.5
+      User.load_from_activation_token(@user.activation_token).should == nil
+    end
+    
+    it "load_from_activation_token should return nil if token is blank" do
+      User.load_from_activation_token(nil).should == nil
+      User.load_from_activation_token("").should == nil
+    end
+    
+    it "load_from_activation_token should always be valid if expiration period is nil" do
+      sorcery_model_property_set(:activation_token_expiration_period, nil)
+      create_new_user
+      User.load_from_activation_token(@user.activation_token).should == @user
+    end
+  end
+  
+end

data/spec/sinatra/spec/user_activity_logging_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "User with activity logging submodule" do
+  before(:all) do
+  end
+  
+  after(:all) do
+  end
+
+  # ----------------- PLUGIN CONFIGURATION -----------------------
+  describe User, "loaded plugin configuration" do
+    before(:all) do
+      sorcery_reload!([:activity_logging])
+    end
+  
+    after(:each) do
+      User.sorcery_config.reset!
+    end
+    
+    it "should allow configuration option 'last_login_at_attribute_name'" do
+      sorcery_model_property_set(:last_login_at_attribute_name, :login_time)
+      User.sorcery_config.last_login_at_attribute_name.should equal(:login_time)
+    end
+    
+    it "should allow configuration option 'last_logout_at_attribute_name'" do
+      sorcery_model_property_set(:last_logout_at_attribute_name, :logout_time)
+      User.sorcery_config.last_logout_at_attribute_name.should equal(:logout_time)
+    end
+    
+    it "should allow configuration option 'last_activity_at_attribute_name'" do
+      sorcery_model_property_set(:last_activity_at_attribute_name, :activity_time)
+      User.sorcery_config.last_activity_at_attribute_name.should equal(:activity_time)
+    end
+  end
+
+end

data/spec/sinatra/spec/user_brute_force_protection_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "User with brute_force_protection submodule" do
+  before(:all) do
+    ActiveRecord::Migrator.migrate("#{APP_ROOT}/db/migrate/brute_force_protection")
+  end
+  
+  after(:all) do
+    ActiveRecord::Migrator.rollback("#{APP_ROOT}/db/migrate/brute_force_protection")
+  end
+
+  # ----------------- PLUGIN CONFIGURATION -----------------------
+  describe User, "loaded plugin configuration" do
+  
+    before(:all) do
+      sorcery_reload!([:brute_force_protection])
+      create_new_user
+    end
+  
+    after(:each) do
+      User.sorcery_config.reset!
+    end
+    
+    it "should respond to 'failed_logins_count'" do
+      @user.should respond_to(:failed_logins_count)
+    end
+    
+    it "should respond to 'lock_expires_at'" do
+      @user.should respond_to(:failed_logins_count)
+    end
+ 
+    it "should enable configuration option 'failed_logins_count_attribute_name'" do
+      sorcery_model_property_set(:failed_logins_count_attribute_name, :my_count)
+      User.sorcery_config.failed_logins_count_attribute_name.should equal(:my_count)    
+    end
+    
+    it "should enable configuration option 'lock_expires_at_attribute_name'" do
+      sorcery_model_property_set(:lock_expires_at_attribute_name, :expires)
+      User.sorcery_config.lock_expires_at_attribute_name.should equal(:expires)    
+    end
+    
+    it "should enable configuration option 'consecutive_login_retries_amount_allowed'" do
+      sorcery_model_property_set(:consecutive_login_retries_amount_limit, 34)
+      User.sorcery_config.consecutive_login_retries_amount_limit.should equal(34)    
+    end
+    
+    it "should enable configuration option 'login_lock_time_period'" do
+      sorcery_model_property_set(:login_lock_time_period, 2.hours)
+      User.sorcery_config.login_lock_time_period.should == 2.hours    
+    end
+  end
+
+  # ----------------- PLUGIN ACTIVATED -----------------------
+  describe User, "when activated with sorcery" do
+  
+    before(:all) do
+      sorcery_reload!([:brute_force_protection])
+    end
+  
+    before(:each) do
+      User.delete_all
+    end
+
+    # it "should increment failed_logins_count on a failed login" do
+    #   create_new_user
+    #   
+    # end
+    # 
+    # it "should set lock expiry (effectively lock user) when failed_logins_count reaches max within max period" do
+    #   create_new_user
+    #   @user.lock_expires_at.should == Time.now.utc + 30
+    # end
+ 
+  end
+  
+end

data/spec/sinatra/spec/user_oauth_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "User with oauth submodule" do
+  before(:all) do
+    ActiveRecord::Migrator.migrate("#{APP_ROOT}/db/migrate/oauth")
+  end
+  
+  after(:all) do
+    ActiveRecord::Migrator.rollback("#{APP_ROOT}/db/migrate/oauth")
+  end
+
+  # ----------------- PLUGIN CONFIGURATION -----------------------
+  describe User, "loaded plugin configuration" do
+  
+    before(:all) do
+      sorcery_reload!([:oauth])
+      sorcery_controller_property_set(:oauth_providers, [:twitter])
+      sorcery_model_property_set(:authentications_class, Authentication)
+      sorcery_controller_oauth_property_set(:twitter, :key, "eYVNBjBDi33aa9GkA3w")
+      sorcery_controller_oauth_property_set(:twitter, :secret, "XpbeSdCoaKSmQGSeokz5qcUATClRW5u08QWNfv71N8")
+      sorcery_controller_oauth_property_set(:twitter, :callback_url, "http://blabla.com")
+      create_new_external_user(:twitter)
+    end
+    
+    it "should respond to 'load_from_provider'" do
+      User.should respond_to(:load_from_provider)
+    end
+    
+    it "'load_from_provider' should load user if exists" do
+      User.load_from_provider(:twitter,123).should == @user
+    end
+    
+    it "'load_from_provider' should return nil if user doesn't exist" do
+      User.load_from_provider(:twitter,980342).should be_nil
+    end
+    
+  end
+  
+end

data/spec/sinatra/spec/user_remember_me_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "User with remember_me submodule" do
+  before(:all) do
+    ActiveRecord::Migrator.migrate("#{APP_ROOT}/db/migrate/remember_me")
+  end
+  
+  after(:all) do
+    ActiveRecord::Migrator.rollback("#{APP_ROOT}/db/migrate/remember_me")
+  end
+
+  # ----------------- PLUGIN CONFIGURATION -----------------------
+  describe User, "loaded plugin configuration" do
+    before(:all) do
+      sorcery_reload!([:remember_me])
+    end
+  
+    after(:each) do
+      User.sorcery_config.reset!
+    end
+    
+    it "should allow configuration option 'remember_me_token_attribute_name'" do
+      sorcery_model_property_set(:remember_me_token_attribute_name, :my_token)
+      User.sorcery_config.remember_me_token_attribute_name.should equal(:my_token)
+    end
+
+    it "should allow configuration option 'remember_me_token_expires_at_attribute_name'" do
+      sorcery_model_property_set(:remember_me_token_expires_at_attribute_name, :my_expires)
+      User.sorcery_config.remember_me_token_expires_at_attribute_name.should equal(:my_expires)
+    end
+    
+    it "should respond to 'remember_me!'" do
+      create_new_user
+      @user.should respond_to(:remember_me!)
+    end
+    
+    it "should respond to 'forget_me!'" do
+      create_new_user
+      @user.should respond_to(:forget_me!)
+    end
+    
+    it "should generate a new token on 'remember_me!'" do
+      create_new_user
+      @user.remember_me_token.should be_nil
+      @user.remember_me!
+      @user.remember_me_token.should_not be_nil
+    end
+    
+    it "should set an expiration based on 'remember_me_for' attribute" do
+      create_new_user
+      sorcery_model_property_set(:remember_me_for, 2 * 60 * 60 * 24)
+      @user.remember_me!
+      @user.remember_me_token_expires_at.to_s.should == (Time.now + 2 * 60 * 60 * 24).to_s
+    end
+    
+    it "should delete the token and expiration on 'forget_me!'" do
+      create_new_user
+      @user.remember_me!
+      @user.remember_me_token.should_not be_nil
+      @user.forget_me!
+      @user.remember_me_token.should be_nil
+      @user.remember_me_token_expires_at.should be_nil
+    end
+  end
+
+end