restful_authentication 1.1.6

data/generators/authenticated/lib/insert_routes.rb

@@ -0,0 +1,69 @@
+Rails::Generator::Commands::Create.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource_list}\n"
+      end
+    end
+  end
+  
+  def route_resources(*resources)
+    resource_options = resources.last.is_a?(Hash) ? resources.pop : nil    
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+
+    resource_list << ", #{resource_options.inspect}" if resource_options
+    logger.route "map.resources #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resources #{resource_list}\n"
+      end
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    routing_options = route_options.map { |k,v| ":#{k} => '#{v}'" }.join(', ')
+    logger.route "map.#{name} '#{path}', #{routing_options}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.#{name} '#{path}', #{routing_options}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    look_for = "\n  map.resource #{resource_list}\n"
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    look_for =   "\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    logger.route "map.#{name} '#{path}',     :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file    'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    logger.route "map.resource #{resource_list}"
+  end
+  
+  def route_name(name, path, options = {})
+    logger.route "map.#{name} '#{path}', :controller => '{options[:controller]}', :action => '#{options[:action]}'"
+  end
+end

data/generators/authenticated/templates/_model_partial.html.erb

@@ -0,0 +1,8 @@
+<%% if logged_in? -%>
+  <div id="<%= file_name %>-bar-greeting">Logged in as <%%= link_to_current_<%= file_name %> :content_method => :login %></div>
+  <div id="<%= file_name %>-bar-action"  >(<%%= link_to "Log out", logout_path, { :title => "Log out" }    %>)</div>
+<%% else -%>
+  <div id="<%= file_name %>-bar-greeting"><%%= link_to_login_with_IP 'Not logged in', :style => 'border: none;' %></div>
+  <div id="<%= file_name %>-bar-action"  ><%%= link_to "Log in",  login_path,  { :title => "Log in" } %> /
+                               <%%= link_to "Sign up", signup_path, { :title => "Create an account" } %></div>
+<%% end -%>

data/generators/authenticated/templates/activation.erb

@@ -0,0 +1,3 @@
+<%%=h @<%= file_name %>.login %>, your account has been activated.  Welcome aboard!
+
+  <%%=h @url %>

data/generators/authenticated/templates/authenticated_system.rb

