sorcery 0.8.1 → 0.9.1

data/spec/shared_examples/user_activation_shared_examples.rb

@@ -1,45 +1,53 @@
 shared_examples_for "rails_3_activation_model" do
-  # ----------------- PLUGIN CONFIGURATION -----------------------
-  describe User, "loaded plugin configuration" do
+  let(:user) { create_new_user }
+  let(:new_user) { build_new_user }
+
+  context "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
+
+    it "enables 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)    
+
+      expect(User.sorcery_config.activation_state_attribute_name).to eq :status
     end
-    
-    it "should enable configuration option 'activation_token_attribute_name'" do
+
+    it "enables 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)    
+
+      expect(User.sorcery_config.activation_token_attribute_name).to eql :code
     end
-    
-    it "should enable configuration option 'user_activation_mailer'" do
+
+    it "enables configuration option 'user_activation_mailer'" do
       sorcery_model_property_set(:user_activation_mailer, TestMailer)
-      User.sorcery_config.user_activation_mailer.should equal(TestMailer)    
+
+      expect(User.sorcery_config.user_activation_mailer).to equal(TestMailer)
     end
-    
-    it "should enable configuration option 'activation_needed_email_method_name'" do
+
+    it "enables 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)
+
+      expect(User.sorcery_config.activation_needed_email_method_name).to eq :my_activation_email
     end
-    
-    it "should enable configuration option 'activation_success_email_method_name'" do
+
+    it "enables 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)
+
+      expect(User.sorcery_config.activation_success_email_method_name).to eq :my_activation_email
     end
 
-    it "should enable configuration option 'activation_mailer_disabled'" do
+    it "enables configuration option 'activation_mailer_disabled'" do
       sorcery_model_property_set(:activation_mailer_disabled, :my_activation_mailer_disabled)
-      User.sorcery_config.activation_mailer_disabled.should equal(:my_activation_mailer_disabled)
+
+      expect(User.sorcery_config.activation_mailer_disabled).to eq :my_activation_mailer_disabled
     end
-    
+
     it "if mailer is nil and mailer is enabled, throw exception!" do
       expect{sorcery_reload!([:user_activation], :activation_mailer_disabled => false)}.to raise_error(ArgumentError)
     end
@@ -49,72 +57,88 @@ shared_examples_for "rails_3_activation_model" do
     end
   end
 
-  # ----------------- ACTIVATION PROCESS -----------------------
-  describe User, "activation process" do
+
+  context "activation process" do
     before(:all) do
       sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
-    
-    before(:each) do
-      create_new_user
-    end
-    
-    it "should initialize user state to 'pending'" do
-      @user.activation_state.should == "pending"
+
+    it "initializes user state to 'pending'" do
+      expect(user.activation_state).to eq "pending"
     end
-    
-    specify { @user.should respond_to(:activate!) }
-    
-    it "should clear activation code and change state to 'active' on activation" do
-      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
+
+    specify { expect(user).to respond_to :activate! }
+
+    it "clears activation code and change state to 'active' on activation" do
+      activation_token = user.activation_token
+      user.activate!
+      user2 = User.sorcery_adapter.find(user.id) # go to db to make sure it was saved and not just in memory
+
+      expect(user2.activation_token).to be_nil
+      expect(user2.activation_state).to eq "active"
+      expect(User.sorcery_adapter.find_by_activation_token activation_token).to be_nil
     end
 
 
     context "mailer is enabled" do
-      it "should send the user an activation email" do
+      it "sends the user an activation email" do
         old_size = ActionMailer::Base.deliveries.size
         create_new_user
-        ActionMailer::Base.deliveries.size.should == old_size + 1
+
+        expect(ActionMailer::Base.deliveries.size).to eq old_size + 1
+      end
+
+      it "calls send_activation_needed_email! method of user" do
+        expect(new_user).to receive(:send_activation_needed_email!).once
+
+        new_user.sorcery_adapter.save(:raise_on_failure => true)
       end
 
       it "subsequent saves do not send activation email" do
