sorcery 0.7.4 → 0.8.0

data/lib/sorcery/model.rb

@@ -17,39 +17,39 @@ module Sorcery
               include InstanceMethods
               include TemporaryToken
             end
-            
+
             include_required_submodules!
 
             # This runs the options block set in the initializer on the model class.
             ::Sorcery::Controller::Config.user_config.tap{|blk| blk.call(@sorcery_config) if blk}
-            
+
             init_mongoid_support! if defined?(Mongoid) and self.ancestors.include?(Mongoid::Document)
             init_mongo_mapper_support! if defined?(MongoMapper) and self.ancestors.include?(MongoMapper::Document)
 
             init_orm_hooks!
-            
+
             @sorcery_config.after_config << :add_config_inheritance if @sorcery_config.subclasses_inherit_config
             @sorcery_config.after_config.each { |c| send(c) }
           end
-          
+
           protected
-          
-          # includes required submodules into the model class, 
+
+          # includes required submodules into the model class,
           # which usually is called User.
           def include_required_submodules!
             self.class_eval do
               @sorcery_config.submodules = ::Sorcery::Controller::Config.submodules
               @sorcery_config.submodules.each do |mod|
                 begin
-                  include Submodules.const_get(mod.to_s.split("_").map {|p| p.capitalize}.join("")) 
+                  include Submodules.const_get(mod.to_s.split("_").map {|p| p.capitalize}.join(""))
                 rescue NameError
-                  # don't stop on a missing submodule. Needed because some submodules are only defined 
+                  # don't stop on a missing submodule. Needed because some submodules are only defined
                   # in the controller side.
                 end
               end
             end
           end
-          
+
           # defines mongoid fields on the model class,
           # using 1.8.x hash syntax to perserve compatibility.
           def init_mongoid_support!
@@ -62,7 +62,7 @@ module Sorcery
               field sorcery_config.salt_attribute_name,             :type => String
             end
           end
-          
+
           # defines mongo_mapper fields on the model class,
           def init_mongo_mapper_support!
             self.class_eval do
@@ -91,42 +91,51 @@ module Sorcery
         end
       end
     end
-    
+
     module ClassMethods
       # Returns the class instance variable for configuration, when called by the class itself.
       def sorcery_config
         @sorcery_config
       end
-      
+
       # The default authentication method.
       # Takes a username and password,
       # Finds the user by the username and compares the user's password to the one supplied to the method.
       # returns the user if success, nil otherwise.
       def authenticate(*credentials)
         raise ArgumentError, "at least 2 arguments required" if credentials.size < 2
+        credentials[0].downcase! if @sorcery_config.downcase_username_before_authenticating
         user = find_by_credentials(credentials)
+
+        set_encryption_attributes()
+
         _salt = user.send(@sorcery_config.salt_attribute_name) if user && !@sorcery_config.salt_attribute_name.nil? && !@sorcery_config.encryption_provider.nil?
         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
-      
+
       # encrypt tokens using current encryption_provider.
       def encrypt(*tokens)
         return tokens.first if @sorcery_config.encryption_provider.nil?
-        
-        @sorcery_config.encryption_provider.stretches = @sorcery_config.stretches if @sorcery_config.encryption_provider.respond_to?(:stretches) && @sorcery_config.stretches
-        @sorcery_config.encryption_provider.join_token = @sorcery_config.salt_join_token if @sorcery_config.encryption_provider.respond_to?(:join_token) && @sorcery_config.salt_join_token
+
+        set_encryption_attributes()
+
         CryptoProviders::AES256.key = @sorcery_config.encryption_key
         @sorcery_config.encryption_provider.encrypt(*tokens)
       end
-      
+
       protected
-      
+
+      def set_encryption_attributes()
+        @sorcery_config.encryption_provider.stretches = @sorcery_config.stretches if @sorcery_config.encryption_provider.respond_to?(:stretches) && @sorcery_config.stretches
+        @sorcery_config.encryption_provider.join_token = @sorcery_config.salt_join_token if @sorcery_config.encryption_provider.respond_to?(:join_token) && @sorcery_config.salt_join_token
+      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
-      
+
       def add_config_inheritance
         self.class_eval do
           def self.inherited(subclass)
