sorcery 0.5.21 → 0.6.0

data/spec/shared_examples/user_shared_examples.rb

@@ -0,0 +1,292 @@
+shared_examples_for "rails_3_core_model" do
+  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
+      ActiveRecord::Base.should_not respond_to(:authenticate) if defined?(ActiveRecord)
+      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
+      sorcery_reload!()
+      @text = "Some Text!"
+    end
+  
+    before(:each) do
+      User.delete_all
+    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.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',@user.salt)
+      Sorcery::CryptoProviders::SHA512.join_token = User.sorcery_config.salt_join_token
+      @user.crypted_password.should == Sorcery::CryptoProviders::SHA512.encrypt('secret',@user.salt)
+    end
+    
+  end
+end
+
+shared_examples_for "external_user" do
+  before(:each) do
+    User.delete_all
+  end
+  
+  it "should respond to 'external?'" do
+    create_new_user
+    @user.should respond_to(:external?)
+  end
+  
+  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

data/spec/sinatra/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../
   specs:
-    sorcery (0.5.2)
+    sorcery (0.5.30)
       bcrypt-ruby (~> 2.1.4)
       oauth (>= 0.4.4)
       oauth (>= 0.4.4)

data/spec/sinatra/spec/controller_oauth2_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../shared_examples/controller_oauth2_shared_examples')
 
 def stub_all_oauth2_requests!
   @client = OAuth2::Client.new("key","secret", :site => "http://myapi.com")
@@ -58,30 +59,8 @@ describe 'MyApp' do
     end
   end
   
-  describe Sinatra::Application, "'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
+  describe Sinatra::Application do
+    it_behaves_like "oauth2_controller"
   end
   
   describe Sinatra::Application, "OAuth with User Activation features" do

data/spec/sinatra/spec/controller_oauth_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../shared_examples/controller_oauth_shared_examples')
 require 'ostruct'
 
 def stub_all_oauth_requests!
@@ -63,30 +64,8 @@ describe Sinatra::Application do
     end
   end
   
-  describe Sinatra::Application, "'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
+  describe Sinatra::Application do
+    it_behaves_like "oauth_controller"
   end
   
   describe Sinatra::Application, "OAuth with User Activation features" do

data/spec/sinatra/spec/controller_spec.rb

@@ -14,8 +14,8 @@ describe Sinatra::Application do
     end
     
     it "should enable configuration option 'user_class'" do
-      sorcery_controller_property_set(:user_class, TestUser)
-      Sorcery::Controller::Config.user_class.should equal(TestUser)
+      sorcery_controller_property_set(:user_class, "TestUser")
+      Sorcery::Controller::Config.user_class.should == "TestUser"
     end
     
     it "should enable configuration option 'not_authenticated_action'" do

data/spec/sinatra_modular/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../
   specs:
-    sorcery (0.5.2)
+    sorcery (0.5.30)
       bcrypt-ruby (~> 2.1.4)
       oauth (>= 0.4.4)
       oauth (>= 0.4.4)

data/spec/sinatra_modular/spec_modular/controller_oauth2_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../shared_examples/controller_oauth2_shared_examples')
 
 def stub_all_oauth2_requests!
   @client = OAuth2::Client.new("key","secret", :site => "http://myapi.com")
@@ -58,30 +59,8 @@ describe 'MyApp' do
     end
   end
   
-  describe Modular, "'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
+  describe Modular do
+    it_behaves_like "oauth2_controller"
   end
   
   describe Modular, "OAuth with User Activation features" do

data/spec/sinatra_modular/spec_modular/controller_oauth_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../shared_examples/controller_oauth_shared_examples')
 require 'ostruct'
 
 def stub_all_oauth_requests!
@@ -63,30 +64,8 @@ describe Modular do
     end
   end
   
-  describe Modular, "'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
+  describe Modular do
+    it_behaves_like "oauth_controller"
   end
   
   describe Modular, "OAuth with User Activation features" do

data/spec/sinatra_modular/spec_modular/controller_spec.rb

@@ -14,8 +14,8 @@ describe Modular do
     end
     
     it "should enable configuration option 'user_class'" do
-      sorcery_controller_property_set(:user_class, TestUser)
-      Sorcery::Controller::Config.user_class.should equal(TestUser)
+      sorcery_controller_property_set(:user_class, "TestUser")
+      Sorcery::Controller::Config.user_class.should == "TestUser"
     end
     
     it "should enable configuration option 'not_authenticated_action'" do

metadata

@@ -2,7 +2,7 @@
 name: sorcery
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.21
+  version: 0.6.0
 platform: ruby
 authors: 
 - Noam Ben Ari
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 +03:00
+date: 2011-07-30 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -422,6 +422,15 @@ files:
 - spec/rails3_mongoid/spec/user_reset_password_spec.rb
 - spec/rails3_mongoid/spec/user_spec.rb
 - spec/rails3_mongoid/vendor/plugins/.gitkeep
+- spec/shared_examples/controller_oauth2_shared_examples.rb
+- spec/shared_examples/controller_oauth_shared_examples.rb
+- spec/shared_examples/user_activation_shared_examples.rb
+- spec/shared_examples/user_activity_logging_shared_examples.rb
+- spec/shared_examples/user_brute_force_protection_shared_examples.rb
+- spec/shared_examples/user_oauth_shared_examples.rb
+- spec/shared_examples/user_remember_me_shared_examples.rb
+- spec/shared_examples/user_reset_password_shared_examples.rb
+- spec/shared_examples/user_shared_examples.rb
 - spec/sinatra/Gemfile
 - spec/sinatra/Gemfile.lock
 - spec/sinatra/Rakefile
@@ -581,6 +590,15 @@ test_files:
 - spec/rails3_mongoid/spec/user_remember_me_spec.rb
 - spec/rails3_mongoid/spec/user_reset_password_spec.rb
 - spec/rails3_mongoid/spec/user_spec.rb
+- spec/shared_examples/controller_oauth2_shared_examples.rb
+- spec/shared_examples/controller_oauth_shared_examples.rb
+- spec/shared_examples/user_activation_shared_examples.rb
+- spec/shared_examples/user_activity_logging_shared_examples.rb
+- spec/shared_examples/user_brute_force_protection_shared_examples.rb
+- spec/shared_examples/user_oauth_shared_examples.rb
+- spec/shared_examples/user_remember_me_shared_examples.rb
+- spec/shared_examples/user_reset_password_shared_examples.rb
+- spec/shared_examples/user_shared_examples.rb
 - spec/sinatra/authentication.rb
 - spec/sinatra/db/migrate/activation/20101224223622_add_activation_to_users.rb
 - spec/sinatra/db/migrate/activity_logging/20101224223624_add_activity_logging_to_users.rb