sorcery 0.1.1 → 0.1.2

data/README.rdoc

@@ -8,15 +8,36 @@ Crypto code taken almost unchanged from Authlogic.
 
 https://github.com/NoamB/sorcery-example-app
 
-== Current Features:
+== Full Features List by module:
 
-* Basic Login/Logout.
-* Password encryption with configurable algorithm.
+Core (see lib/sorcery/model/model.rb and lib/sorcery/controller/controller.rb): 
+* login/logout, optional redirect on login to where the user tried to reach before, 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.
+
+User Activation (see lib/sorcery/model/submodules/user_activation.rb):
 * User activation by email with optional success email.
+* configurable attribute names.
+* configurable mailer.
+* Optionally prevent active users to login.
+
+Password Reset (see lib/sorcery/model/submodules/password_reset.rb):
 * Reset password with email verification.
+* configurable mailer, method name, and attribute name.
+
+Remember Me (see lib/sorcery/model/submodules/remember_me.rb):
 * Remember me with configurable expiration.
+* configurable attribute names.
+
+Session Timeout (see lib/sorcery/controller/submodules/session_timeout.rb):
 * Configurable session timeout.
+* Optionally session timeout will be calculated from last user action.
+
+Brute Force Protection (see lib/sorcery/controller/submodules/brute_force_protection.rb):
 * Brute force login hammering protection.
+* configurable logins before ban, logins within time period before ban, ban time and ban action.
+
+Other:
 * Modular design, load only the modules you need.
 * 100% TDD'd code, 100% test coverage.
 
@@ -80,7 +101,7 @@ For example:
 2. app/models/user.rb (or another model of your choice)
 
 	activate_sorcery! do |config|
-  	  config.sorcery_mailer = MyMailer
+  	  config.user_activation_mailer = MyMailer
 	  config.username_attribute_name = :email
 	end
 
@@ -92,45 +113,17 @@ For example:
 
 Also check the migrations in the example app to see what database fields are expected.
 
-
-
 The configuration options vary with the modules you've chosen to use.
 
-== Basic Configuration (in Model):
-
-see lib/sorcery/model.rb
-
-== User Activation Configuration (in Model):
-
-see lib/sorcery/model/submodules/user_activation.rb
-
-== Remember Me Configuration (in Model):
-
-see lib/sorcery/model/submodules/remember_me.rb
-
-== Password Reset Configuration (in Model):
-
-see lib/sorcery/model/submodules/password_reset.rb
-
-
-
-== Session Timeout Configuration (in Controller or config/application.rb):
-
-see lib/sorcery/controller/submodules/session_timeout.rb
-
-== Brute Force Protection Configuration (in Controller or config/application.rb):
-
-see lib/sorcery/controller/submodules/brute_force_protection.rb
-
-
 
 == Contributing to sorcery
 
-I can use help of any kind, be it comments on code (code review), suggestions, features, bug reports, bug fixes and even a donation.
+I can use help of any kind, be it comments on code, suggestions, features, bug reports, bug fixes, documentation and if you like, a donation.
 
 == Contact
 
 	email: nbenari@gmail.com
+	twitter: @nbenari
 	
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/sorcery/crypto_providers/bcrypt.rb

@@ -46,10 +46,10 @@ module Sorcery
         # This is the :cost option for the BCrpyt library. The higher the cost the more secure it is and the longer is take the generate a hash. By default this is 10.
         # Set this to whatever you want, play around with it to get that perfect balance between security and performance.
         def cost
-          @cost ||= 10
+          @cost ||= 1
         end
         attr_writer :cost
-        #alias :stretches= :cost=
+        alias :stretches= :cost=
         
         # Creates a BCrypt hash for the password passed.
         def encrypt(*tokens)

data/lib/sorcery/model/submodules/password_reset.rb

@@ -6,14 +6,14 @@ module Sorcery
         def self.included(base)
           base.sorcery_config.class_eval do
             attr_accessor :reset_password_code_attribute_name,        # reset password code attribute name.
-                          :sorcery_mailer,                            # mailer class. Needed.
+                          :reset_password_mailer,                     # mailer class. Needed.
                           :reset_password_email_method_name           # reset password email method on your mailer class.
 
           end
           
           base.sorcery_config.instance_eval do
             @defaults.merge!(:@reset_password_code_attribute_name => :reset_password_code,
-                             :@sorcery_mailer                     => nil,
+                             :@reset_password_mailer              => nil,
                              :@reset_password_email_method_name   => :reset_password_email)
 
             reset!
