sorcery 0.5.0 → 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

@@ -2,9 +2,12 @@ source 'http://rubygems.org'
 
 gem 'sinatra', '>= 1.2.0'
 gem 'sqlite3-ruby', :require => 'sqlite3'
+gem 'activerecord', '>= 3.0.3'
+gem 'actionmailer', '>= 3.0.3'
 gem "sorcery", '>= 0.1.0', :path => '../../'
 
 group :development, :test do
+  gem "rake"
   gem "rspec", "~> 2.5.0"
   gem 'ruby-debug19'
   gem 'simplecov', '>= 0.3.8', :require => false # Will install simplecov-html as a dependency

data/spec/sinatra/Gemfile.lock

@@ -1,45 +1,40 @@
 PATH
   remote: ../../
   specs:
-    sorcery (0.5.0)
+    sorcery (0.5.30)
       bcrypt-ruby (~> 2.1.4)
-      json (>= 1.5.1)
       oauth (>= 0.4.4)
       oauth (>= 0.4.4)
       oauth2 (>= 0.1.1)
       oauth2 (>= 0.1.1)
-      rails (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.3)
-      actionpack (= 3.0.3)
-      mail (~> 2.2.9)
-    actionpack (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
       i18n (~> 0.4)
       rack (~> 1.2.1)
       rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.6)
+      rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
       builder (~> 2.1.2)
       i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
       arel (~> 2.0.2)
       tzinfo (~> 0.3.23)
-    activeresource (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-    activesupport (3.0.3)
+    activesupport (3.0.5)
     addressable (2.2.5)
     archive-tar-minitar (0.5.2)
     arel (2.0.7)
@@ -54,7 +49,6 @@ GEM
       multipart-post (~> 1.1.0)
       rack (< 2, >= 1.1.0)
     i18n (0.5.0)
-    json (1.5.1)
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
     mail (2.2.15)
@@ -75,19 +69,6 @@ GEM
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.3)
-      actionmailer (= 3.0.3)
-      actionpack (= 3.0.3)
-      activerecord (= 3.0.3)
-      activeresource (= 3.0.3)
-      activesupport (= 3.0.3)
-      bundler (~> 1.0)
-      railties (= 3.0.3)
-    railties (3.0.3)
-      actionpack (= 3.0.3)
-      activesupport (= 3.0.3)
-      rake (>= 0.8.7)
-      thor (~> 0.14.4)
     rake (0.8.7)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
@@ -114,7 +95,6 @@ GEM
       rack (~> 1.1)
       tilt (< 2.0, >= 1.2.2)
     sqlite3-ruby (1.3.2)
-    thor (0.14.6)
     tilt (1.2.2)
     timecop (0.3.5)
     treetop (1.4.9)
@@ -125,6 +105,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionmailer (>= 3.0.3)
+  activerecord (>= 3.0.3)
+  rake
   rspec (~> 2.5.0)
   ruby-debug19
   simplecov (>= 0.3.8)

data/spec/sinatra/Rakefile

@@ -6,6 +6,6 @@ task :default => :spec
 
 desc "Run all specs"
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = '**/*_spec.rb'
+  t.pattern = 'spec/*_spec.rb'
   t.rspec_opts = ["--options #{File.dirname(__FILE__)}/spec/spec.opts"]
 end

data/spec/sinatra/filters.rb

@@ -1,21 +1,27 @@
 # --- before filters
+module Filters
 
-['/test_logout','/some_action','/test_should_be_logged_in'].each do |patt|
-  before patt do
-    require_login
-  end
-end
+  def self.included(klass)
+    klass.class_eval do
+      ['/test_logout', '/some_action', '/test_should_be_logged_in'].each do |pattern|
+        before pattern do
+          require_login
+        end
+      end
 
-before '/test_http_basic_auth' do
-  require_login_from_http_basic
-end
+      before '/test_http_basic_auth' do
+        require_login_from_http_basic
+      end
 
-# ----- test filters
+      # ----- test filters
 
-before do
-  self.class.sorcery_vars = {}
-end
+      before do
+        self.class.sorcery_vars = {}
+      end
 
-after do
-  save_instance_vars
+      after do
+        save_instance_vars
+      end
+    end
+  end
 end

data/spec/sinatra/modular.rb

@@ -0,0 +1,157 @@
+require 'sinatra/base'
+#enable :sessions
+
+require 'sqlite3'
+require 'active_record'
+
+# establish connection
+ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database => ":memory:",
+    :verbosity => "quiet"
+)
+
+require 'action_mailer'
+ActionMailer::Base.delivery_method = :test
+require File.join(File.dirname(__FILE__), 'sorcery_mailer')
+
+# models
+require File.join(File.dirname(__FILE__), 'user')
+require 'sorcery'
+
+APP_ROOT = File.dirname(__FILE__)
+
+class Modular < Sinatra::Base
+  set :sessions, true
+
+#  ['/test_logout', '/some_action', '/test_should_be_logged_in'].each do |patt|
+#    before patt do
+#      require_login
+#    end
+#  end
+#
+#  before '/test_http_basic_auth' do
+#    require_login_from_http_basic
+#  end
+#
+## ----- test filters
+#
+#  before do
+#    self.class.sorcery_vars = {}
+#  end
+#
+#  after do
+#    save_instance_vars
+#  end
+
+  get '/' do
+
+  end
+
+  get '/test_login' do
+    @user = login(params[:username], params[:password])
+    @current_user = current_user
+    @logged_in = logged_in?
+    erb :test_login
+  end
+
+  get '/test_logout' do
+    session[:user_id] = User.first.id
+    logout
+    @current_user = current_user
+    @logged_in = logged_in?
+  end
+
+  get '/test_current_user' do
+    session[:user_id] = params[:id]
+    current_user
+  end
+
+  get '/some_action' do
+    erb ''
+  end
+
+  post '/test_return_to' do
+    session[:return_to_url] = params[:return_to_url] if params[:return_to_url]
+    @user = login(params[:username], params[:password])
+    redirect_back_or_to(:some_action)
+  end
+
+  get '/test_should_be_logged_in' do
+    erb ''
+  end
+
+  def test_not_authenticated_action
+    halt "test_not_authenticated_action"
+  end
+
+  def not_authenticated2
+    @session = session
+    save_instance_vars
+    redirect '/'
+  end
+
+# remember me
+
+  post '/test_login_with_remember' do
+    @user = login(params[:username], params[:password])
+    remember_me!
+    erb ''
+  end
+
+  post '/test_login_with_remember_in_login' do
+    @user = login(params[:username], params[:password], params[:remember])
+    erb ''
+  end
+
+  get '/test_login_from_cookie' do
+    @user = current_user
+    erb ''
+  end
+
+# http_basic
+
+  get '/test_http_basic_auth' do
+    erb "HTTP Basic Auth"
+  end
+
+# oauth
+
+  get '/login_at_test' do
+    login_at(:twitter)
+  end
+
+  get '/test_login_from' do
+    if @user = login_from(:twitter)
+      erb "Success!"
+    else
+      erb "Failed!"
+    end
+  end
+
+# oauth2
+
+  get '/login_at_test2' do
+    login_at(:facebook)
+  end
+
+  get '/test_login_from2' do
+    if @user = login_from(:facebook)
+      erb "Success!"
+    else
+      erb "Failed!"
+    end
+  end
+
+  get '/test_create_from_provider' do
+    provider = params[:provider]
+    login_from(provider)
+    if @user = create_from(provider)
+      erb "Success!"
+    else
+      erb "Failed!"
+    end
+  end
+
+  #run! if app_file == $2
+end

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