sorcery 0.5.0 → 0.6.0

data/spec/rails3_mongoid/spec/user_remember_me_spec.rb

@@ -1,51 +1,8 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../shared_examples/user_remember_me_shared_examples')
 
 describe "User with remember_me submodule" do
 
-  # ----------------- PLUGIN CONFIGURATION -----------------------
-  describe User, "loaded plugin configuration" do
-    before(:all) do
-      sorcery_reload!([:remember_me])
-      create_new_user
-    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
-    
-    specify { @user.should respond_to(:remember_me!) }
-    
-    specify { @user.should respond_to(:forget_me!) }
-    
-    it "should generate a new token on 'remember_me!'" do
-      @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
-      sorcery_model_property_set(:remember_me_for, 2 * 60 * 60 * 24)
-      @user.remember_me!
-      @user.remember_me_token_expires_at.utc.to_s.should == (Time.now + 2 * 60 * 60 * 24).utc.to_s
-    end
-    
-    it "should delete the token and expiration on 'forget_me!'" do
-      @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
+  it_behaves_like "rails_3_remember_me_model"
 
 end

data/spec/rails3_mongoid/spec/user_reset_password_spec.rb

@@ -1,174 +1,8 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../shared_examples/user_reset_password_shared_examples')
 
 describe "User with reset_password submodule" do
 