@@ -140,23 +149,23 @@ module Sorcery
           end
         end
       end
-      
+
     end
-    
+
     module InstanceMethods
       # Returns the class instance variable for configuration, when called by an instance.
       def sorcery_config
         self.class.sorcery_config
       end
-      
+
       # identifies whether this user is regular, i.e. we hold his credentials in our db,
       # or that he is external, and his credentials are saved elsewhere (twitter/facebook etc.).
       def external?
         send(sorcery_config.crypted_password_attribute_name).nil?
       end
-      
+
       protected
-      
+
       # creates new salt and saves it.
       # encrypts password with salt and saves it.
       def encrypt_password
@@ -169,47 +178,50 @@ module Sorcery
         config = sorcery_config
         self.send(:"#{config.password_attribute_name}=", nil)
       end
-      
+
       # calls the requested email method on the configured mailer
       # supports both the ActionMailer 3 way of calling, and the plain old Ruby object way.
       def generic_send_email(method, mailer)
         config = sorcery_config
         mail = config.send(mailer).send(config.send(method),self)
-        if defined?(ActionMailer) and config.send(mailer).superclass == ActionMailer::Base
+        if defined?(ActionMailer) and config.send(mailer).kind_of?(Class) and config.send(mailer) < ActionMailer::Base
           mail.deliver
         end
       end
     end
 
     # Each class which calls 'activate_sorcery!' receives an instance of this class.
-    # Every submodule which gets loaded may add accessors to this class so that all 
+    # Every submodule which gets loaded may add accessors to this class so that all
     # options will be configured from a single place.
     class Config
 
       attr_accessor :username_attribute_names,           # change default username attribute, for example, to use :email
                                                         # as the login.
-                                                        
+
                     :password_attribute_name,           # change *virtual* password attribute, the one which is used
                                                         # until an encrypted one is generated.
-                                                        
+
                     :email_attribute_name,              # change default email attribute.
+
+                    :downcase_username_before_authenticating, # downcase the username before trying to authenticate, default is false
+
                     :crypted_password_attribute_name,   # change default crypted_password attribute.
                     :salt_join_token,                   # what pattern to use to join the password with the salt
                     :salt_attribute_name,               # change default salt attribute.
                     :stretches,                         # how many times to apply encryption to the password.
                     :encryption_key,                    # encryption key used to encrypt reversible encryptions such as
                                                         # AES256.
-                                                        
+
                     :subclasses_inherit_config,         # make this configuration inheritable for subclasses. Useful for
                                                         # ActiveRecord's STI.
-                    
+
                     :submodules,                        # configured in config/application.rb
                     :before_authenticate,               # an array of method names to call before authentication
                                                         # completes. used internally.
-                                                        
+
                     :after_config                       # an array of method names to call after configuration by user.
                                                         # used internally.
-                    
+
       attr_reader   :encryption_provider,               # change default encryption_provider.
                     :custom_encryption_provider,        # use an external encryption class.
                     :encryption_algorithm               # encryption algorithm name. See 'encryption_algorithm=' below
@@ -220,6 +232,7 @@ module Sorcery
           :@submodules                           => [],
           :@username_attribute_names              => [:username],
           :@password_attribute_name              => :password,
+          :@downcase_username_before_authenticating => false,
           :@email_attribute_name                 => :email,
           :@crypted_password_attribute_name      => :crypted_password,
           :@encryption_algorithm                 => :bcrypt,
@@ -234,26 +247,26 @@ module Sorcery
           :@after_config                         => []
         }
         reset!
-      end     
-           
+      end
+
       # Resets all configuration options to their default values.
       def reset!
         @defaults.each do |k,v|
           instance_variable_set(k,v)
-        end       
+        end
       end
-      
+
       def username_attribute_names=(fields)
         @username_attribute_names = fields.kind_of?(Array) ? fields : [fields]
       end
-      
+
       def custom_encryption_provider=(provider)
         @custom_encryption_provider = @encryption_provider = provider
       end
