tkh_authentication 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# TKH Authentication
+
+
+
+## 0.0.1
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# TKH Authentication
+
+This is a Rails engine which provides basic authentication. It is based on Railscasts 250 and 274.
+
+Primarily developed for Ten Thousand Hours but we are happy to share if anybody finds it useful.
+
+It's still in its infancy. Many improvements to come.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tkh_authentication', '~> 0.0'
+
+And then execute:
+
+    $ bundle
+
+Import migration and locale files
+
+		$ rails g tkh_authentication:install
+		
+Run the migration
+
+		$ rake db:migrate
+		
+You need a root route in your app but most apps have that already.
+
+And then of course restart your server!
+
+		$ rails s
+
+
+## Usage
+
+
+A starting point could be:
+
+    $ /login
+
+... and it should work out of the box.
+
+To display the login information module anywhere in your views
+
+		$ render 'shared/login_info'
+		
+At this point the user only needs to be authenticated to access any area. We are coming up with an authorization solution as well. To restrict access to your controllers, you can do any of the following:
+
+		$ before_filter :authenticate
+		before_filter :authenticate, :only => [ 'new', 'edit']
+		before_filter :authenticate, :except => 'show'
+
+
+## Contributing
+
+Pull requests for new features and bug fixes are welcome.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create your failing tests based on the Test Unit framework.
+4. Create your code which makes the tests pass.
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TkhAuthentication'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/controllers/password_resets_controller.rb

@@ -0,0 +1,28 @@
+class PasswordResetsController < ApplicationController
+  
+  def create
+    user = User.find_by_email(params[:email])
+    if user
+      user.send_password_reset
+      redirect_to root_url, :notice => t('authentication.reset_password_email_sent_confirmation')
+    else
+      redirect_to root_url, :alert => t('authentication.warning.no_such_email')
+    end
+  end
+
+  def edit
+    @user = User.find_by_password_reset_token!(params[:id])
+  end
+
+  def update
+    @user = User.find_by_password_reset_token!(params[:id])
+    if @user.password_reset_sent_at < 24.hours.ago
+      redirect_to new_password_reset_path, :alert => t('authentication.warning.password_reset_expired')
+    elsif @user.update_attributes(params[:user])
+      redirect_to root_url, :notice => t('authentication.password_reset_confirmation')
+    else
+      render :edit
+    end
+  end
+
+end

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,26 @@
+class SessionsController < ApplicationController
+
+  def new
+  end
+
+  def create
+    user = User.find_by_email(params[:email])
+    if user && user.authenticate(params[:password])
+      if params[:remember_me]
+        cookies.permanent[:auth_token] = user.auth_token
+      else
+        cookies[:auth_token] = user.auth_token
+      end
+      redirect_to root_url, notice: t('authentication.login_confirmation')
+    else
+      flash.now.alert = t('authentication.warning.email_or_password_invalid')
+      render "new"
+    end
+  end
+
+  def destroy
+    cookies.delete(:auth_token)
+    redirect_to root_url, notice: t('authentication.logout_confirmation')
+  end
+
+end

data/app/controllers/users_controller.rb

@@ -0,0 +1,24 @@
+class UsersController < ApplicationController
+  
+  before_filter :authenticate, only: 'index'
+  
+  def index
+    @users = User.by_recent
+    render layout: 'admin'
+  end
+
+  def new
+    @user = User.new
+  end
+
+  def create
+    @user = User.new(params[:user])
+    if @user.save
+      session[:user_id] = @user.id
+      redirect_to root_url, notice: t('authentication.signup_confirmation')
+    else
+      render "new"
+    end
+  end
+  
+end

data/app/mailers/user_mailer.rb

@@ -0,0 +1,23 @@
+class UserMailer < ActionMailer::Base
+  
+  if defined?(SETTINGS) && SETTINGS['site_admin_email'] 
+    default :from => SETTINGS['site_admin_email']
+  else
+    default :from => 'test@example.com'
+  end
+
+  # Subject can be set in your I18n file at config/locales/en.yml
+  # with the following lookup:
+  #
+  #   en.user_mailer.password_reset.subject
+  #
+  def password_reset(user)  
+    @user = user
+    if defined?(SETTINGS) && SETTINGS['site_name']
+      mail :to => user.email, :subject => t('authentication.password_reset_email_subject') + ' | ' + SETTINGS['site_name']
+    else
+      mail :to => user.email, :subject => t('authentication.password_reset_email_subject')
+    end
+  end
+
+end

data/app/models/user.rb

