sorcery 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ece0272de9fa2ea03bbc1be9b2f9aa3b80e0f870
-  data.tar.gz: 5369015b55c79aab6aeeeae13328624a8e20b7c8
+  metadata.gz: 73519a45c58c078688dd72b3ef7dc52b2b05ba92
+  data.tar.gz: a715fe10e2de64c09d76ec93e658849dd3b9112b
 SHA512:
-  metadata.gz: 1a45a1696ebbcf7e4e8e248918389a38ea4555c263f12e290b1fdfd92c4e413d9713c29bbe98aa909ab9cb8642ff3e872a15405e6db9398afdf4f940521f68d5
-  data.tar.gz: aed312b559bbdecd335535df0814989b906d4768fe56382ae18a029f534fb0d9904e8540913e2c6dccc51de9d5e8d2096212a3dbf7f6b787df647987aa72076a
+  metadata.gz: 08d0df3e5b8970ec81233d6dbb373cdabb4ff0e219dce27c7c790756507a36d683557ca11d19b70ea8e85217646ef20259892b6e0ee55f8d35c7d25cfb8df636
+  data.tar.gz: 66cb33e9e89b23036e1470bf0b937da42e68828ecdb821bc736b471cf938c23fa9eb53911ac35050704748ebdfd1790caa27af12ee97fdd26b58c7fae4cf30f9

data/.gitignore