-      
+
       def encryption_algorithm=(algo)
         @encryption_algorithm = algo
-        @encryption_provider = case @encryption_algorithm
+        @encryption_provider = case @encryption_algorithm.to_sym
         when :none   then nil
         when :md5    then CryptoProviders::MD5
         when :sha1   then CryptoProviders::SHA1
@@ -262,10 +275,11 @@ module Sorcery
         when :aes256 then CryptoProviders::AES256
         when :bcrypt then CryptoProviders::BCrypt
         when :custom then @custom_encryption_provider
+        else raise ArgumentError.new("Encryption algorithm supplied, #{algo}, is invalid")
         end
       end
-      
+
     end
-    
+
   end
-end
+end

data/lib/sorcery/railties/tasks.rake

@@ -3,6 +3,8 @@ require 'fileutils'
 namespace :sorcery do
   desc "Adds sorcery's initializer file"
   task :bootstrap do
+    warn "This task is obsolete.\nUse \"rails g sorcery:install\" now.\nSee README for more information."
+
     src = File.join(File.dirname(__FILE__), '..', 'initializers', 'initializer.rb')
     target = File.join(Rails.root, "config", "initializers", "sorcery.rb")
     FileUtils.cp(src, target)

data/lib/sorcery.rb

@@ -34,6 +34,10 @@ module Sorcery
           autoload :Twitter, 'sorcery/controller/submodules/external/providers/twitter'
           autoload :Facebook, 'sorcery/controller/submodules/external/providers/facebook'
           autoload :Github, 'sorcery/controller/submodules/external/providers/github'
+          autoload :Google, 'sorcery/controller/submodules/external/providers/google'
+          autoload :Liveid, 'sorcery/controller/submodules/external/providers/liveid'
+          autoload :Linkedin, 'sorcery/controller/submodules/external/providers/linkedin'
+          autoload :Vkontakte, 'sorcery/controller/submodules/external/providers/vkontakte'
         end
       end
     end
@@ -76,5 +80,5 @@ module Sorcery
     MongoMapper::Document.send(:plugin, Sorcery::Model::Adapters::MongoMapper)
   end
 
-  require 'sorcery/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'sorcery/engine' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
 end

data/sorcery.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sorcery"
-  s.version = "0.7.4"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Noam Ben Ari"]
-  s.date = "2011-10-29"
+  s.date = "2013-01-12"
   s.description = "Provides common authentication needs such as signing in/out, activating by email and resetting password."
   s.email = "nbenari@gmail.com"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -45,7 +46,11 @@ Gem::Specification.new do |s|
     "lib/sorcery/controller/submodules/external/protocols/oauth2.rb",
     "lib/sorcery/controller/submodules/external/providers/facebook.rb",
     "lib/sorcery/controller/submodules/external/providers/github.rb",
+    "lib/sorcery/controller/submodules/external/providers/google.rb",
+    "lib/sorcery/controller/submodules/external/providers/linkedin.rb",
+    "lib/sorcery/controller/submodules/external/providers/liveid.rb",
     "lib/sorcery/controller/submodules/external/providers/twitter.rb",
+    "lib/sorcery/controller/submodules/external/providers/vkontakte.rb",
     "lib/sorcery/controller/submodules/http_basic_auth.rb",
     "lib/sorcery/controller/submodules/remember_me.rb",
     "lib/sorcery/controller/submodules/session_timeout.rb",
@@ -97,6 +102,7 @@ Gem::Specification.new do |s|
     "spec/rails3/app/views/sorcery_mailer/activation_success_email.text.erb",
     "spec/rails3/app/views/sorcery_mailer/reset_password_email.html.erb",
     "spec/rails3/app/views/sorcery_mailer/reset_password_email.text.erb",
+    "spec/rails3/app/views/sorcery_mailer/send_unlock_token_email.text.erb",
     "spec/rails3/config.ru",
     "spec/rails3/config/application.rb",
     "spec/rails3/config/boot.rb",
@@ -298,7 +304,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/NoamB/sorcery"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.21"
   s.summary = "Magical authentication for Rails 3 applications"
 
   if s.respond_to? :specification_version then
