sorcery 0.4.0 → 0.4.2

data/lib/sorcery/test_helpers/sinatra.rb

@@ -1,127 +1,84 @@
 module Sorcery
   module TestHelpers
     module Sinatra
-      
-      class MyApp
-        class << self
-          def new
-            return this
+      def self.included(base)
+        base.send(:include, InstanceMethods)
+        base.send(:include, CookieSessionMethods)
+        ::Sinatra::Base.class_eval do
+          class << self
+            attr_accessor :rack_test_session
           end
-        end
-      end
-      
-      class ::Sinatra::Application
-        class << self
-          attr_accessor :sorcery_vars
-        end
-        @sorcery_vars = {}
 
-        # NOTE: see before and after test filters in filters.rb
-        
-        def save_instance_vars
-          instance_variables.each do |var|
-            self.class.sorcery_vars[:"#{var.to_s.delete("@")}"] = instance_variable_get(var)
+          def self.inherited(subclass)
+            super
+            subclass.class_eval do
+              class << self
+                attr_accessor :rack_test_session
+              end
+            end
+          end
+
+          include CookieSessionMethods
+
+          def rack_test_session
+            self.class.rack_test_session
           end
         end
       end
-                    
-      ::RSpec::Matchers.define :redirect_to do |expected|
-        match do |actual|
-          actual.status == 302 && actual.location == expected
-        end
-      end
-      
-      def get_sinatra_app(app)
-        while app.class != ::Sinatra::Application do
-          app = app.instance_variable_get(:@app)
-        end
-        app
-      end
-      
-      def login_user(user=nil)
-        user ||= @user
-        get_sinatra_app(subject).send(:login_user,user)
-        get_sinatra_app(subject).send(:after_login!,user,[user.username,'secret'])
-      end
-      
-      def logout_user
-        get_sinatra_app(subject).send(:logout)
-      end
 
-      def clear_user_without_logout
-        get_sinatra_app(subject).instance_variable_set(:@current_user,nil)
-      end
-        
-      def assigns
-        ::Sinatra::Application.sorcery_vars
-      end
-      
-      class SessionData
-        def initialize(cookies)
-          @cookies = cookies
-          @data = cookies['rack.session']
-          if @data
-            @data = @data.unpack("m*").first
-            @data = Marshal.load(@data)
-          else
-            @data = {}
+      module InstanceMethods
+        def get_sinatra_app(app)
+          while !app.kind_of? ::Sinatra::Base do
+            app = app.instance_variable_get(:@app)
           end
+          app
         end
 
-        def [](key)
-          @data[key]
+        def login_user(user=nil)
+          user ||= @user
+          get_sinatra_app(app).send(:login_user, user)
+          get_sinatra_app(app).send(:after_login!, user, [user.send(user.sorcery_config.username_attribute_name), 'secret'])
         end
 
-        def []=(key, value)
-          @data[key] = value
-          session_data = Marshal.dump(@data)
-          session_data = [session_data].pack("m*")
-          @cookies.merge("rack.session=#{Rack::Utils.escape(session_data)}", URI.parse("//example.org//"))
-          raise "session variable not set" unless @cookies['rack.session'] == session_data
+        def logout_user
+          get_sinatra_app(app).send(:logout)
         end
       end
 
-      def session
-        SessionData.new(rack_test_session.instance_variable_get(:@rack_mock_session).cookie_jar)
-      end
-      
-      def cookies
-        rack_test_session.instance_variable_get(:@rack_mock_session).cookie_jar
-      end
-      
-      def sorcery_reload!(submodules = [], options = {})
-        reload_user_class
+      module CookieSessionMethods
+        class SessionData
+          def initialize(cookies)
+            @cookies = cookies
+            @data = cookies['rack.session']
+            if @data
+              @data = @data.unpack("m*").first
+              @data = Marshal.load(@data)
+            else
+              @data = {}
+            end
+          end
 
-        # return to no-module configuration
-        ::Sorcery::Controller::Config.init!
-        ::Sorcery::Controller::Config.reset!
+          def [](key)
+            @data[key]
+          end
 