@@ -0,0 +1,189 @@
+module AuthenticatedSystem
+  protected
+    # Returns true or false if the <%= file_name %> is logged in.
+    # Preloads @current_<%= file_name %> with the <%= file_name %> model if they're logged in.
+    def logged_in?
+      !!current_<%= file_name %>
+    end
+
+    # Accesses the current <%= file_name %> from the session.
+    # Future calls avoid the database because nil is not equal to false.
+    def current_<%= file_name %>
+      @current_<%= file_name %> ||= (login_from_session || login_from_basic_auth || login_from_cookie) unless @current_<%= file_name %> == false
+    end
+
+    # Store the given <%= file_name %> id in the session.
+    def current_<%= file_name %>=(new_<%= file_name %>)
+      session[:<%= file_name %>_id] = new_<%= file_name %> ? new_<%= file_name %>.id : nil
+      @current_<%= file_name %> = new_<%= file_name %> || false
+    end
+
+    # Check if the <%= file_name %> is authorized
+    #
+    # Override this method in your controllers if you want to restrict access
+    # to only a few actions or if you want to check if the <%= file_name %>
+    # has the correct rights.
+    #
+    # Example:
+    #
+    #  # only allow nonbobs
+    #  def authorized?
+    #    current_<%= file_name %>.login != "bob"
+    #  end
+    #
+    def authorized?(action = action_name, resource = nil)
+      logged_in?
+    end
+
+    # Filter method to enforce a login requirement.
+    #
+    # To require logins for all actions, use this in your controllers:
+    #
+    #   before_filter :login_required
+    #
+    # To require logins for specific actions, use this in your controllers:
+    #
+    #   before_filter :login_required, :only => [ :edit, :update ]
+    #
+    # To skip this in a subclassed controller:
+    #
+    #   skip_before_filter :login_required
+    #
+    def login_required
+      authorized? || access_denied
+    end
+
+    # Redirect as appropriate when an access request fails.
+    #
+    # The default action is to redirect to the login screen.
+    #
+    # Override this method in your controllers if you want to have special
+    # behavior in case the <%= file_name %> is not authorized
+    # to access the requested action.  For example, a popup window might
+    # simply close itself.
+    def access_denied
+      respond_to do |format|
+        format.html do
+          store_location
+          redirect_to new_<%= controller_routing_name %>_path
+        end
+        # format.any doesn't work in rails version < http://dev.rubyonrails.org/changeset/8987
+        # Add any other API formats here.  (Some browsers, notably IE6, send Accept: */* and trigger 
+        # the 'format.any' block incorrectly. See http://bit.ly/ie6_borken or http://bit.ly/ie6_borken2
+        # for a workaround.)
+        format.any(:json, :xml) do
+          request_http_basic_authentication 'Web Password'
+        end
+      end
+    end
+
+    # Store the URI of the current request in the session.
+    #
+    # We can return to this location by calling #redirect_back_or_default.
+    def store_location
+      session[:return_to] = request.request_uri
+    end
+
+    # Redirect to the URI stored by the most recent store_location call or
+    # to the passed default.  Set an appropriately modified
+    #   after_filter :store_location, :only => [:index, :new, :show, :edit]
+    # for any controller you want to be bounce-backable.
+    def redirect_back_or_default(default)
+      redirect_to(session[:return_to] || default)
+      session[:return_to] = nil
+    end
+
+    # Inclusion hook to make #current_<%= file_name %> and #logged_in?
+    # available as ActionView helper methods.
+    def self.included(base)
+      base.send :helper_method, :current_<%= file_name %>, :logged_in?, :authorized? if base.respond_to? :helper_method
+    end
+
+    #
+    # Login
+    #
+
+    # Called from #current_<%= file_name %>.  First attempt to login by the <%= file_name %> id stored in the session.
+    def login_from_session
+      self.current_<%= file_name %> = <%= class_name %>.find_by_id(session[:<%= file_name %>_id]) if session[:<%= file_name %>_id]
+    end
+
+    # Called from #current_<%= file_name %>.  Now, attempt to login by basic authentication information.
+    def login_from_basic_auth
+      authenticate_with_http_basic do |login, password|
+        self.current_<%= file_name %> = <%= class_name %>.authenticate(login, password)
+      end
+    end
+    
+    #
+    # Logout
+    #
+
+    # Called from #current_<%= file_name %>.  Finaly, attempt to login by an expiring token in the cookie.
+    # for the paranoid: we _should_ be storing <%= file_name %>_token = hash(cookie_token, request IP)
+    def login_from_cookie
+      <%= file_name %> = cookies[:auth_token] && <%= class_name %>.find_by_remember_token(cookies[:auth_token])
+      if <%= file_name %> && <%= file_name %>.remember_token?
+        self.current_<%= file_name %> = <%= file_name %>
+        handle_remember_cookie! false # freshen cookie token (keeping date)
+        self.current_<%= file_name %>
+      end
+    end
+
+    # This is ususally what you want; resetting the session willy-nilly wreaks
+    # havoc with forgery protection, and is only strictly necessary on login.
+    # However, **all session state variables should be unset here**.
+    def logout_keeping_session!
+      # Kill server-side auth cookie
+      @current_<%= file_name %>.forget_me if @current_<%= file_name %>.is_a? <%= class_name %>
+      @current_<%= file_name %> = false     # not logged in, and don't do it for me
+      kill_remember_cookie!     # Kill client-side auth cookie
+      session[:<%= file_name %>_id] = nil   # keeps the session but kill our variable
+      # explicitly kill any other session variables you set
+    end
+
+    # The session should only be reset at the tail end of a form POST --
+    # otherwise the request forgery protection fails. It's only really necessary
+    # when you cross quarantine (logged-out to logged-in).
+    def logout_killing_session!
+      logout_keeping_session!
+      reset_session
+    end
+    
+    #
+    # Remember_me Tokens
+    #
+    # Cookies shouldn't be allowed to persist past their freshness date,
+    # and they should be changed at each login
+
+    # Cookies shouldn't be allowed to persist past their freshness date,
+    # and they should be changed at each login
+
+    def valid_remember_cookie?
+      return nil unless @current_<%= file_name %>
+      (@current_<%= file_name %>.remember_token?) && 
+        (cookies[:auth_token] == @current_<%= file_name %>.remember_token)
+    end
+    
+    # Refresh the cookie auth token if it exists, create it otherwise
+    def handle_remember_cookie!(new_cookie_flag)
+      return unless @current_<%= file_name %>
+      case
+      when valid_remember_cookie? then @current_<%= file_name %>.refresh_token # keeping same expiry date
+      when new_cookie_flag        then @current_<%= file_name %>.remember_me 
+      else                             @current_<%= file_name %>.forget_me
+      end
+      send_remember_cookie!
+    end
+  
+    def kill_remember_cookie!
+      cookies.delete :auth_token
+    end
+    
+    def send_remember_cookie!
+      cookies[:auth_token] = {
+        :value   => @current_<%= file_name %>.remember_token,
+        :expires => @current_<%= file_name %>.remember_token_expires_at }
+    end
+
+end

