auto_auth 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e35be5a61d4d181863f37c1fcdd055428c113a47
+  data.tar.gz: ab2b7f4fc1f8aa1a0d7516485cb4c85448c54dfa
+SHA512:
+  metadata.gz: ebec47215fe6608392c8e7aea468986afff70116da6159162a0b6a0f0513bc9144caf4c99b6a072893abeec6580d599d2a1816c9e4426f91981c8a2061e2b18e
+  data.tar.gz: e75c6b28666af1dd82a2539299aac2274ecb123b3f9a903b031ffff51bc243dd106977e1a8d0f72387ca963071671e20b7f847d08a4a206c12d73526b918e6b7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tony Schneider
+
+MIT License
+
+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,57 @@
+# AutoAuth
+
+A simple and sane rails authentication generator.
+
+Generates roughly the following:
+```
+app/
+    models/
+        concerns/
+            token_verification.rb
+        user.rb
+        identity.rb
+        registration.rb
+    controllers/
+        concerns/
+            authentication.rb
+        sessions_controller.rb
+        registrations_controller.rb
+        passwords_controller.rb
+    mailers
+        identity_mailer.rb
+    views
+        passwords/
+            edit.html.erb
+            new.html.erb
+        sessions/
+            new.html.erb
+        registrations/
+            new.html.erb
+        identity_mailer/
+            confirm_email.html.erb
+            reset_password.html.erb
+      config/
+          locales/
+              auto_auth.en.yml
+
+```
+
+## Installation
+
+I wouldn't add this to my gemfile, since it's really only meant to be run once. Instead, do `gem install auto_auth`
+
+And then execute:
+
+    $ rails generate auto_auth:install
+
+## Usage
+
+By default I have my domain model named `User` and my identity model named `Identity`. You can customize this by passing `--domain_model` and `--identity_model` to the rails generator.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/auto_auth/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+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/auto_auth.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generators/auto_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auto_auth"
+  spec.version       = AutoAuth::VERSION
+  spec.authors       = ["Tony Schneider"]
+  spec.email         = ["tonywok@gmail.com"]
+  spec.summary       = %q{Simple authentication templates ready to be customized.}
+  spec.homepage      = "https://github.com/tonywok/auto_auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 4.1.8"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/auto_auth.rb

@@ -0,0 +1,2 @@
+module AutoAuth
+end

data/lib/generators/auto_auth/install_generator.rb