-        # clear all filters
-        ::Sinatra::Application.instance_variable_set(:@filters,{:before => [],:after => []})
-        ::Sinatra::Application.class_eval do
-          load File.join(File.dirname(__FILE__),'..','..','..','spec','sinatra','filters.rb')
-        end
-        
-        # configure
-        ::Sorcery::Controller::Config.submodules = submodules
-        ::Sorcery::Controller::Config.user_class = nil
-        ::Sinatra::Application.send(:include, Sorcery::Controller::Adapters::Sinatra)
-        ::Sinatra::Application.send(:include, Sorcery::Controller)
-        
-        ::Sorcery::Controller::Config.user_config do |user|
-          options.each do |property,value|
-            user.send(:"#{property}=", value)
+          def []=(key, value)
+            @data[key] = value
+            session_data = Marshal.dump(@data)
+            session_data = [session_data].pack("m*")
+            @cookies.merge("rack.session=#{Rack::Utils.escape(session_data)}", URI.parse("//example.org//"))
+            raise "session variable not set" unless @cookies['rack.session'] == session_data
+          end
+
+          def clear
+            @data = {}
           end
         end
-        User.authenticates_with_sorcery!
-      end
-      
-      def sorcery_controller_property_set(property, value)
-        ::Sorcery::Controller::Config.send(:"#{property}=", value)
-      end
 
-      def sorcery_controller_external_property_set(provider, property, value)
-        ::Sorcery::Controller::Config.send(provider).send(:"#{property}=", value)
+        def session
+          SessionData.new(rack_test_session.instance_variable_get(:@rack_mock_session).cookie_jar)
+        end
+
       end
     end
   end

data/lib/sorcery/test_helpers.rb

@@ -1,52 +1,5 @@
 module Sorcery
-  # This file will be included in the spec_helper file.
   module TestHelpers
-    def self.included(base)
-      # reducing default cost for specs speed
-      CryptoProviders::BCrypt.class_eval do
-        class << self
-          def cost
-            1
-          end
-        end
-      end
-    end
-    
-    # a patch to fix a bug in testing that happens when you 'destroy' a session twice.
-    # After the first destroy, the session is an ordinary hash, and then when destroy is called again there's an exception.
-    class ::Hash
-      def destroy
-        clear
-      end
-    end
-    
-    def create_new_user(attributes_hash = nil)
-      user_attributes_hash = attributes_hash || {:username => 'gizmo', :email => "bla@bla.com", :password => 'secret'}
-      @user = User.new(user_attributes_hash)
-      @user.save!
-      @user
-    end
 
-    def create_new_external_user(provider, attributes_hash = nil)
-      user_attributes_hash = attributes_hash || {:username => 'gizmo', :authentications_attributes => [{:provider => provider, :uid => 123}]}
-      @user = User.new(user_attributes_hash)
-      @user.save!
-      @user
-    end
-    
-    def sorcery_model_property_set(property, *values)
-      User.class_eval do
-        sorcery_config.send(:"#{property}=", *values)
-      end
-    end
-    
-    private
-
-    # reload user class between specs
-    # so it will be possible to test the different submodules in isolation
-    def reload_user_class
-      Object.send(:remove_const,:User)
-      load 'user.rb'
-    end
   end
 end

data/lib/sorcery.rb

@@ -48,7 +48,14 @@ module Sorcery
   module TestHelpers
     autoload :Rails, 'sorcery/test_helpers/rails'
     autoload :Sinatra, 'sorcery/test_helpers/sinatra'
+    autoload :Internal, 'sorcery/test_helpers/internal'
+    module Internal
+      autoload :Rails, 'sorcery/test_helpers/internal/rails'
+      autoload :Sinatra, 'sorcery/test_helpers/internal/sinatra'
+    end
+
   end
+
   
   require 'sorcery/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
   require 'sorcery/sinatra' if defined?(Sinatra)

