trestle-auth 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c66ad14a57d22f21b9e9b170a48a505060704b557c0abde4e56526f1b7d95561
-  data.tar.gz: b8d449820f15f9923724d58650f965715cf420073d52d52d4353e20f6de14068
+  metadata.gz: 464d95c8de9173fe65265a2c9721c6da23b78fbf49e566a5b148b68ddd534ed1
+  data.tar.gz: b016d91dedc61d8bd1213137f6118b13a28a099f383ca002496101ea3d001722
 SHA512:
-  metadata.gz: d58fe42ceab549559ffa679ef6e028695c27d815e4958278300a0de0ff943ff0f8480519e3bfd1cd59fac6e3763afdfa3829dc31c8d6475018f7ef8c21d4e738
-  data.tar.gz: af0149b4c92cad0b37bf42f82369507a2d3a57c46a8ed116ef2781965a7b837688c7a7fd0c50fd0087493b39b74266d0ba062a2e25c700747c47b4730591a835
+  metadata.gz: 88d8a60ce5d4a8a2e8fdec285706ae5fa45212cc81db6b75970ee92e8b1013665e05884adb921967319a3942c374b46a54eed434a14c81e0cecb01a3d426e9e3
+  data.tar.gz: a0ee867bde142a6580ce2ecd89afe1a68f21335d133bf6442c076dd3d6f98652803d20a27047df7c5a7c8384ce252f055ff0fc10909ecc6a6bc9f5e6ba9e4450

data/.browserslistrc

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

data/.gitignore

@@ -8,3 +8,7 @@
 /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,5 +1,9 @@
 # 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-1.png" width="50%" /><img src="https://trestle.io/images/Trestle-Auth-2.png" width="50%" />
@@ -7,25 +11,48 @@
 
 ## 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

@@ -1 +1 @@
-.auth-body{display:-webkit-box;display:flex;color:#fff}.auth-body .container{margin:auto;width:320px}.auth-header{text-align:center;margin-bottom:20px}.auth-header h1{display:-webkit-box;display:flex;-webkit-box-align:center;align-items:center;-webkit-box-pack: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::-moz-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}
+.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

@@ -1 +1 @@
-.userbox{-webkit-box-ordinal-group:100;order:99;padding:2px 0}.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)}}
+.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/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 || instance_exec(&Trestle.config.auth.redirect_on_login)
+    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

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

@@ -1,16 +1,28 @@
-<div class="userbox dropdown">
-  <%= link_to "#", data: { toggle: 'dropdown' } do %>
-    <span class="name dropdown-toggle">
+<% 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>
 
     <%= 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><%= admin_link_to t("admin.auth.my_account", default: "My Account"), current_user, admin: user_admin, class: "dropdown-item" %></li>
     <% end -%>
-    <li><%= link_to t("admin.auth.logout", default: "Log out"), trestle.logout_path, class: "dropdown-item" %></li>
+    <% if Trestle.config.auth.enable_logout -%>
+      <li><%= link_to t("admin.auth.logout", default: "Log out"), trestle.logout_path, class: "dropdown-item" %></li>
+    <% end -%>
   </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") %>
+
+<% 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,4 +1,4 @@
-<%= form_tag login_path, class: "login-form" do %>
+<%= 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>
@@ -11,36 +11,5 @@
     </div>
   <% end -%>
 
-  <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>
-      <%= 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">
-      <div class="input-group-prepend">
-        <span class="input-group-text"><i class="fa fa-lock fa-fw"></i></span>
-      </div>
-      <%= 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">
-    <div class="custom-control custom-checkbox remember-me">
-      <%= check_box_tag :remember_me, "1", false, class: "custom-control-input" %>
-      <%= label_tag :remember_me, t("admin.auth.remember_me", default: "Remember me"), class: "custom-control-label" %>
-    </div>
-  </div>
-  <% end %>
-
-  <div class="form-group">
-    <%= submit_tag t("admin.auth.login", default: "Login"), class: "btn btn-primary btn-block btn-lg" %>
-  </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/routes.rb

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

data/frontend/userbox.scss

@@ -4,6 +4,9 @@
   order: 99;
   padding: 2px 0;
 
+  display: flex;
+  align-items: center;
+
   > a {
     color: $body-color;
 
@@ -42,6 +45,7 @@
 
     .avatar {
       border: 1px solid rgba(white, 0.25);
+      margin-left: 0;
     }
   }
 }

data/gemfiles/rails-4.2.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "coveralls", require: false
+  gem "capybara"
+
+  gem "sqlite3", "~> 1.3.13"
+  gem "devise"
+end
+
+gem "rails", "~> 4.2.0"
+gem "sassc-rails"
+
+gem "rake", "~> 12.0"
+
+gem "trestle", github: "TrestleAdmin/trestle"
+
+gemspec path: "../"

data/gemfiles/rails-5.0.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "coveralls", require: false
+  gem "capybara"
+
+  gem "sqlite3", "~> 1.3.13"
+  gem "devise"
+end
+
+gem "rails", "~> 5.0.0"
+gem "sassc-rails"
+
+gem "rake", "~> 12.0"
+
+gem "trestle", github: "TrestleAdmin/trestle"
+
+gemspec path: "../"

data/gemfiles/rails-5.1.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "coveralls", require: false
+  gem "capybara"
+
+  gem "sqlite3", "~> 1.3.13"
+  gem "devise"
+end
+
+gem "rails", "~> 5.1.0"
+gem "sassc-rails"
+
+gem "rake", "~> 12.0"
+
+gem "trestle", github: "TrestleAdmin/trestle"
+
+gemspec path: "../"

data/gemfiles/rails-5.2.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "coveralls", require: false
+  gem "capybara"
+
+  gem "sqlite3", "~> 1.3.13"
+  gem "devise"
+end
+
+gem "rails", "~> 5.2.0"
+gem "sassc-rails"
+
+gem "rake", "~> 12.0"
+
+gem "trestle", github: "TrestleAdmin/trestle"
+
+gemspec path: "../"

data/gemfiles/rails-6.0.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "coveralls", require: false
+
+  gem "capybara"
+  gem "sqlite3", "~> 1.4"
+  gem "devise"
+end
+
+gem "rails", "~> 6.0.0"
+gem "sassc-rails"
+
+gem "rake", "~> 12.0"
+
+gem "trestle", github: "TrestleAdmin/trestle"
+
+gemspec path: "../"

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

@@ -6,12 +6,18 @@ module Trestle
 
         argument :model, type: :string, default: "Administrator"
 
+        class_option :devise, type: :boolean, default: false, desc: "Create admin for a Devise user model"
+
         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
 
+        def devise?
+          options[:devise]
+        end
+
       protected
         def plural_name
           model.demodulize.underscore.pluralize