auther 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f17e327c4dabbffda8ee383dae1ef6bdeaf24133
-  data.tar.gz: 67bf753f588c0e086648e03797a5d2dfa8ada553
+  metadata.gz: f2ae43fc51d37f75faf9fa729587498f09194c1b
+  data.tar.gz: 26b8e79adab7feaa6d2eee41bd80a03e4a214ed1
 SHA512:
-  metadata.gz: 6888f4b765335b231ac2209f9982a1e079eb0ba2ee5858c2818e4cffdba3020fed4795f777bd03a13db572163abab3080559a4f2115eb12a557ff7f29153773a
-  data.tar.gz: 3ae905d11cb2351d79ffc72412265f0d2f4daa9a59f8eda196d08ad7e431e25273e150d45400530cd996c5c20ce2cba248b56e0c53f9d9b30334e05cf52d6811
+  metadata.gz: ad47869986c5cf8d48157656433b8b48474e6e745a5858e36d3f9e5263647a6d75e7309520a006684262846570b122e249ea235687accc503086a147ada3376c
+  data.tar.gz: 7ae485b60d8155f5c211c3b43af3a9bb5886089dc7dd44415f6d8c800b4184610bf5e917b9e8e976cb8d350dff5319c6212c645060e952ecd8e4523427f19594

data/README.md

@@ -1,23 +1,27 @@
 # Overview
 