data/sorcery.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sorcery}
-  s.version = "0.4.0"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Noam Ben Ari"]
-  s.date = %q{2011-04-21}
+  s.date = %q{2011-04-30}
   s.description = %q{Provides common authentication needs such as signing in/out, activating by email and resetting password.}
   s.email = %q{nbenari@gmail.com}
   s.extra_rdoc_files = [
@@ -66,6 +66,9 @@ Gem::Specification.new do |s|
     "lib/sorcery/railties/tasks.rake",
     "lib/sorcery/sinatra.rb",
     "lib/sorcery/test_helpers.rb",
+    "lib/sorcery/test_helpers/internal.rb",
+    "lib/sorcery/test_helpers/internal/rails.rb",
+    "lib/sorcery/test_helpers/internal/sinatra.rb",
     "lib/sorcery/test_helpers/rails.rb",
     "lib/sorcery/test_helpers/sinatra.rb",
     "sorcery.gemspec",

data/spec/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gem "rails", '3.0.3'
 gem 'bcrypt-ruby', :require => 'bcrypt'
-gem "sorcery", '0.4.0', :path => '../../../'
+gem "sorcery", '>= 0.1.0', :path => '../'
 gem 'oauth', ">= 0.4.4"
 gem 'oauth2', ">= 0.1.1"
 group :development do

data/spec/Gemfile.lock

@@ -1,7 +1,14 @@
 PATH
-  remote: ../../../
+  remote: ../
   specs:
-    sorcery (0.4.0)
+    sorcery (0.4.2)
+      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/
@@ -36,7 +43,7 @@ GEM
     addressable (2.2.4)
     archive-tar-minitar (0.5.2)
     arel (2.0.6)
-    bcrypt-ruby (2.1.3)
+    bcrypt-ruby (2.1.4)
     builder (2.1.2)
     columnize (0.3.2)
     diff-lcs (1.1.2)
@@ -47,6 +54,7 @@ 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.13)
@@ -118,4 +126,4 @@ DEPENDENCIES
   rspec (~> 2.5.0)
   ruby-debug19
   simplecov (>= 0.3.8)
-  sorcery (= 0.4.0)!
+  sorcery (>= 0.1.0)!

data/spec/rails3/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gem 'rails', '3.0.3'
 gem 'sqlite3-ruby', :require => 'sqlite3'
-gem "sorcery", '0.4.0', :path => '../../../'
+gem "sorcery", '>= 0.1.0', :path => '../../../'
 
 group :development, :test do
   gem "rspec", "~> 2.5.0"

data/spec/rails3/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: ../../../
   specs:
     oauth (0.4.4)
-    sorcery (0.4.0)
+    sorcery (0.4.2)
       bcrypt-ruby (~> 2.1.4)
       json (>= 1.5.1)
       oauth (>= 0.4.4)
@@ -131,6 +131,6 @@ DEPENDENCIES
   rspec-rails (~> 2.5.0)
   ruby-debug19
   simplecov (>= 0.3.8)
-  sorcery (= 0.4.0)!
+  sorcery (>= 0.1.0)!
   sqlite3-ruby
   timecop

data/spec/rails3/spec/controller_activity_logging_spec.rb

@@ -22,10 +22,8 @@ describe ApplicationController do
     after(:each) do
       User.delete_all
     end
-
-    it "should respond to 'current_users'" do
-      subject.should respond_to(:current_users)
-    end
+    
+    specify { subject.should respond_to(:current_users) }
 
     it "'current_users' should be empty when no users are logged in" do
       subject.current_users.size.should == 0

data/spec/rails3/spec/controller_oauth_spec.rb

@@ -31,7 +31,7 @@ describe ApplicationController do
     ActiveRecord::Migrator.rollback("#{Rails.root}/db/migrate/external")
   end
   # ----------------- OAuth -----------------------
-  describe ApplicationController, "'login_from'" do
+  describe ApplicationController, "'using external API to login'" do
   
     before(:each) do
       stub_all_oauth_requests!
@@ -64,7 +64,7 @@ describe ApplicationController do
     end
   end
   
-  describe ApplicationController, "'create_from'" do
+  describe ApplicationController, "using 'create_from'" do
     before(:each) do
       stub_all_oauth_requests!
       User.delete_all
@@ -90,7 +90,7 @@ describe ApplicationController do
     end
   end
   
