sorcery 0.6.1 → 0.7.1

data/Gemfile

@@ -4,6 +4,7 @@ source "http://rubygems.org"
 #   gem "activesupport", ">= 2.3.5"
 gem 'oauth', "~> 0.4.4"
 gem 'oauth2', "~> 0.4.1"
+gem 'mongo_mapper'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -1,41 +1,39 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.1.0)
-      actionpack (= 3.1.0)
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
       mail (~> 2.3.0)
-    actionpack (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       i18n (~> 0.6)
       rack (~> 1.3.2)
-      rack-cache (~> 1.0.3)
+      rack-cache (~> 1.1)
       rack-mount (~> 0.8.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.0.0)
-    activemodel (3.1.0)
-      activesupport (= 3.1.0)
-      bcrypt-ruby (~> 3.0.0)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
       arel (~> 2.2.1)
       tzinfo (~> 0.3.29)
-    activeresource (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-    activesupport (3.1.0)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
       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)
+    bson (1.4.1)
+    bson_ext (1.4.1)
     builder (3.0.0)
     columnize (0.3.4)
     diff-lcs (1.1.3)
@@ -43,7 +41,7 @@ GEM
     faraday (0.6.1)
       addressable (~> 2.2.4)
       multipart-post (~> 1.1.0)
-      rack (< 2, >= 1.1.0)
+      rack (>= 1.1.0, < 2)
     git (1.2.5)
     hike (1.2.1)
     i18n (0.6.0)
@@ -51,7 +49,7 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    json (1.5.4)
+    json (1.6.1)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
     mail (2.3.0)
@@ -59,11 +57,15 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
-    mongo (1.3.1)
-      bson (>= 1.3.1)
-    mongoid (2.2.0)
+    mongo (1.4.1)
+      bson (= 1.4.1)
+    mongo_mapper (0.9.2)
       activemodel (~> 3.0)
-      mongo (~> 1.3)
+      activesupport (~> 3.0)
+      plucky (~> 0.3.8)
+    mongoid (2.3.2)
+      activemodel (~> 3.1)
+      mongo (~> 1.4)
       tzinfo (~> 0.3.22)
     multi_json (1.0.3)
     multipart-post (1.1.3)
@@ -71,9 +73,11 @@ GEM
     oauth2 (0.4.1)
       faraday (~> 0.6.1)
       multi_json (>= 0.0.5)
+    plucky (0.3.8)
+      mongo (~> 1.3)
     polyglot (0.3.2)
-    rack (1.3.2)
-    rack-cache (1.0.3)
+    rack (1.3.5)
+    rack-cache (1.1)
       rack (>= 0.4)
     rack-mount (0.8.3)
       rack (>= 1.0.0)
@@ -81,23 +85,24 @@ GEM
       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.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
       bundler (~> 1.0)
-      railties (= 3.1.0)
-    railties (3.1.0)
-      actionpack (= 3.1.0)
-      activesupport (= 3.1.0)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
     rake (0.9.2)
-    rdoc (3.9.4)
+    rdoc (3.11)
+      json (~> 1.4)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)
@@ -121,13 +126,14 @@ 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)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sprockets (2.0.3)
       hike (~> 1.2)
       rack (~> 1.0)
-      tilt (!= 1.3.0, ~> 1.1)
+      tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.4)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
@@ -137,7 +143,7 @@ GEM
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
+    tzinfo (0.3.30)
     yard (0.6.8)
 
 PLATFORMS
@@ -148,6 +154,7 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
   json (>= 1.5.1)
+  mongo_mapper
   mongoid (~> 2.0)
   oauth (~> 0.4.4)
   oauth2 (~> 0.4.1)

data/README.rdoc

@@ -1,11 +1,11 @@
 = 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
 
@@ -24,12 +24,11 @@ Hopefully, I've achieved this. If not, let me know.
 
 == Useful Links:
 
+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.6.0/frames
+Documentation: http://rubydoc.info/gems/sorcery/0.7.1/frames
 
 Check out the tutorials in the github wiki!
 
@@ -42,9 +41,10 @@ Below is a summary of the library methods. Most method names are self explaining
   # core
   require_login # this is a before filter
   login(username,password,remember_me = false)
+  auto_login(user)# login without credentials
   logout
-  logged_in?
-  current_user
+  logged_in?      # available to view
+  current_user    # available to view
   redirect_back_or_to # used when a user tries to access a page while logged out, is asked to login, and we want to return him back to the page he originally wanted.
   @user.external? # external users, such as facebook/twitter etc.
   User.authenticates_with_sorcery!
@@ -61,6 +61,7 @@ Below is a summary of the library methods. Most method names are self explaining
   create_from(provider) # create the user in the local app db.
 
   # remember me
+  auto_login(user, should_remember=false)  # login without credentials, optional remember_me
   remember_me!
   forget_me!
 
@@ -94,53 +95,26 @@ Otherwise simply
 
 == Rails 3 Configuration:
 
+    rails generate sorcery:install
 
-For Rails 3 create an initializer file using:
-
-    rake sorcery:bootstrap
-
-This will create the file as config/initializers/sorcery.rb .
-Inside it the comments will tell you everything you need to know.
-
-For your convenience, Sorcery includes a migrations generator for Rails, which can be used like so:
-
-  rails g sorcery_migration [list of submodules]
-
-For example, for only the core functionality use:
-
-  rails g sorcery_migration core
-
-To generate migrations for both the core AND 'remember_me' submodule:
+This will generate the core migration file, the initializer file and the 'User' model class.
 
-  rails g sorcery_migration core remember_me
+    rails generate sorcery:install remember_me reset_password
 
-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.
+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
 
-== Sinatra Configuration:
+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')
 
+    rails generate sorcery:install http_basic_auth external remember_me --migrations
 
-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
-      ...
-      ...
+This will generate only the migration files for the specified submodules and will
+add them to the initializer file.
     
-      config.user_config do |user|
-        user.username_attribute_name                      = :email
-        ...
-    	...
-    	
-      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
+Inside the initializer, the comments will tell you what each setting does.
 
 
 == Full Features List by module:
@@ -150,6 +124,7 @@ Core (see lib/sorcery/model.rb and lib/sorcery/controller.rb):
 * login/logout, optional return user to requested url on login, configurable redirect for non-logged-in users.
 * password encryption, algorithms: bcrypt(default), md5, sha1, sha256, sha512, aes256, custom(yours!), none. Configurable stretches and salt.
 * configurable attribute names for username, password and email.
+* allow multiple fields to serve as username.
 
 User Activation (see lib/sorcery/model/submodules/user_activation.rb):
 * User activation by email with optional success email.
@@ -206,13 +181,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
 
 
@@ -228,11 +196,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

@@ -54,3 +54,29 @@ task :all_sorcery_specs do
     CMD
   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.6.1
+0.7.1

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,71 @@
+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
+          str = submodules.collect{ |submodule| ':' + submodule + ', ' }
+          str.last.delete!(", ")
+          
+          gsub_file "config/initializers/sorcery.rb", /submodules = \[\]/, "submodules = [#{str.join()}]"
+        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}.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
+        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
+        
+        # Copy core migration file in all cases except when you pass --migrations.
+        migration_template "migration/core.rb", "db/migrate/sorcery_core.rb" unless options[:migrations]
+      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
+          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 capitalized form or return the default "User".
+      def model_class_name
+        options[:model] ? options[:model].capitalize : "User"
+      end
+    end
+  end
+end