+        user
         old_size = ActionMailer::Base.deliveries.size
-        @user.username = "Shauli"
-        @user.save!
-        ActionMailer::Base.deliveries.size.should == old_size
+        user.email = "Shauli"
+        user.sorcery_adapter.save(:raise_on_failure => true)
+
+        expect(ActionMailer::Base.deliveries.size).to eq old_size
       end
 
-      it "should send the user an activation success email on successful activation" do
+      it "sends the user an activation success email on successful activation" do
+        user
         old_size = ActionMailer::Base.deliveries.size
-        @user.activate!
-        ActionMailer::Base.deliveries.size.should == old_size + 1
+        user.activate!
+
+        expect(ActionMailer::Base.deliveries.size).to eq old_size + 1
+      end
+
+      it "calls send_activation_success_email! method of user on activation" do
+        expect(user).to receive(:send_activation_success_email!).once
+
+        user.activate!
       end
 
       it "subsequent saves do not send activation success email" do
-        @user.activate!
+        user.activate!
         old_size = ActionMailer::Base.deliveries.size
-        @user.username = "Shauli"
-        @user.save!
-        ActionMailer::Base.deliveries.size.should == old_size
+        user.email = "Shauli"
+        user.sorcery_adapter.save(:raise_on_failure => true)
+
+        expect(ActionMailer::Base.deliveries.size).to eq 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
+
+        expect(ActionMailer::Base.deliveries.size).to eq old_size
       end
 
       it "activation success email is optional" do
         sorcery_model_property_set(:activation_success_email_method_name, nil)
         old_size = ActionMailer::Base.deliveries.size
-        @user.activate!
-        ActionMailer::Base.deliveries.size.should == old_size
+        user.activate!
+
+        expect(ActionMailer::Base.deliveries.size).to eq old_size
       end
     end
 
@@ -123,81 +147,96 @@ shared_examples_for "rails_3_activation_model" do
         sorcery_reload!([:user_activation], :activation_mailer_disabled => true, :user_activation_mailer => ::SorceryMailer)
       end
 
-      it "should not send the user an activation email" do
+      it "does not send the user an activation email" do
         old_size = ActionMailer::Base.deliveries.size
-        create_new_user
-        ActionMailer::Base.deliveries.size.should == old_size
+
+        expect(ActionMailer::Base.deliveries.size).to eq old_size
       end
 
-      it "should not send the user an activation success email on successful activation" do
+      it "does not call send_activation_needed_email! method of user" do
+        user = build_new_user
+
+        expect(user).to receive(:send_activation_needed_email!).never
+
+        user.sorcery_adapter.save(:raise_on_failure => true)
+      end
+
+      it "does not send the user an activation success email on successful activation" do
         old_size = ActionMailer::Base.deliveries.size
-        @user.activate!
-        ActionMailer::Base.deliveries.size.should == old_size
+        user.activate!
+
+        expect(ActionMailer::Base.deliveries.size).to eq old_size
+      end
+
+      it "calls send_activation_success_email! method of user on activation" do
+        expect(user).to receive(:send_activation_success_email!).never
+
+        user.activate!
       end
     end
   end
 
-  describe User, "prevent non-active login feature" do
+  describe "prevent non-active login feature" do
     before(:all) do
       sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
 
     before(:each) do
-      User.delete_all
-      create_new_user
+      User.sorcery_adapter.delete_all
     end
 
-    it "should not allow a non-active user to authenticate" do
-      User.authenticate(@user.username,'secret').should be_false
+    it "does not allow a non-active user to authenticate" do
+      expect(User.authenticate user.email, 'secret').to be_falsy
     end
-    
-    it "should allow a non-active user to authenticate if configured so" do
+
+    it "allows a non-active user to authenticate if configured so" do
       sorcery_model_property_set(:prevent_non_active_users_to_login, false)