@@ -0,0 +1,142 @@
+require 'rails/generators/base'
+
+module AutoAuth
+  class InstallGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    def self.source_root
+      File.expand_path(File.join(File.dirname(__FILE__), "..", "templates"))
+    end
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    desc "Install base authentication strategy into app ready to be customized"
+
+    class_option :domain_model, :type => :string, :default => 'user', :desc => 'Domain resource for users of the system (e.g user, admin, student etc)'
+    class_option :identity_model, :type => :string, :default => 'identity', :desc => 'Login credentials owned by a user (e.g login, credential, identity etc)'
+
+    def add_gems
+      gem "bcrypt"
+    end
+
+    def create_model_files
+      template "models/domain_model.rb", "app/models/#{domain_model}.rb"
+      template "models/identity_model.rb", "app/models/#{identity_model}.rb"
+      template "models/registration.rb", "app/models/registration.rb"
+      template "models/concerns/token_verification.rb", "app/models/concerns/token_verification.rb"
+    end
+
+    def create_controller_files
+      template "controllers/sessions_controller.rb", "app/controllers/sessions_controller.rb"
+      template "controllers/passwords_controller.rb", "app/controllers/passwords_controller.rb"
+      template "controllers/registrations_controller.rb", "app/controllers/registrations_controller.rb"
+    end
+
+    def create_mailer_files
+      template "mailers/identity_mailer.rb", "app/mailers/#{identity_model}_mailer.rb"
+
+      template "views/mailers/reset_password.html.erb", "app/views/#{identity_model}_mailer/reset_password.html.erb"
+      template "views/mailers/confirm_email.html.erb", "app/views/#{identity_model}_mailer/confirm_email.html.erb"
+    end
+
+    def create_routes
+      route <<-REGISTRATION_ROUTE
+resources :registrations, only: [:create] do
+    get :confirm, on: :collection
+  end
+      REGISTRATION_ROUTE
+      route "resources :passwords, only: [:edit, :create, :update]"
+      route "resources :sessions, only: [:create]"
+      route "get :forgot_password, to: 'passwords#new'"
+      route "get :sign_up, to: 'registrations#new'"
+      route "get :sign_out, to: 'sessions#destroy'"
+      route "get :sign_in, to: 'sessions#new'"
+    end
+
+    def create_migration_files
+      migration_template "migration.rb", "db/migrate/create_#{domain_model}_and_#{identity_model}.rb"
+    end
+
+    def include_authentication
+      template "controllers/concerns/authentication.rb", "app/controllers/concerns/authentication.rb"
+      inject_into_file "app/controllers/application_controller.rb", after: /protect_from_forgery.*$/ do
+      <<-AUTOAUTH
+
+
+  include Authentication
+
+  before_action :authenticate!
+
+  rescue_from ActiveSupport::MessageVerifier::InvalidSignature, with: :handle_invalid_signature
+
+
+  private
+
+  def handle_invalid_signature
+    redirect_to(root_path, alert: t(:'auto_auth.application.invalid_signature'))
+  end
+      AUTOAUTH
+      end
+    end
+
+    def create_view_files
+      template "views/sessions/new.html.erb", "app/views/sessions/new.html.erb"
+
+      template "views/passwords/new.html.erb", "app/views/passwords/new.html.erb"
+      template "views/passwords/edit.html.erb", "app/views/passwords/edit.html.erb"
+
+      template "views/registrations/new.html.erb", "app/views/registrations/new.html.erb"
+
+      template "config/locales/auto_auth.en.yml", "config/locales/auto_auth.en.yml"
+    end
+
+
+    private
+
+    # Domain model helpers
+    #
+    def domain_model
+      @domain_model ||= options.domain_model.underscore
+    end
+
+    def domain_model_class
+      @domain_model_class ||= domain_model.classify
+    end
+
+    def domain_model_id
+      @domain_model_id ||= "#{domain_model}_id"
+    end
+
+    def plural_domain_model
+      @plural_domain_model ||= domain_model.pluralize
+    end
+
+
+    # Identity Model Helpers
+    #
+    def identity_model
+      @identity_model ||= options.identity_model.underscore
+    end
+
+    def identity_model_class
+      @identity_model_class ||= identity_model.classify
+    end
+
+    def plural_identity_model
+      @plural_identity_model ||= identity_model.pluralize
+    end
+
+    def identity_mailer_class
+      @identity_mailer_class ||= "#{identity_model_class}Mailer".classify
+    end
+
+
+  end
+end

data/lib/generators/auto_auth/version.rb

@@ -0,0 +1,3 @@
+module AutoAuth
+  VERSION = "0.0.1"
+end

data/lib/generators/templates/config/locales/auto_auth.en.yml

@@ -0,0 +1,24 @@
+auto_auth:
+
+  mailers:
+    reset_password:
+      subject: "Reset your password"
+    confirm_email:
+      subject: "Confirm your email"
+
+  application:
+    invalid_signature: "The token you've provided is invalid."
+  sessions:
+    existing: "You're already signed in"
+    required: "You must be signed in to perform that action"
+    signed_in: "Successfully signed in"
+    signed_out: "You've been signed out"
+    bad_combination: "Bad combination of email and password"
+  passwords:
+    reset_instructions: "Check your email for password reset instructions"
+    reset: "Password successfully updated"
+    expired: "Your password reset link has expired"
+  registrations:
+    account_created: "You've succuessfully registered"
+    confirmed: "You've successfully confirmed your account"
+    expired: "Your email confirmation link has expired"

data/lib/generators/templates/controllers/concerns/authentication.rb

@@ -0,0 +1,52 @@
+require 'active_support/concern'
+
+module Authentication
+
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :current_<%= domain_model %>, :signed_in?, :redirect_to_or_default
+  end
+
+  def sign_in!(<%= domain_model %>)
+    session[:user_id] = user.id
+  end
+
+  def current_<%= domain_model %>
+    if session[:<%= domain_model %>_id].present?
+      @current_<%= domain_model %> ||= <%= domain_model_class %>.find(session[:<%= domain_model %>_id])
+    end
+  rescue ActiveRecord::RecordNotFound => e
+    reset_session
+  end
+
+  def signed_in?
+    !!current_<%= domain_model %>
+  end
+
+  def authenticate!
+    unless signed_in?
+      store_target_location
+      redirect_to(sign_in_url, alert: t(:"auto_auth.sessions.required"))
+    end
+  end
+
+  def redirect_to_target_or_default(default, *args)
+    redirect_to(session[:return_to] || default, *args)
+    session[:return_to] = nil
+  end
+
+  def redirect_authenticated
+    if signed_in?
+      redirect_to_target_or_default(root_path, notice: t(:"auto_auth.sessions.existing"))
+    end
+  end
+
+
+  private
+
+  def store_target_location
+    session[:return_to] = request.url
+  end
+
+end

