openid_fu_generator 0.0.1

data/templates/functional_test.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= controller_file_name %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
+  # Be sure to include AuthenticatedTestHelper in test/test_helper.rb instead
+  # Then, you can remove it from this and the units test.
+  include AuthenticatedTestHelper
+
+  fixtures :<%= table_name %>
+
+  def setup
+    @controller = <%= controller_class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  def test_should_login_and_redirect
+    post :create, :email => 'quentin@example.com', :password => 'test'
+    assert session[:<%= file_name %>]
+    assert_response :redirect
+  end
+
+  def test_should_fail_login_and_not_redirect
+    post :create, :email => 'quentin@example.com', :password => 'bad password'
+    assert_nil session[:<%= file_name %>]
+    assert_response :success
+  end
+
+  def test_should_logout
+    login_as :quentin
+    get :destroy
+    assert_nil session[:<%= file_name %>]
+    assert_response :redirect
+  end
+
+  def test_should_remember_me
+    post :create, :email => 'quentin@example.com',
+      :password => 'test', :remember_me => "1"
+    assert_not_nil @response.cookies["auth_token"]
+  end
+
+  def test_should_not_remember_me
+    post :create, :email => 'quentin@example.com',
+      :password => 'test', :remember_me => "0"
+    assert_nil @response.cookies["auth_token"]
+  end
+  
+  def test_should_delete_token_on_logout
+    login_as :quentin
+    get :destroy
+    assert_equal @response.cookies["auth_token"], []
+  end
+
+  def test_should_login_with_cookie
+    <%= table_name %>(:quentin).remember_me
+    @request.cookies["auth_token"] = cookie_for(:quentin)
+    get :new
+    assert @controller.send(:logged_in?)
+  end
+
+  def test_should_fail_expired_cookie_login
+    <%= table_name %>(:quentin).remember_me
+    <%= table_name %>(:quentin).update_attribute :remember_token_expires_at, 5.minutes.ago
+    @request.cookies["auth_token"] = cookie_for(:quentin)
+    get :new
+    assert !@controller.send(:logged_in?)
+  end
+
+  def test_should_fail_cookie_login
+    <%= table_name %>(:quentin).remember_me
+    @request.cookies["auth_token"] = auth_token('invalid_auth_token')
+    get :new
+    assert !@controller.send(:logged_in?)
+  end
+
+  protected
+    def auth_token(token)
+      CGI::Cookie.new('name' => 'auth_token', 'value' => token)
+    end
+    
+    def cookie_for(<%= file_name %>)
+      auth_token <%= table_name %>(<%= file_name %>).remember_token
+    end
+end

data/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= controller_class_name %>Helper
+end

data/templates/login.html.erb

@@ -0,0 +1,20 @@
+<h2>Sign in with OpenID</h2>
+<%%= render :partial => "<%= controller_file_name %>/open_id_form" %>
+
+<p>If you don't already have an OpenID account you can easily create one at <%%= link_to 'MyOpenID', 'http://www.myopenid.com' -%>.</p>
+
+<h2>Or use your email/password</h2>
+<%% form_tag <%= controller_singular_name %>_path do -%>
+  <p><label for="email">email</label><br/>
+  <%%= text_field_tag 'email' %></p>
+
+  <p><label for="password">Password</label><br/>
+  <%%= password_field_tag 'password' %></p>
+
+  <!-- Uncomment this if you want this functionality
+  <p><label for="remember_me">Remember me:</label>
+  <%%= check_box_tag 'remember_me' %></p>
+  -->
+
+  <p><%%= submit_tag 'Log in' %></p>
+<%% end -%>

data/templates/migration.rb

@@ -0,0 +1,55 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %>, :force => true do |t|
+      t.string :nickname
+      t.string :email
+      t.string :claimed_id
+      t.string :crypted_password, :limit => 40
+      t.string :salt, :limit => 40
+      t.string :remember_token
+      t.datetime :remember_token_expires_at
+      t.string :open_id_claimed_identifier
+      <% if options[:include_activation] %>
+      t.string :activation_code, :limit => 40
+      t.datetime :activated_at
+      <% end %>
+      <% unless options[:exclude_personal_identity] %>
+      # Common properties among SREG and AX
+      t.string :fullname
+      t.string :birth_date
+      t.integer :gender, :limit => 1
+      t.string :postcode
+      t.string :country
+      t.string :language
+      t.string :timezone
+      <% end %>
+      t.timestamps
+    end
+
+    create_table :open_id_associations, :force => true do |t|
+      t.binary :server_url
+      t.string :handle
+      t.binary :secret
+      t.integer :issued
+      t.integer :lifetime
+      t.string :assoc_type
+
+      t.timestamps
+    end
+
+    create_table :open_id_nonces, :force => true do |t|
+      t.string :server_url, :null => false
+      t.integer :timestamp, :null => false
+      t.string :salt, :null => false
+
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+    drop_table :open_id_associations
+    drop_table :open_id_nonces
+  end
+end