-      User.authenticate(@user.username,'secret').should be_true
+
+      expect(User.authenticate user.email, 'secret').to be_truthy
     end
   end
-  
-  describe User, "load_from_activation_token" do
+
+  describe "load_from_activation_token" do
     before(:all) do
       sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
-    
+
     after(:each) do
       Timecop.return
     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
+
+    it "load_from_activation_token returns user when token is found" do
+      expect(User.load_from_activation_token user.activation_token).to eq 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
+
+    it "load_from_activation_token does NOT return user when token is NOT found" do
+      expect(User.load_from_activation_token "a").to be_nil
     end
-    
-    it "load_from_activation_token should return user when token is found and not expired" do
+
+    it "load_from_activation_token returas 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
+
+      expect(User.load_from_activation_token user.activation_token).to eq user
     end
-    
-    it "load_from_activation_token should NOT return user when token is found and expired" do
+
+    it "load_from_activation_token does NOT return user when token is found and expired" do
       sorcery_model_property_set(:activation_token_expiration_period, 0.1)
-      create_new_user
+      user
+
       Timecop.travel(Time.now.in_time_zone+0.5)
-      User.load_from_activation_token(@user.activation_token).should == nil
+
+      expect(User.load_from_activation_token user.activation_token).to be_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
+
+    it "load_from_activation_token returns nil if token is blank" do
+      expect(User.load_from_activation_token nil).to be_nil
+      expect(User.load_from_activation_token "").to be_nil
     end
-    
-    it "load_from_activation_token should always be valid if expiration period is nil" do
+
+    it "load_from_activation_token is always 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
+
+      expect(User.load_from_activation_token user.activation_token).to eq user
     end
   end
-end
+end

data/spec/shared_examples/user_activity_logging_shared_examples.rb

@@ -1,27 +1,100 @@
 shared_examples_for "rails_3_activity_logging_model" do
-  # ----------------- PLUGIN CONFIGURATION -----------------------
-  describe User, "loaded plugin configuration" do
+  context "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
+
+    it "allows 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)
+
+      expect(User.sorcery_config.last_login_at_attribute_name).to eq :login_time
     end
-    
-    it "should allow configuration option 'last_logout_at_attribute_name'" do
+
+    it "allows 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)
+      expect(User.sorcery_config.last_logout_at_attribute_name).to eq :logout_time
     end
