trestle-auth 0.2.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71e10f075c0aee1777d1823511187dfac4d50788006476a5f1a67f9f3555b352
-  data.tar.gz: e00d07780f77c7914eeaffea5574143064dfe5adc514d5c0580d7d794834cff6
+  metadata.gz: bc7d72e5d295f88b10eeb2a14c1a854ba9f7cfb59617a4ec9dd4cea95d00295a
+  data.tar.gz: b4e1dfdcba7438acf673c6f36dc2cf4c81eba3c28dcd92d99403bee8f844c803
 SHA512:
-  metadata.gz: 46d21d2099835f6d7f80a41f98b6983c1de41c2f4fbec486f7c069038f881a7097d6c78377c41e6a1c9b1a8d2d1e2e453c177de2cbfcfbf44f3e3f9410556b14
-  data.tar.gz: dd803d5a8055402aa4f1b9c6351429c8c4160052e3b2f902db7c830894b78ed9d416f434f0ea99c8e823b043943152465a49df4cd3023494539c149780539629
+  metadata.gz: b2b1b76740eac08413c4e074cc2e8a530b8d428905d6fc9a48b2de814457a3cf1d1716698a14306466e93fa29afedf358258a320177cb2ac1e71e7c5b6ee24b7
+  data.tar.gz: 246cef636500c0e8337a1a0bf447923d251ee34c48a5de108becfd07b2320f8732e6b08610a0e7c1bf1e852f21d3d5818ac2eda71b4d7b71a9cb0071374be785

data/.browserslistrc

@@ -0,0 +1 @@
+> 0.25%

data/.gitignore