@@ -0,0 +1,39 @@
+class User < ActiveRecord::Base
+  
+  has_secure_password
+  
+  # not allowed are :admin:boolean, :auth_token:string, password_reset_token:string, password_reset_sent_at:datetime
+  attr_accessible :email, :password, :password_confirmation, :first_name, :last_name
+  
+  validates_uniqueness_of :email, :case_sensitive => false
+  validates_presence_of :password, on: :create
+  validates_presence_of :first_name
+  validates_presence_of :last_name
+  
+  before_create { generate_token(:auth_token) }
+  
+  # use the stringex gem to create slug | usually on the title or name attribute
+  def to_param
+    "#{id}-#{name.to_url}"
+  end
+
+  scope :by_recent, :order => 'updated_at desc'
+  
+  def name
+    result = "#{first_name} #{last_name}".strip
+  end
+
+  def send_password_reset
+    generate_token(:password_reset_token)
+    self.password_reset_sent_at = Time.zone.now
+    save!
+    UserMailer.password_reset(self).deliver
+  end
+
+  def generate_token(column)
+    begin
+      self[column] = SecureRandom.urlsafe_base64
+    end while User.exists?(column => self[column])
+  end
+  
+end

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

@@ -0,0 +1,10 @@
+<%= simple_form_for @user, :url => password_reset_path(params[:id]) do |f| %>
+<%= f.error_notification %>
+
+  <div class="field">
+    <%= f.input :password %>
+    <%= f.input :password_confirmation %>
+  </div>
+  <div class="actions"><%= f.submit t('authentication.update_password') %></div>
+<% end %>
+

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

@@ -0,0 +1,8 @@
+<%= form_tag password_resets_path, :method => :post do %>
+  <div class="field">
+    <%= label_tag :email %>
+    <%= text_field_tag :email, params[:email] %>
+  </div>
+  <div class="actions"><%= submit_tag t('authentication.reset_your_password') %></div>
+<% end %>
+

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

@@ -0,0 +1,22 @@
+<h1>Log In</h1>
+
+<%= form_tag sessions_path do %>
+  <div class="field">
+    <%= label_tag :email %><br />
+    <%= text_field_tag :email, params[:email] %><br />
+		<%= link_to t('authentication.not_registered'), signup_path %>
+  </div>
+
+  <div class="field">
+    <%= label_tag :password %><br />
+    <%= password_field_tag :password %><br />
+		<%= link_to t('authentication.forgot_password'), new_password_reset_path %>
+  </div>
+	<p></p>
+	
+	<div class="field">
+	  <%= check_box_tag :remember_me, 1, params[:remember_me] %>
+	  <%= label_tag :remember_me %>
+	</div>
+  <div class="actions"><%= submit_tag t('authentication.login_now') %></div>
+<% end %>

data/app/views/shared/_login_info.html.erb

@@ -0,0 +1,7 @@
+<p class="login-info">
+	<% if current_user %>
+	  <strong><%= current_user.email %></strong> <%= link_to "Log Out", logout_path, class: 'btn btn-mini' %>
+	<% else %>
+	  <%= link_to "Log In", login_path, class: 'btn btn-mini' %> or <%= link_to "Sign Up", signup_path, class: 'btn btn-mini' %>
+	<% end %>
+</p>

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

@@ -0,0 +1 @@
+<%= t 'authentication.reset_instructions', reset_url:  edit_password_reset_url(@user.password_reset_token, locale: I18n.locale) %>

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

@@ -0,0 +1,23 @@
+<h1>Listing Users</h1>
+
+<table class='table table-striped'>
+	<thead>
+  <tr>	
+			<th>Name</th>
+	    <th>Email</th>
+			<th>Admin?</th>
+	  </tr>
+	</thead>
+	
+	<tbody>
+		<% @users.each do |user| %>
+		  <tr>
+		    <td><%= user.name %></td>
+				<td><%= user.email %></td>
+				<td><%= user.admin? ? 'YES' : 'no' %></td>
+		  </tr>
+		<% end %>
+	</tbody>
+</table>
+
+<%= render 'shared/admin_sidebar' %>

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

@@ -0,0 +1,15 @@
+<%= simple_form_for @user do |f| %>
+  <%= f.error_notification %>
+
+  <div class="form-inputs">
+    <%= f.input :email %>
+		<%= f.input :first_name %>
+		<%= f.input :last_name %>
+    <%= f.input :password %>
+		<%= f.input :password_confirmation %>
+  </div>
+
+  <div class="form-actions">
+    <%= f.button :submit, label: t('authentication.create_account'), :class => 'btn btn-primary' %>
+  </div>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  scope "(:locale)", locale: /#{I18n.available_locales.join("|")}/ do
+    get 'signup', to: 'users#new', as: 'signup'
+    get 'login', to: 'sessions#new', as: 'login'
+    get 'logout', to: 'sessions#destroy', as: 'logout'
+
+    resources :users
+    resources :sessions
+    resources :password_resets
+  end
+end