@@ -35,8 +35,8 @@ module Sorcery
         
         module ClassMethods
           def validate_mailer_defined
-            msg = "To use password_reset submodule, you must define a mailer (config.sorcery_mailer = YourMailerClass)."
-            raise ArgumentError, msg if @sorcery_config.sorcery_mailer == nil
+            msg = "To use password_reset submodule, you must define a mailer (config.reset_password_mailer = YourMailerClass)."
+            raise ArgumentError, msg if @sorcery_config.reset_password_mailer == nil
           end
         end
         
@@ -46,7 +46,7 @@ module Sorcery
             self.send(:"#{config.reset_password_code_attribute_name}=", generate_random_code)
             self.class.transaction do
               self.save!(:validate => false)
-              generic_send_email(:reset_password_email_method_name)
+              generic_send_email(:reset_password_email_method_name, :reset_password_mailer)
             end
           end
 

data/lib/sorcery/model/submodules/user_activation.rb

@@ -10,7 +10,7 @@ module Sorcery
           base.sorcery_config.class_eval do
             attr_accessor :activation_state_attribute_name,         # the attribute name to hold activation state (active/pending).
                           :activation_code_attribute_name,          # the attribute name to hold activation code (sent by email).
-                          :sorcery_mailer,                          # your mailer class. Needed.
+                          :user_activation_mailer,                  # your mailer class. Needed.
                           :activation_needed_email_method_name,     # activation needed email method on your mailer class.
                           :activation_success_email_method_name,    # activation success email method on your mailer class.
                           :prevent_non_active_users_to_login        # do you want to prevent or allow users that did not activate by email to login?
@@ -19,7 +19,7 @@ module Sorcery
           base.sorcery_config.instance_eval do
             @defaults.merge!(:@activation_state_attribute_name      => :activation_state,
                              :@activation_code_attribute_name       => :activation_code,
-                             :@sorcery_mailer                       => nil,
+                             :@user_activation_mailer               => nil,
                              :@activation_needed_email_method_name  => :activation_needed_email,
                              :@activation_success_email_method_name => :activation_success_email,
                              :@prevent_non_active_users_to_login    => true)
@@ -41,8 +41,8 @@ module Sorcery
         
         module ClassMethods
           def validate_mailer_defined
-            msg = "To use user_activation submodule, you must define a mailer (config.sorcery_mailer = YourMailerClass)."
-            raise ArgumentError, msg if @sorcery_config.sorcery_mailer == nil
+            msg = "To use user_activation submodule, you must define a mailer (config.user_activation_mailer = YourMailerClass)."
+            raise ArgumentError, msg if @sorcery_config.user_activation_mailer == nil
           end
         end
         
@@ -65,11 +65,11 @@ module Sorcery
           end
 
           def send_activation_needed_email!
-            generic_send_email(:activation_needed_email_method_name) unless sorcery_config.activation_needed_email_method_name.nil?
+            generic_send_email(:activation_needed_email_method_name, :user_activation_mailer) unless sorcery_config.activation_needed_email_method_name.nil?
           end
 
           def send_activation_success_email!
-            generic_send_email(:activation_success_email_method_name) unless sorcery_config.activation_success_email_method_name.nil?
+            generic_send_email(:activation_success_email_method_name, :user_activation_mailer) unless sorcery_config.activation_success_email_method_name.nil?
           end
           
           def prevent_non_active_login

data/lib/sorcery/model.rb

@@ -95,10 +95,10 @@ module Sorcery
       
       # 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)
+      def generic_send_email(method, mailer)
         config = sorcery_config
-        mail = config.sorcery_mailer.send(config.send(method),self)
-        if defined?(ActionMailer) and config.sorcery_mailer.superclass == ActionMailer::Base
+        mail = config.send(mailer).send(config.send(method),self)
+        if defined?(ActionMailer) and config.send(mailer).superclass == ActionMailer::Base
           mail.deliver
         end
       end

data/sorcery.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sorcery}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Noam Ben Ari"]

data/spec/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gem "rails", '3.0.3'
 gem 'bcrypt-ruby', :require => 'bcrypt'
