auther 4.1.0 → 5.0.0

data/app/presenters/auther/account.rb

@@ -2,6 +2,7 @@ require "active_model"
 
 module Auther
   module Presenter
+    # Adapter for presenting an account within a view.
     class Account
       include ActiveModel::Validations
 
@@ -14,6 +15,15 @@ module Auther
         @login = options[:login]
         @password = options[:password]
       end
+
+      def error? key
+        errors.key? key
+      end
+
+      def error_message key
+        return "" unless error?(key)
+        "#{key.capitalize} #{errors.messages[key].first}"
+      end
     end
   end
 end

data/app/views/auther/session/new.html.slim

@@ -1,43 +1,25 @@
 - content_for(:title) { @title }
 
-- error_keys = @account_presenter.errors.keys
-- login_error = error_keys.include?(:login)
-- password_error = error_keys.include?(:password)
-- name_error = error_keys.include?(:name)
+.auther-page
+  .auther-content
+    h1.auther-title = "Authorization"
 
-.authorization
-  = form_for @account_presenter, as: :account, url: "/auther/session" do |form|
-    .small-12
-      .row
-        h1.authorization-label = @label
+    = form_for @account, as: :account, url: "/auther/session", html: {class: "auther-credentials"} do |form|
+      div class=%(auther-form-section #{"auther-error" if @account.error?(:login)})
+        = form.label :login, "Login:", class: "auther-form-label"
+        .auther-form-group
+          = form.text_field :login, class: "auther-form-input"
+          small.auther-error-message = @account.error_message(:login)
 
-      .row
-        .small-8
-          .row
-            = content_tag :div, class: render_foundation_error(login_error, classes: %w(small-6 columns))
-              = form.label :login, "Login:", class: "inline right"
-            = content_tag :div, class: render_foundation_error(login_error, classes: %w(small-6 columns))
-              = form.text_field :login
-              = content_tag(:small, @account_presenter.errors.full_messages.first, class: "error") if login_error
-      .row
-        .small-8
-          .row
-            = content_tag :div, class: render_foundation_error(password_error, classes: %w(small-6 columns))
-              = form.label :password, "Password:", class: "inline right"
-            = content_tag :div, class: render_foundation_error(password_error, classes: %w(small-6 columns))
-              = form.password_field :password
-              = content_tag(:small, @account_presenter.errors.full_messages.first, class: "error") if password_error
+      div class=%(auther-form-section #{"auther-error" if @account.error?(:password)})
+        = form.label :password, "Password:", class: "auther-form-label"
+        .auther-form-group
+          = form.password_field :password, class: "auther-form-input"
+          small.auther-error-message = @account.error_message(:password)
 
-      .row
-        .small-8
-          .row
-            .small-6.columns
-              = form.label :name, "Account:", class: "inline right"
-            .small-6.columns
-              = form.select :name, @account_options
+      .auther-form-section
+        = form.label :name, "Account:", class: "auther-form-select-label"
+        .auther-form-group
+          = form.select :name, @account_options, {}, class: "auther-form-select"
 
-      .row
-        .small-8
-          .row
-            .small-6.right
-              = form.submit "Login", class: "button round expand"
+      = form.submit "Login", class: "auther-button"

data/app/views/layouts/auther/auth.html.slim

@@ -6,8 +6,6 @@ html lang="en"
     title = yield :title
 
     = stylesheet_link_tag "auther/application", media: "all"
-    = javascript_include_tag :modernizr
     = csrf_meta_tags
   body
     = yield
-    = javascript_include_tag "auther/application"

data/bin/rails

@@ -1,8 +1,5 @@
-#!/usr/bin/env ruby
-# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+ENGINE_ROOT = File.expand_path("../..", __FILE__)
+ENGINE_PATH = File.expand_path("../../lib/auther/engine", __FILE__)
 
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/auther/engine', __FILE__)
-
-require 'rails/all'
-require 'rails/engine/commands'
+require "rails/all"
+require "rails/engine/commands"

data/lib/auther/authenticator.rb

@@ -1,9 +1,7 @@
 module Auther
+  # Manages account authentication.
   class Authenticator
-
-    attr_reader :logger
-
-    def initialize secret, account_model, account_presenter, logger = Auther::NullLogger.new(STDOUT)
+    def initialize secret, account_model, account_presenter, logger: Auther::NullLogger.new(STDOUT)
       @cipher = Auther::Cipher.new secret
       @account_model = account_model
       @account_presenter = account_presenter
@@ -12,15 +10,15 @@ module Auther
 
     def authenticated?
       account_model.valid? &&
-      account_presenter.valid? &&
-      authentic_name? &&
-      authentic_login? &&
-      authentic_password?
+        account_presenter.valid? &&
+        authentic_name? &&
+        authentic_login? &&
+        authentic_password?
     end
 
     private
 
-    attr_reader :cipher, :account_model, :account_presenter
+    attr_reader :cipher, :account_model, :account_presenter, :logger
 
     def log_info message
       id = "[#{Auther::Keymaster.namespace}]"
@@ -28,17 +26,15 @@ module Auther
     end
 
     def authentic? encrypted_value, value, error_name
-      begin
-        if cipher.decrypt(encrypted_value) == value
-          true
-        else
-          account_presenter.errors.add error_name, "is invalid"
-          false
-        end
-      rescue ActiveSupport::MessageVerifier::InvalidSignature => error
-        log_info %(Authentication failed! Invalid credential(s) for "#{account_model.name}" account.)
+      if cipher.decrypt(encrypted_value) == value
+        true
+      else
+        account_presenter.errors.add error_name, "is invalid"
         false
       end
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      log_info %(Authentication failed! Invalid credential(s) for "#{account_model.name}" account.)
+      false
     end
 
     def authentic_name?

data/lib/auther/cipher.rb

@@ -1,4 +1,5 @@
 module Auther
+  # Manages encryption/decryption.
   class Cipher
     def initialize secret
       @encryptor = ActiveSupport::MessageEncryptor.new secret
@@ -14,8 +15,6 @@ module Auther
 
     private
 
-    def encryptor
-      @encryptor
-    end
+    attr_reader :encryptor
   end
 end

data/lib/auther/engine.rb

@@ -1,11 +1,11 @@
 module Auther
+  # The main engine.
   class Engine < ::Rails::Engine
     isolate_namespace Auther
 
-    # Set defaults. Can be overwritten in app config.
     config.auther_settings = {}
+    config.action_view.field_error_proc = proc { |html_tag, _| html_tag.html_safe }
 
-    # Autoload presenters
     config.to_prepare do
       Dir.glob(Engine.root + "app/presenters/**/*.rb").each do |presenter|
         require_dependency presenter
@@ -13,23 +13,8 @@ module Auther
     end
 
     initializer "auther.initialize" do |app|
-      asset_paths = app.config.assets.paths
-
-      # Add jQuery assets.
-      add_asset_paths asset_paths, "jquery-rails", "javascripts"
-
-      # Add Modernizr assets.
-      add_asset_paths asset_paths, "modernizr-rails", "javascripts"
-
-      # Add Zurb Foundation assets.
-      add_asset_paths asset_paths, "foundation-rails", "javascripts"
-      add_asset_paths asset_paths, "foundation-rails", "stylesheets"
-
-      # Configure log filter parameters.
+      app.config.app_middleware.use Gatekeeper, app.config.auther_settings
       app.config.filter_parameters += [:login, :password]
-
-      # Initialize Gatekeeper middleware.
-      app.config.app_middleware.use Auther::Gatekeeper, app.config.auther_settings
     end
 
     private
@@ -37,9 +22,5 @@ module Auther
     def full_gem_path name
       Gem.loaded_specs[name].full_gem_path
     end
-
-    def add_asset_paths paths, name, directory
-      paths << "#{full_gem_path name}/vendor/assets/#{directory}"
-    end
   end
 end

data/lib/auther/gatekeeper.rb

@@ -1,4 +1,5 @@
 module Auther
+  # Rack middleware that guards access to sensitive routes.
   class Gatekeeper
     attr_reader :application, :environment, :settings
 
@@ -70,7 +71,7 @@ module Auther
     end
 
     def clean_paths paths
-      paths.map { |path| path.chomp '/' }
+      paths.map { |path| path.chomp "/" }
     end
 
     def blacklisted_paths
@@ -82,23 +83,25 @@ module Auther
       blacklisted_paths.select { |blacklisted_path| path.include? blacklisted_path }
     end
 
-    def authenticated? account
+    def account_authenticated? account
       keymaster = Auther::Keymaster.new account.fetch(:name)
       cipher = Auther::Cipher.new settings.secret
 
-      begin
-        session_login = cipher.decrypt session[keymaster.login_key]
-        session_password = cipher.decrypt session[keymaster.password_key]
-        account_login = cipher.decrypt account.fetch(:encrypted_login)
-        account_password = cipher.decrypt account.fetch(:encrypted_password)
-
-        authenticated = session_login == account_login && session_password == account_password
-        log_authentication authenticated, account.fetch(:name)
-        authenticated
-      rescue ActiveSupport::MessageVerifier::InvalidSignature => error
-        log_info %(Authentication failed! Invalid credential(s) for "#{account.fetch :name}" account.)
-        false
-      end
+      session_login = cipher.decrypt session[keymaster.login_key]
+      session_password = cipher.decrypt session[keymaster.password_key]
+      account_login = cipher.decrypt account.fetch(:encrypted_login)
+      account_password = cipher.decrypt account.fetch(:encrypted_password)
+
+      session_login == account_login && session_password == account_password
+    end
+
+    def authenticated? account
+      authenticated = account_authenticated? account
+      log_authentication authenticated, account.fetch(:name)
+      authenticated
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      log_info %(Authentication failed! Invalid credential(s) for "#{account.fetch :name}" account.)
+      false
     end
 
     def account_authorized? account, path

data/lib/auther/identity.rb

@@ -1,4 +1,5 @@
 module Auther
+  # Gem identity information.
   module Identity
     def self.name
       "auther"
@@ -9,11 +10,11 @@ module Auther
     end
 
     def self.version
-      "4.1.0"
+      "5.0.0"
     end
 
     def self.label_version
-      [label, version].join " "
+      "#{label} #{version}"
     end
   end
 end

data/lib/auther/keymaster.rb

@@ -1,4 +1,5 @@
 module Auther
+  # Provides access to setting keys.
   class Keymaster
     attr_reader :account_name
 
@@ -7,13 +8,13 @@ module Auther
     end
 
     def self.redirect_url_key options = {}
-      [namespace, "redirect", "url"] * options.fetch(:delimiter, '_')
+      [namespace, "redirect", "url"] * options.fetch(:delimiter, "_")
     end
 
     def self.get_account_name session = {}
       matching_keys = session.keys.select { |key| key.to_s =~ /auther.+login/ }
-      key = matching_keys.first || ''
-      key.gsub("#{namespace}_", '').gsub "_login", ''
+      key = matching_keys.first || ""
+      key.gsub("#{namespace}_", "").gsub "_login", ""
     end
 
     def self.get_account_login session = {}
@@ -36,7 +37,7 @@ module Auther
     private
 
     def build_key key_name, options = {}
-      [self.class.namespace, account_name, key_name].compact * options.fetch(:delimiter, '_')
+      [self.class.namespace, account_name, key_name].compact * options.fetch(:delimiter, "_")
     end
   end
 end

data/lib/auther/null_logger.rb

@@ -1,22 +1,22 @@
 module Auther
   # The default logger which purposefully does nothing at all.
   class NullLogger
-    def initialize(*)
+    def initialize _
     end
 
-    def info(*)
+    def info _
     end
 
-    def warn(*)
+    def warn _
     end
 
-    def error(*)
+    def error _
     end
 
-    def fatal(*)
+    def fatal _
     end
 
-    def debug(*)
+    def debug _
     end
   end
 end

data/lib/auther/settings.rb

@@ -1,14 +1,21 @@
 module Auther
+  # Represents Auther settings.
   class Settings
     attr_reader :title, :label, :secret, :accounts, :auth_url, :logger
 
-    def initialize options = {}
-      @title = options.fetch :title, "Authorization"
-      @label = options.fetch :title, "Authorization"
-      @secret = options.fetch :secret, nil
-      @accounts = options.fetch :accounts, []
-      @auth_url = options.fetch :auth_url, "/login"
-      @logger = options.fetch :logger, Auther::NullLogger.new(STDOUT)
+    def initialize title: "Authorization",
+                   label: "Authorization",
+                   secret: "",
+                   accounts: [],
+                   auth_url: "/login",
+                   logger: Auther::NullLogger.new(STDOUT)
+
+      @title = title
+      @label = label
+      @secret = secret
+      @accounts = accounts
+      @auth_url = auth_url
+      @logger = logger
     end
 
     def find_account name

data/lib/auther/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/auther/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

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

@@ -1,4 +1,5 @@
 module Auther
+  # Install generator for adding Auther support to existing application.
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.join(File.dirname(__FILE__), "..", "templates")
 

data/vendor/assets/stylesheets/bitters/_base.scss

@@ -0,0 +1,10 @@
+// Bitters 1.1.0
+// http://bitters.bourbon.io
+// Copyright 2013-2015 thoughtbot, inc.
+// MIT License
+
+@import "variables";
+@import "grid-settings";
+@import "buttons";
+@import "forms";
+@import "typography";

data/vendor/assets/stylesheets/bitters/_buttons.scss

@@ -0,0 +1,35 @@
+#{$all-buttons} {
+  appearance: none;
+  background-color: $action-color;
+  border: 0;
+  border-radius: $base-border-radius;
+  color: #fff;
+  cursor: pointer;
+  display: inline-block;
+  font-family: $base-font-family;
+  font-size: $base-font-size;
+  -webkit-font-smoothing: antialiased;
+  font-weight: 600;
+  line-height: 1;
+  padding: $small-spacing $base-spacing;
+  text-decoration: none;
+  transition: background-color $base-duration $base-timing;
+  user-select: none;
+  vertical-align: middle;
+  white-space: nowrap;
+
+  &:hover,
+  &:focus {
+    background-color: shade($action-color, 20%);
+    color: #fff;
+  }
+
+  &:disabled {
+    cursor: not-allowed;
+    opacity: 0.5;
+
+    &:hover {
+      background-color: $action-color;
+    }
+  }
+}