-Provides simple, form-based authentication for apps that need security but don't want to use the clunky UI of
-HTTP Basic Authentication and/or want to be compatible with password managers.
-
 [![Gem Version](https://badge.fury.io/rb/auther.png)](http://badge.fury.io/rb/auther)
 [![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/auther.png)](https://codeclimate.com/github/bkuhlmann/auther)
 [![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/auther.png)](http://travis-ci.org/bkuhlmann/auther)
 
+Provides simple, form-based authentication for apps that need security but don't want to deal with the clunky UI
+of HTTP Basic Authentication or something as heavyweight as [Devise](https://github.com/plataformatec/devise). It
+doesn't require a database and is compatible with password managers like [1Password](https://agilebits.com/onepassword)
+making for a pleasent user experience.
+
 # Features
 
 * Form-based authentication compatible with password managers like [1Password](https://agilebits.com/onepassword).
 
-[![Screenshot](https://github.com/bkuhlmann/auther/raw/master/screenshot.png)](https://github.com/bkuhlmann/auther)
+[![Screenshot - Clean](https://github.com/bkuhlmann/auther/raw/master/screenshot-clean.png)](https://github.com/bkuhlmann/auther)
+[![Screenshot - Error](https://github.com/bkuhlmann/auther/raw/master/screenshot-error.png)](https://github.com/bkuhlmann/auther)
 
-* Encrypted session account credentials.
+* Encrypted account credentials.
 * Multiple account support with account specific blacklisted paths.
+* Log filtering for account credentials (login and password).
 * Auto-redirection to requested path (once credentials have been verified).
-* Customizable session view.
-* Customizable session controller.
+* Customizable view.
+* Customizable controller.
 
 # Requirements
 
@@ -67,10 +71,16 @@ Edit your application.rb as follows:
       end
     end
 
-NOTE: The decrypted account credentials, for example above, are as follows:
+The purpose of each setting is as follows:
 
-* login: test@test.com
-* password: password
+* *title* - The HTML page title (as rendered within a browser tab).
+* *label* - The page label (what would appear above the form).
+* *accounts* - The array of accounts with different or similar access to the application.
+    * *login* - The encrypted account login. For example, the above decrypts to: *test@test.com*.
+    * *password* - The encrypted account password. For example, the above decrypts to: *password*.
+    * *paths* - The array of blacklisted paths for which only this account has access to.
+* *secret* - The secret passphrase used to encrypt/decrypt account credentials.
+* *auth_url* - The URL to redirect to when enforcing authentication to a blacklisted path.
 
 # Usage
 
@@ -95,9 +105,9 @@ To encrypt/decrypt account credentials, launch a rails console and type the foll
 ## Model
 
 The [Auther::Account](app/models/auther/account.rb) is a plain old Ruby object that uses ActiveRecord validations
-to aid in form/credential validation. This model could potentially be replaced with a database-backed object if
-desired (would require controller customization)...but, if this neccessary, you might want to question if you have
-outgrown the use of this gem and require a different solution altogether.
+to aid in form/credential validation. This model could potentially be replaced with a database-backed object
+(would require controller customization)...but you might want to question if you have outgrown the use of this
+gem and need a different solution altogether if it comes to that.
 
 ## Views
 
@@ -106,11 +116,14 @@ default Auther::SessionController implementation is sufficient):
 
     app/views/auther/session/new.html
 
+The form can be stylized by attaching new styles to the .authorization class (see
+[auther.scss](app/assets/stylesheets/auther/auther.scss) for details).
+
 ## Controller
 
 The [Auther::SessionController](app/controllers/auther/session_controller.rb) inherits from the
 [Auther::BaseController](app/controllers/auther/base_controller.rb). To customize, it is recommended that
-you add a controller to your app that inherit from the Auther::BaseController. Example:
+you add a controller to your app that inherits from the Auther::BaseController. Example:
 
     # Example Path:  app/controllers/session_controller.rb
     class SessionController < Auther::BaseController

data/app/assets/stylesheets/auther/application.scss

@@ -1 +1,2 @@
 @import "foundation_and_overrides";
+@import "auther";

data/app/assets/stylesheets/auther/auther.scss

@@ -0,0 +1,12 @@
+.authorization {
+  position: relative;
+  top: 25%;
+  -webkit-transform: translateY(25%);
+  -ms-transform: translateY(25%);
+  transform: translateY(25%);
+
+  .authorization-label {
+    text-align: center !important;
+    margin-bottom: 0.5em;
+  }
+}

data/app/helpers/auther/foundation_helper.rb

@@ -0,0 +1,8 @@
+module Auther
+  module FoundationHelper
+    def render_foundation_error enabled, classes: []
+      classes << "error" if enabled
+      classes.compact * ' '
+    end
+  end
+end

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

@@ -1,36 +1,43 @@
 - content_for(:title) { @title }
 
-= form_for @account, as: :account, url: "/auther/session", html: {class: "auther-form"} do |form|
-  .small-12
-    .row
-      h1.text-center = @label
+- error_keys = @account.errors.keys
+- login_error = error_keys.include?(:login)
+- password_error = error_keys.include?(:password)
+- name_error = error_keys.include?(:name)
 
-    .row
-      .small-8
-        .row
-          .small-6.columns
-            = form.label :login, "Login:", class: "inline right"
-          .small-6.columns
-            = form.text_field :login
+.authorization
+  = form_for @account, as: :account, url: "/auther/session" do |form|
+    .small-12
+      .row
+        h1.authorization-label = @label
 
-    .row
-      .small-8
-        .row
-          .small-6.columns
-            = form.label :password, "Password:", class: "inline right"
-          .small-6.columns
-            = form.password_field :password
+      .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.errors.full_messages.first) 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.errors.full_messages.first) if password_error
 
-    .row
-      .small-8
-        .row
-          .small-6.columns
-            = form.label :name, "Account:", class: "inline right"
-          .small-6.columns
-            = form.select :name, @name_options
+      .row
+        .small-8
+          .row
+            .small-6.columns
+              = form.label :name, "Account:", class: "inline right"
+            .small-6.columns
+              = form.select :name, @name_options
 
-    .row
-      .small-8
-        .row
-          .small-6.right
-            = form.submit "Login", class: "button round expand"
+      .row
+        .small-8
+          .row
+            .small-6.right
+              = form.submit "Login", class: "button round expand"

data/lib/auther/version.rb

@@ -1,3 +1,3 @@
 module Auther
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auther
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   SJpzzzZ8gO6BKn4fhd+ENNQ333Qy3nuNk07TVIaNnlgeHhowUDuD9T7Z8Lka0pt3
   4PteiTppsf0SSVAM9zSO5IuFngXMRwWgvjOfXE70f43RDuUVTCSyylc=
   -----END CERTIFICATE-----
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -284,8 +284,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Rails Engine with simple, form-based authentication, session, and blacklist
-  route support.
+description: Enhances Rails with multi-account, form-based, database-less, application-wide
+  authentication as a Rails Engine.
 email:
 - brooke@redalchemist.com
 executables: []
@@ -298,10 +298,11 @@ files:
 - README.md
 - app/assets/javascripts/auther/application.js
 - app/assets/stylesheets/auther/application.scss
+- app/assets/stylesheets/auther/auther.scss
 - app/assets/stylesheets/auther/foundation_and_overrides.scss
 - app/controllers/auther/base_controller.rb
 - app/controllers/auther/session_controller.rb
-- app/helpers/auther/application_helper.rb
+- app/helpers/auther/foundation_helper.rb
 - app/models/auther/account.rb
 - app/views/auther/session/new.html.slim
 - app/views/layouts/auther/auth.html.slim
@@ -336,6 +337,7 @@ rubyforge_project:
 rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
-summary: A Rails Engine with simple, form-based authentication support.
+summary: Enhances Rails with multi-account, form-based, database-less, application-wide
+  authentication.
 test_files: []
 has_rdoc: 

data/app/helpers/auther/application_helper.rb

@@ -1,4 +0,0 @@
-module Auther
-  module ApplicationHelper
-  end
-end