@@ -7,3 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/node_modules/
+/spec/dummy/db/*.sqlite3
+/spec/dummy/*.sqlite3-journal
+/spec/dummy/log/*.log
+/spec/dummy/tmp/*

data/.rspec

@@ -1,2 +1,3 @@
+--require spec_helper
 --format documentation
 --color

data/.travis.yml

@@ -1,5 +1,22 @@
-sudo: false
 language: ruby
+
+cache: bundler
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.12.5
+  - 2.6.5
+
+gemfile:
+  - gemfiles/rails-5.0.gemfile
+  - gemfiles/rails-5.1.gemfile
+  - gemfiles/rails-5.2.gemfile
+  - gemfiles/rails-6.0.gemfile
+
+jobs:
+  include:
+    gemfile: gemfiles/rails-4.2.gemfile
+    before_install:
+      - gem install bundler -v '< 2'

data/Gemfile

@@ -2,3 +2,17 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in trestle-auth.gemspec
 gemspec
+
+group :test do
+  gem "coveralls", require: false
+
+  gem "capybara"
+  gem "sqlite3", "~> 1.4"
+  gem "devise"
+end
+
+gem "sassc-rails"
+
+gem "rake", "~> 12.0"
+
+gem "trestle", github: "TrestleAdmin/trestle"

data/README.md

@@ -1,31 +1,58 @@
 # Trestle Authentication (trestle-auth)
 
+[![RubyGem](https://img.shields.io/gem/v/trestle-auth.svg?style=flat&colorB=4065a9)](https://rubygems.org/gems/trestle-auth)
+[![Travis](https://img.shields.io/travis/TrestleAdmin/trestle-auth.svg?style=flat)](https://travis-ci.org/TrestleAdmin/trestle-auth)
+[![Coveralls](https://img.shields.io/coveralls/TrestleAdmin/trestle-auth.svg?style=flat)](https://coveralls.io/github/TrestleAdmin/trestle-auth)
+
 > Authentication plugin for the Trestle admin framework
 
-<img src="https://trestle.io/images/Trestle-Auth.png" width="50%" />
+<img src="https://trestle.io/images/Trestle-Auth-1.png" width="50%" /><img src="https://trestle.io/images/Trestle-Auth-2.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:
+These instructions assume you have a working Trestle application. See the [Getting Started](https://github.com/TrestleAdmin/trestle#getting-started) section in the Trestle README.
+
+To integrate trestle-auth, first add it to your application's Gemfile, and then run `bundle install`:
 
 ```ruby
 gem 'trestle-auth'
 ```
 
-Run `bundle install`, and then run the install generator to set up configuration options, user model and user admin resource.
+As of version 0.4.0, trestle-auth now supports multiple authentication backends including Devise/Warden.
+
+
+### Option 1: Built-in Integration
 
-    $ rails generate trestle:auth:install
-    $ rake db:migrate
+Run the install generator to add the configuration to `config/initializers/trestle.rb`, and generate a `User` model and admin resource.
 
-Then create an initial admin user from the rails console:
+    $ rails generate trestle:auth:install User
 
-    $ rails console
-    > Administrator.create(email: "admin@example.com", password: "password", first_name: "Admin", last_name: "User")
+(if no user model name is specified it will default to `Administrator`)
+
+Then run your migrations with `rake db:migrate` and create an initial admin user from within `rails console`:
+
+```ruby
+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.
 
 
+### Option 2: Devise Integration
+
+If you already have an existing user model and Devise integration, you can configure trestle-auth to use that instead.
+
+    $ rails generate trestle:auth:install User --devise
+
+Replace `User` with the name of your Devise user model. If not specified, it will default to `Administrator`.
+
+
+## Configuration
+
+After running the `trestle:auth:install` generator, check your `config/initializers/trestle.rb` for further configuration options.
+
+
 ## License
 
 The gem is available as open source under the terms of the [LGPLv3 License](https://opensource.org/licenses/LGPL-3.0).

data/app/assets/bundle/trestle/auth/bundle.css

@@ -0,0 +1 @@
+.auth-body{display:flex;color:#fff}.auth-body .container{margin:auto;width:320px}.auth-header{text-align:center;margin-bottom:20px}.auth-header h1{display:flex;align-items:center;justify-content:center;font-size:1.75rem;font-weight:500;text-shadow:rgba(0,0,0,.5) 0 1px 1px;padding:.75rem 1rem}.auth-header img{max-width:80%;max-height:100%}.auth-header span{margin-left:10px}.login-form .form-control,.login-form .input-group-text{background:hsla(0,0%,100%,.1);border:0}.login-form .form-control{color:#fff;font-size:1.1rem;padding:1.75rem .75rem}.login-form .form-control:focus{outline-color:transparent;outline-style:none;box-shadow:none}.login-form .form-control::-webkit-input-placeholder{color:hsla(0,0%,100%,.5)}.login-form .form-control:-ms-input-placeholder{color:hsla(0,0%,100%,.5)}.login-form .form-control::-ms-input-placeholder{color:hsla(0,0%,100%,.5)}.login-form .form-control::placeholder{color:hsla(0,0%,100%,.5)}.login-form .form-control:-webkit-autofill{-webkit-text-fill-color:#fff}.login-form .form-control:-webkit-autofill,.login-form .form-control:-webkit-autofill:active,.login-form .form-control:-webkit-autofill:focus,.login-form .form-control:-webkit-autofill:hover{-webkit-transition:background-color 9999999s ease-in-out 0s;transition:background-color 9999999s ease-in-out 0s}.login-form .input-group-prepend{margin-right:0}.login-form .input-group-text{color:hsla(0,0%,100%,.5);padding:.375rem .25rem .375rem 1rem}.login-form .btn-primary{box-shadow:0 0 2px rgba(0,0,0,.1);padding-top:.75rem;padding-bottom:.75rem}.login-form .alert-danger{background-color:rgba(222,116,113,.75)}.login-form .remember-me{font-size:.95rem;line-height:1.5;padding-left:0}.login-form .remember-me .custom-control-label{display:block;cursor:pointer;background:rgba(0,0,0,.075);color:hsla(0,0%,100%,.75);border-radius:.25rem;padding:.75em 1.5em .75em 3.25em}.login-form .remember-me .custom-control-label:hover{background:rgba(0,0,0,.125)}.login-form .remember-me .custom-control-label:after,.login-form .remember-me .custom-control-label:before{top:.925em;left:1.1em}

data/app/assets/bundle/trestle/auth/userbox.css

@@ -0,0 +1 @@
+.userbox{order:99;padding:2px 0;display:flex;align-items:center}.userbox>a{color:#333;display:block;padding:2px 0;font-weight:400;line-height:40px}.userbox>a:focus,.userbox>a:hover{text-decoration:none}.userbox .avatar{vertical-align:top;margin-left:6px}.userbox .dropdown-toggle:after{vertical-align:middle}@media (max-width:767.98px){.userbox{display:block;position:relative;z-index:5}.userbox .name{display:none}.userbox .avatar{border:1px solid hsla(0,0%,100%,.25);margin-left:0}}

data/app/assets/stylesheets/trestle/_custom-auth.css

@@ -0,0 +1,6 @@
+/*
+ * This file is left as an extension point for user customization.
+ *
+ * It will be overridden by the similarly named file within
+ * the app/assets folder of the Rails application.
+ */

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

