sorcery 0.2.1 → 0.3.1

data/spec/sinatra/spec/user_spec.rb

@@ -0,0 +1,317 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../sorcery_mailer')
+
+describe "User with no submodules (core)" do
+  before(:all) do
+    sorcery_reload!
+  end
+
+  describe User, "when app has plugin loaded" do
+    it "should respond to the plugin activation class method" do
+      ActiveRecord::Base.should respond_to(:activate_sorcery!)
+      User.should respond_to(:activate_sorcery!)
+    end
+    
+    it "plugin activation should yield config to block" do
+      User.activate_sorcery! do |config|
+        config.class.should == ::Sorcery::Model::Config 
+      end
+    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
+        activate_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
+      ActiveRecord::Base.should_not respond_to(:authenticate)
+      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
+  
+    it "should respond to the class method encrypt" do
+      User.should respond_to(:encrypt)
+    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 = 'blupush'
+      @user.username = nil
+      begin
+        @user.save # triggers SQL exception since username field is defined not null.
+      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
+  
+  describe User, "external users" do
+    before(:all) do
+      ActiveRecord::Migrator.migrate("#{APP_ROOT}/db/migrate/external")
+      sorcery_reload!()
+    end
+  
+    after(:all) do
+      ActiveRecord::Migrator.rollback("#{APP_ROOT}/db/migrate/external")
+    end
+    
+    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
+
+end

data/spec/sinatra/user.rb

@@ -0,0 +1,6 @@
+class User < ActiveRecord::Base
+  attr_accessible :email, :password, :password_confirmation, :authentications_attributes
+  
+  has_many :authentications, :dependent => :destroy
+  accepts_nested_attributes_for :authentications
+end

data/spec/sinatra/views/test_login.erb

@@ -0,0 +1,4 @@
+<%= @user %> bla bla
+
+hourdyasd
+<bla>

data/spec/untitled folder

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'simplecov'
+SimpleCov.root File.join(File.dirname(__FILE__), '..', 'lib')
+SimpleCov.start
+
+
+require 'rspec'
+require 'sorcery'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: sorcery
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Noam Ben Ari
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 +02:00
+date: 2011-04-17 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -196,16 +196,27 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- lib/generators/sorcery_migration/sorcery_migration_generator.rb
+- lib/generators/sorcery_migration/templates/activity_logging.rb
+- lib/generators/sorcery_migration/templates/brute_force_protection.rb
+- lib/generators/sorcery_migration/templates/core.rb
+- lib/generators/sorcery_migration/templates/external.rb
+- lib/generators/sorcery_migration/templates/remember_me.rb
+- lib/generators/sorcery_migration/templates/reset_password.rb
+- lib/generators/sorcery_migration/templates/user_activation.rb
 - lib/sorcery.rb
 - lib/sorcery/controller.rb
+- lib/sorcery/controller/adapters/sinatra.rb
 - lib/sorcery/controller/submodules/activity_logging.rb
 - lib/sorcery/controller/submodules/brute_force_protection.rb
+- lib/sorcery/controller/submodules/email.rb
+- lib/sorcery/controller/submodules/external.rb
+- lib/sorcery/controller/submodules/external/protocols/oauth1.rb
+- lib/sorcery/controller/submodules/external/protocols/oauth2.rb
+- lib/sorcery/controller/submodules/external/providers/facebook.rb
+- lib/sorcery/controller/submodules/external/providers/twitter.rb
 - lib/sorcery/controller/submodules/http_basic_auth.rb
 - lib/sorcery/controller/submodules/oauth.rb
-- lib/sorcery/controller/submodules/oauth/oauth1.rb
-- lib/sorcery/controller/submodules/oauth/oauth2.rb
-- lib/sorcery/controller/submodules/oauth/providers/facebook.rb
-- lib/sorcery/controller/submodules/oauth/providers/twitter.rb
 - lib/sorcery/controller/submodules/remember_me.rb
 - lib/sorcery/controller/submodules/session_timeout.rb
 - lib/sorcery/crypto_providers/aes256.rb
@@ -218,12 +229,15 @@ files:
 - lib/sorcery/model.rb
 - lib/sorcery/model/submodules/activity_logging.rb
 - lib/sorcery/model/submodules/brute_force_protection.rb