data/templates/model.rb

@@ -0,0 +1,92 @@
+require 'digest/sha1'
+class <%= class_name %> < ActiveRecord::Base
+  # Virtual attribute for the unencrypted password
+  attr_accessor :password
+
+  validates_presence_of     :email
+  validates_presence_of     :password,                   :if => :password_required?
+  validates_presence_of     :password_confirmation,      :if => :password_required?
+  validates_length_of       :password, :within => 4..40, :if => :password_required?
+  validates_confirmation_of :password,                   :if => :password_required?
+  validates_length_of       :email,    :within => 3..100
+  validates_uniqueness_of   :email, :case_sensitive => false
+  before_save :encrypt_password
+  <% if options[:include_activation] %> before_create :make_activation_code <% end %>
+  <% if options[:include_activation] %>
+  # Activates the user in the database.
+  def activate
+    @activated = true
+    self.attributes = {:activated_at => Time.now.utc, :activation_code => nil}
+    save(false)
+  end
+
+  def activated?
+    !! activation_code.nil?
+  end
+
+  # Returns true if the user has just been activated.
+  def recently_activated?
+    @activated
+  end <% end %>
+  # Authenticates a user by their email and unencrypted password.  Returns the user or nil.
+  def self.authenticate(email, password)
+    u = <% if options[:include_activation] %>find :first, :conditions => ['email = ? and activated_at IS NOT NULL', email]<% else %>find_by_email(email)<% end %> # need to get the salt
+    u && u.authenticated?(password) ? u : nil
+  end
+
+  # Encrypts some data with the salt.
+  def self.encrypt(password, salt)
+    Digest::SHA1.hexdigest("--#{salt}--#{password}--")
+  end
+
+  # Encrypts the password with the user salt
+  def encrypt(password)
+    self.class.encrypt(password, salt)
+  end
+
+  def authenticated?(password)
+    crypted_password == encrypt(password)
+  end
+
+  def remember_token?
+    remember_token_expires_at && Time.now.utc < remember_token_expires_at 
+  end
+
+  # These create and unset the fields required for remembering users between browser closes
+  def remember_me
+    remember_me_for 2.weeks
+  end
+
+  def remember_me_for(time)
+    remember_me_until time.from_now.utc
+  end
+
+  def remember_me_until(time)
+    self.remember_token_expires_at = time
+    self.remember_token            = encrypt("#{email}--#{remember_token_expires_at}")
+    save(false)
+  end
+
+  def forget_me
+    self.remember_token_expires_at = nil
+    self.remember_token            = nil
+    save(false)
+  end
+
+  protected
+    # before filter 
+    def encrypt_password
+      return if password.blank?
+      self.salt = Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{email}--") if new_record?
+      self.crypted_password = encrypt(password)
+    end
+    
+    def password_required?
+      claimed_id.nil? && (crypted_password.blank? || !password.blank?)
+    end
+
+    <% if options[:include_activation] %>
+    def make_activation_code
+      self.activation_code = Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join )
+    end <% end %>
+end

data/templates/model_controller.rb

@@ -0,0 +1,30 @@
+class <%= model_controller_class_name %>Controller < ApplicationController
+  # Be sure to include AuthenticationSystem in Application Controller instead
+  include AuthenticatedSystem
+  # If you want "remember me" functionality, add this before_filter to Application Controller
+  before_filter :login_from_cookie
+
+  # render new.rhtml
+  def new
+  end
+
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+    @<%= file_name %>.save!
+    self.current_<%= file_name %> = @<%= file_name %>
+    redirect_back_or_default('/')
+    flash[:notice] = "Thanks for signing up!"
+  rescue ActiveRecord::RecordInvalid
+    render :action => 'new'
+  end
+<% if options[:include_activation] %>
+  def activate
+    self.current_<%= file_name %> = <%= class_name %>.find_by_activation_code(params[:activation_code])
+    if logged_in? && !current_<%= file_name %>.activated?
+      current_<%= file_name %>.activate
+      flash[:notice] = "Signup complete!"
+    end
+    redirect_back_or_default('/')
+  end
+<% end %>
+end