@@ -0,0 +1,2 @@
+//= require trestle/auth/bundle
+//= require trestle/_custom-auth

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

@@ -1,16 +1,15 @@
 class Trestle::Auth::SessionsController < Trestle::ApplicationController
   layout 'trestle/auth'
 
+  skip_before_action :authenticate_user, only: [:new, :create]
   skip_before_action :require_authenticated_user
 
   def new
   end
 
   def create
-    if user = Trestle.config.auth.authenticate(params)
-      login!(user)
-      remember_me! if params[:remember_me] == "1"
-      redirect_to previous_location || Trestle.config.path
+    if authentication_backend.authenticate!
+      redirect_to authentication_backend.previous_location || instance_exec(&Trestle.config.auth.redirect_on_login)
     else
       flash[:error] = t("admin.auth.error", default: "Incorrect login details.")
       redirect_to action: :new
@@ -19,6 +18,6 @@ class Trestle::Auth::SessionsController < Trestle::ApplicationController
 
   def destroy
     logout!
-    redirect_to login_url
+    redirect_to instance_exec(&Trestle.config.auth.redirect_on_logout)
   end
 end

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

@@ -0,0 +1,20 @@
+module Trestle
+  module Auth
+    module TitleHelper
+      def trestle_auth_title
+        if Trestle.config.auth.logo
+          image_tag(Trestle.config.auth.logo)
+        elsif Trestle.config.site_logo
+          image_tag(Trestle.config.site_logo)
+        elsif Trestle.config.site_logo_small
+          safe_join([
+            image_tag(Trestle.config.site_logo_small, alt: "", class: ""),
+            content_tag(:span, Trestle.config.site_title)
+          ], "\n")
+        else
+          Trestle.config.site_title
+        end
+      end
+    end
+  end
+end

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

@@ -1,13 +1,9 @@
 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
+    instance_exec(user, &Trestle.config.auth.format_user_name)
   end
 
   def avatar_for(user)
-    avatar { instance_exec(user, &Trestle.config.auth.avatar) } if Trestle.config.auth.avatar
+    instance_exec(user, &Trestle.config.auth.avatar) if Trestle.config.auth.avatar
   end
 end

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

@@ -5,32 +5,27 @@
     <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'>
+    <% if Trestle.config.turbolinks %>
+      <meta content='no-cache' name='turbolinks-cache-control'>
+    <% end %>
 
     <%= csrf_meta_tags %>
 
     <title><%= Trestle.config.site_title %></title>
 
+    <%= stylesheet_link_tag "trestle/admin", 'data-turbolinks-track': 'reload' %>
+    <%= stylesheet_link_tag "trestle/theme", 'data-turbolinks-track': 'reload' if Trestle.config.theme %>
+    <%= stylesheet_link_tag "trestle/custom", 'data-turbolinks-track': 'reload' %>
+
     <%= 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' %>
+    <%= javascript_include_tag "turbolinks" if Trestle.config.turbolinks %>
+
+    <%= hook "auth.head" %>
   </head>
 
-  <body>
+  <body class="auth-body theme-bg-dark">
     <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>

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

@@ -1,17 +1,28 @@
-<div class="userbox pull-right dropdown">
-  <%= link_to "#", class: 'dropdown-toggle', data: { toggle: 'dropdown' } do %>
-    <span class="name">
+<% show_dropdown = (Trestle.config.auth.user_admin && Trestle.lookup(Trestle.config.auth.user_admin)) || Trestle.config.auth.enable_logout %>
+
+<div class="userbox<% if show_dropdown %> dropdown<% end %>">
+  <% content = capture do %>
+    <span class="name<% if show_dropdown %> dropdown-toggle<% end %>">
       <%= format_user_name(current_user) %>