-    
-    it "should allow configuration option 'last_activity_at_attribute_name'" do
+
+    it "allows 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)
+      expect(User.sorcery_config.last_activity_at_attribute_name).to eq :activity_time
+    end
+
+    it "allows configuration option 'last_login_from_ip_adress'" do
+      sorcery_model_property_set(:last_login_from_ip_address_name, :ip_address)
+      expect(User.sorcery_config.last_login_from_ip_address_name).to eq :ip_address
+    end
+
+    describe ".current_users" do
+      let(:user) { create_new_user }
+
+      it "is empty when no users are logged in" do
+        skip('unavailable in MongoMapper') if SORCERY_ORM == :mongo_mapper
+        expect(User.current_users).to be_empty
+      end
+
+      it "holds the user object when 1 user is logged in" do
+        skip('unavailable in MongoMapper') if SORCERY_ORM == :mongo_mapper
+        user.set_last_activity_at(Time.now.in_time_zone)
+
+        expect(User.current_users).to match([User.sorcery_adapter.find(user.id)])
+      end
+
+      it "'current_users' shows all current_users, whether they have logged out before or not." do
+        skip('unavailable in MongoMapper') if SORCERY_ORM == :mongo_mapper
+        User.sorcery_adapter.delete_all
+        user1 = create_new_user({:username => 'gizmo1', :email => "bla1@bla.com", :password => 'secret1'})
+        user2 = create_new_user({:username => 'gizmo2', :email => "bla2@bla.com", :password => 'secret2'})
+        user3 = create_new_user({:username => 'gizmo3', :email => "bla3@bla.com", :password => 'secret3'})
+
+        now = Time.now.in_time_zone
+        [user1, user2, user3].each do |user|
+          user.set_last_login_at(now)
+          user.set_last_activity_at(now)
+        end
+
+        expect(User.current_users.map(&:id)).to match_array([user1, user2, user3].map(&:id))
+        Timecop.travel now + 5
+        user1.set_last_logout_at(Time.now.in_time_zone)
+        expect(User.current_users.map(&:id)).to match_array([user2, user3].map(&:id))
+        Timecop.return
+      end
+
+    end
+
+    it '.set_last_login_at update last_login_at' do
+      user = create_new_user
+      now = Time.now.in_time_zone
+      expect(user.sorcery_adapter).to receive(:update_attribute).with(:last_login_at, now)
+
+      user.set_last_login_at(now)
+    end
+
+    it '.set_last_logout_at update last_logout_at' do
+      user = create_new_user
+      now = Time.now.in_time_zone
+      expect(user.sorcery_adapter).to receive(:update_attribute).with(:last_logout_at, now)
+
+      user.set_last_logout_at(now)
+    end
+
+    it '.set_last_activity_at update last_activity_at' do
+      user = create_new_user
+      now = Time.now.in_time_zone
+      expect(user.sorcery_adapter).to receive(:update_attribute).with(:last_activity_at, now)
+
+      user.set_last_activity_at(now)
+    end
+
+    it '.set_last_ip_addess update last_login_from_ip_address' do
+      user = create_new_user
+      expect(user.sorcery_adapter).to receive(:update_attribute).with(:last_login_from_ip_address, '0.0.0.0')
+
+      user.set_last_ip_addess('0.0.0.0')
     end
   end
-end
+end

data/spec/shared_examples/user_brute_force_protection_shared_examples.rb

@@ -1,37 +1,156 @@
 shared_examples_for "rails_3_brute_force_protection_model" do
-  # ----------------- PLUGIN CONFIGURATION -----------------------
-  describe User, "loaded plugin configuration" do
-  
+  let(:user) { create_new_user }
+  before(:each) do
+    User.sorcery_adapter.delete_all
+  end
+
+
+  context "loaded plugin configuration" do
+
+    let(:config) { User.sorcery_config }
+
     before(:all) do
       sorcery_reload!([:brute_force_protection])
-      create_new_user
     end
-  
+
     after(:each) do
       User.sorcery_config.reset!
     end
-    
-    specify { @user.should respond_to(:failed_logins_count) }
-    specify { @user.should respond_to(:lock_expires_at) }
- 
-    it "should enable configuration option 'failed_logins_count_attribute_name'" do
+
+    specify { expect(user).to respond_to(:failed_logins_count) }
+    specify { expect(user).to respond_to(:lock_expires_at) }
+
+    it "enables 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)    
+      expect(config.failed_logins_count_attribute_name).to eq :my_count
     end
-    
-    it "should enable configuration option 'lock_expires_at_attribute_name'" do
+
+    it "enables 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)    
+      expect(config.lock_expires_at_attribute_name).to eq :expires
     end
-    
-    it "should enable configuration option 'consecutive_login_retries_amount_allowed'" do
+
+    it "enables 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)    
+      expect(config.consecutive_login_retries_amount_limit).to eq 34
     end