-- lib/sorcery/model/submodules/oauth.rb
+- lib/sorcery/model/submodules/external.rb
 - lib/sorcery/model/submodules/remember_me.rb
 - lib/sorcery/model/submodules/reset_password.rb
 - lib/sorcery/model/submodules/user_activation.rb
 - lib/sorcery/model/temporary_token.rb
+- lib/sorcery/sinatra.rb
 - lib/sorcery/test_helpers.rb
+- lib/sorcery/test_helpers/rails.rb
+- lib/sorcery/test_helpers/sinatra.rb
 - sorcery.gemspec
 - spec/Gemfile
 - spec/Gemfile.lock
@@ -268,7 +282,7 @@ files:
 - spec/rails3/app_root/db/migrate/activity_logging/20101224223624_add_activity_logging_to_users.rb
 - spec/rails3/app_root/db/migrate/brute_force_protection/20101224223626_add_brute_force_protection_to_users.rb
 - spec/rails3/app_root/db/migrate/core/20101224223620_create_users.rb
-- spec/rails3/app_root/db/migrate/oauth/20101224223628_create_authentications.rb
+- spec/rails3/app_root/db/migrate/external/20101224223628_create_authentications.rb
 - spec/rails3/app_root/db/migrate/remember_me/20101224223623_add_remember_me_token_to_users.rb
 - spec/rails3/app_root/db/migrate/reset_password/20101224223622_add_reset_password_to_users.rb
 - spec/rails3/app_root/db/schema.rb
@@ -307,8 +321,42 @@ files:
 - spec/rails3/app_root/spec/user_reset_password_spec.rb
 - spec/rails3/app_root/spec/user_spec.rb
 - spec/rails3/app_root/vendor/plugins/.gitkeep
+- spec/sinatra/Gemfile
+- spec/sinatra/Gemfile.lock
+- spec/sinatra/Rakefile
+- 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
+- spec/sinatra/db/migrate/brute_force_protection/20101224223626_add_brute_force_protection_to_users.rb
+- spec/sinatra/db/migrate/core/20101224223620_create_users.rb
+- spec/sinatra/db/migrate/external/20101224223628_create_authentications.rb
+- spec/sinatra/db/migrate/remember_me/20101224223623_add_remember_me_token_to_users.rb
+- spec/sinatra/db/migrate/reset_password/20101224223622_add_reset_password_to_users.rb
+- spec/sinatra/filters.rb
+- spec/sinatra/myapp.rb
+- spec/sinatra/sorcery_mailer.rb
+- spec/sinatra/spec/controller_activity_logging_spec.rb
+- spec/sinatra/spec/controller_brute_force_protection_spec.rb
+- spec/sinatra/spec/controller_http_basic_auth_spec.rb
+- spec/sinatra/spec/controller_oauth2_spec.rb
+- spec/sinatra/spec/controller_oauth_spec.rb
+- spec/sinatra/spec/controller_remember_me_spec.rb
+- spec/sinatra/spec/controller_session_timeout_spec.rb
+- spec/sinatra/spec/controller_spec.rb
+- spec/sinatra/spec/spec.opts
+- spec/sinatra/spec/spec_helper.rb
+- spec/sinatra/spec/user_activation_spec.rb
+- spec/sinatra/spec/user_activity_logging_spec.rb
+- spec/sinatra/spec/user_brute_force_protection_spec.rb
+- spec/sinatra/spec/user_oauth_spec.rb
+- spec/sinatra/spec/user_remember_me_spec.rb
+- spec/sinatra/spec/user_reset_password_spec.rb
+- spec/sinatra/spec/user_spec.rb
+- spec/sinatra/user.rb
+- spec/sinatra/views/test_login.erb
 - spec/sorcery_crypto_providers_spec.rb
 - spec/spec_helper.rb
+- spec/untitled folder
 has_rdoc: true
 homepage: http://github.com/NoamB/sorcery
 licenses: 
@@ -360,7 +408,7 @@ test_files:
 - spec/rails3/app_root/db/migrate/activity_logging/20101224223624_add_activity_logging_to_users.rb
 - spec/rails3/app_root/db/migrate/brute_force_protection/20101224223626_add_brute_force_protection_to_users.rb
 - spec/rails3/app_root/db/migrate/core/20101224223620_create_users.rb