-  # ----------------- PLUGIN CONFIGURATION -----------------------
-  describe User, "loaded plugin configuration" do
-  
-    before(:all) do
-      sorcery_reload!([:reset_password], :reset_password_mailer => ::SorceryMailer)
-    end
-  
-    after(:each) do
-      User.sorcery_config.reset!
-    end
-    
-    context "API" do
-      before(:all) do
-        create_new_user
-      end
-      
-      specify { @user.should respond_to(:deliver_reset_password_instructions!) }
-      
-      specify { @user.should respond_to(:reset_password!) }
-
-      it "should respond to .load_from_reset_password_token" do
-        User.should respond_to(:load_from_reset_password_token)
-      end
-    end
-
-    it "should allow configuration option 'reset_password_token_attribute_name'" do
-      sorcery_model_property_set(:reset_password_token_attribute_name, :my_code)
-      User.sorcery_config.reset_password_token_attribute_name.should equal(:my_code)
-    end
-    
-    it "should allow configuration option 'reset_password_mailer'" do
-      sorcery_model_property_set(:reset_password_mailer, TestUser)
-      User.sorcery_config.reset_password_mailer.should equal(TestUser)
-    end
-    
-    it "should allow configuration option 'reset_password_email_method_name'" do
-      sorcery_model_property_set(:reset_password_email_method_name, :my_mailer_method)
-      User.sorcery_config.reset_password_email_method_name.should equal(:my_mailer_method)
-    end
-    
-    it "should allow configuration option 'reset_password_expiration_period'" do
-      sorcery_model_property_set(:reset_password_expiration_period, 16)
-      User.sorcery_config.reset_password_expiration_period.should equal(16)
-    end
-    
-    it "should allow configuration option 'reset_password_email_sent_at_attribute_name'" do
-      sorcery_model_property_set(:reset_password_email_sent_at_attribute_name, :blabla)
-      User.sorcery_config.reset_password_email_sent_at_attribute_name.should equal(:blabla)
-    end
-    
-    it "should allow configuration option 'reset_password_time_between_emails'" do
-      sorcery_model_property_set(:reset_password_time_between_emails, 16)
-      User.sorcery_config.reset_password_time_between_emails.should equal(16)
-    end
-  end
-
-  # ----------------- PLUGIN ACTIVATED -----------------------
-  describe User, "when activated with sorcery" do
-  
-    before(:all) do
-      sorcery_reload!([:reset_password], :reset_password_mailer => ::SorceryMailer)
-    end
-  
-    before(:each) do
-      User.delete_all
-    end
-    
-    after(:each) do
-      Timecop.return
-    end
-    
-    it "load_from_reset_password_token should return user when token is found" do
-      create_new_user
-      @user.deliver_reset_password_instructions!
-      User.load_from_reset_password_token(@user.reset_password_token).should == @user
-    end
-    
-    it "load_from_reset_password_token should NOT return user when token is NOT found" do
-      create_new_user
-      @user.deliver_reset_password_instructions!
-      User.load_from_reset_password_token("a").should == nil
-    end
-    
-    it "load_from_reset_password_token should return user when token is found and not expired" do
-      create_new_user
-      sorcery_model_property_set(:reset_password_expiration_period, 500)
-      @user.deliver_reset_password_instructions!
-      User.load_from_reset_password_token(@user.reset_password_token).should == @user
-    end
-    
-    it "load_from_reset_password_token should NOT return user when token is found and expired" do
-      create_new_user
-      sorcery_model_property_set(:reset_password_expiration_period, 0.1)
-      @user.deliver_reset_password_instructions!
-      Timecop.travel(Time.now+0.5)
-      User.load_from_reset_password_token(@user.reset_password_token).should == nil
-    end
-    
-    it "load_from_reset_password_token should always be valid if expiration period is nil" do
-      create_new_user
-      sorcery_model_property_set(:reset_password_expiration_period, nil)
-      @user.deliver_reset_password_instructions!
-      User.load_from_reset_password_token(@user.reset_password_token).should == @user
-    end
-    
-    it "load_from_reset_password_token should return nil if token is blank" do
-      User.load_from_reset_password_token(nil).should == nil
-      User.load_from_reset_password_token("").should == nil
-    end
-    
-    it "'deliver_reset_password_instructions!' should generate a reset_password_token" do
-      create_new_user
-      @user.reset_password_token.should be_nil
-      @user.deliver_reset_password_instructions!
-      @user.reset_password_token.should_not be_nil
-    end
-
-    it "the reset_password_token should be random" do
-      create_new_user
-      sorcery_model_property_set(:reset_password_time_between_emails, 0)
-      @user.deliver_reset_password_instructions!
-      old_password_code = @user.reset_password_token
-      @user.deliver_reset_password_instructions!
-      @user.reset_password_token.should_not == old_password_code
-    end
-
-    it "should send an email on reset" do
-      create_new_user
-      old_size = ActionMailer::Base.deliveries.size
-      @user.deliver_reset_password_instructions!
-      ActionMailer::Base.deliveries.size.should == old_size + 1
-    end
-
-    it "when reset_password! is called, should delete reset_password_token" do
-      create_new_user
-      @user.deliver_reset_password_instructions!
-      @user.reset_password_token.should_not be_nil
-      @user.change_password!("blabulsdf")
-      @user.save!
-      @user.reset_password_token.should be_nil
-    end
-    
-    it "should not send an email if time between emails has not passed since last email" do
-      create_new_user
-      sorcery_model_property_set(:reset_password_time_between_emails, 10000)
-      old_size = ActionMailer::Base.deliveries.size
-      @user.deliver_reset_password_instructions!
-      ActionMailer::Base.deliveries.size.should == old_size + 1
-      @user.deliver_reset_password_instructions!
-      ActionMailer::Base.deliveries.size.should == old_size + 1
-    end
-    
-    it "should send an email if time between emails has passed since last email" do
-      create_new_user
-      sorcery_model_property_set(:reset_password_time_between_emails, 0.5)
-      old_size = ActionMailer::Base.deliveries.size
-      @user.deliver_reset_password_instructions!
-      ActionMailer::Base.deliveries.size.should == old_size + 1
-      Timecop.travel(Time.now+0.5)
-      @user.deliver_reset_password_instructions!
-      ActionMailer::Base.deliveries.size.should == old_size + 2
-    end
-    
-    it "if mailer is nil on activation, throw exception!" do
-      expect{sorcery_reload!([:reset_password])}.to raise_error(ArgumentError)
-    end
-    
-  end
+  it_behaves_like "rails_3_reset_password_model"
   
 end