-    
-    it "should enable configuration option 'login_lock_time_period'" do
+
+    it "enables 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    
+      expect(config.login_lock_time_period).to eq 2.hours
+    end
+
+    describe "#locked?" do
+      it "is locked" do
+        user.send("#{config.lock_expires_at_attribute_name}=", Time.now + 5.days)
+        expect(user).to be_locked
+      end
+
+      it "isn't locked" do
+        user.send("#{config.lock_expires_at_attribute_name}=", nil)
+        expect(user).not_to be_locked
+      end
+    end
+  end
+
+  describe "#register_failed_login!" do
+    it "locks user when number of retries reached the limit" do
+      expect(user.lock_expires_at).to be_nil
+
+      sorcery_model_property_set(:consecutive_login_retries_amount_limit, 1)
+      user.register_failed_login!
+      lock_expires_at = User.sorcery_adapter.find_by_id(user.id).lock_expires_at
+
+      expect(lock_expires_at).not_to be_nil
+    end
+
+    context "unlock_token_mailer_disabled is true" do
+      it "does not automatically send unlock email" do
+        sorcery_model_property_set(:unlock_token_mailer_disabled, true)
+        sorcery_model_property_set(:consecutive_login_retries_amount_limit, 2)
+        sorcery_model_property_set(:login_lock_time_period, 0)
+        sorcery_model_property_set(:unlock_token_mailer, SorceryMailer)
+
+        3.times { user.register_failed_login! }
+
+        expect(ActionMailer::Base.deliveries.size).to eq 0
+
+      end
+    end
+
+    context "unlock_token_mailer_disabled is false" do
+      before do
+        sorcery_model_property_set(:unlock_token_mailer_disabled, false)
+        sorcery_model_property_set(:consecutive_login_retries_amount_limit, 2)
+        sorcery_model_property_set(:login_lock_time_period, 0)
+        sorcery_model_property_set(:unlock_token_mailer, SorceryMailer)
+      end
+
+      it "does not automatically send unlock email" do
+        3.times { user.register_failed_login! }
+
+        expect(ActionMailer::Base.deliveries.size).to eq 1
+      end
+
+      it "generates unlock token before mail is sent" do
+        3.times { user.register_failed_login! }
+
+        expect(ActionMailer::Base.deliveries.last.body.to_s.match(user.unlock_token)).not_to be_nil
+      end
+    end
+  end
+
+  context ".authenticate" do
+
+    it "unlocks after lock time period passes" do
+      sorcery_model_property_set(:consecutive_login_retries_amount_limit, 2)
+      sorcery_model_property_set(:login_lock_time_period, 0.2)
+      2.times { user.register_failed_login! }
+
+      lock_expires_at = User.sorcery_adapter.find_by_id(user.id).lock_expires_at
+      expect(lock_expires_at).not_to be_nil
+
+      Timecop.travel(Time.now.in_time_zone + 0.3)
+      User.authenticate('bla@bla.com', 'secret')
+
+      lock_expires_at = User.sorcery_adapter.find_by_id(user.id).lock_expires_at
+      expect(lock_expires_at).to be_nil
+      Timecop.return
+    end
+
+    it "doest not unlock if time period is 0 (permanent lock)" do
+      sorcery_model_property_set(:consecutive_login_retries_amount_limit, 2)
+      sorcery_model_property_set(:login_lock_time_period, 0)
+
+      2.times { user.register_failed_login! }
+
+      unlock_date = user.lock_expires_at
+      Timecop.travel(Time.now.in_time_zone + 1)
+
+      user.register_failed_login!
+
+      expect(user.lock_expires_at.to_s).to eq unlock_date.to_s
+      Timecop.return
+    end
+
+  end
+
+  describe "#unlock!" do
+    it "unlocks after entering unlock token" do
+      sorcery_model_property_set(:consecutive_login_retries_amount_limit, 2)
+      sorcery_model_property_set(:login_lock_time_period, 0)
+      sorcery_model_property_set(:unlock_token_mailer, SorceryMailer)
+      3.times { user.register_failed_login! }
+
+      expect(user.unlock_token).not_to be_nil
+
+      token = user.unlock_token
+      user = User.load_from_unlock_token(token)
+
+      expect(user).not_to be_nil
+
+      user.unlock!
+      expect(User.load_from_unlock_token(user.unlock_token)).to be_nil
     end
   end
-end
+end