@@ -306,7 +312,9 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<oauth>, ["~> 0.4.4"])
-      s.add_runtime_dependency(%q<oauth2>, ["~> 0.4.1"])
+      s.add_runtime_dependency(%q<oauth2>, ["~> 0.8.0"])
+      s.add_runtime_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<abstract>, [">= 1.0.0"])
       s.add_development_dependency(%q<rails>, [">= 3.0.0"])
       s.add_development_dependency(%q<json>, [">= 1.5.1"])
       s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
@@ -314,16 +322,18 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<simplecov>, [">= 0.3.8"])
       s.add_development_dependency(%q<timecop>, [">= 0"])
-      s.add_runtime_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
-      s.add_runtime_dependency(%q<oauth>, ["~> 0.4.4"])
-      s.add_runtime_dependency(%q<oauth2>, ["~> 0.4.1"])
+      s.add_development_dependency(%q<capybara>, [">= 0"])
+      s.add_development_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_development_dependency(%q<mongoid>, ["~> 2.4.4"])
     else
       s.add_dependency(%q<oauth>, ["~> 0.4.4"])
-      s.add_dependency(%q<oauth2>, ["~> 0.4.1"])
+      s.add_dependency(%q<oauth2>, ["~> 0.8.0"])
+      s.add_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
+      s.add_dependency(%q<abstract>, [">= 1.0.0"])
       s.add_dependency(%q<rails>, [">= 3.0.0"])
       s.add_dependency(%q<json>, [">= 1.5.1"])
       s.add_dependency(%q<rspec>, ["~> 2.5.0"])