data/lib/generators/tkh_authentication/install/install_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/migration'
+ 
+module TkhAuthentication
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the migrations and locale files"
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+ 
+      def copy_migrations
+        puts 'creating user migration'
+        migration_template "create_users.rb", "db/migrate/create_users.rb"
+      end
+      
+      def copy_locales
+        puts 'creating locale files'
+        # copy_file "locales/en.yml", "config/locales/tkh_authentication.en.yml"
+        # copy_file "locales/fr.yml", "config/locales/tkh_authentication.fr.yml"
+        I18n.available_locales.each do |l|
+          copy_file "locales/#{l.to_s}.yml", "config/locales/tkh_authentication.#{l.to_s}.yml"
+        end
+      end
+ 
+    end
+  end
+end

data/lib/generators/tkh_authentication/install/templates/create_users.rb

@@ -0,0 +1,16 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :email
+      t.string :password_digest
+      t.string :first_name
+      t.string :last_name
+      t.boolean :admin, default: false
+      t.string  :auth_token
+      t.string  :password_reset_token
+      t.datetime  :password_reset_sent_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/tkh_authentication/install/templates/locales/en.yml

@@ -0,0 +1,78 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  date:
+    formats:
+      simple_date: "%B %d"
+  time:
+    formats:
+      informal: "at %H:%M"
+      default: "%a. %b. %d, '%y at %H:%M"
+      just_time: "%I:%M %p"
+      long: "%A %d %B %Y at %H:%M"
+  # custom sections - the obove is provided by rails
+  language_name: English
+  authentication:
+    create_account: 'create your account'
+    forgot_password: "forgot your password?"
+    login_confirmation: "You have been logged in!"
+    login_now: "log in"
+    logout: "log out"
+    logout_confirmation: "You have been logged out!"
+    not_registered: "you don't have an account yet?"
+    password_reset_confirmation: "Your password has been successfully reset!"
+    password_reset_email_subject: "Password reset"
+    reset_instructions: "To reset your password, click or visit this link: %{reset_url}  \n\nIf you did not request your password to be reset, please ignore this email. Your password will stay as it is."
+    reset_password_email_sent_confirmation: "We have emailed you a link to reset your password."
+    reset_your_password: "Reset Password"
+    signup_confirmation: "Your account has been created and you have been logged in!"
+    update_password: "Update Password"
+    warning:
+      email_or_password_invalid: "Email or password is invalid"
+      login_needed: "You must be logged in to access this page. You have been redirected to the login form."
+      no_such_email: "We do not have any accounts with the email you have provided."
+      password_reset_expired: "Password reset has expired. There was a 24 hours grace period" 
+    
+    
+  # leaving these until I have used up all the ones I need.
+  access_control:  
+    already_signed_up_message: "You already have a La Source account. Please login to your existing account." 
+    email_hint: This address will be used as your login id
+    email_must_be_valid: Please enter a valid email address before submitting
+    
+    
+    have_an_account: 'have an account?'
+    hello: hello
+    hello_name: "Hi %{name},"
+    invalid_email_or_password: "Invalid email or password. Please double check your data, modify it, and resubmit the form"
+    login: "log in"
+    
+    
+    login_now_in_text: log in here
+    
+    
+    my_profile: 'my profile'
+    new_password: New Password
+    new_password_confirmation: New Password confirmation
+
+    not_authorized_alert: "You are not authorized to access this page. You have been redirected to the home page."
+    
+    or: "or"
+    password: password
+    password_confirmation: password confirmation
+
+
+    password_must_match_confirmation: 'the password and the password confirmation must match'
+    password_on_its_way: "A new password has been generated. It will be emailed within 24 hours to %{email_address}."
+    password_reset: Password reset
+    phone_entry_request: "If enrolling in a course, we would appreciate at least one phone number."
+    please_log_in: Please log in to see your personal information.
+    remember_me: "stay logged in"
+    
+    
+    signup: "create an account"
+    
+    signup_now: "create an account"
+
+    valid_email_needed: 'Please enter a valid email address'

data/lib/generators/tkh_authentication/install/templates/locales/es.yml

@@ -0,0 +1,22 @@
+es:
+  language_name: "Español"
+  authentication:
+    create_account: 'create your account'
+    forgot_password: "forgot your password?_es"
+    login_confirmation: "You have been logged in!"
+    login_now: "log in"
+    logout: "log out"
+    logout_confirmation: "You have been logged out!"
+    not_registered: "you don't have an account yet?"
+    password_reset_confirmation: "Your password has been successfully reset!"
+    password_reset_email_subject: "Password reset"
+    reset_instructions: "To reset your password, click or visit this link: %{reset_url}  \n\nIf you did not request your password to be reset, please ignore this email. Your password will stay as it is."
+    reset_password_email_sent_confirmation: "We have emailed you a link to reset your password."
+    reset_your_password: "Reset Password"
+    signup_confirmation: "Your account has been created and you have been logged in!"
+    update_password: "Update Password"
+    warning:
+      email_or_password_invalid: "Email or password is invalid"
+      login_needed: "You must be logged in to access this page. You have been redirected to the log in form."
+      no_such_email: "We do not have any accounts with the email you have provided."
+      password_reset_expired: "Password reset has expired. There was a 24 hours grace period"