salted_login_generator 1.1.1 → 2.0.0

data/salted_login_generator.rb

@@ -1,5 +1,16 @@
+class Sandbox
+  def sandbox_binding
+    binding
+  end
+end
+
 class SaltedLoginGenerator < LocalizationGenerator #Rails::Generator::NamedBase
+  def create_sandbox
+    sandbox = Sandbox.new
+    sandbox
+  end
   def manifest
+    
     record do |m|
       m.dependency 'localization', [ARGV[1]]
 
@@ -15,6 +26,7 @@ class SaltedLoginGenerator < LocalizationGenerator #Rails::Generator::NamedBase
       # Model class, unit test, fixtures, and example schema.
       m.template "user.rb", File.join("app/models", class_path, "#{file_name}.rb")
       m.template "notify.rb", File.join("app/models", class_path, "#{file_name}_notify.rb")
+      m.directory "db/migrate"
       m.template "mock_notify.rb", "test/mocks/test/#{file_name}_notify.rb"
       m.file "mock_time.rb", "test/mocks/test/time.rb"
 
@@ -22,13 +34,16 @@ class SaltedLoginGenerator < LocalizationGenerator #Rails::Generator::NamedBase
       m.template "users.yml", "test/fixtures/#{plural_name}.yml"
       m.template "user_model.erbsql", "db/user_model.erbsql"
 
+
+      m.migration_template("migration.rb", "db/migrate", {:migration_file_name => "create_#{plural_name}"})
+
       # Configuration and miscellaneous
       m.template "login_environment.rb", "config/environments/#{file_name}_environment.rb"
       m.file "create_db", "script/create_db"
       m.template "en.yaml", "lang/en.yaml"
 
       # Layout and stylesheet.
-      m.template "scaffold:layout.rhtml", "app/views/layouts/scaffold.rhtml"
+      m.template "scaffold:layout.html.erb", "app/views/layouts/scaffold.rhtml"
       m.template "scaffold:style.css", "public/stylesheets/scaffold.css"
 
       # Views. 

data/templates/README

@@ -4,30 +4,48 @@ After generating the login system, edit your app/controllers/application.rb
 file. The beginning of your ApplicationController should look something like
 this:
 
-  require '<%= file_name %>_system'
+require 'localization' 
+require '<%= file_name %>_system'
+require 'environment.rb'
 
-  class ApplicationController < ActionController::Base
-    include <%= class_name %>System
-    helper :<%= singular_name %>
-    model :<%= singular_name %>
-    before_filter :login_required
+class ApplicationController < ActionController::Base
+  include Localization
+  include <%= class_name %>System
+  require_dependency <%= singular_name %>
 
-After you have done the modifications the the ApplicationController and its
-helper, you can import the <%= singular_name %> model into the database. This
-model is meant as an example and you should extend it. If you just want to get
-things up and running you can find some create table syntax in
-db/user_model.sql.
+And optionally, if you want to protect all actions of all controllers with login :
+  before_filter :login_required
+
+And the ApplicationHelper (app/helpers/application_helper.rb) should contain :
 
-You also need to add the following at the end of your config/environment.rb
-file:
+module ApplicationHelper
+  include Localization
+end
 
+In the config/environment.rb, add the following lines after the final end :
+
+require 'environments/localization_environment'
+require 'localization'
+Localization::load_localized_strings
 require 'environments/<%= singular_name %>_environment'
 
-Under the 'enviroments' subdirectory, you'll find <%= singular_name %>_environment.rb.
+You can import the <%= singular_name %> model into the database. This
+model is meant as an example and you should extend it. If you just want to get
+things up and running you can run the generated migration or create the table using the syntax in db/user_model.sql.
+
+Under the 'environments' subdirectory, you'll find <%= singular_name %>_environment.rb.
 Edit this file as necessary.
 