data/generators/authenticated/templates/authenticated_test_helper.rb

@@ -0,0 +1,12 @@
+module AuthenticatedTestHelper
+  def log_in
+    <%= file_name %> = <%= class_name %>.make
+    @request.session[:<%= file_name %>_id] = <%= file_name %>.id
+  end
+
+  def authorize
+    <%= file_name %> = <%= class_name %>.make
+    @request.env["HTTP_AUTHORIZATION"] = ActionController::HttpAuthentication::Basic.encode_credentials(<%= file_name %>.login, <%= file_name %>.password)
+  end
+  
+end

data/generators/authenticated/templates/controller.rb

@@ -0,0 +1,43 @@
+# This controller handles the login/logout function of the site.  
+class <%= controller_class_name %>Controller < ApplicationController
+  # Be sure to include AuthenticationSystem in Application Controller instead
+  include AuthenticatedSystem
+
+  # render new.html.erb
+  def new
+  end
+
+  def create
+    logout_keeping_session!
+    <%= file_name %> = <%= class_name %>.authenticate(params[:login], params[:password])
+    if <%= file_name %>
+      # Protects against session fixation attacks, causes request forgery
+      # protection if user resubmits an earlier form using back
+      # button. Uncomment if you understand the tradeoffs.
+      # reset_session
+      self.current_<%= file_name %> = <%= file_name %>
+      new_cookie_flag = (params[:remember_me] == "1")
+      handle_remember_cookie! new_cookie_flag
+      redirect_back_or_default('/')
+      flash[:notice] = "Logged in successfully"
+    else
+      note_failed_signin
+      @login       = params[:login]
+      @remember_me = params[:remember_me]
+      render :action => 'new'
+    end
+  end
+
+  def destroy
+    logout_killing_session!
+    flash[:notice] = "You have been logged out."
+    redirect_back_or_default('/')
+  end
+
+protected
+  # Track failed login attempts
+  def note_failed_signin
+    flash[:error] = "Couldn't log you in as '#{params[:login]}'"
+    logger.warn "Failed login for '#{params[:login]}' from #{request.remote_ip} at #{Time.now.utc}"
+  end
+end

data/generators/authenticated/templates/features/accounts.feature