data/spec/rails3_mongoid/spec/user_spec.rb

@@ -1,5 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require File.expand_path(File.dirname(__FILE__) + '/../app/mailers/sorcery_mailer')
+require File.expand_path(File.dirname(__FILE__) + '/../../shared_examples/user_shared_examples')
 
 describe "User with no submodules (core)" do
   before(:all) do
@@ -11,308 +12,15 @@ describe "User with no submodules (core)" do
       User.should respond_to(:authenticates_with_sorcery!)
     end
   end
-
-  # ----------------- PLUGIN ACTIVATION -----------------------
-  describe TestUser, "Testing activated class self-registration" do
-    it "should register itself as user_class if activated" do
-      TestUser.class_eval do
-        authenticates_with_sorcery!
-      end
-      ::Sorcery::Controller::Config.user_class.should == TestUser
-    end
-  end
   
   # ----------------- PLUGIN CONFIGURATION -----------------------
-  describe User, "loaded plugin configuration" do
-    after(:each) do
-      User.sorcery_config.reset!
-    end
-  
-    it "should enable configuration option 'username_attribute_name'" do
-      sorcery_model_property_set(:username_attribute_name, :email)
-      User.sorcery_config.username_attribute_name.should equal(:email)    
-    end
-  
-    it "should enable configuration option 'password_attribute_name'" do
-      sorcery_model_property_set(:password_attribute_name, :mypassword)
-      User.sorcery_config.password_attribute_name.should equal(:mypassword)
-    end
-    
-    it "should enable configuration option 'email_attribute_name'" do
-      sorcery_model_property_set(:email_attribute_name, :my_email)
-      User.sorcery_config.email_attribute_name.should equal(:my_email)
-    end
-
-    it "should enable configuration option 'crypted_password_attribute_name'" do
-      sorcery_model_property_set(:crypted_password_attribute_name, :password)
-      User.sorcery_config.crypted_password_attribute_name.should equal(:password)
-    end
-    
-    it "should enable configuration option 'salt_attribute_name'" do
-      sorcery_model_property_set(:salt_attribute_name, :my_salt)
-      User.sorcery_config.salt_attribute_name.should equal(:my_salt)
-    end
-
-    it "should enable configuration option 'encryption_algorithm'" do
-      sorcery_model_property_set(:encryption_algorithm, :none)
-      User.sorcery_config.encryption_algorithm.should equal(:none)
-    end
-
-    it "should enable configuration option 'encryption_key'" do
-      sorcery_model_property_set(:encryption_key, 'asdadas424234242')
-      User.sorcery_config.encryption_key.should == 'asdadas424234242'
-    end
-
-    it "should enable configuration option 'custom_encryption_provider'" do
-      sorcery_model_property_set(:encryption_algorithm, :custom)
-      sorcery_model_property_set(:custom_encryption_provider, Array)
-      User.sorcery_config.custom_encryption_provider.should equal(Array)
-    end
-  
-    it "should enable configuration option 'salt_join_token'" do
-      salt_join_token = "--%%*&-"
-      sorcery_model_property_set(:salt_join_token, salt_join_token)
-      User.sorcery_config.salt_join_token.should equal(salt_join_token)
-    end
-    
-    it "should enable configuration option 'stretches'" do
-      stretches = 15
-      sorcery_model_property_set(:stretches, stretches)
-      User.sorcery_config.stretches.should equal(stretches)
-    end
-  
-  end
-
-  # ----------------- PLUGIN ACTIVATED -----------------------
-  describe User, "when activated with sorcery" do
-    before(:all) do
-      sorcery_reload!()
-    end
-  
-    before(:each) do
-      User.delete_all
-    end
-  
-    it "should respond to class method authenticate" do
-      User.should respond_to(:authenticate)
-    end
-  
-    it "authenticate should return true if credentials are good" do
-      create_new_user
-      User.authenticate(@user.send(User.sorcery_config.username_attribute_name), 'secret').should be_true
-    end
-  
-    it "authenticate should return false if credentials are bad" do
-      create_new_user
-      User.authenticate(@user.send(User.sorcery_config.username_attribute_name), 'wrong!').should be_false
-    end
-  
-    specify { User.should respond_to(:encrypt) }
-    
-    it "subclass should inherit config if defined so" do
-      sorcery_reload!([],{:subclasses_inherit_config => true})
-      class Admin < User
-      end
-      Admin.sorcery_config.should_not be_nil
-      Admin.sorcery_config.should == User.sorcery_config
-    end
-    
-    it "subclass should not inherit config if not defined so" do
-      sorcery_reload!([],{:subclasses_inherit_config => false})
-      class Admin2 < User
-      end
-      Admin2.sorcery_config.should be_nil
-    end
-  end
-
-  # ----------------- REGISTRATION -----------------------
-  describe User, "registration" do
-  
-    before(:all) do
-      sorcery_reload!()
-    end
-
-    before(:each) do
-      User.delete_all
-    end
-  
-    it "by default, encryption_provider should not be nil" do
-      User.sorcery_config.encryption_provider.should_not be_nil
-    end
-    
-    it "should encrypt password when a new user is saved" do
-      create_new_user
-      User.sorcery_config.encryption_provider.matches?(@user.send(User.sorcery_config.crypted_password_attribute_name),'secret',@user.salt).should be_true
-    end
-
-    it "should clear the virtual password field if the encryption process worked" do
-      create_new_user
-      @user.password.should be_nil
-    end
-    
-    it "should not clear the virtual password field if save failed due to validity" do
-      create_new_user
-      User.class_eval do
-        validates_format_of :email, :with => /^(.)+@(.)+$/, :if => Proc.new {|r| r.email}, :message => "is invalid"
-      end
-      @user.password = 'blupush'
-      @user.email = 'asd'
-      @user.save
-      @user.password.should_not be_nil
-    end
-    
-    it "should not clear the virtual password field if save failed due to exception" do
-      create_new_user
-      @user.password = '4blupush'
-      @user.username = nil
-      User.class_eval do
-        validates_presence_of :username
-      end
-      begin
-        @user.save! # triggers validation exception since username field is required.
-      rescue
-      end
-      @user.password.should_not be_nil
-    end
-    
-    it "should not encrypt the password twice when a user is updated" do
-      create_new_user
-      @user.email = "blup@bla.com"
-      @user.save!
-      User.sorcery_config.encryption_provider.matches?(@user.send(User.sorcery_config.crypted_password_attribute_name),'secret',@user.salt).should be_true
-    end
-
-    it "should replace the crypted_password in case a new password is set" do
-      create_new_user
-      @user.password = 'new_secret'
-      @user.save!
-      User.sorcery_config.encryption_provider.matches?(@user.send(User.sorcery_config.crypted_password_attribute_name),'secret',@user.salt).should be_false
-    end
-
-  end
-
-  # ----------------- PASSWORD ENCRYPTION -----------------------
-  describe User, "special encryption cases" do
-    before(:all) do
-
-      @text = "Some Text!"
-    end
-  
-    before(:each) do
-      User.delete_all
-      sorcery_reload!()
-    end
-  
-    after(:each) do
-      User.sorcery_config.reset!
-    end
-  
-    it "should work with no password encryption" do
-      sorcery_model_property_set(:encryption_algorithm, :none)
-      create_new_user
-      User.authenticate(@user.send(User.sorcery_config.username_attribute_name), 'secret').should be_true
-    end
-  
-    it "should work with custom password encryption" do
-      class MyCrypto
-        def self.encrypt(*tokens)
-          tokens.flatten.compact.join('').gsub(/e/,'A')
-        end
-        
-        def self.matches?(crypted,*tokens)
-          crypted == encrypt(*tokens)
-        end
-      end
-      sorcery_model_property_set(:encryption_algorithm, :custom)
-      sorcery_model_property_set(:custom_encryption_provider, MyCrypto)
-      create_new_user
-      User.authenticate(@user.send(User.sorcery_config.username_attribute_name), 'secret').should be_true
-    end
-  
-    it "if encryption algo is aes256, it should set key to crypto provider" do
-      sorcery_model_property_set(:encryption_algorithm, :aes256)
-      sorcery_model_property_set(:encryption_key, nil)
-      expect{User.encrypt(@text)}.to raise_error(ArgumentError)
-      sorcery_model_property_set(:encryption_key, "asd234dfs423fddsmndsflktsdf32343")
-      expect{User.encrypt(@text)}.to_not raise_error(ArgumentError)
-    end
-    
-    it "if encryption algo is aes256, it should set key to crypto provider, even if attributes are set in reverse" do
-      sorcery_model_property_set(:encryption_key, nil)
-      sorcery_model_property_set(:encryption_algorithm, :none)
-      sorcery_model_property_set(:encryption_key, "asd234dfs423fddsmndsflktsdf32343")
-      sorcery_model_property_set(:encryption_algorithm, :aes256)
-      expect{User.encrypt(@text)}.to_not raise_error(ArgumentError)
-    end
-  
-    it "if encryption algo is md5 it should work" do
-      sorcery_model_property_set(:encryption_algorithm, :md5)
-      User.encrypt(@text).should == Sorcery::CryptoProviders::MD5.encrypt(@text)
-    end
-  
-    it "if encryption algo is sha1 it should work" do
-      sorcery_model_property_set(:encryption_algorithm, :sha1)
-      User.encrypt(@text).should == Sorcery::CryptoProviders::SHA1.encrypt(@text)
-    end
   