@@ -51,4 +51,5 @@ spec/rails_app/log/*
 *.log
 *.sqlite3
 Gemfile*.lock
+gemfiles/*.lock
 .ruby-version

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1
 
 services: mongodb
 
@@ -9,7 +10,62 @@ gemfile:
   - Gemfile
   - Gemfile.rails4
 
-script:
-  - "SORCERY_ORM=active_record bundle exec rake spec SPEC=spec/active_record"
-  - "SORCERY_ORM=mongoid bundle exec rake spec SPEC=spec/mongoid"
-  - "SORCERY_ORM=mongo_mapper bundle exec rake spec SPEC=spec/mongo_mapper"
+env:
+  - "SORCERY_ORM=active_record"
+  - "SORCERY_ORM=mongoid"
+  - "SORCERY_ORM=mongo_mapper"
+  - "SORCERY_ORM=datamapper"
+
+before_script:
+  - mysql -e 'create database sorcery_test;'
+
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: Gemfile.rails4
+      env: "SORCERY_ORM=datamapper"
+
+    - rvm: 2.0.0
+      gemfile: Gemfile.rails4
+      env: "SORCERY_ORM=datamapper"
+
+    - rvm: 2.1
+      gemfile: Gemfile.rails4
+      env: "SORCERY_ORM=datamapper"
+
+  include:
+    - rvm: 1.9.3
+      gemfile: gemfiles/mongoid-rails41.gemfile
+      env: "SORCERY_ORM=mongoid"
+
+    - rvm: 2.0.0
+      gemfile: gemfiles/mongoid-rails41.gemfile
+      env: "SORCERY_ORM=mongoid"
+
+    - rvm: 2.1
+      gemfile: gemfiles/mongoid-rails41.gemfile
+      env: "SORCERY_ORM=mongoid"
+
+    - rvm: 1.9.3
+      gemfile: gemfiles/mongo_mapper-rails41.gemfile
+      env: "SORCERY_ORM=mongo_mapper"
+
+    - rvm: 2.0.0
+      gemfile: gemfiles/mongo_mapper-rails41.gemfile
+      env: "SORCERY_ORM=mongo_mapper"
+
+    - rvm: 2.1
+      gemfile: gemfiles/mongo_mapper-rails41.gemfile
+      env: "SORCERY_ORM=mongo_mapper"
+
+    - rvm: 1.9.3
+      gemfile: gemfiles/active_record-rails41.gemfile
+      env: "SORCERY_ORM=active_record"
+
+    - rvm: 2.0.0
+      gemfile: gemfiles/active_record-rails41.gemfile
+      env: "SORCERY_ORM=active_record"
+
+    - rvm: 2.1
+      gemfile: gemfiles/active_record-rails41.gemfile
+      env: "SORCERY_ORM=active_record"

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 
-## 0.8.5 (not released)
+## 0.8.6 (not released)
+
+* `current_user` returns `nil` instead of `false` if there's no user loggd in (#493)
+* MongoMapper adapter does not override `save!` method anymore. However due to ORM's lack of support for `validate: false` in `save!`, the combination of `validate: false` and `raise_on_failure: true` is not possible in MongoMapper. The errors will not be raised in this situation. (#151)
+* Fixed rename warnings for bcrypt-ruby
+* The way Sorcery adapters are included has been changed due to problem with multiple `included` blocks error in `ActiveSupport::Concern` class (#527)
+* Session timeout works with new cookie serializer introduced in Rails 4.1
+* Rails 4.1 compatibility bugs were fixed, this version is fully supported (#538)
+* VK providers now supports `scope` option
+* Support for DataMapper added
+* Helpers for integration tests were added
+* Fixed problems with special characters in user login attributes (MongoMapper & Mongoid)
+* Fixed remaining `password_confirmation` value - it is now cleared just like `password`
+
+## 0.8.5
 * Fixed add_provider_to_user with CamelCased authentications_class model (#382)
 * Fixed unlock_token_mailer_disabled to only disable automatic mailing (#467)
 * Make send_email_* methods easier to overwrite (#473)

data/Gemfile

@@ -1,24 +1,7 @@
 source 'https://rubygems.org'
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem 'oauth', "~> 0.4.4"
-gem 'oauth2', "~> 0.8.0"
-gem 'bcrypt-ruby', "~> 3.0.0"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-
-gem 'abstract', '>= 1.0.0'
-gem "rails", "~> 3.2.15"
-gem 'json', ">= 1.7.7"
-gem "rspec", "~> 2.14.0"
-gem 'rspec-rails', "~> 2.14.0"
+gem 'rails', '~> 3.2'
 gem 'sqlite3'
-gem "yard", "~> 0.6.0"
-gem "bundler", ">= 1.1.0"
-gem 'simplecov', '>= 0.3.8', :require => false # Will install simplecov-html as a dependency
-gem 'timecop'
 
 group :mongomapper do
   gem 'mongo_mapper'
@@ -28,3 +11,11 @@ group :mongoid do
   gem 'mongoid', "~> 2.4.4"
   gem 'bson_ext'
 end
+
+group :datamapper do
+  gem 'mysql2'
+  gem 'data_mapper'
+  gem 'dm-mysql-adapter'
+end
+
+gemspec

data/Gemfile.rails4

@@ -1,16 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'oauth', "~> 0.4.4"
-gem 'oauth2', "~> 0.8.0"
-gem 'bcrypt-ruby', "~> 3.0.0"
-
-gem "rspec", "~> 2.14.0"
-gem 'rspec-rails', "~> 2.14.0"
-#gem 'ruby-debug19'
 gem 'sqlite3'
-gem "yard", "~> 0.6.0"
-gem "bundler", ">= 1.1.0"
-gem 'timecop'
 
 group :mongomapper do
   gem 'mongo_mapper', github: 'jnunemaker/mongomapper'
@@ -21,4 +11,12 @@ group :mongoid do
   gem 'bson_ext'
 end
 
+group :datamapper do
+  gem 'mysql2'
+  gem 'data_mapper'
+  gem 'dm-mysql-adapter'
+end
+
 gem 'rails', '~> 4.0.1'
+
+gemspec

data/README.md

@@ -1,19 +1,17 @@
-[<img src="https://secure.travis-ci.org/NoamB/sorcery.png"
-/>](http://travis-ci.org/NoamB/sorcery) [<img
-src="https://codeclimate.com/github/NoamB/sorcery.png"
-/>](https://codeclimate.com/github/NoamB/sorcery)
+[![Build Status](https://travis-ci.org/NoamB/sorcery.svg?branch=master)](https://travis-ci.org/NoamB/sorcery)
+[![Code Climate](https://codeclimate.com/github/NoamB/sorcery.png)](https://codeclimate.com/github/NoamB/sorcery)
 
 # sorcery
-Magical Authentication for Rails 3 and 4. Supports ActiveRecord, Mongoid and
-MongoMapper.
+Magical Authentication for Rails 3 and 4. Supports ActiveRecord,
+DataMapper, Mongoid and MongoMapper.
 
 Inspired by restful_authentication, Authlogic and Devise. Crypto code taken
 almost unchanged from Authlogic. OAuth code inspired by OmniAuth and Ryan
 Bates's railscasts about it.
 
-**Rails 4 status:** basicly it works without issues, except
-[the issue with protect_from_forgery](https://github.com/NoamB/sorcery/issues/464).
-We will release new version soon, which will be updated for Rails 4.
+**Rails 4 status:** [Sorcery 0.8.5](http://rubygems.org/gems/sorcery/versions/0.8.5) is fully tested and ready for Rails 4.0.
+
+**Rails 4.1 status:** Sorcery 0.8.6 (to be released, currently in master branch) works with Rails 4.1
 
 https://github.com/NoamB/sorcery/wiki/Simple-Password-Authentication
 
@@ -212,7 +210,8 @@ Activity Logging (see lib/sorcery/model/submodules/activity_logging.rb):
 
 
 External (see lib/sorcery/controller/submodules/external.rb):
-*   OAuth1 and OAuth2 support (currently twitter & facebook)
+*   OAuth1 and OAuth2 support (currently: Twitter, Facebook, Github, Google,
+    LinkedIn, VK, LiveID and Xing)
 *   configurable db field names and authentications table.
 
 
@@ -243,17 +242,38 @@ In short, an app that works with x.3.1 should be able to upgrade to x.3.2 with
 no code changes. The same cannot be said about upgrading to x.4.0 and above,
 however.
 
+## DataMapper Support
+
+Important notes:
+
+*   Expected to work with DM adapters: dm-mysql-adapter,
+    dm-redis-adapter.
+*   Submodules DM adapter dependent: activity_logging (dm-mysql-adapter)
+*   Usage: include DataMapper::Resource in user model, follow sorcery
+    instructions (remember to add property id, validators and accessor
+attributes such as password and password_confirmation)
+*   Option downcase__username_before_authenticating and dm-mysql, 
+    http://datamapper.lighthouseapp.com/projects/20609/tickets/1105-add-support-for-definingchanging-default-collation
+
 ## Upgrading
 
 Important notes while upgrading:
 
+*   If you are upgrading from <= **0.8.5** and you're using Sorcery test helpers,
+    you need to change the way you include them to following code:
+
+        RSpec.configure do |config|
+          config.include Sorcery::TestHelpers::Rails::Controler, type: [:controller]
+          config.include Sorcery::TestHelpers::Rails::Integration, type: [:feature]
+        end
+
 *   If are upgrading to **0.8.2** and use activity_logging feature with
     ActiveRecord, you will have to add a new column
     `last_login_from_ip_address`
     [#465](https://github.com/NoamB/sorcery/issues/465)
 *   Sinatra support existed until **v0.7.0** (including), but was dropped
     later due to being a maintenance nightmare.
-*   If upgrading from <= **0.6.1 to >= <b>0.7.0** you need to change
+*   If upgrading from <= **0.6.1 to >= **0.7.0** you need to change
     'username_attribute_name' to 'username_attribute_names' in initializer.
 *   If upgrading from <= **v0.5.1** to >= **v0.5.2** you need to explicitly
     set your user_class model in the initializer file.

data/VERSION

@@ -1 +1 @@
-0.8.2
+0.8.5

data/gemfiles/active_record-rails41.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'sqlite3'
+gem 'rails', '~> 4.1'
+
+gemspec path: '..'

data/gemfiles/mongo_mapper-rails41.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1.0'
+
+gem 'mongo_mapper', github: 'mongomapper/mongomapper'
+gem 'sqlite3'
+
+gemspec path: '..'

data/gemfiles/mongoid-rails41.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1.0'
+
+gem 'pry'
+
+gem 'mongoid', github: 'mongoid/mongoid'
+gem 'bson_ext'
+gem 'sqlite3'
+
+gemspec path: '..'

data/lib/sorcery.rb

@@ -6,6 +6,7 @@ module Sorcery
       autoload :ActiveRecord, 'sorcery/model/adapters/active_record'
       autoload :Mongoid, 'sorcery/model/adapters/mongoid'
       autoload :MongoMapper, 'sorcery/model/adapters/mongo_mapper'
+      autoload :DataMapper, 'sorcery/model/adapters/datamapper'
     end
     module Submodules
       autoload :UserActivation, 'sorcery/model/submodules/user_activation'
@@ -25,25 +26,12 @@ module Sorcery
       autoload :HttpBasicAuth, 'sorcery/controller/submodules/http_basic_auth'
       autoload :ActivityLogging, 'sorcery/controller/submodules/activity_logging'
       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 :Base, 'sorcery/controller/submodules/external/providers/base'
-          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 :Vk, 'sorcery/controller/submodules/external/providers/vk'
-          autoload :Xing, 'sorcery/controller/submodules/external/providers/xing'
-        end
-      end
     end
   end
+  module Protocols
+    autoload :Oauth, 'sorcery/protocols/oauth'
+    autoload :Oauth2, 'sorcery/protocols/oauth2'
+  end
   module CryptoProviders
     autoload :Common, 'sorcery/crypto_providers/common'
     autoload :AES256, 'sorcery/crypto_providers/aes256'
@@ -53,34 +41,38 @@ module Sorcery
     autoload :SHA256, 'sorcery/crypto_providers/sha256'
     autoload :SHA512, 'sorcery/crypto_providers/sha512'
   end
-  autoload :TestHelpers, 'sorcery/test_helpers'
   module TestHelpers
-    autoload :Rails, 'sorcery/test_helpers/rails'
     autoload :Internal, 'sorcery/test_helpers/internal'
     module Internal
       autoload :Rails, 'sorcery/test_helpers/internal/rails'
     end
+    autoload :Rails, 'sorcery/test_helpers/rails'
+    module Rails
+      autoload :Controller, 'sorcery/test_helpers/rails/controller'
+      autoload :Integration, 'sorcery/test_helpers/rails/integration'
+    end
 
   end
 
   if defined?(ActiveRecord)
-    ActiveRecord::Base.send(:include, Sorcery::Model)
-    ActiveRecord::Base.send(:include, Sorcery::Model::Adapters::ActiveRecord)
+    ActiveRecord::Base.extend Sorcery::Model
+    ActiveRecord::Base.send :include, Sorcery::Model::Adapters::ActiveRecord
   end
 
   if defined?(Mongoid)
-    Mongoid::Document.module_eval do
-      included do
-        attr_reader :new_record
-        include Sorcery::Model
-        include Sorcery::Model::Adapters::Mongoid
-      end
-    end
+    Mongoid::Document::ClassMethods.send :include, Sorcery::Model
+    Mongoid::Document::ClassMethods.send :include, Sorcery::Model::Adapters::Mongoid::ClassMethods
+    Mongoid::Document.send :include, Sorcery::Model::Adapters::Mongoid::InstanceMethods
   end
 
   if defined?(MongoMapper)
     MongoMapper::Document.send(:plugin, Sorcery::Model::Adapters::MongoMapper)
   end
 
+  if defined?(DataMapper)
+    DataMapper::Model.append_extensions(Sorcery::Model)
+    DataMapper::Model.append_inclusions(Sorcery::Model::Adapters::DataMapper)
+  end
+
   require 'sorcery/engine' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
 end

data/lib/sorcery/controller.rb

@@ -5,7 +5,7 @@ module Sorcery
         include InstanceMethods
         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.
           end
@@ -72,13 +72,12 @@ module Sorcery
       end
 
       # attempts to auto-login from the sources defined (session, basic_auth, cookie, etc.)
-      # returns the logged in user if found, false if not (using old restful-authentication trick, nil != false).
+      # returns the logged in user if found, nil if not
       def current_user
-        if @current_user == false
-          false
-        else
-          @current_user ||= login_from_session || login_from_other_sources
+        unless defined?(@current_user)
+          @current_user = login_from_session || login_from_other_sources || nil
         end
+        @current_user
       end
 
       def current_user=(user)
@@ -127,11 +126,7 @@ module Sorcery
       end
 
       def login_from_session
-        @current_user = (user_class.find(session[:user_id]) if session[:user_id]) || false
-      rescue => exception
-        return false if defined?(Mongoid) and exception.is_a?(Mongoid::Errors::DocumentNotFound)
-        return false if defined?(ActiveRecord) and exception.is_a?(ActiveRecord::RecordNotFound)
-        raise exception
+        @current_user = (user_class.find_by_id(session[:user_id]) if session[:user_id]) || nil
       end
 
       def after_login!(user, credentials = [])

data/lib/sorcery/controller/submodules/external.rb

@@ -6,21 +6,38 @@ module Sorcery
       module External
         def self.included(base)
           base.send(:include, InstanceMethods)
+
+          require 'sorcery/providers/base'
+          require 'sorcery/providers/facebook'
+          require 'sorcery/providers/twitter'
+          require 'sorcery/providers/vk'
+          require 'sorcery/providers/linkedin'
+          require 'sorcery/providers/liveid'
+          require 'sorcery/providers/xing'
+          require 'sorcery/providers/github'
+          require 'sorcery/providers/google'
+
           Config.module_eval do
             class << self
-              attr_reader :external_providers                           # external providers like twitter.
-              attr_accessor :ca_file                                    # path to ca_file. By default use a internal ca-bundle.crt.
-
-              def merge_external_defaults!
-                @defaults.merge!(:@external_providers => [],
-                                 :@ca_file => File.join(File.expand_path(File.dirname(__FILE__)), 'external/protocols/certs/ca-bundle.crt'))
-              end
+              attr_reader :external_providers
+              attr_accessor :ca_file
 
               def external_providers=(providers)
-                providers.each do |provider|
-                  include Providers.const_get(provider.to_s.split("_").map {|p| p.capitalize}.join(""))
+                @external_providers = providers
+
+                providers.each do |name|
+                  class_eval <<-E
+                    def self.#{name}
+                      @#{name} ||= Sorcery::Providers.const_get('#{name}'.to_s.capitalize).new
+                    end
+                  E
                 end
               end
+
+              def merge_external_defaults!
+                @defaults.merge!(:@external_providers => [],
+                                 :@ca_file => File.join(File.expand_path(File.dirname(__FILE__)), '../../protocols/certs/ca-bundle.crt'))
+              end
             end
             merge_external_defaults!
           end
@@ -31,9 +48,7 @@ module Sorcery
 
           # save the singleton ProviderClient instance into @provider
           def sorcery_get_provider(provider_name)
-            allowed = %w(facebook github google linkedin liveid twitter vk xing)
-            return unless allowed.include?(provider_name.to_s)
-
+            return unless Config.external_providers.include?(provider_name.to_sym)
             Config.send(provider_name.to_sym)
           end
 
@@ -121,7 +136,7 @@ module Sorcery
             # first check to see if user has a particular authentication already
             unless (current_user.send(config.authentications_class.name.underscore.pluralize).send("find_by_#{config.provider_attribute_name}_and_#{config.provider_uid_attribute_name}", provider_name, @user_hash[:uid].to_s))
               user = current_user.send(config.authentications_class.name.underscore.pluralize).build(config.provider_uid_attribute_name => @user_hash[:uid], config.provider_attribute_name => provider_name.to_s)
-              user.save(:validate => false)
+              user.sorcery_save(:validate => false)
             else
               user = false
             end
@@ -144,7 +159,7 @@ module Sorcery
             session[:incomplete_user] = {
               :provider => {config.provider_uid_attribute_name => @user_hash[:uid], config.provider_attribute_name => provider_name},
               :user_hash => attrs
-            } unless user.save
+            } unless user.sorcery_save
 
             return user
           end
@@ -181,7 +196,7 @@ module Sorcery
                 return false unless yield @user
               end
 
-              @user.save(:validate => false)
+              @user.sorcery_save(:validate => false)
               user_class.sorcery_config.authentications_class.create!({config.authentications_user_id_attribute_name => @user.id, config.provider_attribute_name => provider_name, config.provider_uid_attribute_name => @user_hash[:uid]})
             end
             @user