sorcery 0.2.1 → 0.4.0

data/lib/sorcery/model/submodules/{oauth.rb → external.rb}

@@ -1,9 +1,9 @@
 module Sorcery
   module Model
     module Submodules
-      # This submodule helps you login users from OAuth providers such as Twitter.
+      # This submodule helps you login users from external providers such as Twitter.
       # This is the model part which handles finding the user using access tokens.
-      # For the controller options see Sorcery::Controller::Oauth.
+      # For the controller options see Sorcery::Controller::External.
       #
       # Socery assumes (read: requires) you will create external users in the same table where you keep your regular users,
       # but that you will have a separate table for keeping their external authentication data,
@@ -11,7 +11,7 @@ module Sorcery
       #
       # External users will have a null crypted_password field, since we do not hold their password.
       # They will not be sent activation emails on creation.
-      module Oauth
+      module External
         def self.included(base)
           base.sorcery_config.class_eval do
             attr_accessor :authentications_class,

data/lib/sorcery/model.rb

@@ -9,11 +9,13 @@ module Sorcery
     def self.included(klass)
       klass.class_eval do
         class << self
-          def activate_sorcery!
+          def authenticates_with_sorcery!
             @sorcery_config = Config.new
             self.class_eval do
               extend ClassMethods # included here, before submodules, so they can be overriden by them.
               include InstanceMethods
+              
+              # set the user_class for the controller methods which call it
               ::Sorcery::Controller::Config.user_class = self
               @sorcery_config.submodules = ::Sorcery::Controller::Config.submodules
               @sorcery_config.submodules.each do |mod|
@@ -25,7 +27,7 @@ module Sorcery
               end
             end
             
-            yield @sorcery_config if block_given?
+            ::Sorcery::Controller::Config.user_config.tap{|blk| blk.call(@sorcery_config) if blk}
             
             self.class_eval do
               attr_accessor @sorcery_config.password_attribute_name
@@ -56,12 +58,6 @@ module Sorcery
         user if user && @sorcery_config.before_authenticate.all? {|c| user.send(c)} && credentials_match?(user.send(@sorcery_config.crypted_password_attribute_name),credentials[1],_salt)
       end
       
-      # Calls the configured encryption provider to compare the supplied password with the encrypted one.
-      def credentials_match?(crypted, *tokens)
-        return crypted == tokens.join if @sorcery_config.encryption_provider.nil?
-        @sorcery_config.encryption_provider.matches?(crypted, *tokens)
-      end
-      
       # encrypt tokens using current encryption_provider.
       def encrypt(*tokens)
         return tokens.first if @sorcery_config.encryption_provider.nil?
@@ -71,6 +67,15 @@ module Sorcery
         CryptoProviders::AES256.key = @sorcery_config.encryption_key if @sorcery_config.encryption_algorithm == :aes256
         @sorcery_config.encryption_provider.encrypt(*tokens)
       end
+      
+      protected
+      
+      # Calls the configured encryption provider to compare the supplied password with the encrypted one.
+      def credentials_match?(crypted, *tokens)
+        return crypted == tokens.join if @sorcery_config.encryption_provider.nil?
+        @sorcery_config.encryption_provider.matches?(crypted, *tokens)
+      end
+      
     end
     
     module InstanceMethods

data/lib/sorcery/railties/tasks.rake

@@ -0,0 +1,10 @@
+require 'fileutils'
+
+namespace :sorcery do
+  desc "Adds sorcery's initializer file"
+  task :bootstrap do
+    src = File.join(File.dirname(__FILE__), '..', 'initializers', 'initializer.rb')
+    target = File.join(Rails.root, "config", "initializers", "sorcery.rb")
+    FileUtils.cp(src, target)
+  end
+end

data/lib/sorcery/sinatra.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Base.send(:include, Sorcery::Model) if defined?(ActiveRecord)
+if defined?(Sinatra::Base)
+  Sinatra::Base.send(:include, Sorcery::Controller::Adapters::Sinatra)
+  Sinatra::Base.send(:include, Sorcery::Controller)
+end

data/lib/sorcery/test_helpers/rails.rb

@@ -0,0 +1,54 @@
+module Sorcery
+  module TestHelpers
+    module Rails
+      SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS = [:register_last_activity_time_to_db, :deny_banned_user, :validate_session]
+      
+      def sorcery_reload!(submodules = [], options = {})
+        reload_user_class
+
+        # return to no-module configuration
+        ::Sorcery::Controller::Config.init!
+        ::Sorcery::Controller::Config.reset!
+
+        # remove all plugin before_filters so they won't fail other tests.
+        # I don't like this way, but I didn't find another.
+        # hopefully it won't break until Rails 4.
+        ApplicationController._process_action_callbacks.delete_if {|c| SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS.include?(c.filter) }
+
+        # configure
+        ::Sorcery::Controller::Config.submodules = submodules
+        ::Sorcery::Controller::Config.user_class = nil
+        ActionController::Base.send(:include,::Sorcery::Controller)
+
+        ::Sorcery::Controller::Config.user_config do |user|
+          options.each do |property,value|
+            user.send(:"#{property}=", value)
+          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)
+      end
+      
+      def login_user(user = nil)
+        user ||= @user
+        subject.send(:login_user,user)
+        subject.send(:after_login!,user,[user.username,'secret'])
+      end
+
+      def logout_user
+        subject.send(:logout)
+      end
+
+      def clear_user_without_logout
+        subject.instance_variable_set(:@current_user,nil)
+      end
+    end
+  end
+end