-    it "if encryption algo is sha256 it should work" do
-      sorcery_model_property_set(:encryption_algorithm, :sha256)
-      User.encrypt(@text).should == Sorcery::CryptoProviders::SHA256.encrypt(@text)
-    end
-  
-    it "if encryption algo is sha512 it should work" do
-      sorcery_model_property_set(:encryption_algorithm, :sha512)
-      User.encrypt(@text).should == Sorcery::CryptoProviders::SHA512.encrypt(@text)
-    end
-  
-    it "salt should be random for each user and saved in db" do
-      sorcery_model_property_set(:salt_attribute_name, :salt)
-      create_new_user
-      @user.salt.should_not be_nil
-    end
-    
-    it "if salt is set should use it to encrypt" do
-      sorcery_model_property_set(:salt_attribute_name, :salt)
-      sorcery_model_property_set(:encryption_algorithm, :sha512)
-      create_new_user
-      @user.crypted_password.should_not == Sorcery::CryptoProviders::SHA512.encrypt('secret')
-      @user.crypted_password.should == Sorcery::CryptoProviders::SHA512.encrypt('secret',@user.salt)
-    end
-    
-    it "if salt_join_token is set should use it to encrypt" do
-      sorcery_model_property_set(:salt_attribute_name, :salt)
-      sorcery_model_property_set(:salt_join_token, "-@=>")
-      sorcery_model_property_set(:encryption_algorithm, :sha512)
-      create_new_user
-      @user.crypted_password.should_not == Sorcery::CryptoProviders::SHA512.encrypt('secret')
-      Sorcery::CryptoProviders::SHA512.join_token = ""
-      @user.crypted_password.should_not == Sorcery::CryptoProviders::SHA512.encrypt('secret')
-      Sorcery::CryptoProviders::SHA512.join_token = User.sorcery_config.salt_join_token
-      @user.crypted_password.should == Sorcery::CryptoProviders::SHA512.encrypt('secret',@user.salt)
-    end
-    
-  end
+  it_should_behave_like "rails_3_core_model"
   
   describe User, "external users" do
 
