trestle-auth 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80c40a35773f90ba2b88c6c7af72ffe90adcb9c5
+  data.tar.gz: 930feb5ddb650ada9bbfe02c6cca9b065dcc92e5
+SHA512:
+  metadata.gz: af280f95145ceafa64841d50e3efe63d311f027297ebc72d5bc1e46e4f80406b786baaa5a780acd380239e749f3be87576d481098d09f197c94b2e61b895e1ff
+  data.tar.gz: 1eaf8e6473f391122c785e33692c03a9effc59ceb716a0c380344e25176a6c672fe4aa7ebe7aada5ec420d1a2587635914eb607a4cf129add8d726e6818d3cb3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trestle-auth.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,31 @@
+# Trestle Authentication (trestle-auth)
+
+> Authentication plugin for the Trestle admin framework
+
+<img src="https://trestle.io/images/Trestle-Auth.png" width="50%" />
+
+
+## Getting Started
+
+These instructions assume you have a working Trestle application. To integrate trestle-auth, first add it to your application's Gemfile:
+
+```ruby
+gem 'trestle-auth'
+```
+
+Run `bundle install`, and then run the install generator to set up configuration options, user model and user admin resource.
+
+    $ rails generate trestle:auth:install
+    $ rake db:migrate
+
+Then create an initial admin user from the rails console:
+
+    $ rails console
+    > User.create(email: "admin@example.com", password: "password", first_name: "Admin", last_name: "User")
+
+After restarting your Rails server, any attempt to access a page within your admin will redirect you to the login page.
+
+
+## License
+
+The gem is available as open source under the terms of the [LGPLv3 License](https://opensource.org/licenses/LGPL-3.0).

data/Rakefile

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

data/app/assets/stylesheets/trestle/auth/_form.scss

@@ -0,0 +1,114 @@
+a {
+  color: rgba(white, 0.75);
+  &:hover { color: white; }
+}
+
+.auth-header {
+  text-align: center;
+  margin-bottom: 20px;
+
+  img {
+    max-width: 100%;
+  }
+}
+
+.remember-me {
+  display: block;
+  font-weight: normal;
+  color: rgba(white, 0.75);
+  background: rgba(black, 0.075);
+  border-radius: 5px;
+  padding: 10px 15px;
+  font-size: 13px;
+  cursor: pointer;
+
+  input {
+    margin-right: 10px;
+  }
+
+  &:hover {
+    background: rgba(black, 0.1);
+  }
+}
+
+.form-control, .input-group-addon {
+  background: rgba(white, 0.1);
+  border: none;
+}
+
+.form-control {
+  box-shadow: none;
+
+  color: white;
+
+  height: auto;
+  padding: 12px 5px;
+
+  font-size: 16px;
+
+  &:focus {
+    outline-color: transparent;
+    outline-style: none;
+    box-shadow: none;
+  }
+
+  &::placeholder {
+    color: rgba(white, 0.5);
+  }
+
+  &:-webkit-autofill {
+    -webkit-text-fill-color: white;
+
+    &, &:hover, &:focus, &:active {
+      transition: background-color 9999999s ease-in-out 0s;
+    }
+  }
+}
+
+.input-group-addon {
+  color: rgba(white, 0.5);
+
+  &:first-child {
+    padding-right: 5px;
+  }
+}
+
+.btn {
+  box-shadow: rgba(black, 0.1) 0 0 2px;
+  padding: 12px;
+  font-size: 16px;
+}
+
+.btn-primary {
+  outline: none;
+
+  &:hover {
+    background-color: darken($btn-primary-bg, 2.5%);
+    border-color: darken($btn-primary-border, 5%);
+  }
+
+  &:focus, &:active {
+    background-color: darken($btn-primary-bg, 5%);
+    border-color: darken($btn-primary-border, 10%);
+  }
+
+  &:active:focus {
+    outline: none !important;
+    background-color: darken($btn-primary-bg, 10%);
+    border-color: darken($btn-primary-border, 15%);
+  }
+}
+
+.form-footer {
+  font-size: 12px;
+}
+
+.forgot-password {
+  float: right;
+  padding: 10px 5px;
+}
+
+.alert-danger {
+  background: $theme-bg-texture-url fixed, $alert-danger-bg;
+  color: white;
+}

data/app/assets/stylesheets/trestle/auth/_layout.scss

@@ -0,0 +1,20 @@
+html, body {
+  height: 100%;
+}
+
+body {
+  -webkit-font-smoothing: antialiased;
+
+  margin: 0;
+  overflow: hidden;
+
+  color: white;
+  background: $theme-bg;
+
+  display: flex;
+}
+
+.container {
+  margin: auto;
+  width: 320px;
+}

data/app/assets/stylesheets/trestle/auth/userbox.scss

@@ -0,0 +1,49 @@
+@import "trestle/support";
+
+.userbox {
+  margin-top: 2px;
+  margin-bottom: 2px;
+
+  > a {
+    color: $text-color;
+
+    display: block;
+    padding: 2px 0;
+
+    font-size: 14px;
+    font-weight: normal;
+    line-height: 40px;
+
+    &:hover, &:focus {
+      text-decoration: none;
+    }
+  }
+
+  .avatar {
+    vertical-align: top;
+    margin-left: 6px;
+  }
+
+  .name {
+    color: $text-color;
+  }
+}
+
+@include mobile {
+  .userbox {
+    position: relative;
+    z-index: 5;
+
+    > a, .name {
+      color: white;
+    }
+
+    .name {
+      display: none;
+    }
+
+    .avatar {
+      border: 1px solid rgba(white, 0.25);
+    }
+  }
+}

data/app/assets/stylesheets/trestle/auth.scss

@@ -0,0 +1,9 @@
+// User-defined variables
+@import "trestle/support";
+
+// 3rd party dependencies
+@import "trestle/bootstrap";
+@import "trestle/font-awesome";
+
+@import "auth/layout";
+@import "auth/form";

data/app/controllers/trestle/auth/sessions_controller.rb

@@ -0,0 +1,24 @@
+class Trestle::Auth::SessionsController < Trestle::ApplicationController
+  layout 'trestle/auth'
+
+  skip_before_action :require_authenticated_user
+
+  def new
+  end
+
+  def create
+    if user = Trestle.config.auth.authenticate(params)
+      login!(user)
+      remember_me! if Trestle.config.auth.remember.enabled && params[:remember_me] == "1"
+      redirect_to previous_location || Trestle.config.path
+    else
+      flash[:error] = t("admin.auth.error", default: "Incorrect login details.")
+      redirect_to action: :new
+    end
+  end
+
+  def destroy
+    logout!
+    redirect_to login_url
+  end
+end

data/app/helpers/trestle/auth/user_helper.rb

@@ -0,0 +1,13 @@
+module Trestle::Auth::UserHelper
+  def format_user_name(user)
+    if user.respond_to?(:first_name) && user.respond_to?(:last_name)
+      safe_join([user.first_name, content_tag(:strong, user.last_name)], " ")
+    else
+      display(user)
+    end
+  end
+
+  def avatar_for(user)
+    avatar { instance_exec(user, &Trestle.config.auth.avatar) } if Trestle.config.auth.avatar
+  end
+end

data/app/views/layouts/trestle/auth.html.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <meta content='width=device-width, initial-scale=1' name='viewport'>
+    <meta content='IE=edge,chrome=1' http-equiv='X-UA-Compatible'>
+
+    <meta content='no-cache' name='turbolinks-cache-control'>
+
+    <%= csrf_meta_tags %>
+
+    <title><%= Trestle.config.site_title %></title>
+
+    <%= stylesheet_link_tag "trestle/auth", 'data-turbolinks-track': 'reload' %>
+
+    <%= javascript_include_tag "turbolinks" if defined?(Turbolinks) %>
+    <%= javascript_include_tag "trestle/auth", 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <main class="container">
+      <header class="auth-header">
+        <h1>
+          <% if Trestle.config.site_logo -%>
+            <%= image_tag(Trestle.config.site_logo, alt: Trestle.config.site_title) %>
+          <% elsif Trestle.config.site_logo_small -%>
+            <%= image_tag(Trestle.config.site_logo_small, alt: Trestle.config.site_title) %>
+          <% else -%>
+            <%= Trestle.config.site_title %>
+          <% end -%>
+        </h1>
+      </header>
+
+      <%= yield %>
+    </main>
+  </body>
+</html>

data/app/views/trestle/auth/_userbox.html.erb

@@ -0,0 +1,17 @@
+<div class="userbox pull-right dropdown">
+  <%= link_to "#", class: 'dropdown-toggle', data: { toggle: 'dropdown' } do %>
+    <span class="name">
+      <%= format_user_name(current_user) %>
+      <span class="caret"></span>
+    </span>
+
+    <%= avatar_for(current_user) %>
+  <% end %>
+
+  <ul class="dropdown-menu dropdown-menu-right">
+    <% if Trestle.config.auth.user_admin && user_admin = Trestle.lookup(Trestle.config.auth.user_admin) -%>
+      <li><%= link_to t("admin.auth.my_account", default: "My Account"), user_admin.path(:show, id: current_user), class: "dropdown-item" %></li>
+    <% end -%>
+    <li><%= link_to t("admin.auth.logout", default: "Log out"), trestle.logout_path, class: "dropdown-item" %></li>
+  </ul>
+</div>

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

@@ -0,0 +1,38 @@
+<%= form_tag login_path, class: "login-form" do %>
+  <%= hook("auth.login.heading") %>
+
+  <% if flash[:error] -%>
+    <div class="alert alert-danger">
+      <p><%= flash[:error] %></p>
+    </div>
+  <% end -%>
+
+  <div class="form-group">
+    <div class="input-group">
+      <span class="input-group-addon"><i class="fa fa-user fa-fw"></i></span>
+      <%= text_field_tag Trestle.config.auth.authenticate_with, "", placeholder: Trestle.config.auth.authenticate_with.to_s.humanize, class: "form-control" %>
+    </div>
+  </div>
+
+  <div class="form-group">
+    <div class="input-group">
+      <span class="input-group-addon"><i class="fa fa-lock fa-fw"></i></span>
+      <%= password_field_tag :password, "", placeholder: "Password", class: "form-control" %>
+    </div>
+  </div>
+
+  <%= hook("auth.login.form") %>
+
+  <% if Trestle.config.auth.remember.enabled %>
+  <div class="form-group">
+    <label class="remember-me">
+      <%= check_box_tag :remember_me %>
+      <%= t("admin.auth.remember_me", default: "Remember me") %>
+    </label>
+  </div>
+  <% end %>
+
+  <div class="form-group">
+    <%= submit_tag t("admin.auth.login", default: "Login"), class: "btn btn-primary btn-block" %>
+  </div>
+<% end %>

data/config/initializers/trestle.rb

@@ -0,0 +1,9 @@
+Trestle.configure do |config|
+  config.hook("stylesheets") do
+    stylesheet_link_tag("trestle/auth/userbox")
+  end
+
+  config.hook("view.header") do
+    render "trestle/auth/userbox"
+  end
+end

data/config/locale/en.yml

@@ -0,0 +1,8 @@
+en:
+  admin:
+    auth:
+      my_account: My Account
+      login: Login
+      logout: Logout
+      error: Incorrect login details.
+      remember_me: Remember me

data/config/routes.rb

@@ -0,0 +1,7 @@
+Trestle::Engine.routes.draw do
+  controller "trestle/auth/sessions" do
+    get  'login'  => :new, as: :login
+    post 'login'  => :create
+    get  'logout' => :destroy, as: :logout
+  end
+end

data/lib/generators/trestle/auth/admin/admin_generator.rb

@@ -0,0 +1,22 @@
+module Trestle
+  module Auth
+    module Generators
+      class AdminGenerator < ::Rails::Generators::Base
+        desc "Creates a Trestle admin for managing Administrators"
+
+        argument :model, type: :string, default: "Administrator"
+
+        source_root File.expand_path("../templates", __FILE__)
+
+        def create_admin
+          template "admin.rb.erb", File.join('app/admin/auth', "#{model.underscore.pluralize}_admin.rb")
+        end
+
+      protected
+        def plural_name
+          model.demodulize.underscore.pluralize
+        end
+      end
+    end
+  end
+end

data/lib/generators/trestle/auth/admin/templates/admin.rb.erb

@@ -0,0 +1,33 @@
+Trestle.resource(:<%= plural_name %>, model: Trestle.config.auth.user_class, scope: Auth) do
+  menu do
+    group :configuration, priority: :last do
+      item :<%= plural_name %>, icon: "fa fa-users"
+    end
+  end
+
+  table do
+    column :avatar, header: false do |administrator|
+      avatar_for(administrator)
+    end
+    column :email, link: true
+    column :first_name
+    column :last_name
+    actions do |a|
+      a.delete unless a.instance == current_user
+    end
+  end
+
+  form do |administrator|
+    text_field :email
+
+    row do
+      col(sm: 6) { text_field :first_name }
+      col(sm: 6) { text_field :last_name }
+    end
+
+    row do
+      col(sm: 6) { password_field :password }
+      col(sm: 6) { password_field :password_confirmation }
+    end
+  end
+end

data/lib/generators/trestle/auth/install/install_generator.rb

@@ -0,0 +1,95 @@
+module Trestle
+  module Auth
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc "Installs trestle-auth"
+
+        argument :model, type: :string, default: "Administrator"
+
+        def insert_configuration
+          inject_into_file "config/initializers/trestle.rb", before: /^end/ do
+            <<-RUBY.strip_heredoc.indent(2)
+
+              # == Authentication Options
+              #
+              # Specify the user class to be used by trestle-auth.
+              #
+              config.auth.user_class = -> { #{model} }
+
+              # Specify the scope for valid admin users.
+              # Defaults to config.auth.user_class (unscoped).
+              #
+              # config.auth.user_scope = -> { User.where(admin: true) }
+
+              # Specify the Trestle admin for managing administrator users.
+              #
+              config.auth.user_admin = -> { :"auth/#{model.underscore.pluralize}" }
+
+              # Specify the parameter (along with a password) to be used to
+              # authenticate an administrator. Defaults to :email.
+              #
+              # config.auth.authenticate_with = :login
+
+              # Customize the method for authenticating a user given login parameters.
+              # The block should return an instance of the auth user class, or nil.
+              #
+              # config.auth.authenticate = ->(params) {
+              #   User.authenticate(params[:login], params[:password])
+              # }
+
+              # Customize the rendering of user avatars. Can be disabled by setting to false.
+              # Defaults to the Gravatar based on the user's email address.
+              #
+              # config.auth.avatar = ->(user) {
+              #   image_tag(user.avatar_url, alt: user.name)
+              # }
+
+              # Customize the method for determining the user's locale.
+              # Defaults to user.locale (if the method is defined).
+              #
+              # config.auth.locale = ->(user) {
+              #   user.locale if user.respond_to?(:locale)
+              # }
+
+              # Enable or disable remember me functionality. Defaults to true.
+              #
+              # config.auth.remember.enabled = false
+
+              # Specify remember me expiration time. Defaults to 2 weeks.
+              #
+              # config.auth.remember.for = 30.days
+
+              # Customize the method for authenticating a user given a remember token.
+              #
+              # config.auth.remember.authenticate = ->(token) {
+              #   User.authenticate_with_remember_token(token)
+              # }
+
+              # Customize the method for remembering a user.
+              #
+              # config.auth.remember.remember_me, ->(user) { user.remember_me! }
+
+              # Customize the method for forgetting a user.
+              #
+              # config.auth.remember.forget_me, ->(user) { user.forget_me! }
+
+              # Customize the method for generating the remember cookie.
+              #
+              # config.auth.remember.cookie, ->(user) {
+              #   { value: user.remember_token, expires: user.remember_token_expires_at }
+              # }
+            RUBY
+          end
+        end
+
+        def generate_model
+          generate "trestle:auth:model", model
+        end
+
+        def generate_admin
+          generate "trestle:auth:admin", model
+        end
+      end
+    end
+  end
+end

data/lib/generators/trestle/auth/model/model_generator.rb

@@ -0,0 +1,19 @@
+module Trestle
+  module Auth
+    module Generators
+      class ModelGenerator < ::Rails::Generators::Base
+        desc "Creates an Administrator model for use with trestle-auth"
+
+        argument :name, type: :string, default: "Administrator"
+
+        def create_model
+          generate "model", "#{name} email:string password_digest:string first_name:string last_name:string remember_token:string remember_token_expires_at:datetime"
+        end
+
+        def inject_model_methods
+          inject_into_file "app/models/#{name.underscore}.rb", "  include Trestle::Auth::ModelMethods\n  include Trestle::Auth::ModelMethods::Rememberable\n", before: /^end/
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/configuration/rememberable.rb

@@ -0,0 +1,30 @@
+module Trestle
+  module Auth
+    class Configuration
+      class Rememberable
+        include Configurable
+
+        option :enabled, true
+
+        option :for, 2.weeks
+
+        option :authenticate, ->(token) {
+          scope = Trestle.config.auth.user_scope
+          scope.authenticate_with_remember_token(token)
+        }
+
+        option :remember_me, ->(user) {
+          user.remember_me!
+        }
+
+        option :forget_me, ->(user) {
+          user.forget_me!
+        }
+
+        option :cookie, ->(user) {
+          { value: user.remember_token, expires: user.remember_token_expires_at }
+        }
+      end
+    end
+  end
+end

data/lib/trestle/auth/configuration.rb

@@ -0,0 +1,36 @@
+module Trestle
+  module Auth
+    class Configuration
+      extend ActiveSupport::Autoload
+
+      autoload :Rememberable
+
+      include Configurable
+
+      option :user_class, -> { ::Administrator }
+      option :user_scope, -> { Trestle.config.auth.user_class }
+      option :user_admin
+
+      option :authenticate_with, :email
+
+      option :authenticate, ->(params) {
+        scope = Trestle.config.auth.user_scope
+
+        scope.authenticate(
+          params[Trestle.config.auth.authenticate_with],
+          params[:password]
+        )
+      }
+
+      option :avatar, ->(user) {
+        gravatar(user.email)
+      }, evaluate: false
+
+      option :locale, ->(user) {
+        user.locale if user.respond_to?(:locale)
+      }
+
+      option :remember, Rememberable.new
+    end
+  end
+end

data/lib/trestle/auth/controller_methods.rb

@@ -0,0 +1,77 @@
+module Trestle
+  module Auth
+    module ControllerMethods
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :current_user, :logged_in?
+
+        before_action :require_authenticated_user
+        around_action :set_locale
+      end
+
+    protected
+      def current_user
+        @current_user ||= begin
+          if session[:trestle_user]
+            Trestle.config.auth.user_scope.find_by(id: session[:trestle_user])
+          elsif Trestle.config.auth.remember.enabled && token = cookies.signed[:trestle_remember_token]
+            user = Trestle.config.auth.remember.authenticate(token)
+            login!(user) if user
+            user
+          end
+        end
+      end
+
+      def login!(user)
+        session[:trestle_user] = user.id
+        @current_user = user
+      end
+
+      def logout!
+        forget_me!
+        session.delete(:trestle_user)
+        @current_user = nil
+      end
+
+      def logged_in?
+        !!current_user
+      end
+
+      def store_location
+        session[:trestle_return_to] = request.fullpath
+      end
+
+      def previous_location
+        session.delete(:trestle_return_to)
+      end
+
+      def require_authenticated_user
+        logged_in? || login_required!
+      end
+
+      def login_required!
+        store_location
+        redirect_to trestle.login_url
+        false
+      end
+
+      def remember_me!
+        Trestle.config.auth.remember.remember_me(current_user)
+        cookies.signed[:trestle_remember_token] = Trestle.config.auth.remember.cookie(current_user)
+      end
+
+      def forget_me!
+        Trestle.config.auth.remember.forget_me(current_user) if logged_in?
+        cookies.delete(:trestle_remember_token)
+      end
+
+      def set_locale
+        self.locale = Trestle.config.auth.locale(current_user) || I18n.default_locale if logged_in?
+        yield
+      ensure
+        self.locale = I18n.default_locale
+      end
+    end
+  end
+end

data/lib/trestle/auth/engine.rb

@@ -0,0 +1,15 @@
+module Trestle
+  module Auth
+    class Engine < ::Rails::Engine
+      config.assets.precompile << "trestle/auth.css" << "trestle/auth.js" << "trestle/auth/userbox.scss"
+
+      initializer "trestle.auth.helpers" do
+        Trestle::Engine.paths["app/helpers"].concat(paths["app/helpers"].existent)
+      end
+
+      config.to_prepare do
+        Trestle::ApplicationController.send(:include, Trestle::Auth::ControllerMethods)
+      end
+    end
+  end
+end

data/lib/trestle/auth/model_methods/rememberable.rb

@@ -0,0 +1,28 @@
+module Trestle
+  module Auth
+    module ModelMethods
+      module Rememberable
+        extend ActiveSupport::Concern
+
+        def remember_me!
+          update(remember_token: SecureRandom.urlsafe_base64(15), remember_token_expires_at: Time.now + Trestle.config.auth.remember.for)
+        end
+
+        def forget_me!
+          update(remember_token: nil, remember_token_expires_at: nil)
+        end
+
+        def remember_token_expired?
+          remember_token_expires_at.nil? || Time.now > remember_token_expires_at
+        end
+
+        module ClassMethods
+          def authenticate_with_remember_token(token)
+            user = find_by(remember_token: token)
+            user if user && !user.remember_token_expired?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/model_methods.rb

@@ -0,0 +1,21 @@
+module Trestle
+  module Auth
+    module ModelMethods
+      extend ActiveSupport::Concern
+      extend ActiveSupport::Autoload
+
+      autoload :Rememberable
+
+      included do
+        has_secure_password
+      end
+
+      module ClassMethods
+        def authenticate(identifier, password)
+          user = find_by(Trestle.config.auth.authenticate_with => identifier) || NullUser.new
+          user.authenticate(password)
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/null_user.rb

@@ -0,0 +1,13 @@
+module Trestle
+  module Auth
+    class NullUser
+      def authenticate(*)
+        BCrypt::Password.new(self.class.password).is_password?("incorrect")
+      end
+
+      def self.password
+        @password ||= BCrypt::Password.create("password", cost: BCrypt::Engine.cost)
+      end
+    end
+  end
+end

data/lib/trestle/auth/version.rb

@@ -0,0 +1,5 @@
+module Trestle
+  module Auth
+    VERSION = "0.2.0"
+  end
+end

data/lib/trestle/auth.rb

@@ -0,0 +1,16 @@
+require "trestle/auth/version"
+
+module Trestle
+  module Auth
+    extend ActiveSupport::Autoload
+
+    autoload :Configuration
+    autoload :ControllerMethods
+    autoload :ModelMethods
+    autoload :NullUser
+  end
+
+  Configuration.option :auth, Auth::Configuration.new
+end
+
+require "trestle/auth/engine" if defined?(Rails)

data/trestle-auth.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trestle/auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trestle-auth"
+  spec.version       = Trestle::Auth::VERSION
+
+  spec.authors       = ["Sam Pohlenz"]
+  spec.email         = ["sam@sampohlenz.com"]
+
+  spec.summary       = "Authentication plugin for the Trestle admin framework"
+  spec.description   = "Authentication plugin for the Trestle admin framework."
+  spec.homepage      = "https://www.trestle.io"
+  spec.license       = "LGPL-3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "trestle", "~> 0.8"
+  spec.add_dependency "bcrypt",  "~> 3.1.7"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: trestle-auth
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Sam Pohlenz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trestle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Authentication plugin for the Trestle admin framework.
+email:
+- sam@sampohlenz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/trestle/auth.js
+- app/assets/stylesheets/trestle/auth.scss
+- app/assets/stylesheets/trestle/auth/_form.scss
+- app/assets/stylesheets/trestle/auth/_layout.scss
+- app/assets/stylesheets/trestle/auth/userbox.scss
+- app/controllers/trestle/auth/sessions_controller.rb
+- app/helpers/trestle/auth/user_helper.rb
+- app/views/layouts/trestle/auth.html.erb
+- app/views/trestle/auth/_userbox.html.erb
+- app/views/trestle/auth/sessions/new.html.erb
+- config/initializers/trestle.rb
+- config/locale/en.yml
+- config/routes.rb
+- lib/generators/trestle/auth/admin/admin_generator.rb
+- lib/generators/trestle/auth/admin/templates/admin.rb.erb
+- lib/generators/trestle/auth/install/install_generator.rb
+- lib/generators/trestle/auth/model/model_generator.rb
+- lib/trestle/auth.rb
+- lib/trestle/auth/configuration.rb
+- lib/trestle/auth/configuration/rememberable.rb
+- lib/trestle/auth/controller_methods.rb
+- lib/trestle/auth/engine.rb
+- lib/trestle/auth/model_methods.rb
+- lib/trestle/auth/model_methods/rememberable.rb
+- lib/trestle/auth/null_user.rb
+- lib/trestle/auth/version.rb
+- trestle-auth.gemspec
+homepage: https://www.trestle.io
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Authentication plugin for the Trestle admin framework
+test_files: []