@@ -331,17 +341,19 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<ruby-debug19>, [">= 0"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_dependency(%q<simplecov>, [">= 0.3.8"])
       s.add_dependency(%q<timecop>, [">= 0"])
-      s.add_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
-      s.add_dependency(%q<oauth>, ["~> 0.4.4"])
-      s.add_dependency(%q<oauth2>, ["~> 0.4.1"])
+      s.add_dependency(%q<capybara>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, [">= 0"])
+      s.add_dependency(%q<mongoid>, ["~> 2.4.4"])
     end
   else
     s.add_dependency(%q<oauth>, ["~> 0.4.4"])
-    s.add_dependency(%q<oauth2>, ["~> 0.4.1"])
+    s.add_dependency(%q<oauth2>, ["~> 0.8.0"])
+    s.add_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
+    s.add_dependency(%q<abstract>, [">= 1.0.0"])
     s.add_dependency(%q<rails>, [">= 3.0.0"])
     s.add_dependency(%q<json>, [">= 1.5.1"])
     s.add_dependency(%q<rspec>, ["~> 2.5.0"])
@@ -349,13 +361,13 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<ruby-debug19>, [">= 0"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<bundler>, [">= 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     s.add_dependency(%q<simplecov>, [">= 0.3.8"])
     s.add_dependency(%q<timecop>, [">= 0"])
-    s.add_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
-    s.add_dependency(%q<oauth>, ["~> 0.4.4"])
-    s.add_dependency(%q<oauth2>, ["~> 0.4.1"])
+    s.add_dependency(%q<capybara>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, [">= 0"])
+    s.add_dependency(%q<mongoid>, ["~> 2.4.4"])
   end
 end
 

data/spec/Gemfile

@@ -4,7 +4,7 @@ gem "rails", '3.0.3'
 gem 'bcrypt-ruby', :require => 'bcrypt'
 gem "sorcery", '>= 0.1.0', :path => '../'
 gem 'oauth', "~> 0.4.4"
-gem 'oauth2', "~> 0.4.1"
+gem 'oauth2', "~> 0.8.0"
 group :development do
   gem "rspec", "~> 2.5.0"
   gem 'ruby-debug19'

data/spec/Gemfile.lock

@@ -1,12 +1,10 @@
 PATH
   remote: ../
   specs:
-    sorcery (0.7.2)
+    sorcery (0.7.13)
       bcrypt-ruby (~> 3.0.0)
       oauth (~> 0.4.4)
-      oauth (~> 0.4.4)
-      oauth2 (~> 0.4.1)
-      oauth2 (~> 0.4.1)
+      oauth2 (~> 0.8.0)
 
 GEM
   remote: http://rubygems.org/
@@ -38,20 +36,20 @@ GEM
       activemodel (= 3.0.3)
       activesupport (= 3.0.3)
     activesupport (3.0.3)
-    addressable (2.2.6)
     archive-tar-minitar (0.5.2)
     arel (2.0.10)
     bcrypt-ruby (3.0.1)
     builder (2.1.2)
-    columnize (0.3.4)
+    columnize (0.3.6)
     diff-lcs (1.1.3)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    faraday (0.6.1)
-      addressable (~> 2.2.4)
-      multipart-post (~> 1.1.0)
-      rack (>= 1.1.0, < 2)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    httpauth (0.2.0)
     i18n (0.6.0)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
     mail (2.2.19)
@@ -60,14 +58,17 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
-    multi_json (1.0.3)
-    multipart-post (1.1.3)
+    multi_json (1.1.0)
+    multipart-post (1.1.5)
     oauth (0.4.5)
-    oauth2 (0.4.1)
-      faraday (~> 0.6.1)
-      multi_json (>= 0.0.5)
-    polyglot (0.3.2)
-    rack (1.2.4)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    polyglot (0.3.3)
+    rack (1.2.5)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
@@ -104,15 +105,15 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.5)
       archive-tar-minitar (>= 0.5.2)
-    simplecov (0.5.4)
-      multi_json (~> 1.0.3)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
     thor (0.14.6)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.30)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
@@ -120,7 +121,7 @@ PLATFORMS
 DEPENDENCIES
   bcrypt-ruby
   oauth (~> 0.4.4)
-  oauth2 (~> 0.4.1)
+  oauth2 (~> 0.8.0)
   rails (= 3.0.3)
   rspec (~> 2.5.0)
   ruby-debug19

data/spec/README.md

@@ -7,25 +7,25 @@ Each sample app runs a set of shared specs ( `spec/shared_examples/*_example.rb`
 Sorcery has one set of specs (`sorcery_crypto_providers_spec.rb`) that can be run outside of any of the frameworks. To run it simply:
     
     cd spec/
-    bundle install
-    rake spec
+    bundle
+    bundle exec rake spec
 
 Running Framework Specs
 -----------------------
 To run framework specs, cd into each directory, bundle, and run the specs. For example, to run the rails3 specs you would:
 
     cd spec/rails3/
-    bundle install
-    rake spec
+    bundle
+    bundle exec rake spec
 
 **Note:** the rails3_mongoid and rails3_mongo_mapper sample apps do require, well, MongoDB. Installing MongoDB on mac osx is easy with homebrew. Seeing as you're reading the readme for running specs, I'll assume you can install MongoDB on your machine. For the purpose of running these tests, I put mongod in verbose mode and in the background so I can see it log to stdout. 
 
     cd spec/rails3_mongoid
-    bundle install
+    bundle
     mongod -v &
-    rake spec
+    bundle exec rake spec
     
     cd spec/rails3_mongo_mapper
-    bundle install
+    bundle
     mongod -v &
-    rake spec
+    bundle exec rake spec

data/spec/rails3/Gemfile

@@ -1,15 +1,15 @@
 source 'http://rubygems.org'
 
+gem 'bcrypt-ruby', '~> 3.0.0'
 gem 'rails', '3.0.3'
 gem 'sqlite3-ruby', :require => 'sqlite3'
 gem "sorcery", '>= 0.1.0', :path => '../../'
 
 group :development, :test do
-  gem "rspec", "~> 2.5.0"
-  gem 'rspec-rails', "~> 2.5.0"
+  gem 'rspec-rails', "~> 2.7.0"
   gem 'ruby-debug19'
   gem 'simplecov', '>= 0.3.8', :require => false # Will install simplecov-html as a dependency
   gem 'timecop'
-  # gem 'capybara', '~> 1.1.1'
+  gem 'capybara', '~> 1.1.1'
   gem 'launchy', '~> 2.0.5'
 end