data/templates/model_functional_test.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= model_controller_file_name %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= model_controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= model_controller_class_name %>ControllerTest < Test::Unit::TestCase
+  # Be sure to include AuthenticatedTestHelper in test/test_helper.rb instead
+  # Then, you can remove it from this and the units test.
+  include AuthenticatedTestHelper
+
+  fixtures :<%= table_name %>
+
+  def setup
+    @controller = <%= model_controller_class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  def test_should_allow_signup
+    assert_difference "<%= class_name %>.count" do
+      create_<%= file_name %>
+      assert_response :redirect
+    end
+  end
+
+  def test_should_require_password_on_signup
+    assert_no_difference "<%= class_name %>.count" do
+      create_<%= file_name %>(:password => nil)
+      assert assigns(:<%= file_name %>).errors.on(:password)
+      assert_response :success
+    end
+  end
+
+  def test_should_require_password_confirmation_on_signup
+    assert_no_difference "<%= class_name %>.count" do
+      create_<%= file_name %>(:password_confirmation => nil)
+      assert assigns(:<%= file_name %>).errors.on(:password_confirmation)
+      assert_response :success
+    end
+  end
+
+  def test_should_require_email_on_signup
+    assert_no_difference "<%= class_name %>.count" do
+      create_<%= file_name %>(:email => nil)
+      assert assigns(:<%= file_name %>).errors.on(:email)
+      assert_response :success
+    end
+  end
+  <% if options[:include_activation] %>
+  def test_should_activate_user
+    assert_nil <%= class_name %>.authenticate('aaron', 'test')
+    get :activate, :activation_code => <%= table_name %>(:aaron).activation_code
+    assert_redirected_to '/'
+    assert_not_nil flash[:notice]
+    assert_equal <%= table_name %>(:aaron), <%= class_name %>.authenticate('aaron', 'test')
+  end <% end %>
+
+  protected
+    def create_<%= file_name %>(options = {})
+      post :create, :<%= file_name %> => { :nickname => 'quire', :email => 'quire@example.com', 
+        :password => 'quire', :password_confirmation => 'quire' }.merge(options)
+    end
+end

data/templates/model_helper.rb

@@ -0,0 +1,2 @@
+module <%= model_controller_class_name %>Helper
+end

data/templates/notifier.rb

@@ -0,0 +1,25 @@
+class <%= class_name %>Notifier < ActionMailer::Base
+  def signup_notification(<%= file_name %>)
+    setup_email(<%= file_name %>)
+    @subject    += 'Please activate your new account'
+  <% if options[:include_activation] %>
+    @body[:url]  = "http://YOURSITE/activate/#{<%= file_name %>.activation_code}"
+  <% else %>
+    @body[:url]  = "http://YOURSITE/login/" <% end %>
+  end
+  
+  def activation(<%= file_name %>)
+    setup_email(<%= file_name %>)
+    @subject    += 'Your account has been activated!'
+    @body[:url]  = "http://YOURSITE/"
+  end
+  
+  protected
+    def setup_email(<%= file_name %>)
+      @recipients  = "#{<%= file_name %>.email}"
+      @from        = "ADMINEMAIL"
+      @subject     = "[YOURSITE] "
+      @sent_on     = Time.now
+      @body[:<%= file_name %>] = <%= file_name %>
+    end
+end

data/templates/notifier_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= file_name %>_notifier'
+
+class <%= class_name %>NotifierTest < Test::Unit::TestCase
+  FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures'
+  CHARSET = "utf-8"
+
+  include ActionMailer::Quoting
+
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+
+    @expected = TMail::Mail.new
+    @expected.set_content_type "text", "plain", { "charset" => CHARSET }
+  end
+
+  def test_dummy_test
+    #do nothing
+  end
+
+  private
+    def read_fixture(action)
+      IO.readlines("#{FIXTURES_PATH}/<%= file_name %>_notifier/#{action}")
+    end
+
+    def encode(subject)
+      quoted_printable(subject, CHARSET)
+    end
+end

data/templates/observer.rb

@@ -0,0 +1,11 @@
+class <%= class_name %>Observer < ActiveRecord::Observer
+  def after_create(<%= file_name %>)
+    <%= class_name %>Notifier.deliver_signup_notification(<%= file_name %>)
+  end
+
+  def after_save(<%= file_name %>)
+  <% if options[:include_activation] %>
+    <%= class_name %>Notifier.deliver_activation(<%= file_name %>) if <%= file_name %>.recently_activated?
+  <% end %>
+  end
+end

data/templates/open_id_form.html.erb

@@ -0,0 +1,13 @@
+<%% form_tag begin_<%= controller_singular_name %>_path do -%>
+  <p>
+    <label>
+      Identity URL:
+      <%%= text_field_tag :open_id_claimed_id, nil, :style => 'width:250px' %>
+    </label>
+    <%%= submit_tag :Verify %>
+  </p>
+  <!-- Uncomment this if you want this functionality
+  <p><label for="remember_me">Remember me:</label>
+  <%%= check_box_tag 'remember_me' %></p>
+  -->
+<%% end -%>