-  describe ApplicationController, "OAuth with User Activation features" do
+  describe ApplicationController, "using OAuth with User Activation features" do
     before(:all) do
       ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate/activation")
       sorcery_reload!([:user_activation,:external], :user_activation_mailer => ::SorceryMailer)

data/spec/rails3/spec/controller_session_timeout_spec.rb

@@ -29,26 +29,27 @@ describe ApplicationController do
       response.should be_a_redirect
     end
     
-    it "with 'session_timeout_from_last_action' should not logout if there was activity" do
-      sorcery_controller_property_set(:session_timeout_from_last_action, true)
-      get :test_login, :username => 'gizmo', :password => 'secret'
-      Timecop.travel(Time.now+0.3)
-      get :test_should_be_logged_in
-      session[:user_id].should_not be_nil
-      Timecop.travel(Time.now+0.3)
-      get :test_should_be_logged_in
-      session[:user_id].should_not be_nil
-      response.should be_a_success
-    end
+    context "with 'session_timeout_from_last_action'" do
+      it "should not logout if there was activity" do
+        sorcery_controller_property_set(:session_timeout_from_last_action, true)
+        get :test_login, :username => 'gizmo', :password => 'secret'
+        Timecop.travel(Time.now+0.3)
+        get :test_should_be_logged_in
+        session[:user_id].should_not be_nil
+        Timecop.travel(Time.now+0.3)
+        get :test_should_be_logged_in
+        session[:user_id].should_not be_nil
+        response.should be_a_success
+      end
     
-    it "with 'session_timeout_from_last_action' should logout if there was no activity" do
-      sorcery_controller_property_set(:session_timeout_from_last_action, true)
-      get :test_login, :username => 'gizmo', :password => 'secret'
-      Timecop.travel(Time.now+0.6)
-      get :test_should_be_logged_in
-      session[:user_id].should be_nil
-      response.should be_a_redirect
+      it "with 'session_timeout_from_last_action' should logout if there was no activity" do
+        sorcery_controller_property_set(:session_timeout_from_last_action, true)
+        get :test_login, :username => 'gizmo', :password => 'secret'
+        Timecop.travel(Time.now+0.6)
+        get :test_should_be_logged_in
+        session[:user_id].should be_nil
+        response.should be_a_redirect
+      end
     end
-    
   end
 end

data/spec/rails3/spec/controller_spec.rb

@@ -37,21 +37,13 @@ describe ApplicationController do
       sorcery_controller_property_set(:user_class, User)
     end
     
-    it "should respond to the instance method login" do
-      should respond_to(:login)
-    end
-  
-    it "should respond to the instance method logout" do
-      should respond_to(:logout)
-    end
+    specify { should respond_to(:login) }
+
+    specify { should respond_to(:logout) }
   
-    it "should respond to the instance method logged_in?" do
-      should respond_to(:logged_in?)
-    end
+    specify { should respond_to(:logged_in?) }
     
-    it "should respond to the instance method current_user" do
-      should respond_to(:current_user)
-    end
+    specify { should respond_to(:current_user) }
   
     it "login(username,password) should return the user when success and set the session with user.id" do
       get :test_login, :username => 'gizmo', :password => 'secret'
@@ -93,9 +85,7 @@ describe ApplicationController do
       subject.current_user.should == false
     end
     
-    it "should respond to 'require_login'" do
-      should respond_to(:require_login)
-    end
+    specify { should respond_to(:require_login) }
     
     it "should call the configured 'not_authenticated_action' when authenticate before_filter fails" do
       session[:user_id] = nil

data/spec/rails3/spec/spec_helper.rb

@@ -65,6 +65,6 @@ class TestMailer < ActionMailer::Base
 
 end
 
-include ::Sorcery::TestHelpers
-include ::Sorcery::TestHelpers::Rails
+include ::Sorcery::TestHelpers::Internal
+include ::Sorcery::TestHelpers::Internal::Rails
 

data/spec/rails3/spec/user_activation_spec.rb