-    before(:each) do
-      User.delete_all
-    end
-    
-    it "should respond to 'external?'" do
-      create_new_user
-      @user.should respond_to(:external?)
-    end
+    it_should_behave_like "external_user"
     
-    it "external? should be false for regular users" do
-      create_new_user
-      @user.external?.should be_false
-    end
-    
-    it "external? should be true for external users" do
-      create_new_external_user(:twitter)
-      @user.external?.should be_true
-    end
   end
 
   describe User, "when inherited" do

data/spec/shared_examples/controller_oauth2_shared_examples.rb

@@ -0,0 +1,37 @@
+shared_examples_for "oauth2_controller" do
+  describe "using 'create_from'" do
+    before(:each) do
+      stub_all_oauth2_requests!
+      User.delete_all
+      Authentication.delete_all
+    end
+
+    it "should create a new user" do
+      sorcery_model_property_set(:authentications_class, Authentication)
+      sorcery_controller_external_property_set(:facebook, :user_info_mapping, {:username => "name"})
+      lambda do
+        get :test_create_from_provider, :provider => "facebook"
+      end.should change(User, :count).by(1)
+      User.first.username.should == "Noam Ben Ari"
+    end
+
+    it "should support nested attributes" do
+      sorcery_model_property_set(:authentications_class, Authentication)
+      sorcery_controller_external_property_set(:facebook, :user_info_mapping, {:username => "hometown/name"})
+      lambda do
+        get :test_create_from_provider, :provider => "facebook"
+      end.should change(User, :count).by(1)
+      User.first.username.should == "Haifa, Israel"
+    end
+
+    it "should not crash on missing nested attributes" do
+      sorcery_model_property_set(:authentications_class, Authentication)
+      sorcery_controller_external_property_set(:facebook, :user_info_mapping, {:username => "name", :created_at => "does/not/exist"})
+      lambda do
+        get :test_create_from_provider, :provider => "facebook"
+      end.should change(User, :count).by(1)
+      User.first.username.should == "Noam Ben Ari"
+      User.first.created_at.should_not be_nil
+    end 
+  end
+end