-      <span class="caret"></span>
     </span>
 
     <%= avatar_for(current_user) %>
   <% end %>
 
+  <% if show_dropdown %>
+    <%= link_to content, "#", data: { toggle: 'dropdown' } %>
+  <% else %>
+    <%= content %>
+  <% end %>
+
+  <% if show_dropdown -%>
   <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>
+      <li><%= admin_link_to t("admin.auth.my_account", default: "My Account"), current_user, admin: user_admin, class: "dropdown-item" %></li>
+    <% end -%>
+    <% if Trestle.config.auth.enable_logout -%>
+      <li><%= link_to t("admin.auth.logout", default: "Log out"), trestle.logout_path, class: "dropdown-item" %></li>
     <% end -%>
-    <li><%= link_to t("admin.auth.logout", default: "Log out"), trestle.logout_path, class: "dropdown-item" %></li>
   </ul>
+  <% end %>
 </div>

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

@@ -0,0 +1,32 @@
+<div class="form-group">
+  <div class="input-group">
+    <div class="input-group-prepend">
+      <span class="input-group-text"><i class="fa fa-user fa-fw"></i></span>
+    </div>
+    <%= f.text_field Trestle.config.auth.authenticate_with, placeholder: Trestle.config.auth.human_attribute_name(Trestle.config.auth.authenticate_with), class: "form-control" %>
+  </div>
+</div>
+
+<div class="form-group">
+  <div class="input-group">
+    <div class="input-group-prepend">
+      <span class="input-group-text"><i class="fa fa-lock fa-fw"></i></span>
+    </div>
+    <%= f.password_field :password, placeholder: Trestle.config.auth.human_attribute_name(:password), class: "form-control" %>
+  </div>
+</div>
+
+<%= hook("auth.login.form", f) %>
+
+<% if Trestle.config.auth.remember.enabled %>
+<div class="form-group">
+  <div class="custom-control custom-checkbox remember-me">
+    <%= f.check_box :remember_me, class: "custom-control-input", include_hidden: false %>
+    <%= f.label :remember_me, t("admin.auth.remember_me", default: "Remember me"), class: "custom-control-label" %>
+  </div>
+</div>
+<% end %>
+
+<div class="form-group">
+  <%= f.submit t("admin.auth.login", default: "Login"), class: "btn btn-primary btn-block btn-lg" %>
+</div>

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

@@ -1,38 +1,15 @@
-<%= form_tag login_path, class: "login-form" do %>
-  <%= hook("auth.login.heading") %>
+<%= form_for authentication_scope, url: login_path, html: { class: "login-form" } do |f| %>
+  <header class="auth-header">
+    <%= hook("auth.login.heading") do %>
+      <h1><%= trestle_auth_title %></h1>
+    <% end %>
+  </header>
 
   <% if flash[:error] -%>
-    <div class="alert alert-danger">
+    <div class="alert alert-danger error-bg">
       <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>
+  <%= render "form", f: f %>
 <% end %>

data/bin/rails

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/trestle/auth/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/{locale → locales}/en.yml

@@ -6,3 +6,10 @@ en:
       logout: "Logout"
       error: "Incorrect login details."
       remember_me: "Remember me"
+
+    auth/account:
+      titles:
+        edit: "My Account"
+
+      breadcrumbs:
+        index: "My Account"

data/config/locales/es.yml

@@ -0,0 +1,15 @@
+es:
+  admin:
+    auth:
+      my_account: "Mi Cuenta"
+      login: "Inicio de sesión"
+      logout: "Sair"
+      error: "Email o contraseña incorrectos."
+      remember_me: "Recuérdame"
+
+    auth/account:
+      titles:
+        edit: "Mi Cuenta"
+
+      breadcrumbs:
+        index: "Mi Cuenta"

data/config/{locale → locales}/pl.yml

@@ -6,3 +6,10 @@ pl:
       logout: "Wyloguj się"
       error: "Nieprawidłowe dane logowania."
       remember_me: "Zapamiętaj mnie"
+
+    auth/account:
+      titles:
+        edit: "Moje konto"
+
+      breadcrumbs:
+        index: "Moje konto"