@@ -0,0 +1,67 @@
+Feature: Sign up
+  As a <%= file_name %>
+  I want to sign up
+  So that I can log in
+
+  Scenario:  Navigating to the Sign Up page
+    Given I am not logged in
+    When I am on the home page
+    And I follow "Sign up"
+    Then I should be on the signup page
+    
+    Scenario:  Create fails when creating an existing <%= file_name %>
+      Given I am not logged in
+      And someone with the login "testing" already exists
+      When I am on the signup page
+      And I fill in "Login" with "testing"
+      And I fill in "Email" with "test@testing.com"
+      And I fill in "Password" with "password"
+      And I fill in "Confirm Password" with "password"    
+      And I press "Sign up"
+      Then I should see "Login has already been taken"
+      And I should not be logged in
+      
+    Scenario:  Create fails when given an invalid email
+      Given I am not logged in
+      When I am on the signup page
+      And I fill in "Login" with "testing"
+      And I fill in "Email" with "invalid.email"
+      And I fill in "Password" with "password"
+      And I fill in "Confirm Password" with "password"    
+      And I press "Sign up"
+      Then I should see "Email should look like an email address"
+      And I should not be logged in
+
+    Scenario:  Create fails when no password is given
+      Given I am not logged in
+      When I am on the signup page
+      And I fill in "Login" with "testing"
+      And I fill in "Email" with "test@testing.com"
+      And I press "Sign up"
+      Then I should see "Password can't be blank"
+      And I should not be logged in
+
+    Scenario:  Create fails when no password confirmation is given
+      Given I am not logged in
+      When I am on the signup page
+      And I fill in "Login" with "testing"
+      And I fill in "Email" with "test@testing.com"
+      And I fill in "Password" with "password"      
+      And I press "Sign up"
+      Then I should see "Password confirmation can't be blank"
+      And I should not be logged in
+
+    Scenario:  Create successful when given valid parameters
+      Given I am not logged in
+      When I am on the signup page
+      And I fill in "Login" with "testing"
+      And I fill in "Email" with "test@testing.com"
+      And I fill in "Password" with "password"
+      And I fill in "Confirm Password" with "password"
+      And I press "Sign up"
+      Then I should be on the home page
+      <% if options[:include_activation] %>
+      And I should not be logged in
+      <% else %>
+      And I should be logged in
+      <% end %>

data/generators/authenticated/templates/features/sessions.feature

@@ -0,0 +1,77 @@
+Feature:  Logging in
+  As a <%= file_name %>
+  I want to log in
+  So that I can use the application
+
+  Scenario:  Navigating to the Login page
+    Given I am not logged in
+    When I follow "Log in"
+    Then I should be on the login page
+
+  Scenario:  Existing <%= file_name %> can log in
+    Given I am not logged in
+    And someone with the login "testing" already exists
+    When I am on the login page
+    And I fill in "Login" with "testing"
+    And I fill in "Password" with "testing"
+    And I press "Log in"
+    Then I should be on the home page
+    And I should be logged in
+    And I should not have a remember token
+
+  Scenario:  Existing <%= file_name %> can log in and be remembered
+    Given I am not logged in
+    And someone with the login "testing" already exists
+    And I am on the login page
+    When I fill in "Login" with "testing"
+    And I fill in "Password" with "testing"
+    And I check "remember_me"
+    And I press "Log in"
+    Then I should be on the home page
+    And I should be logged in
+    And I should have a remember token
+   
+  Scenario:  Logged in <%= file_name %> who fails log in should be logged out
+    Given I am logged in
+    And I am on the login page
+    When I fill in "Login" with "testing"
+    And I fill in "Password" with "testing1234fail"
+    And I press "Log in"
+    Then I should see "Couldn't log you in as 'testing'"    
+    And  I should not be logged in
+    
+  Scenario:  Logging in with an invalid login should fail
+    Given I am not logged in
+    And someone with the login "testing" already exists
+    And I am on the login page
+    When I fill in "Login" with "testing123"
+    And I fill in "Password" with "testing"
+    And I press "Log in"
+    Then I should see "Couldn't log you in as 'testing123'"
+    And I should not be logged in
+  
+  Scenario:  Logging in with an invalid password should fail
+    Given I am not logged in
+    And someone with the login "testing" already exists
+    When I go to the login page
+    And I fill in "Login" with "testing"
+    And I fill in "Password" with "testing123"
+    And I press "Log in"
+    Then I should see "Couldn't log you in as 'testing'"
+    And I should not be logged in
+
+  Scenario:  Logged out <%= file_name %> can log out
+    Given I am not logged in
+    And I am on the home page
+    When I go to the logout page
+    Then I should see "You have been logged out"
+    And I should be on the home page
+    And I should not be logged in
+    
+  Scenario:  Logged in <%= file_name %> can log out
+    Given I am logged in
+    And I am on the home page
+    When I follow "Log out"
+    Then I should see "You have been logged out"
+    And I should be on the home page
+    And I should not be logged in