constellation-authentication 0.0.1

data/app/controllers/application_controller.rb

@@ -0,0 +1,71 @@
+class ApplicationController < ActionController::Base
+
+  helper_method :current_user_session, :current_user
+
+protected
+  
+  # Returns the current user session
+  def current_user_session
+    return @current_user_session if defined?(@current_user_session)
+    @current_user_session = UserSession.find
+  end
+
+  # Returns the currently logged in user, or nil if the user is not logged in.
+  def current_user
+    return @current_user if defined?(@current_user)
+    @current_user = current_user_session && current_user_session.user
+  end
+
+  # A class level shortcut to declaritively define a before filter that requires
+  # the current user to be logged in.
+  def self.require_user(options = {})
+    before_filter :require_user, options
+  end
+
+  # A class level shortcut to declaritively define a before filter that requires
+  # the current user to be logged out.
+  def self.require_no_user(options = {})
+    before_filter :require_no_user, options
+  end
+  
+  # The instance level method that can be a before filter to require a logged in user.
+  # 
+  # config.constellation.authentication.require_user_flash determines the flash key, the default is :notice
+  # config.constellation.authentication.require_user_redirection determines where the user is redirected, the default is user_sessions#new
+  # The locale's constellation.authentication.require_user key is the flash message and can be configured or translated at will
+  def require_user(options = {})
+    unless current_user
+      store_location
+      flash[Rails.application.config.constellation.authentication.require_user_flash] = t('constellation.authentication.require_user')
+      redirect_to Rails.application.config.constellation.authentication.require_user_redirection
+      return false
+    end
+  end
+
+  # The instance level method that can be a before filter to require a logged out user.
+  #
+  # config.constellation.authentication.require_no_user_flash determines the flash key, the default is :notice
+  # config.constellation.authentication.require_no_user_redirection determines where the user is redirected, the default is '/'
+  # The locale's constellation.authentication.require_no_user key is the flash message and can be configured or translated at will
+  def require_no_user(options = {})
+    if current_user
+      store_location
+      flash[Rails.application.config.constellation.authentication.require_no_user_flash] = t('constellation.authentication.require_no_user')
+      redirect_to Rails.application.config.constellation.authentication.require_no_user_redirection
+      return false
+    end
+  end
+  
+  # A method to store the currently requested URI in the session so that after logging
+  # in the user can be redirected to the page they were previously trying to access.
+  def store_location
+    session[:constellation_stored_location] = request.fullpath
+  end
+  
+  # If a previously requested URI was stored, this redirects the user to that page and
+  # clears the session variable; if not the user is redirected to the parameter passed.
+  def redirect_back_or_default(default)
+    redirect_to(session[:constellation_stored_location] || default)
+    session[:constellation_stored_location] = nil
+  end
+end

data/app/controllers/password_resets_controller.rb