data/lib/sorcery/test_helpers/sinatra.rb

@@ -0,0 +1,128 @@
+module Sorcery
+  module TestHelpers
+    module Sinatra
+      
+      class MyApp
+        class << self
+          def new
+            return this
+          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)
+          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 = {}
+          end
+        end
+
+        def [](key)
+          @data[key]
+        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
+        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
+
+        # return to no-module configuration
+        ::Sorcery::Controller::Config.init!
+        ::Sorcery::Controller::Config.reset!
+
+        # 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)
+          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)
+      end
+    end
+  end
+end

data/lib/sorcery/test_helpers.rb

@@ -1,7 +1,25 @@
 module Sorcery
+  # This file will be included in the spec_helper file.
   module TestHelpers
-    SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS = [:register_last_activity_time_to_db, :deny_banned_user, :validate_session]
-
+    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)
@@ -16,62 +34,12 @@ module Sorcery
       @user
     end
     
-    def login_user(user = nil)
-      user ||= @user
-      subject.send(:login_user,user)
-      subject.send(:after_login!,user,[user.username,'secret'])
-    end
-
-    def logout_user
-      subject.send(:logout)
-    end
-
-    def clear_user_without_logout
-      subject.instance_variable_set(:@current_user,nil)
-    end
-
-    def sorcery_reload!(submodules = [], options = {})
-      reload_user_class
-
-      # return to no-module configuration
-      ::Sorcery::Controller::Config.init!
-      ::Sorcery::Controller::Config.reset!
-
-      # remove all plugin before_filters so they won't fail other tests.
-      # I don't like this way, but I didn't find another.
-      # hopefully it won't break until Rails 4.
-      ApplicationController._process_action_callbacks.delete_if {|c| SUBMODUELS_AUTO_ADDED_CONTROLLER_FILTERS.include?(c.filter) }
-
-      # configure
-      ::Sorcery::Controller::Config.submodules = submodules
-      ::Sorcery::Controller::Config.user_class = nil
-      ActionController::Base.send(:include,::Sorcery::Controller)
-
-      User.activate_sorcery! do |config|
-        options.each do |property,value|
-          config.send(:"#{property}=", value)
-        end
-      end
-    end
-
     def sorcery_model_property_set(property, *values)
       User.class_eval do
         sorcery_config.send(:"#{property}=", *values)
       end
     end
-
-    def sorcery_controller_property_set(property, value)
-      ApplicationController.activate_sorcery! do |config|
-        config.send(:"#{property}=", value)
-      end
-    end
     
-    def sorcery_controller_oauth_property_set(provider, property, value)
-      ApplicationController.activate_sorcery! do |config|
-        config.send(provider).send(:"#{property}=", value)
-      end
-    end
-
     private
 
     # reload user class between specs

data/lib/sorcery.rb

@@ -8,7 +8,7 @@ module Sorcery
       autoload :RememberMe, 'sorcery/model/submodules/remember_me'
       autoload :ActivityLogging, 'sorcery/model/submodules/activity_logging'
       autoload :BruteForceProtection, 'sorcery/model/submodules/brute_force_protection'
-      autoload :Oauth, 'sorcery/model/submodules/oauth'
+      autoload :External, 'sorcery/model/submodules/external'
     end
   end
   autoload :Controller, 'sorcery/controller'
@@ -19,18 +19,24 @@ module Sorcery
       autoload :BruteForceProtection, 'sorcery/controller/submodules/brute_force_protection'
       autoload :HttpBasicAuth, 'sorcery/controller/submodules/http_basic_auth'
       autoload :ActivityLogging, 'sorcery/controller/submodules/activity_logging'
-      autoload :Oauth, 'sorcery/controller/submodules/oauth'
-      module Oauth
-        autoload :Oauth1, 'sorcery/controller/submodules/oauth/oauth1'
-        autoload :Oauth2, 'sorcery/controller/submodules/oauth/oauth2'
+      autoload :External, 'sorcery/controller/submodules/external'
+      module External
+        module Protocols
+          autoload :Oauth1, 'sorcery/controller/submodules/external/protocols/oauth1'
+          autoload :Oauth2, 'sorcery/controller/submodules/external/protocols/oauth2'
+        end
         module Providers
-          autoload :Twitter, 'sorcery/controller/submodules/oauth/providers/twitter'
-          autoload :Facebook, 'sorcery/controller/submodules/oauth/providers/facebook'
+          autoload :Twitter, 'sorcery/controller/submodules/external/providers/twitter'
+          autoload :Facebook, 'sorcery/controller/submodules/external/providers/facebook'
         end
       end
     end
+    module Adapters
+      autoload :Sinatra, 'sorcery/controller/adapters/sinatra'
+    end
   end
   module CryptoProviders
+    autoload :Common, 'sorcery/crypto_providers/common'
     autoload :AES256, 'sorcery/crypto_providers/aes256'
     autoload :BCrypt, 'sorcery/crypto_providers/bcrypt'
     autoload :MD5,    'sorcery/crypto_providers/md5'
@@ -39,6 +45,11 @@ module Sorcery
     autoload :SHA512, 'sorcery/crypto_providers/sha512'
   end
   autoload :TestHelpers, 'sorcery/test_helpers'
+  module TestHelpers
+    autoload :Rails, 'sorcery/test_helpers/rails'
+    autoload :Sinatra, 'sorcery/test_helpers/sinatra'
+  end
   
   require 'sorcery/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'sorcery/sinatra' if defined?(Sinatra)
 end