data/lib/generators/templates/controllers/passwords_controller.rb

@@ -0,0 +1,47 @@
+class PasswordsController < ApplicationController
+
+  respond_to :html
+
+  skip_before_action :authenticate!
+  before_action :setup_<%= identity_model %>, only: [:edit, :update]
+
+  def new
+  end
+
+  def edit
+  end
+
+  def create
+    email = params[:<%= identity_model %>][:email]
+    if <%= identity_model %> = <%= identity_model_class %>.find_by(email: email)
+      <%= identity_mailer_class %>.reset_password(<%= identity_model %>).deliver
+    end
+    redirect_to(root_path, notice: t(:'auth_auth.passwords.reset_instructions'))
+  end
+
+  def update
+    if @<%= identity_model %>.update!(password_params)
+      redirect_to(root_path, notice: t(:'auto_auth.passwords.reset'))
+    else
+      render :edit
+    end
+  end
+
+
+  private
+
+  def setup_<%= identity_model %>
+    <%= identity_model_class %>.verify_signature!(TokenVerification::PASSWORD_RESET, params.require(:password_reset_token)) do |record, expires_at|
+      if expires_at < Time.current
+        redirect_to(root_path, alert: t(:"auto_auth.passwords.expired")) and return
+      else
+        @<%= identity_model %> = record
+      end
+    end
+  end
+
+  def password_params
+    params.require(:<%= identity_model %>).permit(:password, :password_confirmation)
+  end
+
+end

data/lib/generators/templates/controllers/registrations_controller.rb

@@ -0,0 +1,46 @@
+class RegistrationsController < ApplicationController
+
+  respond_to :html
+
+  skip_before_action :authenticate!, only: [:new, :confirm, :create]
+  before_action :redirect_authenticated, only: [:new, :create]
+  before_action :setup_identity, only: [:confirm]
+
+  def new
+    @registration = Registration.new
+  end
+
+  def confirm
+    @<%= identity_model %>.confirm!
+    redirect_to(root_path, notice: t(:'auto_auth.registration.confirmed'))
+  end
+
+  def create
+    @registration = Registration.new(registration_params)
+    if <%= domain_model %> = @registration.save!
+      sign_in!(<%= domain_model %>)
+      <%= domain_model %>.<%= identity_model %>.send_confirmation_email
+      redirect_to(root_path, notice: t(:'auto_auth.registrations.account_created'))
+    else
+      render :new
+    end
+  end
+
+
+  private
+
+  def setup_<%= identity_model %>
+    <%= identity_model_class %>.verify_signature!(TokenVerification::EMAIL_CONFIRMATION, params.require(:email_confirmation_token)) do |record, expires_at|
+      if expires_at < Time.current
+        redirect_to(root_path, alert: t(:'auto_auth.registrations.expired'))
+      else
+        @<%= identity_model %> = record
+      end
+    end
+  end
+
+  def registration_params
+    params.require(:registration).permit(:name, :email, :password, :password_confirmation)
+  end
+
+end

data/lib/generators/templates/controllers/sessions_controller.rb

@@ -0,0 +1,32 @@
+class SessionsController < ApplicationController
+
+  skip_before_action :authenticate!, only: :new
+  before_action :redirect_authenticated, only: [:new]
+
+  def new
+  end
+
+  def create
+    identity = <%= identity_model.classify %>.find_by(email: params[:session][:email])
+    if identity && identity.authenticate(params[:session].delete(:password))
+      session[:<%= "#{domain_model.underscore}_id" %>] = identity.<%= "#{domain_model.underscore}_id" %>
+      redirect_to(after_sign_in_path, notice: t(:'auto_auth.sessions.signed_in'))
+    else
+      flash.now[:alert] = t(:'auto_auth.sessions.bad_combination')
+      render :new
+    end
+  end
+
+  def destroy
+    reset_session
+    redirect_to(sign_in_path, alert: t(:'auto_auth.sessions.signed_out'))
+  end
+
+
+  private
+
+  def after_sign_in_path
+    root_path
+  end
+
+end

data/lib/generators/templates/mailers/identity_mailer.rb