@@ -0,0 +1,45 @@
+class PasswordResetsController < ApplicationController
+  before_filter :load_user_using_perishable_token, :only => [:edit, :update]
+  require_no_user
+  
+  def new
+  end
+  
+  def create
+    @user = User.find_by_email(params[:email])
+    if @user
+      @user.reset_perishable_token!  
+      UserMailer.password_reset(@user).deliver
+      flash[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.password_resets.create.success_flash")
+      redirect_to Rails.application.config.constellation.authentication.password_reset_redirection
+    else
+      flash.now[Rails.application.config.constellation.authentication.failure_flash] = t("constellation.authentication.password_resets.create.failure_flash")
+      render :action => :new
+    end
+  end
+  
+  def edit
+    render
+  end
+ 
+  def update
+    @user.password = params[:user][:password]
+    @user.password_confirmation = params[:user][:password_confirmation]
+    if @user.save
+      flash[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.password_resets.update.success_flash")
+      redirect_to Rails.application.config.constellation.authentication.signin_redirection
+    else
+      render :action => :edit
+    end
+  end
+ 
+  private
+    def load_user_using_perishable_token
+      @user = User.find_using_perishable_token(params[:id])
+      unless @user
+        flash[Rails.application.config.constellation.authentication.failure_flash] = t("constellation.authentication.password_resets.load_user_failure_flash")
+        redirect_to Rails.application.config.constellation.authentication.password_reset_redirection
+        return false
+      end
+    end
+end

data/app/controllers/user_sessions_controller.rb

@@ -0,0 +1,24 @@
+class UserSessionsController < ApplicationController
+  require_no_user :only => [:new, :create]
+  require_user :only => :destroy
+  
+  def new
+    @user_session = UserSession.new
+  end
+  
+  def create
+    @user_session = UserSession.new(params[:user_session])
+    if @user_session.save
+      flash[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.user_sessions.create.success_flash")
+      redirect_back_or_default Rails.application.config.constellation.authentication.signin_redirection
+    else
+      render :action => :new
+    end
+  end
+  
+  def destroy
+    current_user_session.destroy    
+    flash[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.user_sessions.destroy.success_flash")
+    redirect_to signin_path
+  end
+end

data/app/controllers/users_controller.rb

@@ -0,0 +1,67 @@
+class UsersController < ApplicationController
+  require_no_user :only => [:new, :create]
+  require_user :only => [:show, :edit, :update]
+  
+  def new
+    @user = User.new
+  end
+  
+  def create
+    @user = User.new(params[:user])
+    if @user.save
+      UserMailer.confirmation(@user).deliver if Rails.application.config.constellation.authentication.confirm_signup
+      flash[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.users.create.success_flash")
+      redirect_to Rails.application.config.constellation.authentication.signup_redirection
+    else
+      render :action => :new
+    end
+  end
+  
+  def show
+    @user = @current_user
+  end
+ 
+  def edit
+    @user = @current_user
+  end
+  
+  def update
+    @user = @current_user
+    if @user.update_attributes(params[:user])
+      flash[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.users.update.success_flash")
+      redirect_to account_url
+    else
+      render :action => :edit
+    end
+  end
+  
+  if Rails.application.config.constellation.authentication.confirm_signup
+    def confirm
+      @user = User.find_using_perishable_token params[:token]  
+      if @user
+        @user.confirmed_at = Time.now
+        @user.save
+        UserSession.create @user
+        flash[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.users.confirm.success_flash")
+        redirect_to Rails.application.config.constellation.authentication.confirm_redirection
+      else
+        flash.now[Rails.application.config.constellation.authentication.failure_flash] = t("constellation.authentication.users.confirm.failure_flash")
+        redirect_to resend_confirmation_path
+      end
+    end
+  
+    def resend_confirmation
+      if request.post?
+        @user = User.find_by_email params[:email]
+        if @user
+          @user.reset_perishable_token!
+          UserMailer.confirmation(@user).deliver
+          flash.now[Rails.application.config.constellation.authentication.success_flash] = t("constellation.authentication.users.resend_confirmation.success_flash")
+          redirect_to Rails.application.config.constellation.authentication.resend_confirmation_redirection
+        else
+          flash.now[Rails.application.config.constellation.authentication.failure_flash] = t("constellation.authentication.users.resend_confirmation.failure_flash")
+        end
+      end
+    end
+  end
+end

data/app/mailers/user_mailer.rb

@@ -0,0 +1,13 @@
+class UserMailer < ActionMailer::Base
+  def confirmation(user)
+    @url = confirm_url :token => user.perishable_token
+    mail :to => user.email,
+         :subject => "Please confirm your email address!"
+  end
+  
+  def password_reset(user)
+    @url = edit_password_reset_url user.perishable_token
+    mail :to => user.email,
+         :subject => "Please reset your password!"
+  end
+end

data/app/models/user.rb

@@ -0,0 +1,13 @@
+class User < ActiveRecord::Base
+  acts_as_authentic
+    
+  attr_accessible :email, :password, :password_confirmation
+    
+  if Rails.application.config.constellation.authentication.confirm_signup
+    # This is a magic method that Authlogic uses to determine if the user is confirmed
+    # and should be able to log in.
+    def confirmed?
+      !!confirmed_at
+    end
+  end
+end

data/app/models/user_session.rb

@@ -0,0 +1,6 @@
+class UserSession < Authlogic::Session::Base
+  # TODO:  This will likely be unnecessary in a future version of Authlogic.  Rails 3 renamed key -> to_key
+  def to_key
+    new_record? ? nil : [ self.send(self.class.primary_key) ]
+  end
+end

data/app/views/password_resets/edit.html.erb

@@ -0,0 +1,11 @@
+<h1><%= t("constellation.authentication.password_resets.edit.headline") %></h1>
+
+<%= semantic_form_for @user, :url => password_reset_path, :method => :put do |form| %>
+  <%= form.inputs do %>
+    <%= form.input :password %>
+    <%= form.input :password_confirmation %>
+  <% end %>
+  <%= form.buttons do %>
+    <%= form.commit_button :label => t("constellation.authentication.password_resets.edit.button_label") %>
+  <% end %>
+<% end %>

data/app/views/password_resets/new.html.erb

@@ -0,0 +1,9 @@
+<h1><%= t("constellation.authentication.password_resets.new.headline") %></h1>
+
+<p><%= t("constellation.authentication.password_resets.new.description") %></p>
+
+<%= form_tag password_resets_path do %>
+  <%= label_tag :email %>
+  <%= text_field_tag :email, params[:email] %>
+  <br/><%= submit_tag t("constellation.authentication.password_resets.new.button_label") %>
+<% end %>

data/app/views/user_mailer/confirmation.html.erb

@@ -0,0 +1,7 @@
+<p>
+  Thank you for signing up for an account! Please take this time to confirm your email address and activate your account with the link below.
+</p>
+
+<p>
+  <%= link_to @url, @url %>
+</p>

data/app/views/user_mailer/confirmation.text.erb

@@ -0,0 +1,3 @@
+Thank you for signing up for an account! Please take this time to confirm your email address and activate your account with the link below.
+
+<%= @url %>

data/app/views/user_mailer/password_reset.html.erb

@@ -0,0 +1,12 @@
+<p>
+  A request to reset your password has been made. If you did not make this request, simply ignore this email.  If you did make this request just click the link below.
+</p>
+
+<p>
+  <%= link_to @url, @url %>
+</p>
+
+<p>
+  If the above URL does not work try copying and pasting it into your browser.  If you continue to have problem please feel free to contact us.
+</p>
+

data/app/views/user_mailer/password_reset.text.erb

@@ -0,0 +1,5 @@
+A request to reset your password has been made. If you did not make this request, simply ignore this email.  If you did make this request just click the link below.
+
+<%= @url %>
+
+If the above URL does not work try copying and pasting it into your browser.  If you continue to have problem please feel free to contact us.

data/app/views/user_sessions/new.html.erb

@@ -0,0 +1,16 @@
+<h1><%= t("constellation.authentication.user_sessions.new.headline")%></h1>
+
+<%= semantic_form_for @user_session, :url => user_session_path, :method => :post do |form| %>
+  <%= form.semantic_errors %>
+  <%= form.inputs do %>
+    <%= form.input :email %>
+    <%= form.input :password %>
+    <%= form.check_box :remember_me %><%= form.label :remember_me %>
+  <% end %>
+  <%= form.buttons do %>
+    <%= form.commit_button :label => t("constellation.authentication.user_sessions.new.button_label") %>
+  <% end %>
+<% end %>
+  
+<%= link_to t("constellation.authentication.users.resend_confirmation.link_text"), resend_confirmation_path %>
+<%= link_to t("constellation.authentication.password_resets.new.link_text"), new_password_reset_path %>

data/app/views/users/edit.html.erb

@@ -0,0 +1,11 @@
+<h1><%= t("constellation.authentication.users.edit.headline") %></h1>
+
+<%= semantic_form_for @user do |form| %>
+  <%= form.inputs do %>
+    <%= form.input :password %>
+    <%= form.input :password_confirmation %>
+  <% end %>
+  <%= form.buttons do %>
+    <%= form.commit_button :label => t("constellation.authentication.users.edit.button_label") %>
+  <% end %>
+<% end %>

data/app/views/users/new.html.erb

@@ -0,0 +1,12 @@
+<h1><%= t("constellation.authentication.users.new.headline") %></h1>
+
+<%= semantic_form_for @user do |form| %>
+  <%= form.inputs do %>
+    <%= form.input :email %>
+    <%= form.input :password %>
+    <%= form.input :password_confirmation %>
+  <% end %>
+  <%= form.buttons do %>
+    <%= form.commit_button :label => t("constellation.authentication.users.new.button_label") %>
+  <% end %>
+<% end %>

data/app/views/users/resend_confirmation.html.erb

@@ -0,0 +1,9 @@
+<h1><%= t("constellation.authentication.users.resend_confirmation.headline") %></h1>
+
+<p><%= t("constellation.authentication.users.resend_confirmation.description") %></p>
+  
+<% form_tag resend_confirmation_path do %>
+  <%= label_tag :email %>
+  <%= text_field_tag :email, params[:email] %>
+  <br/><%= submit_tag t("constellation.authentication.users.resend_confirmation.button_label") %>
+<% end %>

data/app/views/users/show.html.erb

@@ -0,0 +1,7 @@
+<h1><%= t("constellation.authentication.users.show.headline") %></h1>
+ 
+<p>
+  <%=h @user.email %>
+</p>
+ 
+<%= link_to t("constellation.authentication.users.edit.link_text"), edit_account_path %>

data/config/locales/en.yml

@@ -0,0 +1,51 @@
+en:
+  constellation:
+    authentication:
+      require_user: "You must be signed in to access this page."
+      require_no_user: "You must be signed out to access this page."
+      users:
+        new:
+          headline: "Sign Up"
+          button_label: "Sign Up"
+        create:
+          success_flash: "Thanks for signing up!"
+        show:
+          headline: "My Account"
+        edit:
+          headline: "Edit My Account"
+          button_label: "Update"
+          link_text: "Edit"
+        update:
+          success_flash: "Account updated!"
+        confirm:
+          success_flash: "Account successfully activated!"
+          failure_flash: "Your account could not be confirmed.  This usually happens if you wait too long before clicking on the link in your email."
+        resend_confirmation:
+          headline: "Resend Confirmation Email"
+          description: "Please check your spam folder!  But if you don't find it there, enter your email address below and we'll send you a fresh confirmation email."
+          button_label: "Resend Email"
+          link_text: "Never got your confirmation email? Click here to resend it."
+          failure_flash: "We couldn't find that user.  Is your email right?  Did you sign up properly?"
+      user_sessions:
+        new:
+          headline: "Sign In"
+          button_label: "Sign In"
+        create:
+          success_flash: "Welcome back!"
+        destroy:
+          success_flash: "You have been signed out."
+      password_resets:
+        new:
+          headline: "Reset Password"
+          description: "Fill out the form below and instructions to reset your password will be emailed to you.  Please check your spam folder if you don't see it."
+          button_label: "Reset Password"
+          link_text: "Forget your password? Click here to reset it."
+        create:
+          success_flash: "Instructions to reset your password have been emailed to you. Please check your email."
+          failure_flash: "No user was found with that email address."
+        edit:
+          headline: "Change My Password"
+          button_label: "Update my password and log me in"
+        update:
+          success_flash: "Password successfully updated."
+        load_user_failure_flash: "We could not locate your account. If you are having issues try copying and pasting the URL from your email into your browser or restarting the reset password process."

data/config/routes.rb

@@ -0,0 +1,18 @@
+if Rails.application.config.constellation.authentication.include_routes
+  Rails::Application.routes.draw do |map|
+    
+    resource :user_session
+    resources :users
+    resource :account, :controller => "users"
+
+    match "signout", :to => "user_sessions#destroy", :as => "signout"
+    match "signin", :to => "user_sessions#new", :as => "signin"
+    match "signup", :to => "users#new", :as => "signup"
+
+    match 'confirm/:token', :to => 'users#confirm', :as => 'confirm'
+    match "resend_confirmation", :to => "users#resend_confirmation", :as => "resend_confirmation"
+
+    resources :password_resets
+    
+  end
+end

data/lib/constellation/authentication.rb

@@ -0,0 +1 @@
+require 'constellation/authentication/engine' if defined?(Rails)

data/lib/constellation/authentication/engine.rb

@@ -0,0 +1,40 @@
+require 'constellation/authentication'
+require 'rails'
+require 'active_record'
+
+module Constellation
+  module Authentication
+    class Engine < Rails::Engine
+      config.constellation = ActiveSupport::OrderedOptions.new unless config.respond_to? :constellation
+      config.constellation.authentication = ActiveSupport::OrderedOptions.new
+      config.constellation.authentication.root = __FILE__.gsub('/lib/constellation/authentication/engine.rb', '')
+      
+      # Flash keys
+      config.constellation.authentication.success_flash = :success
+      config.constellation.authentication.failure_flash = :error
+      
+      # Include the engine's routes?  Disable if you wish to provide your own.
+      config.constellation.authentication.include_routes = true
+      
+      # Settings for checking if the current user is signed in or not
+      config.constellation.authentication.require_user_redirection = { :controller => 'user_sessions', :action => 'new' }
+      config.constellation.authentication.require_no_user_redirection = '/'
+      config.constellation.authentication.require_user_flash = :notice
+      config.constellation.authentication.require_no_user_flash = :notice
+      
+      # Signing Up
+      config.constellation.authentication.signup_redirection = "/"
+      
+      # Confirming the user's email
+      config.constellation.authentication.confirm_signup = true
+      config.constellation.authentication.confirm_redirection = "/"
+      config.constellation.authentication.resend_confirmation_redirection = "/"
+      
+      # Signing In
+      config.constellation.authentication.signin_redirection = "/"
+      
+      # Forgot password
+      config.constellation.authentication.password_reset_redirection = "/"
+    end
+  end
+end

data/lib/generators/constellation/templates/migration.rb

@@ -0,0 +1,25 @@
+class CreateUsers < ActiveRecord::Migration
+   def self.up
+     create_table :users do |t|
+       t.string   "email",                                  :null => false
+       t.string   "crypted_password",                       :null => false
+       t.string   "password_salt",                          :null => false
+       t.string   "persistence_token",                      :null => false
+       t.string   "single_access_token",                    :null => false
+       t.string   "perishable_token",                       :null => false
+       t.integer  "login_count",         :default => 0,     :null => false
+       t.integer  "failed_login_count",  :default => 0,     :null => false
+       t.datetime "last_request_at"
+       t.datetime "current_login_at"
+       t.datetime "last_login_at"
+       t.string   "current_login_ip"
+       t.string   "last_login_ip"
+       t.datetime "confirmed_at"
+       t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/lib/generators/constellation/user_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Constellation
+  class UserGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    
+    # Implement the required interface for Rails::Generators::Migration.
+    # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/create_users.rb'
+    end
+    
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: constellation-authentication
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ian Terrell
+- Jeff Bozek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A full featured authentication solution built around Authlogic.
+email: ian@constellationsoft.com;jeff@constellationsoft.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/constellation/authentication/engine.rb
+- lib/constellation/authentication.rb
+- lib/generators/constellation/templates/migration.rb
+- lib/generators/constellation/user_generator.rb
+- app/controllers/application_controller.rb
+- app/controllers/password_resets_controller.rb
+- app/controllers/user_sessions_controller.rb
+- app/controllers/users_controller.rb
+- app/mailers/user_mailer.rb
+- app/models/user.rb
+- app/models/user_session.rb
+- app/views/password_resets/edit.html.erb
+- app/views/password_resets/new.html.erb
+- app/views/user_mailer/confirmation.html.erb
+- app/views/user_mailer/confirmation.text.erb
+- app/views/user_mailer/password_reset.html.erb
+- app/views/user_mailer/password_reset.text.erb
+- app/views/user_sessions/new.html.erb
+- app/views/users/edit.html.erb
+- app/views/users/new.html.erb
+- app/views/users/resend_confirmation.html.erb
+- app/views/users/show.html.erb
+- config/locales/en.yml
+- config/routes.rb
+has_rdoc: true
+homepage: http://github.com/constellationsoft/authentication
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A full featured authentication solution built around Authlogic.
+test_files: []
+