@@ -57,23 +57,17 @@ describe "User with activation submodule" do
       sorcery_reload!([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
     
-    it "should generate an activation code on registration" do
+    before(:each) do
       create_new_user
-      @user.activation_token.should_not be_nil
     end
     
     it "should initialize user state to 'pending'" do
-      create_new_user
       @user.activation_state.should == "pending"
     end
     
-    it "should respond to 'activate!'" do
-      create_new_user
-      @user.should respond_to(:activate!)
-    end
+    specify { @user.should respond_to(:activate!) }
     
     it "should clear activation code and change state to 'active' on activation" do
-      create_new_user
       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
@@ -89,7 +83,6 @@ describe "User with activation submodule" do
     end
     
     it "subsequent saves do not send activation email" do
-      create_new_user
       old_size = ActionMailer::Base.deliveries.size
       @user.username = "Shauli"
       @user.save!
@@ -97,14 +90,12 @@ describe "User with activation submodule" do
     end
     
     it "should send the user an activation success email on successful activation" do
-      create_new_user
       old_size = ActionMailer::Base.deliveries.size
       @user.activate!
       ActionMailer::Base.deliveries.size.should == old_size + 1
     end
     
     it "subsequent saves do not send activation success email" do
-      create_new_user
       @user.activate!
       old_size = ActionMailer::Base.deliveries.size
       @user.username = "Shauli"
@@ -121,7 +112,6 @@ describe "User with activation submodule" do
     
     it "activation success email is optional" do
       sorcery_model_property_set(:activation_success_email_method_name, nil)
-      create_new_user
       old_size = ActionMailer::Base.deliveries.size
       @user.activate!
       ActionMailer::Base.deliveries.size.should == old_size

data/spec/rails3/spec/user_brute_force_protection_spec.rb

@@ -21,13 +21,8 @@ describe "User with brute_force_protection submodule" do
       User.sorcery_config.reset!
     end
     
-    it "should respond to 'failed_logins_count'" do
-      @user.should respond_to(:failed_logins_count)
-    end
-    
-    it "should respond to 'lock_expires_at'" do
-      @user.should respond_to(:failed_logins_count)
-    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
       sorcery_model_property_set(:failed_logins_count_attribute_name, :my_count)
@@ -49,28 +44,5 @@ describe "User with brute_force_protection submodule" do
       User.sorcery_config.login_lock_time_period.should == 2.hours    
     end
   end
-
-  # ----------------- PLUGIN ACTIVATED -----------------------
-  describe User, "when activated with sorcery" do
-  
-    before(:all) do
-      sorcery_reload!([:brute_force_protection])
-    end
-  
-    before(:each) do
-      User.delete_all
-    end
-
-    # it "should increment failed_logins_count on a failed login" do
-    #   create_new_user
-    #   
-    # end
-    # 
-    # it "should set lock expiry (effectively lock user) when failed_logins_count reaches max within max period" do
-    #   create_new_user
-    #   @user.lock_expires_at.should == Time.now.utc + 30
-    # end
- 
-  end
   
 end

data/spec/rails3/spec/user_remember_me_spec.rb

@@ -13,6 +13,7 @@ describe "User with remember_me submodule" do
   describe User, "loaded plugin configuration" do
     before(:all) do
       sorcery_reload!([:remember_me])
+      create_new_user
     end
   
     after(:each) do
@@ -29,32 +30,23 @@ describe "User with remember_me submodule" do
       User.sorcery_config.remember_me_token_expires_at_attribute_name.should equal(:my_expires)
     end
     
-    it "should respond to 'remember_me!'" do
-      create_new_user
-      @user.should respond_to(:remember_me!)
-    end
+    specify { @user.should respond_to(:remember_me!) }
     
-    it "should respond to 'forget_me!'" do
-      create_new_user
-      @user.should respond_to(:forget_me!)
-    end
+    specify { @user.should respond_to(:forget_me!) }
     
     it "should generate a new token on 'remember_me!'" do
-      create_new_user
       @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
-      create_new_user
       sorcery_model_property_set(:remember_me_for, 2 * 60 * 60 * 24)
       @user.remember_me!
       @user.remember_me_token_expires_at.to_s.should == (Time.now + 2 * 60 * 60 * 24).utc.to_s
     end
     
     it "should delete the token and expiration on 'forget_me!'" do
-      create_new_user
       @user.remember_me!
       @user.remember_me_token.should_not be_nil
       @user.forget_me!