trestle-omniauth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cad62fb2c0fa01f9dce110649b434c19fecebcd108a9df32124ce483669d4290
+  data.tar.gz: de520c86922822405d5972983f7c0b38142e96b95a3b2aeac551c47a48c467e2
+SHA512:
+  metadata.gz: 5deed4dd1d798e931343fdbc363e0a6d718429dfb69bf3bdcfdc7928e7ea9bd9e7fdd0cea7dbbdb74d0602d12ca27e041d79990d4befc50cf47c72021e8010e2
+  data.tar.gz: 6082bd8485a6921f7d86091a7712aaa1b2892dddb150e7d80b77169471070c6af0369ce766902b6a25312a256d6426ab366f3acbc0d57d03b943d2bdb8d18f3c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Harry Brundage
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Trestle::Omniauth
+
+Adds stateless authentication for [Trestle](https://trestle.io/) via [`omniauth`](https://github.com/omniauth/omniauth) providers. Similar to [`trestle-auth`](https://github.com/TrestleAdmin/trestle-auth), but doesn't require extra models, and works good if you're already using an OAuth provider for authentication elsehwere.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trestle-omniauth'
+```
+
+Add whichever OmniAuth strategies you will use for authentication to your Gemfile as well:
+
+```ruby
+gem 'omniauth-google-oauth2'  # for example
+```
+
+And then run bundler to install your new gems:
+```bash
+$ bundle
+```
+
+__Note__: You don't need to mount this gem like you might with `Trestle`. It just plugs in to the existing way that Trestle is mounted in your app.
+
+## Usage
+
+`trestle-omniauth` uses Omniauth providers unadulterated. To add providers, use the `omniauth.provider` method exposed on the trestle config the same way you'd use the `OmniAuth::Builder#provider` method.
+
+In your `config/initializers/trestle.rb`, add providers like so:
+
+```ruby
+# config/initializers/trestle.rb
+Trestle.configure do |config|
+# ...
+# ...
+  config.omniauth.provider :developer unless Rails.env.production?
+  config.omniauth.provider :google_oauth2, ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET']
+end
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Trestle::Omniauth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/trestle_omniauth_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/trestle/omniauth .css

data/app/assets/stylesheets/trestle/_custom-omniauth.scss

@@ -0,0 +1,4 @@
+// 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/omniauth.scss

@@ -0,0 +1,66 @@
+ // User-defined variables
+@import "trestle/support";
+@import "omniauth/defaults";
+
+// 3rd party dependencies
+@import "trestle/bootstrap";
+@import "trestle/font-awesome";
+
+html, body {
+  height: 100%;
+}
+
+body {
+  -webkit-font-smoothing: antialiased;
+
+  margin: 0;
+  overflow: hidden;
+
+  color: white;
+  background: $auth-bg;
+
+  display: flex;
+}
+
+.container {
+  margin: auto;
+  width: 320px;
+}
+
+a {
+  color: rgba(white, 0.75);
+  &:hover { color: white; }
+}
+
+.btn {
+  box-shadow: rgba(black, 0.1) 0 0 2px;
+  padding: 12px;
+  font-size: 16px;
+  margin-bottom: 12px;
+}
+
+.btn-primary {
+  outline: none;
+
+  color: $auth-login-btn-color;
+  background: $auth-login-btn-bg;
+  border: $auth-login-btn-border;
+
+  &:hover {
+    background-color: darken($auth-login-btn-bg, 2.5%);
+    border-color: darken($auth-login-btn-border, 5%);
+  }
+
+  &:focus, &:active {
+    background-color: darken($auth-login-btn-bg, 5%);
+    border-color: darken($auth-login-btn-border, 10%);
+  }
+
+  &:active:focus {
+    outline: none !important;
+    background-color: darken($auth-login-btn-bg, 10%);
+    border-color: darken($auth-login-btn-border, 15%);
+  }
+}
+
+@import "trestle/custom-omniauth";

data/app/assets/stylesheets/trestle/omniauth/_defaults.scss

@@ -0,0 +1,4 @@
+$auth-bg: $theme-bg !default;
+$auth-login-btn-color: $btn-primary-color !default;
+$auth-login-btn-border: $btn-primary-border !default;
+$auth-login-btn-bg: $btn-primary-bg !default;

data/app/assets/stylesheets/trestle/omniauth/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/controllers/trestle/omniauth/application_controller.rb

@@ -0,0 +1,7 @@
+module Trestle
+  module Omniauth
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+class Trestle::Omniauth::SessionsController < Trestle::ApplicationController
+  layout "trestle/omniauth"
+
+  skip_before_action :require_authenticated_user
+
+  def new
+    @providers = Trestle.config.omniauth.providers.keys
+  end
+
+  def create
+    login!(request.env["omniauth.auth"])
+    redirect_to previous_location || instance_exec(&Trestle.config.omniauth.redirect_on_login)
+  end
+
+  def destroy
+    logout!
+    redirect_to instance_exec(&Trestle.config.omniauth.redirect_on_logout)
+  end
+end

data/app/helpers/trestle/omniauth/application_helper.rb

@@ -0,0 +1,6 @@
+module Trestle
+  module Omniauth
+    module ApplicationHelper
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Trestle
+  module Omniauth
+    module TitleHelper
+      def trestle_omniauth_title
+        if Trestle.config.omniauth.logo
+          image_tag(Trestle.config.omniauth.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/omniauth/user_helper.rb

@@ -0,0 +1,9 @@
+module Trestle::Omniauth::UserHelper
+  def format_user_name(user)
+    instance_exec(user, &Trestle.config.omniauth.format_user_name)
+  end
+
+  def avatar_for(user)
+    instance_exec(user, &Trestle.config.omniauth.avatar) if Trestle.config.omniauth.avatar
+  end
+end

data/app/jobs/trestle/omniauth/application_job.rb

@@ -0,0 +1,6 @@
+module Trestle
+  module Omniauth
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/trestle/omniauth/application_mailer.rb

@@ -0,0 +1,8 @@
+module Trestle
+  module Omniauth
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/trestle/omniauth/application_record.rb

@@ -0,0 +1,7 @@
+module Trestle
+  module Omniauth
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+<!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/omniauth", 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <main class="container">
+      <header class="auth-header">
+        <h1><%= trestle_omniauth_title %></h1>
+      </header>
+
+      <%= yield %>
+    </main>
+  </body>
+</html>

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

@@ -0,0 +1,14 @@
+<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">
+    <li><%= link_to t("admin.omniauth.logout", default: "Log out"), trestle.logout_path, class: "dropdown-item" %></li>
+  </ul>
+</div>

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

@@ -0,0 +1,11 @@
+<%= hook("omniauth.login.heading") %>
+
+<% if flash[:error] -%>
+  <div class="alert alert-danger">
+    <p><%= flash[:error] %></p>
+  </div>
+<% end -%>
+
+<% @providers.each do |name| %>
+  <a class="btn btn-primary" href="/auth/<%= name %>">Login with <%= name.to_s.titleize %></a>
+<% end %>

data/config/initializers/trestle.rb

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

data/config/routes.rb

@@ -0,0 +1,9 @@
+# Trestle::Omniauth::Engine doesn't actually get mounted, and instead the routes are appended to the normal Trestle engine's routes.
+Trestle::Engine.routes.draw do
+  controller "trestle/omniauth/sessions" do
+    get "login" => :new, as: :login
+    get "logout" => :destroy, as: :logout
+    post "/auth/:provider/callback" => :create
+    get "/auth/:provider/callback" => :create
+  end
+end

data/lib/tasks/trestle/omniauth_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :trestle_omniauth do
+#   # Task goes here
+# end

data/lib/trestle/omniauth.rb

@@ -0,0 +1,15 @@
+require "trestle"
+
+module Trestle
+  module Omniauth
+    extend ActiveSupport::Autoload
+
+    autoload :Configuration
+    autoload :LateOmniauthBuilder
+    autoload :ControllerMethods
+  end
+
+  Configuration.option :omniauth, Omniauth::Configuration.new
+end
+
+require "trestle/omniauth/engine"

data/lib/trestle/omniauth/configuration.rb

@@ -0,0 +1,35 @@
+module Trestle
+  module Omniauth
+    class Configuration
+      extend ActiveSupport::Autoload
+      include Configurable
+
+      option :avatar, ->(user) {
+               avatar { gravatar(user["info"]["email"]) }
+             }, evaluate: false
+
+      option :format_user_name, ->(user) {
+               if user["info"]["first_name"] && user["info"]["last_name"]
+                 safe_join([user["info"]["first_name"], content_tag(:strong, user["info"]["last_name"])], " ")
+               elsif user["info"]["name"]
+                 content_tag(:strong, user["info"]["name"])
+               elsif user["info"]["email"]
+                 content_tag(:strong, user["info"]["email"])
+               else
+                 "UID #{user[:uid]}"
+               end
+             }, evaluate: false
+
+      option :redirect_on_login, -> { Trestle.config.path }, evaluate: false
+      option :redirect_on_logout, -> { login_url }, evaluate: false
+
+      option :logo
+
+      option :providers, {}
+
+      def provider(name, *args)
+        providers[name] = args
+      end
+    end
+  end
+end

data/lib/trestle/omniauth/controller_methods.rb

@@ -0,0 +1,51 @@
+module Trestle
+  module Omniauth
+    module ControllerMethods
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :current_user, :logged_in?
+
+        before_action :require_authenticated_user
+      end
+
+      protected
+
+      def current_user
+        @current_user ||= session[:trestle_user]
+      end
+
+      def login!(auth_hash)
+        session[:trestle_user] = request.env["omniauth.auth"].slice("provider", "uid", "info").as_json
+        @current_user = auth_hash
+      end
+
+      def logout!
+        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
+    end
+  end
+end

data/lib/trestle/omniauth/engine.rb

@@ -0,0 +1,27 @@
+require "omniauth"
+
+module Trestle
+  module Omniauth
+    class Engine < ::Rails::Engine
+      isolate_namespace Trestle::Omniauth
+
+      config.assets.precompile << "trestle/omniauth.css" << "trestle/omniauth/userbox.css"
+
+      config.before_initialize do
+        Trestle::Engine.paths["app/helpers"].concat(paths["app/helpers"].existent)
+      end
+
+      config.to_prepare do
+        Trestle::ApplicationController.send(:include, Trestle::Omniauth::ControllerMethods)
+      end
+
+      initializer "trestle.omniauth.configure" do
+        Trestle::Engine.middleware.use ::OmniAuth::Builder do
+          Trestle.config.omniauth.providers.each do |name, args|
+            self.provider name, *args
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trestle/omniauth/version.rb

@@ -0,0 +1,5 @@
+module Trestle
+  module Omniauth
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: trestle-omniauth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Brundage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta3
+- !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: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use omniauth auth providers to authenticate with Trestle
+email:
+- harry.brundage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/trestle_omniauth_manifest.js
+- app/assets/stylesheets/trestle/_custom-omniauth.scss
+- app/assets/stylesheets/trestle/omniauth.scss
+- app/assets/stylesheets/trestle/omniauth/_defaults.scss
+- app/assets/stylesheets/trestle/omniauth/userbox.scss
+- app/controllers/trestle/omniauth/application_controller.rb
+- app/controllers/trestle/omniauth/sessions_controller.rb
+- app/helpers/trestle/omniauth/application_helper.rb
+- app/helpers/trestle/omniauth/title_helper.rb
+- app/helpers/trestle/omniauth/user_helper.rb
+- app/jobs/trestle/omniauth/application_job.rb
+- app/mailers/trestle/omniauth/application_mailer.rb
+- app/models/trestle/omniauth/application_record.rb
+- app/views/layouts/trestle/omniauth.html.erb
+- app/views/trestle/omniauth/_userbox.html.erb
+- app/views/trestle/omniauth/sessions/new.html.erb
+- config/initializers/trestle.rb
+- config/routes.rb
+- lib/tasks/trestle/omniauth_tasks.rake
+- lib/trestle/omniauth.rb
+- lib/trestle/omniauth/configuration.rb
+- lib/trestle/omniauth/controller_methods.rb
+- lib/trestle/omniauth/engine.rb
+- lib/trestle/omniauth/version.rb
+homepage: https://github.com/airhorns/trestle-omniauth
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Use omniauth auth providers to authenticate with Trestle
+test_files: []