-- spec/rails3/app_root/db/migrate/oauth/20101224223628_create_authentications.rb
+- spec/rails3/app_root/db/migrate/external/20101224223628_create_authentications.rb
 - spec/rails3/app_root/db/migrate/remember_me/20101224223623_add_remember_me_token_to_users.rb
 - spec/rails3/app_root/db/migrate/reset_password/20101224223622_add_reset_password_to_users.rb
 - spec/rails3/app_root/db/schema.rb
@@ -382,5 +430,33 @@ test_files:
 - spec/rails3/app_root/spec/user_remember_me_spec.rb
 - spec/rails3/app_root/spec/user_reset_password_spec.rb
 - spec/rails3/app_root/spec/user_spec.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
+- spec/sinatra/db/migrate/brute_force_protection/20101224223626_add_brute_force_protection_to_users.rb
+- spec/sinatra/db/migrate/core/20101224223620_create_users.rb
+- spec/sinatra/db/migrate/external/20101224223628_create_authentications.rb
+- spec/sinatra/db/migrate/remember_me/20101224223623_add_remember_me_token_to_users.rb
+- spec/sinatra/db/migrate/reset_password/20101224223622_add_reset_password_to_users.rb
+- spec/sinatra/filters.rb
+- spec/sinatra/myapp.rb
+- spec/sinatra/sorcery_mailer.rb
+- spec/sinatra/spec/controller_activity_logging_spec.rb
+- spec/sinatra/spec/controller_brute_force_protection_spec.rb
+- spec/sinatra/spec/controller_http_basic_auth_spec.rb
+- spec/sinatra/spec/controller_oauth2_spec.rb
+- spec/sinatra/spec/controller_oauth_spec.rb
+- spec/sinatra/spec/controller_remember_me_spec.rb
+- spec/sinatra/spec/controller_session_timeout_spec.rb
+- spec/sinatra/spec/controller_spec.rb
+- spec/sinatra/spec/spec_helper.rb
+- spec/sinatra/spec/user_activation_spec.rb
+- spec/sinatra/spec/user_activity_logging_spec.rb
+- spec/sinatra/spec/user_brute_force_protection_spec.rb
+- spec/sinatra/spec/user_oauth_spec.rb
+- spec/sinatra/spec/user_remember_me_spec.rb
+- spec/sinatra/spec/user_reset_password_spec.rb
+- spec/sinatra/spec/user_spec.rb
+- spec/sinatra/user.rb
 - spec/sorcery_crypto_providers_spec.rb
 - spec/spec_helper.rb

data/lib/sorcery/controller/submodules/oauth/oauth1.rb

@@ -1,26 +0,0 @@
-require 'oauth'
-module Sorcery
-  module Controller
-    module Submodules
-      module Oauth
-        module Oauth1
-          def oauth_version
-            "1.0"
-          end
-          
-          def get_request_token
-            ::OAuth::Consumer.new(@key, @secret, :site => @site).get_request_token(:oauth_callback => @callback_url)
-          end
-          
-          def authorize_url(args)
-            args[:request_token].authorize_url(:oauth_callback => @callback_url)
-          end
-          
-          def get_access_token(args)
-            args[:request_token].get_access_token(:oauth_verifier => args[:oauth_verifier])
-          end
-        end
-      end
-    end
-  end
-end

data/lib/sorcery/controller/submodules/oauth/oauth2.rb

@@ -1,24 +0,0 @@
-require 'oauth2'
-module Sorcery
-  module Controller
-    module Submodules
-      module Oauth
-        module Oauth2
-          def oauth_version
-            "2.0"
-          end
-          
-          def authorize_url(args)
-            client = ::OAuth2::Client.new(@key, @secret, :site => @site)
-            client.web_server.authorize_url(:redirect_uri => @callback_url, :scope => @scope)
-          end
-          
-          def get_access_token(args)
-            client = ::OAuth2::Client.new(@key, @secret, :site => @site)
-            client.web_server.get_access_token(args[:code], :redirect_uri => @callback_url)
-          end
-        end
-      end
-    end
-  end
-end