data/spec/shared_examples/controller_oauth_shared_examples.rb

@@ -0,0 +1,37 @@
+shared_examples_for "oauth_controller" do
+  describe "using 'create_from'" do
+    before(:each) do
+      stub_all_oauth_requests!
+      User.delete_all
+      Authentication.delete_all
+    end
+      
+    it "should create a new user" do
+      sorcery_model_property_set(:authentications_class, Authentication)
+      sorcery_controller_external_property_set(:twitter, :user_info_mapping, {:username => "screen_name"})
+      lambda do
+        get :test_create_from_provider, :provider => "twitter"
+      end.should change(User, :count).by(1)
+      User.first.username.should == "nbenari"
+    end
+    
+    it "should support nested attributes" do
+      sorcery_model_property_set(:authentications_class, Authentication)
+      sorcery_controller_external_property_set(:twitter, :user_info_mapping, {:username => "status/text"})
+      lambda do
+        get :test_create_from_provider, :provider => "twitter"
+      end.should change(User, :count).by(1)
+      User.first.username.should == "coming soon to sorcery gem: twitter and facebook authentication support."
+    end
+    
+    it "should not crash on missing nested attributes" do
+      sorcery_model_property_set(:authentications_class, Authentication)
+      sorcery_controller_external_property_set(:twitter, :user_info_mapping, {:username => "status/text", :created_at => "does/not/exist"})
+      lambda do
+        get :test_create_from_provider, :provider => "twitter"
+      end.should change(User, :count).by(1)
+      User.first.username.should == "coming soon to sorcery gem: twitter and facebook authentication support."
+      User.first.created_at.should_not be_nil
+    end
+  end
+end