@@ -0,0 +1,15 @@
+class <%= identity_mailer_class %> < ActionMailer::Base
+
+  def reset_password(<%= identity_model %>)
+    @<%= identity_model %> = <%= identity_model %>
+    @reset_password_url = edit_password_url(<%= identity_model %>, password_reset_token: @<%= identity_model %>.password_reset_token)
+    mail(to: <%= identity_model %>.email, subject: t(:'auto_auth.mailers.reset_password.subject'))
+  end
+
+  def confirm_email(<%= identity_model %>)
+    @<%= identity_model %> = <%= identity_model %>
+    @confirm_email_url = confirm_registrations_url(email_confirmation_token: @<%= identity_model %>.email_confirmation_token)
+    mail(to: <%= identity_model %>.email, subject: t(:'auto_auth.mailers.confirm_email.subject'))
+  end
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,21 @@
+class Create<%= domain_model_class %>And<%= identity_model_class %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= plural_domain_model %>) do |t|
+      t.string :name
+
+      t.timestamps
+    end
+
+    create_table(:<%= plural_identity_model %>) do |t|
+      t.string :email
+      t.string :password_digest, null: false, default: ""
+      t.datetime :confirmed_at
+      t.references :<%= domain_model %>
+
+      t.timestamps
+    end
+
+    add_index :<%= plural_identity_model %>, :email, unique: true
+    add_index :<%= plural_identity_model %>, :<%= domain_model_id %>
+  end
+end

data/lib/generators/templates/models/concerns/token_verification.rb

@@ -0,0 +1,35 @@
+require 'active_support/concern'
+
+module TokenVerification
+
+  class ExpiredToken < StandardError; end
+
+  extend ActiveSupport::Concern
+
+  def expiration_token(expires_at, purpose)
+    verifier = self.class.verifier_for(purpose)
+    verifier.generate({ id: id, expires_at: expires_at })
+  end
+
+
+  module ClassMethods
+
+    def verifier_for(purpose)
+      @verifiers ||= {}
+      @verifiers.fetch(purpose) do |p|
+        @verifiers[p] = Rails.application.message_verifier("#{self.name}-#{p.to_s}")
+      end
+    end
+
+    def verify_signature!(purpose, token)
+      data = self.verifier_for(purpose).verify(token)
+      record = self.find(data[:id])
+      record.tap do
+        if block_given?
+          yield(record, data[:expires_at])
+        end
+      end
+    end
+
+  end
+end

data/lib/generators/templates/models/domain_model.rb

@@ -0,0 +1,7 @@
+class <%= domain_model_class %> < ActiveRecord::Base
+
+  has_one :<%= identity_model %>, inverse_of: :<%= domain_model %>, dependent: :destroy
+
+  delegate :email, :confirmed?, to: :<%= identity_model %>
+
+end

data/lib/generators/templates/models/identity_model.rb

@@ -0,0 +1,62 @@
+class <%= identity_model_class %> < ActiveRecord::Base
+
+  include TokenVerification
+
+  PASSWORD_RESET_KEY = :password_reset
+  EMAIL_CONFIRMATION_KEY = :email_confirmation
+
+  has_secure_password
+
+  belongs_to :<%= domain_model %>, inverse_of: :<%= identity_model %>
+
+  validates_presence_of :email
+  validates_uniqueness_of :email
+  validates_format_of :email, with: /\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/, allow_blank: true
+
+  validates_presence_of :password, if: :password_required?
+  validates_confirmation_of :password, if: :password_required?
+  validates_length_of :password, within: 8..128, allow_blank: true
+
+  before_save :downcase_email, -> { |ident| ident.email.downcase! }
+
+  def update_email(new_email)
+    self.email = new_email
+    if email_changed?
+      self.confirmed_at = nil
+      save && send_confirmation_email
+    else
+      save
+    end
+  end
+
+  def confirm!
+    self.confirmed_at = Time.current
+    save(validate: false)
+  end
+
+  def confirmed?
+    confirmed_at.present?
+  end
+
+  def send_confirmation_email
+    <%= identity_mailer_class %>.confirm_email(self).deliver
+  end
+
+  def email_confirmation_token
+    expires_at = 7.days.from_now
+    expiration_token(expires_at, EMAIL_CONFIRMATION_KEY)
+  end
+
+  def password_reset_token
+    expires_at = 1.day.from_now
+    expiration_token(expires_at, PASSWORD_RESET_KEY)
+  end
+
+
+  private
+
+  def password_required?
+    !persisted? || !password.nil? || !password_confirmation.nil?
+  end
+
+end