-Also, you must properly configure ActionMailer for your mail settings. For
-example, I have the following in config/environments/development.rb (for a
+To make sure the test pass, check that these lines are present in test/test_helper.rb :
+
+self.use_transactional_fixtures = false
+self.use_instantiated_fixtures  = true
+
+Also, you must properly configure ActionMailer for your mail settings in config/environments/development.rb  :
+It may be simply (Unix or Mac OS X):
+ActionMailer::Base.delivery_method=:sendmail
+
+Or for example, I have the following in config/environments/development.rb (for a
 .Mac account, and without my username and password, obviously):
 
 ActionMailer::Base.server_settings = {
@@ -52,13 +70,14 @@ You need a database table corresponding to the <%= class_name %> model. Note
 the table type for MySQL. Whatever DB you use, it must support transactions.
 If it does not, the functional tests will not work properly, nor will the
 application in the face of failures during certain DB creates and updates.
+A migration file (mysql specific) will be created by the generate command.
+You can change it to your specific database adapter :
 
   mysql syntax:
   CREATE TABLE <%= plural_name %> (
     id INTEGER UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
     login VARCHAR(80) NOT NULL,
     salted_password VARCHAR(40) NOT NULL,
-    email VARCHAR(60) NOT NULL,
     firstname VARCHAR(40),
     lastname VARCHAR(40),
     salt CHAR(40) NOT NULL,
@@ -75,7 +94,6 @@ application in the face of failures during certain DB creates and updates.
     id SERIAL PRIMARY KEY
     login VARCHAR(80) NOT NULL,
     salted_password VARCHAR(40) NOT NULL,
-    email VARCHAR(60) NOT NULL,
     firstname VARCHAR(40),
     lastname VARCHAR(40),
     salt CHAR(40) NOT NULL,
@@ -92,7 +110,6 @@ application in the face of failures during certain DB creates and updates.
     id INTEGER PRIMARY KEY,
     login VARCHAR(80) NOT NULL,
     salted_password VARCHAR(40) NOT NULL,
-    email VARCHAR(60) NOT NULL,
     firstname VARCHAR(40),
     lastname VARCHAR(40),
     salt CHAR(40) NOT NULL,
@@ -136,9 +153,9 @@ How do I...
 
   ... access the user who is currently logged in
 
-  A: You can get the <%= singular_name %> object from the session using @session['<%= singular_name %>']
+  A: You can get the <%= singular_name %> object from the session using session['<%= singular_name %>']
      Example: 
-       Welcome <%%= @session['<%= singular_name %>'].name %> 
+       Welcome <%%= session['<%= singular_name %>'].name %> 
 
   ... restrict access to only a few methods? 
   
@@ -149,10 +166,10 @@ How do I...
      
   ... check if a user is logged-in in my views?
   
-  A: @session['<%= singular_name %>'] will tell you. Here is an example helper which you can use to make this more pretty:
+  A: session['<%= singular_name %>'] will tell you. Here is an example helper which you can use to make this more pretty:
      Example: 
        def <%= singular_name %>?
-         !@session['<%= singular_name %>'].nil?
+         !session['<%= singular_name %>'].nil?
        end
 
   ... return a user to the page they came from before logging in?
@@ -185,6 +202,7 @@ automatically on startup.
 
 == Changelog
 
+2.0.0 Removed email field (the login IS now the email). Now runs with rails 2.0
 1.0.9 Fixed hardcoded generator name (in controller test and schema) and README
 1.0.8 Generator/schema fixes and some README fixes/improvements
 1.0.7 Fixed bad bug with missing attr_accessor :new_password in user class

data/templates/_view_edit.rhtml

@@ -5,7 +5,6 @@
     <%%= form_input changeable(<%= singular_name %>, "firstname"), "firstname" %>
     <%%= form_input changeable(<%= singular_name %>, "lastname"), "lastname" %>
     <%%= form_input changeable(<%= singular_name %>, "login"), "login", :size => 30 %><br/>
-    <%%= form_input changeable(<%= singular_name %>, "email"), "email" %>
     <%% if submit %>
       <%%= form_input :submit_button, <%= singular_name %>.new_record? ? 'signup' : 'change_settings', :class => 'two_columns' %>
     <%% end %>

data/templates/controller.rb

@@ -1,31 +1,31 @@
 class <%= class_name %>Controller < ApplicationController
-  model   :<%= singular_name %>
+  before_filter :login_required, :only => [:welcome,:change_password]
   layout  'scaffold'
 
   def login
     return if generate_blank
-    @<%= singular_name %> = <%= class_name %>.new(@params['<%= singular_name %>'])
-    if @session['<%= singular_name %>'] = <%= class_name %>.authenticate(@params['<%= singular_name %>']['login'], @params['<%= singular_name %>']['password'])
+    @<%= singular_name %> = <%= class_name %>.new(params['<%= singular_name %>'])
+    if session['<%= singular_name %>'] = <%= class_name %>.authenticate(params['<%= singular_name %>']['login'], params['<%= singular_name %>']['password'])
       flash['notice'] = l(:<%= singular_name %>_login_succeeded)
       redirect_back_or_default :action => 'welcome'
     else
-      @login = @params['<%= singular_name %>']['login']
+      @login = params['<%= singular_name %>']['login']
       flash.now['message'] = l(:<%= singular_name %>_login_failed)
     end
   end
 
   def signup
     return if generate_blank
-    @params['<%= singular_name %>'].delete('form')
-    @<%= singular_name %> = <%= class_name %>.new(@params['<%= singular_name %>'])
+    params['<%= singular_name %>'].delete('form')
+    @<%= singular_name %> = <%= class_name %>.new(params['<%= singular_name %>'])
     begin
-      <%= class_name %>.transaction(@<%= singular_name %>) do
+      <%= class_name %>.transaction do
         @<%= singular_name %>.new_password = true
         if @<%= singular_name %>.save
           key = @<%= singular_name %>.generate_security_token
           url = url_for(:action => 'welcome')
           url += "?<%= singular_name %>[id]=#{@<%= singular_name %>.id}&key=#{key}"
-          <%= class_name %>Notify.deliver_signup(@<%= singular_name %>, @params['<%= singular_name %>']['password'], url)
+          <%= class_name %>Notify.deliver_signup(@<%= singular_name %>, params['<%= singular_name %>']['password'], url)
           flash['notice'] = l(:<%= singular_name %>_signup_succeeded)
           redirect_to :action => 'login'
         end
@@ -36,19 +36,19 @@ class <%= class_name %>Controller < ApplicationController
   end  
   
   def logout
-    @session['<%= singular_name %>'] = nil
+    session['<%= singular_name %>'] = nil
     redirect_to :action => 'login'
   end
 
   def change_password
     return if generate_filled_in
-    @params['<%= singular_name %>'].delete('form')
+    params['<%= singular_name %>'].delete('form')
     begin
-      <%= class_name %>.transaction(@<%= singular_name %>) do
-        @<%= singular_name %>.change_password(@params['<%= singular_name %>']['password'], @params['<%= singular_name %>']['password_confirmation'])
+      <%= class_name %>.transaction do
+        @<%= singular_name %>.change_password(params['<%= singular_name %>']['password'], params['<%= singular_name %>']['password_confirmation'])
         if @<%= singular_name %>.save
-          <%= class_name %>Notify.deliver_change_password(@<%= singular_name %>, @params['<%= singular_name %>']['password'])
-          flash.now['notice'] = l(:<%= singular_name %>_updated_password, "#{@<%= singular_name %>.email}")
+          <%= class_name %>Notify.deliver_change_password(@<%= singular_name %>, params['<%= singular_name %>']['password'])
+          flash.now['notice'] = l(:<%= singular_name %>_updated_password, "#{@<%= singular_name %>.login}")
         end
       end
     rescue
@@ -68,18 +68,18 @@ class <%= class_name %>Controller < ApplicationController
     return if generate_blank
 
     # Handle the :post
-    if @params['<%= singular_name %>']['email'].empty?
+    if params['<%= singular_name %>']['login'].nil?
       flash.now['message'] = l(:<%= singular_name %>_enter_valid_email_address)
-    elsif (<%= singular_name %> = <%= class_name %>.find_by_email(@params['<%= singular_name %>']['email'])).nil?
-      flash.now['message'] = l(:<%= singular_name %>_email_address_not_found, "#{@params['<%= singular_name %>']['email']}")
+    elsif (<%= singular_name %> = <%= class_name %>.find_by_login(params['<%= singular_name %>']['login'])).nil?
+      flash.now['message'] = l(:<%= singular_name %>_email_address_not_found, "#{params['<%= singular_name %>']['login']}")
     else
       begin
-        <%= class_name %>.transaction(<%= singular_name %>) do
+        <%= class_name %>.transaction do
           key = <%= singular_name %>.generate_security_token
           url = url_for(:action => 'change_password')
           url += "?<%= singular_name %>[id]=#{<%= singular_name %>.id}&key=#{key}"
           <%= class_name %>Notify.deliver_forgot_password(<%= singular_name %>, url)
-          flash['notice'] = l(:<%= singular_name %>_forgotten_password_emailed, "#{@params['<%= singular_name %>']['email']}")
+          flash['notice'] = l(:<%= singular_name %>_forgotten_password_emailed, "#{params['<%= singular_name %>']['login']}")
           unless <%= singular_name %>?
             redirect_to :action => 'login'
             return
@@ -87,21 +87,21 @@ class <%= class_name %>Controller < ApplicationController
           redirect_back_or_default :action => 'welcome'
         end
       rescue
-        flash.now['message'] = l(:<%= singular_name %>_forgotten_password_email_error, "#{@params['<%= singular_name %>']['email']}")
+        flash.now['message'] = l(:<%= singular_name %>_forgotten_password_email_error, "#{params['<%= singular_name %>']['login']}")
       end
     end
   end
 
   def edit
     return if generate_filled_in
-    if @params['<%= singular_name %>']['form']
-      form = @params['<%= singular_name %>'].delete('form')
+    if params['<%= singular_name %>']['form']
+      form = params['<%= singular_name %>'].delete('form')
       begin
         case form
         when "edit"
           changeable_fields = ['firstname', 'lastname']
-          params = @params['<%= singular_name %>'].delete_if { |k,v| not changeable_fields.include?(k) }
-          @<%= singular_name %>.attributes = params
+          p = params['<%= singular_name %>'].delete_if { |k,v| not changeable_fields.include?(k) }
+          @<%= singular_name %>.attributes = p
           @<%= singular_name %>.save
         when "change_password"
           change_password
@@ -115,33 +115,40 @@ class <%= class_name %>Controller < ApplicationController
   end
 
   def delete
-    @<%= singular_name %> = @session['<%= singular_name %>']
+    @<%= singular_name %> = session['<%= singular_name %>']
     begin
       if <%= class_name %>System::CONFIG[:delayed_delete]
-        <%= class_name %>.transaction(@<%= singular_name %>) do
+        <%= class_name %>.transaction do
           key = @<%= singular_name %>.set_delete_after
           url = url_for(:action => 'restore_deleted')
           url += "?<%= singular_name %>[id]=#{@<%= singular_name %>.id}&key=#{key}"
           <%= class_name %>Notify.deliver_pending_delete(@<%= singular_name %>, url)
         end
       else
+        session['<%= singular_name %>'] = nil;
         destroy(@<%= singular_name %>)
       end
       logout
     rescue
-      flash.now['message'] = l(:<%= singular_name %>_delete_email_error, "#{@<%= singular_name %>['email']}")
+      flash.now['message'] = l(:<%= singular_name %>_delete_email_error, "#{@<%= singular_name %>['login']}")
       redirect_back_or_default :action => 'welcome'
     end
   end
 
   def restore_deleted
-    @<%= singular_name %> = @session['<%= singular_name %>']
-    @<%= singular_name %>.deleted = 0
-    if not @<%= singular_name %>.save
-      flash.now['notice'] = l(:<%= singular_name %>_restore_deleted_error, "#{@<%= singular_name %>['login']}")
-      redirect_to :action => 'login'
+    @<%= singular_name %> = <%= class_name %>.find_by_id(params['<%= singular_name %>']['id'])
+    if(@<%= singular_name %>) 
+      @<%= singular_name %>.deleted = 0
+      if @<%= singular_name %>.token_expired? or params['key'] != @<%= singular_name %>.security_token or not @<%= singular_name %>.save
+        flash.now['notice'] = l(:<%= singular_name %>_restore_deleted_error, "#{@<%= singular_name %>['login']}")
+        redirect_to :action => 'login'
+      else
+        session['<%= singular_name %>'] = @<%= singular_name %>
+        redirect_to :action => 'welcome'
+      end
     else
-      redirect_to :action => 'welcome'
+      flash.now['notice'] = l(:<%= singular_name %>_restore_deleted_error, "")
+      redirect_to :action => 'login'      
     end
   end
 
@@ -166,7 +173,7 @@ class <%= class_name %>Controller < ApplicationController
 
   # Generate a template <%= singular_name %> for certain actions on get
   def generate_blank
-    case @request.method
+    case request.method
     when :get
       @<%= singular_name %> = <%= class_name %>.new
       render
@@ -177,8 +184,8 @@ class <%= class_name %>Controller < ApplicationController
 
   # Generate a template <%= singular_name %> for certain actions on get
   def generate_filled_in
-    @<%= singular_name %> = @session['<%= singular_name %>']
-    case @request.method
+    @<%= singular_name %> = session['<%= singular_name %>']
+    case request.method
     when :get
       render
       return true