-gem "sorcery", '0.1.0', :path => '../../../'
+gem "sorcery", '0.1.1', :path => '../../../'
 
 group :development do
   gem 'rspec'

data/spec/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../../
   specs:
-    sorcery (0.1.0)
+    sorcery (0.1.1)
 
 GEM
   remote: http://rubygems.org/
@@ -105,4 +105,4 @@ DEPENDENCIES
   rspec
   ruby-debug19
   simplecov (>= 0.3.8)
-  sorcery (= 0.1.0)!
+  sorcery (= 0.1.1)!

data/spec/rails3/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gem 'rails', '3.0.3'
 gem 'sqlite3-ruby', :require => 'sqlite3'
-gem "sorcery", '0.1.0', :path => '../../../'
+gem "sorcery", '0.1.1', :path => '../../../'
 gem 'bcrypt-ruby', '~> 2.1.4', :require => 'bcrypt'
   
 group :development do

data/spec/rails3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../../
   specs:
-    sorcery (0.1.0)
+    sorcery (0.1.1)
 
 GEM
   remote: http://rubygems.org/
@@ -112,5 +112,5 @@ DEPENDENCIES
   rspec-rails
   ruby-debug19
   simplecov (>= 0.3.8)
-  sorcery (= 0.1.0)!
+  sorcery (= 0.1.1)!
   sqlite3-ruby

data/spec/rails3/user_activation_spec.rb

@@ -13,12 +13,12 @@ describe "User with activation submodule" do
   # ----------------- PLUGIN CONFIGURATION -----------------------
   describe User, "loaded plugin configuration" do
     before(:all) do
-      plugin_model_configure([:user_activation], :sorcery_mailer => ::SorceryMailer)
+      plugin_model_configure([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
   
     after(:each) do
       User.sorcery_config.reset!
-      plugin_model_configure([:user_activation], :sorcery_mailer => ::SorceryMailer)
+      plugin_model_configure([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
     
     it "should enable configuration option 'activation_state_attribute_name'" do
@@ -31,9 +31,9 @@ describe "User with activation submodule" do
       User.sorcery_config.activation_code_attribute_name.should equal(:code)    
     end
     
-    it "should enable configuration option 'sorcery_mailer'" do
-      plugin_set_model_config_property(:sorcery_mailer, TestMailer)
-      User.sorcery_config.sorcery_mailer.should equal(TestMailer)    
+    it "should enable configuration option 'user_activation_mailer'" do
+      plugin_set_model_config_property(:user_activation_mailer, TestMailer)
+      User.sorcery_config.user_activation_mailer.should equal(TestMailer)    
     end
     
     it "should enable configuration option 'activation_needed_email_method_name'" do
@@ -54,7 +54,7 @@ describe "User with activation submodule" do
   # ----------------- ACTIVATION PROCESS -----------------------
   describe User, "activation process" do
     before(:all) do
-      plugin_model_configure([:user_activation], :sorcery_mailer => ::SorceryMailer)
+      plugin_model_configure([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
     
     it "should generate an activation code on registration" do
@@ -130,7 +130,7 @@ describe "User with activation submodule" do
 
   describe User, "prevent non-active login feature" do
     before(:all) do
-      plugin_model_configure([:user_activation], :sorcery_mailer => ::SorceryMailer)
+      plugin_model_configure([:user_activation], :user_activation_mailer => ::SorceryMailer)
     end
     
     it "should not allow a non-active user to authenticate" do

data/spec/rails3/user_password_reset_spec.rb

@@ -13,7 +13,7 @@ describe "User with password_reset submodule" do
   describe User, "loaded plugin configuration" do
   
     before(:all) do
-      plugin_model_configure([:password_reset], :sorcery_mailer => ::SorceryMailer)
+      plugin_model_configure([:password_reset], :reset_password_mailer => ::SorceryMailer)
     end
   
     after(:each) do
@@ -30,7 +30,7 @@ describe "User with password_reset submodule" do
   describe User, "when activated with sorcery" do
   
     before(:all) do
-      plugin_model_configure([:password_reset], :sorcery_mailer => ::SorceryMailer)
+      plugin_model_configure([:password_reset], :reset_password_mailer => ::SorceryMailer)
     end
   
     before(:each) do

metadata

@@ -2,7 +2,7 @@
 name: sorcery
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Noam Ben Ari