sorcery 0.7.0 → 0.8.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.2

data/Gemfile

@@ -1,24 +1,27 @@
-source "http://rubygems.org"
+source :rubygems
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 gem 'oauth', "~> 0.4.4"
-gem 'oauth2', "~> 0.5.1"
+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.
 group :development do
+  gem 'abstract', '>= 1.0.0'
   gem "rails", ">= 3.0.0"
   gem 'json', ">= 1.5.1"
-  gem "mongoid", "~> 2.0"
-  gem "bson_ext", "~> 1.3"
   gem "rspec", "~> 2.5.0"
   gem 'rspec-rails', "~> 2.5.0"
   gem 'ruby-debug19'
   gem 'sqlite3-ruby', :require => 'sqlite3'
   gem "yard", "~> 0.6.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
+  gem "bundler", ">= 1.1.0"
+  gem "jeweler", "~> 1.8.3"
   gem 'simplecov', '>= 0.3.8', :require => false # Will install simplecov-html as a dependency
   gem 'timecop'
+  gem 'capybara'
+  gem 'mongo_mapper'
+  gem 'mongoid', "~> 2.4.4"
 end

data/Gemfile.lock

@@ -1,103 +1,122 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.1.0)
-      actionpack (= 3.1.0)
-      mail (~> 2.3.0)
-    actionpack (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
+    abstract (1.0.0)
+    actionmailer (3.2.2)
+      actionpack (= 3.2.2)
+      mail (~> 2.4.0)
+    actionpack (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
-      i18n (~> 0.6)
-      rack (~> 1.3.2)
-      rack-cache (~> 1.0.3)
-      rack-mount (~> 0.8.2)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.0.0)
-    activemodel (3.1.0)
-      activesupport (= 3.1.0)
-      bcrypt-ruby (~> 3.0.0)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
       builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-      arel (~> 2.2.1)
+    activerecord (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-    activesupport (3.1.0)
+    activeresource (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
-    addressable (2.2.6)
     archive-tar-minitar (0.5.2)
-    arel (2.2.1)
-    bcrypt-ruby (3.0.0)
-    bson (1.3.1)
-    bson_ext (1.3.1)
+    arel (3.0.2)
+    bcrypt-ruby (3.0.1)
+    bson (1.6.1)
     builder (3.0.0)
-    columnize (0.3.4)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    columnize (0.3.6)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    faraday (0.7.4)
-      addressable (~> 2.2.6)
-      multipart-post (~> 1.1.0)
-      rack (< 2, >= 1.1.0)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    ffi (1.0.11)
     git (1.2.5)
     hike (1.2.1)
+    httpauth (0.2.0)
     i18n (0.6.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.5.4)
+      rdoc
+    journey (1.0.3)
+    json (1.6.6)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
-    mail (2.3.0)
+    mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    mongo (1.3.1)
-      bson (>= 1.3.1)
-    mongoid (2.2.0)
+    mime-types (1.18)
+    mongo (1.6.1)
+      bson (~> 1.6.1)
+    mongo_mapper (0.11.1)
       activemodel (~> 3.0)
+      activesupport (~> 3.0)
+      plucky (~> 0.4.0)
+    mongoid (2.4.7)
+      activemodel (~> 3.1)
       mongo (~> 1.3)
       tzinfo (~> 0.3.22)
-    multi_json (1.0.3)
-    multipart-post (1.1.3)
+    multi_json (1.3.2)
+    multipart-post (1.1.5)
+    nokogiri (1.5.2)
     oauth (0.4.5)
-    oauth2 (0.5.1)
-      faraday (~> 0.7.4)
-      multi_json (~> 1.0.3)
-    polyglot (0.3.2)
-    rack (1.3.3)
-    rack-cache (1.0.3)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    plucky (0.4.4)
+      mongo (~> 1.5)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
       rack (>= 0.4)
-    rack-mount (0.8.3)
-      rack (>= 1.0.0)
     rack-ssl (1.3.2)
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.1.0)
-      actionmailer (= 3.1.0)
-      actionpack (= 3.1.0)
-      activerecord (= 3.1.0)
-      activeresource (= 3.1.0)
-      activesupport (= 3.1.0)
+    rails (3.2.2)
+      actionmailer (= 3.2.2)
+      actionpack (= 3.2.2)
+      activerecord (= 3.2.2)
+      activeresource (= 3.2.2)
+      activesupport (= 3.2.2)
       bundler (~> 1.0)
-      railties (= 3.1.0)
-    railties (3.1.0)
-      actionpack (= 3.1.0)
-      activesupport (= 3.1.0)
+      railties (= 3.2.2)
+    railties (3.2.2)
+      actionpack (= 3.2.2)
+      activesupport (= 3.2.2)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
-    rake (0.9.2)
-    rdoc (3.9.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)
@@ -121,14 +140,21 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.5)
       archive-tar-minitar (>= 0.5.2)
-    simplecov (0.4.2)
-      simplecov-html (~> 0.4.4)
-    simplecov-html (0.4.5)
-    sprockets (2.0.0)
+    rubyzip (0.9.6.1)
+    selenium-webdriver (2.20.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      multi_json (~> 1.0)
+      rubyzip
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sprockets (2.1.2)
       hike (~> 1.2)
       rack (~> 1.0)
-      tilt (!= 1.3.0, ~> 1.1)
-    sqlite3 (1.3.4)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
     thor (0.14.6)
@@ -137,20 +163,25 @@ GEM
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
+    tzinfo (0.3.32)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
     yard (0.6.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bson_ext (~> 1.3)
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
+  abstract (>= 1.0.0)
+  bcrypt-ruby (~> 3.0.0)
+  bundler (>= 1.1.0)
+  capybara
+  jeweler (~> 1.8.3)
   json (>= 1.5.1)
-  mongoid (~> 2.0)
+  mongo_mapper
+  mongoid (~> 2.4.4)
   oauth (~> 0.4.4)
-  oauth2 (~> 0.5.1)
+  oauth2 (~> 0.8.0)
   rails (>= 3.0.0)
   rspec (~> 2.5.0)
   rspec-rails (~> 2.5.0)

data/README.rdoc

@@ -1,11 +1,12 @@
+{<img src="https://secure.travis-ci.org/NoamB/sorcery.png" />}[http://travis-ci.org/NoamB/sorcery]
+
 = sorcery
-Magical Authentication for Rails 3 and Sinatra.
-Supports ActiveRecord and Mongoid.
+Magical Authentication for Rails 3.
+Supports ActiveRecord, 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.
- 
 
 == Philosophy
 
@@ -28,9 +29,7 @@ Railscast: http://railscasts.com/episodes/283-authentication-with-sorcery
 
 Example Rails 3 app using sorcery: https://github.com/NoamB/sorcery-example-app
 
-Example Sinatra app using sorcery: https://github.com/NoamB/sorcery-example-app-sinatra
-
-Documentation: http://rubydoc.info/gems/sorcery/0.7.0/frames
+Documentation: http://rubydoc.info/gems/sorcery/0.8.0/frames
 
 Check out the tutorials in the github wiki!
 
@@ -84,72 +83,63 @@ Please see the tutorials in the github wiki for detailed usage information.
 
 If using bundler, first add 'sorcery' to your Gemfile:
 
-	gem "sorcery"
+    gem "sorcery"
 
-And run 
-	
-	bundle install
+And run
+
+    bundle install
 
 Otherwise simply
 
-	gem install sorcery
+    gem install sorcery
 
 
 == Rails 3 Configuration:
 
+    rails generate sorcery:install
 
-For Rails 3 create an initializer file using:
+This will generate the core migration file, the initializer file and the 'User' model class.
 
-    rake sorcery:bootstrap
+    rails generate sorcery:install remember_me reset_password
 
-This will create the file as config/initializers/sorcery.rb .
-Inside it the comments will tell you everything you need to know.
+This will generate the migrations files for remember_me and reset_password submodules
+and will create the initializer file (and add submodules to it), and create the 'User' model class.
 
-For your convenience, Sorcery includes a migrations generator for Rails, which can be used like so:
+    rails generate sorcery:install --model Person
 
-  rails g sorcery_migration [list of submodules]
+This will generate the core migration file, the initializer and change the model class
+(in the initializer and migration files) to the class 'Person' (and its pluralized version, 'people')
 
-Note: There is no migration for the session_timeout module. 
-For example, for only the core functionality use:
+    rails generate sorcery:install http_basic_auth external remember_me --migrations
 
-  rails g sorcery_migration core
+This will generate only the migration files for the specified submodules and will
+add them to the initializer file.
 
-To generate migrations for both the core AND 'remember_me' submodule:
+Inside the initializer, the comments will tell you what each setting does.
 
-  rails g sorcery_migration core remember_me
 
-These migrations use the default fields. You can choose to use these migrations or make your own tables and fields. Sorcery tries not to impose a database structure and naming scheme on your application.
+== DelayedJob Integration
 
-Finally, add sorcery to the the model that you will use for authentication:
+By default emails are sent synchronously. You can send them asynchronously by using the 
+[delayed_job gem](https://github.com/collectiveidea/delayed_job).
 
-    class User < ActiveRecord::Base
-      authenticates_with_sorcery!
-    end
-    
-== Sinatra Configuration:
-
-
-For Sinatra you'll need to create the initializer manually. You can do it in the main app file or in a separate file you require (see example in example app). The code looks as follows:
-
-    Sorcery::Controller::Config.submodules = [] # specify here the submodules you want to include
-    
-    Sorcery::Controller::Config.configure do |config|
-      config.session_timeout = 10.minutes
-      ...
-      ...
-    
-      config.user_config do |user|
-        user.username_attribute_name                      = :email
-        ...
-    	...
-    	
+After implementing the `delayed_job` into your project add the code below at the end of 
+the `config/initializers/sorcery.rb` file. After that all emails will be sent asynchronously.
+
+  module Sorcery
+    module Model
+      module InstanceMethods
+        def generic_send_email(method, mailer)
+          config = sorcery_config
+          mail = config.send(mailer).delay.send(config.send(method), self)
+        end
       end
     end
+  end
 
-Finally, to make all the code above take effect, we'll need to re-include the sorcery controller module:
 
-    include Sorcery::Controller::Adapters::Sinatra
-    include Sorcery::Controller
+== Single Table Inheritance (STI) Support
+STI is supported via a single setting in config/initializers/sorcery.rb.
 
 
 == Full Features List by module:
@@ -216,13 +206,6 @@ I've got some thoughts which include (unordered):
 Have an idea? Let me know, and it might get into the gem!
 
 
-Other stuff:
-* Improve specs speed
-* Provide an easy way to run specs after install
-* Improve documentation
-* Try to reduce the number of library methods, and find better names to some
-
-
 == Backward compatibility
 
 
@@ -238,11 +221,15 @@ The same cannot be said about upgrading to x.4.0 and above, however.
 
 Important notes while upgrading:
 
+* 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.
 
     # This line must come after the 'user config' block.
     config.user_class = User
 
+* Sinatra support existed until v0.7.0 (including), but was dropped later due to being a maintenance nightmare. 
+
+
 == Contributing to sorcery
 
 

data/Rakefile

@@ -25,9 +25,6 @@ Jeweler::Tasks.new do |gem|
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
-  gem.add_runtime_dependency 'bcrypt-ruby', '~> 3.0.0'
-  gem.add_runtime_dependency 'oauth', '~> 0.4.4'
-  gem.add_runtime_dependency 'oauth2', '~> 0.5.1'
 end
 Jeweler::RubygemsDotOrgTasks.new
 
@@ -46,11 +43,39 @@ task :default => :all_sorcery_specs
 
 desc "Run all sorcery specs"
 task :all_sorcery_specs do
+  # we need to be empty, otherwise bundler will use parent bundler.
+  env = {
+    'BUNDLE_GEMFILE' => nil,
+    'GEM_HOME'       => nil
+  }
   Dir['spec/**/Rakefile'].each do |rakefile|
     directory_name = File.dirname(rakefile)
-    sh <<-CMD
-      cd #{directory_name}
-      bundle exec rake
-    CMD
+    system(env, "cd #{directory_name} && bundle && bundle exec rake")
+  end
+end
+
+desc "Bundle all folders"
+task :bundle do
+  sh "bundle"
+  Dir['spec', 'spec/**'].each do |dir|
+    if Dir.exists?(dir) && File.exists?(dir + "/Gemfile")
+      sh <<-CMD
+        cd #{dir}
+        bundle
+      CMD
+    end
+  end
+end
+
+desc "Bundle update all folders"
+task :bundle_update do
+  sh "bundle update"
+  Dir['spec', 'spec/**'].each do |dir|
+    if Dir.exists?(dir) && File.exists?(dir + "/Gemfile")
+      sh <<-CMD
+        cd #{dir}
+        bundle update
+      CMD
+    end
   end
 end

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/lib/generators/sorcery/USAGE

@@ -0,0 +1,22 @@
+Description:
+  Generates the necessary files to get you up and running with Sorcery gem
+  
+Examples:
+  rails generate sorcery:install
+
+    This will generate the core migration file, the initializer file and the 'User' model class.
+
+  rails generate sorcery:install remember_me reset_password
+
+    This will generate the migrations files for remember_me and reset_password submodules
+    and will create the initializer file (and add submodules to it), and create the 'User' model class.
+
+  rails generate sorcery:install --model Person
+
+    This will generate the core migration file, the initializer and change the model class
+    (in the initializer and migration files) to the class 'Person' (and it's pluralized version, 'people')
+
+  rails generate sorcery:install http_basic_auth external remember_me --migrations
+
+    This will generate only the migration files for the specified submodules and will
+    add them to the initializer file.

data/lib/generators/sorcery/install_generator.rb

@@ -0,0 +1,77 @@
+require 'rails/generators/migration'
+
+module Sorcery
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path('../templates', __FILE__)
+      
+      argument :submodules, :optional => true, :type => :array, :banner => "submodules"
+      
+      class_option :model, :optional => true, :type => :string, :banner => "model",
+                   :desc => "Specify the model class name if you will use anything other than 'User'"
+                           
+      class_option :migrations, :optional => true, :type => :boolean, :banner => "migrations",
+                   :desc => "Specify if you want to add submodules to an existing model\n\t\t\t     # (will generate migrations files, and add submodules to config file)"
+      
+      
+      # Copy the initializer file to config/initializers folder.
+      def copy_initializer_file
+        template "initializer.rb", "config/initializers/sorcery.rb" unless options[:migrations]
+      end
+
+      def configure_initializer_file
+        # Add submodules to the initializer file.
+        if submodules
+          submodule_names = submodules.collect{ |submodule| ':' + submodule }
+
+          gsub_file "config/initializers/sorcery.rb", /submodules = \[.*\]/ do |str|
+            current_submodule_names = (str =~ /\[(.*)\]/ ? $1 : '').delete(' ').split(',')
+            "submodules = [#{(current_submodule_names | submodule_names).join(', ')}]"
+          end
+        end
+
+        # Generate the model and add 'authenticates_with_sorcery!' unless you passed --migrations
+        unless options[:migrations]
+          generate "model #{model_class_name} --skip-migration"
+          insert_into_file "app/models/#{model_class_name.underscore}.rb", "  authenticates_with_sorcery!\n", :after => "class #{model_class_name} < ActiveRecord::Base\n"
+        end
+      end
+
+      # Copy the migrations files to db/migrate folder
+      def copy_migration_files
+        # Copy core migration file in all cases except when you pass --migrations.
+        return unless defined?(Sorcery::Generators::InstallGenerator::ActiveRecord)
+        migration_template "migration/core.rb", "db/migrate/sorcery_core.rb" unless options[:migrations]
+
+        if submodules
+          submodules.each do |submodule|
+            unless submodule == "http_basic_auth" || submodule == "session_timeout"
+              migration_template "migration/#{submodule}.rb", "db/migrate/sorcery_#{submodule}.rb"
+            end
+          end
+        end
+        
+
+      end
+      
+      # Define the next_migration_number method (necessary for the migration_template method to work)
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          sleep 1 # make sure each time we get a different timestamp
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+      private
+
+      # Either return the model passed in a classified form or return the default "User".
+      def model_class_name
+        options[:model] ? options[:model].classify : "User"
+      end
+    end
+  end
+end