authenticate 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f9f51572691eba2fb35eb46618d2235898149f5
-  data.tar.gz: 69fb6dcf45f900f7433f43e11feb8b69ec966bba
+  metadata.gz: 880f3ddf3bf73620d2ad00b9fa97961e0b9572cb
+  data.tar.gz: 6f8552c11692b6ed41b86bc11d9ad325c54a3b63
 SHA512:
-  metadata.gz: 195b410e9982a6a410bd53abf79ff90aba67d7ab9eca23f7fa00ab278aa28de5a592577783820d15e2bd3a2f752338c8bf2b4c695be515dd09efa2753548eac3
-  data.tar.gz: 0a06b879d4f468e62bf22037d94338a384987e5e1bc4ee72752c038700f87dfb5214d50436e5bd2a69a713fc419e3b5377ea14b7a726ec988f107a32b5d27df9
+  metadata.gz: f8ed33e95016c51092e3b082d51d04c8ab0787cf1f4d98d03a3aafe9f70aaef320beb5acc2653932053970c55c14db0b2d0cacd6deb7f6d26ec882564b113ed6
+  data.tar.gz: 401d92cb7b48b1ce32c961c42901ff20ae586648d1e266b9d0f954a76fb6449a057d12a34fdb52a6e5e9f590297f39cf7a9a93d0b1eca340f6adfb1a57192cba

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  Exclude:
+    - 'bin/rails'
+    - 'spec/dummy/**/*'
+    - 'lib/generators/authenticate/install/templates/db/migrate/**/*'
+    - 'lib/generators/authenticate/routes/templates/routes.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Documentation:
+  Exclude:
+    - 'lib/generators/**/*'
+
+Metrics/MethodLength:
+  Max: 16
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/generators/authenticate/install/install_generator.rb'
+
+Metrics/AbcSize:
+  Max: 18
+
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/generators/authenticate/**/*'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Authenticate Changelog
 
+## [0.3.2] - April 28, 2016
+
+Error now raised if User model is missing required attributes.
+All code now conforms to a rubocode profile.
+
+
 ## [0.3.1] - March 10, 2016
 
 User controller now allows arbitrary parameters without having to explicitly declare

data/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing
+
+I love pull requests. I'm trying to keep it as easy as possible to contribute changes. There
+are just a couple of guidelines to follow to help me stay on top of things.
+
+
+## Let's talk
+
+Whether you're fixing a bug or adding a feature, feel free to talk to me first on 
+[twitter](https://twitter.com/JustinTomich). We can make sure the change isn't already
+underway somewhere else.
+
+
+## Getting started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Open a [New Issue](https://github.com/tomichj/authenticate/issues) on github for your change, 
+assuming one does not already exist. If one already exists, join the conversation.
+* Fork the repository on GitHub.
+
+## Setup
+
+Clone the repo:
+
+`git clone https://github.com/<your-username>/authenticate`
+
+CD into your clone and run bundler install:
+
+`cd authenticate && bundle install`
+
+Make sure the tests pass:
+ 
+`rake`
+
+Make your change. Add tests for your change. Make sure the tests pass:
+
+`rake`
+
+I use `rubocop` to maintain ruby coding style. Install and run it like so:
+
+```sh
+gem install rubocop
+rubocop
+```
+
+Once you resolve any issues rubocop finds, you're ready to go. Push your fork and 
+[submit a pull request](https://github.com/tomichj/authenticate/compare/).
+
+The ball is now in my court. I'll try to comment on your pull request within a couple of business days 
+(hopefully the same day).
+  
+Things you can do to increase the speed of acceptance:
+ 
+* talk to me ahead of time
+* write tests
+* follow the [ruby style guide](https://github.com/bbatsov/ruby-style-guide)
+* write a good [commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+ 
+Thanks very much!

data/Gemfile

@@ -15,4 +15,3 @@ gemspec
 
 # To use a debugger
 # gem 'byebug', group: [:development, :test]
-

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    authenticate (0.3.0)
-      bcrypt
+    authenticate (0.3.1)
+      bcrypt (~> 3.1)
       email_validator (~> 1.6)
       rails (>= 4.0, < 5.1)
 
@@ -56,7 +56,7 @@ GEM
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
     coderay (1.1.0)
-    concurrent-ruby (1.0.0)
+    concurrent-ruby (1.0.1)
     database_cleaner (1.5.1)
     diff-lcs (1.2.5)
     email_validator (1.6.0)
@@ -132,7 +132,7 @@ GEM
     sprockets (3.5.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.0.1)
+    sprockets-rails (3.0.4)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -150,14 +150,14 @@ PLATFORMS
 
 DEPENDENCIES
   authenticate!
-  capybara (~> 2.6.2)
-  database_cleaner (~> 1.5.1)
-  factory_girl
-  pry
-  rspec-rails (~> 3.1.0)
+  capybara (~> 2.6)
+  database_cleaner (~> 1.5)
+  factory_girl (~> 4.4)
+  pry (~> 0.10)
+  rspec-rails (~> 3.1)
   shoulda-matchers (~> 2.8)
-  sqlite3
-  timecop (~> 0.8.0)
+  sqlite3 (~> 1.3)
+  timecop (~> 0.8)
 
 BUNDLED WITH
    1.11.2

data/README.md

@@ -7,11 +7,13 @@ open to significant modification.
 
 Authenticate is inspired by, and draws from, Devise, Warden, Authlogic, Clearance, Sorcery, and restful_authentication.
 
-Please use [GitHub Issues] to report bugs.
+Please use [GitHub Issues] to report bugs. You can contact me directly on twitter 
+[@JustinTomich](https://twitter.com/justintomich).
 
 [GitHub Issues]: https://github.com/tomichj/authenticate/issues
 
-![Build status](https://travis-ci.org/tomichj/authenticate.svg?branch=master) ![Code Climate](https://codeclimate.com/github/tomichj/authenticate/badges/gpa.svg)
+[![Gem Version](https://badge.fury.io/rb/authenticate.svg)](https://badge.fury.io/rb/authenticate) ![Build status](https://travis-ci.org/tomichj/authenticate.svg?branch=master) ![Code Climate](https://codeclimate.com/github/tomichj/authenticate/badges/gpa.svg)
+
 
 ## Philosophy
 
@@ -59,7 +61,7 @@ The generator does the following:
 
 * Insert `include Authenticate::User` into your `User` model. If you don't have a User model, one is created.
 * Insert `include Authenticate::Controller` into your `ApplicationController`
-* Add an initializer at `config/intializers/authenticate.rb`.
+* Add an initializer at `config/initializers/authenticate.rb`.
 * Create migrations to create a users table or add columns to your existing table.
 
 
@@ -213,7 +215,38 @@ If the customization at the views level is not enough, you can customize each co
 authenticate mailer. See [app/controllers](/app/controllers) for the default controllers, and
 [app/mailers](/app/mailers) for the default mailer.
 
-You can use the Authenticate controller generator to copy the default controllers and mailer into your application:
+To override an authenticate controller, subclass an authenticate controller and update your routes to point to it.
+
+For example, to customize `Authenticate::SessionController`:
+
+* subclass the controller:
+
+```ruby
+class SessionsController < Authenticate::SessionController
+  # render sign in screen
+  def new
+    # ...
+  end
+  ...
+end
+```
+
+* update your routes to use your new controller. 
+
+Start by dumping a copy of authenticate routes to your `config/routes.rb`:
+
+```sh
+$ rails generate authenticate:routes 
+```
+
+Now update `config/routes.rb` to point to your new controller:
+```ruby
+resource :session, controller: 'sessions', only: [:create, :new, :destroy]
+  ...
+```
+
+You can also use the Authenticate controller generator to copy the default controllers and mailer into 
+your application:
 
 ```sh
 $ rails generate authenticate:controllers

data/Rakefile

@@ -1,6 +1,4 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+task default: :spec

data/app/controllers/authenticate/passwords_controller.rb

@@ -14,7 +14,7 @@ class Authenticate::PasswordsController < Authenticate::AuthenticateController
   #
   # POST /users/password
   def create
-    if user = find_user_for_create
+    if (user = find_user_for_create)
       user.forgot_password!
       deliver_email(user)
     end
@@ -41,11 +41,11 @@ class Authenticate::PasswordsController < Authenticate::AuthenticateController
 
     if !@user.reset_password_period_valid?
       redirect_to sign_in_path, notice: flash_failure_token_expired
-    elsif @user.update_password password_reset_params
+    elsif @user.update_password password_reset_params # password changed, log user back in!
       login @user
       redirect_to url_after_update, notice: flash_success_password_changed
     else
-      # failed to update password for some reason
+      # failed to update password for some reason, perhaps password was too short or otherwise sucked.
       flash.now[:notice] = flash_failure_after_update
       render template: 'passwords/edit'
     end

data/app/controllers/authenticate/sessions_controller.rb

@@ -1,8 +1,10 @@
+#
+# Allow authenticate users to log in and log out.
+#
 class Authenticate::SessionsController < Authenticate::AuthenticateController
   before_action :redirect_signed_in_users, only: [:new]
   skip_before_action :require_authentication, only: [:create, :new, :destroy], raise: false
 
-
   def new
     render template: 'sessions/new'
   end
@@ -27,9 +29,7 @@ class Authenticate::SessionsController < Authenticate::AuthenticateController
   private
 
   def redirect_signed_in_users
-    if authenticated?
-      redirect_to url_for_signed_in_users
-    end
+    redirect_to url_for_signed_in_users if authenticated?
   end
 
   def url_after_create

data/app/controllers/authenticate/users_controller.rb

@@ -1,3 +1,6 @@
+#
+# Controller to reate new users.
+#
 class Authenticate::UsersController < Authenticate::AuthenticateController
   before_action :redirect_signed_in_users, only: [:create, :new]
   skip_before_action :require_authentication, only: [:create, :new], raise: false
@@ -21,16 +24,13 @@ class Authenticate::UsersController < Authenticate::AuthenticateController
   private
 
   def redirect_signed_in_users
-    if authenticated?
-      redirect_to Authenticate.configuration.redirect_url
-    end
+    redirect_to Authenticate.configuration.redirect_url if authenticated?
   end
 
   def url_after_create
     Authenticate.configuration.redirect_url
   end
 
-
   def user_from_params
     email = user_params.delete(:email)
     password = user_params.delete(:password)
@@ -42,8 +42,6 @@ class Authenticate::UsersController < Authenticate::AuthenticateController
   end
 
   def user_params
-    params[Authenticate.configuration.user_model_param_key] || Hash.new
+    params[Authenticate.configuration.user_model_param_key] || {}
   end
-
-
 end

data/app/mailers/authenticate_mailer.rb

@@ -1,13 +1,11 @@
+# Authenticate mailer.
+#
+# Handles password change requests.
 class AuthenticateMailer < ActionMailer::Base
   def change_password(user)
     @user = user
-    mail(
-      from: Authenticate.configuration.mailer_sender,
-      to: @user.email,
-      subject: I18n.t(
-        :change_password,
-        scope: [:authenticate, :models, :authenticate_mailer]
-      ),
-    )
+    mail from: Authenticate.configuration.mailer_sender,
+         to: @user.email,
+         subject: I18n.t(:change_password, scope: [:authenticate, :models, :authenticate_mailer])
   end
 end

data/authenticate.gemspec

@@ -21,19 +21,18 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = %w(LICENSE README.md CHANGELOG.md)
   s.rdoc_options = ['--charset=UTF-8']
 
-  s.add_dependency 'bcrypt'
+  s.add_dependency 'bcrypt', '~> 3.1'
   s.add_dependency 'email_validator', '~> 1.6'
   s.add_dependency 'rails', '>= 4.0', '< 5.1'
 
-  # s.add_development_dependency 'factory_girl_rails', '~> 4.4.1'
-  s.add_development_dependency 'factory_girl'
-  s.add_development_dependency 'rspec-rails', '~> 3.1.0'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'factory_girl', '~> 4.4'
+  s.add_development_dependency 'rspec-rails', '~> 3.1'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
   s.add_development_dependency 'shoulda-matchers', '~> 2.8'
-  s.add_development_dependency 'capybara', '~> 2.6.2'
-  s.add_development_dependency 'database_cleaner', '~> 1.5.1'
-  s.add_development_dependency 'timecop', '~> 0.8.0'
+  s.add_development_dependency 'capybara', '~> 2.6'
+  s.add_development_dependency 'database_cleaner', '~> 1.5'
+  s.add_development_dependency 'timecop', '~> 0.8'
 
   s.required_ruby_version = Gem::Requirement.new('>= 2.0')
 end

data/lib/authenticate.rb

@@ -7,6 +7,6 @@ require 'authenticate/user'
 require 'authenticate/engine'
 require 'authenticate/modules'
 
+# Top level module of authenticate gem.
 module Authenticate
-  # Your code goes here...
 end

data/lib/authenticate/callbacks/authenticatable.rb

@@ -1,7 +1,6 @@
 # Callback to check that the session has been authenticated.
 #
-
 # If user failed to authenticate, toss them out.
-Authenticate.lifecycle.after_authentication name: 'authenticatable' do |user, session, opts|
+Authenticate.lifecycle.after_authentication name: 'authenticatable' do |_user, session, _opts|
   throw(:failure, I18n.t('callbacks.authenticatable.failure')) unless session && session.authenticated?
 end

data/lib/authenticate/callbacks/brute_force.rb

@@ -1,8 +1,7 @@
 # Prevents a locked user from logging in, and unlocks users that expired their lock time.
 # Runs as a hook after authentication.
-Authenticate.lifecycle.prepend_after_authentication name: 'brute force protection' do |user, session, options|
+Authenticate.lifecycle.prepend_after_authentication name: 'brute force protection' do |user, session, _options|
   include ActionView::Helpers::DateHelper
-
   unless session.authenticated? || Authenticate.configuration.max_consecutive_bad_logins_allowed.nil?
     user_credentials = User.credentials(session.request.params)
     user ||= User.find_by_credentials(user_credentials)
@@ -23,5 +22,4 @@ Authenticate.lifecycle.prepend_after_authentication name: 'brute force protectio
     remaining = time_ago_in_words(user.lock_expires_at)
     throw(:failure, I18n.t('callbacks.brute_force.failure', time_remaining: remaining.to_s))
   end
-
 end

data/lib/authenticate/callbacks/lifetimed.rb

@@ -1,5 +1,6 @@
 # Catch sessions that have been live for too long and kill them, forcing the user to reauthenticate.
-Authenticate.lifecycle.after_set_user name: 'lifetimed after set_user', except: :authentication do |user, session, options|
+Authenticate.lifecycle.after_set_user name: 'lifetimed after set_user',
+                                      except: :authentication do |user, _session, _options|
   if user && user.respond_to?(:max_session_lifetime_exceeded?)
     throw(:failure, I18n.t('callbacks.lifetimed.failure')) if user.max_session_lifetime_exceeded?
   end

data/lib/authenticate/callbacks/timeoutable.rb

@@ -1,5 +1,5 @@
 # Update last_access_at on every authentication
-Authenticate.lifecycle.after_authentication name: 'timeoutable after authentication' do |user, session, options|
+Authenticate.lifecycle.after_authentication name: 'timeoutable after authentication' do |user, _session, _options|
   if user && user.respond_to?(:last_access_at)
     user.last_access_at = Time.now.utc
     user.save!
@@ -7,7 +7,8 @@ Authenticate.lifecycle.after_authentication name: 'timeoutable after authenticat
 end
 
 # Fail users that have timed out. Otherwise update last_access_at.
-Authenticate.lifecycle.after_set_user name: 'timeoutable after set_user', except: :authentication do |user, session, options|
+Authenticate.lifecycle.after_set_user name: 'timeoutable after set_user',
+                                      except: :authentication do |user, _session, _options|
   if user && user.respond_to?(:timedout?)
     throw(:failure, I18n.t('callbacks.timeoutable.failure')) if user.timedout?
     user.last_access_at = Time.now.utc

data/lib/authenticate/callbacks/trackable.rb

@@ -1,5 +1,5 @@
 # Update all standard tracked stats at each authentication.
-Authenticate.lifecycle.after_authentication name: 'trackable' do |user, session, options|
+Authenticate.lifecycle.after_authentication name: 'trackable' do |user, session, _options|
   if user && user.respond_to?(:update_tracked_fields!)
     user.update_tracked_fields!(session.request)
   end