rockstart 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba7c0a5317e53f705cd38bd10ada153e28d5adab8ac3b4d8a182a6312a8a5e7
-  data.tar.gz: 9113486cc9d6f7087d91fa29a54e7c39fda7fb2daf0a386e3739913432344c5a
+  metadata.gz: de8c4a0f815030f8c4bc382d79d366da4f07ebd43dd3bf74260f6d1be2482908
+  data.tar.gz: 842304d35a22b56404a04d8d2f573afe9039ae8ef09d1f25d04f9e7bbce9c223
 SHA512:
-  metadata.gz: 3742b345254b2baf3eb6433af39d686c90bc9c80308128d738b47ea031112b1fd6b888c0f603953439dd60f5349662b279ac94bf2a7858bacb565c31238d82ac
-  data.tar.gz: 8c3a806404352d26ab4f424d71ddb315378d4eb33fa9be666872328f3890f337d993aa6560d31d63a5334ebd8e9411d6b95a8586d441b2a11d3c09d9b947d83d
+  metadata.gz: 38313ea3688a1743a0c1d2d1549fced19af170922094f9638705f35294ce5cb1488c27870e3e0952488740cf5e792af8c34e6bd03067d1b43ea45a2296455c2e
+  data.tar.gz: 783827e82c2b929ed3488d4518ed2aa765a64351e5769a86fd1d25472ee0583473b7104f7e1f08ebee00f61763fd6b2aefece2ad63839e00a815d0834f852a51

data/README.md

@@ -76,6 +76,12 @@ Install it, via Webpacker, by running:
 bundle exec rails g rockstart:tailwindcss
 ```
 
+## Extra Steps
+
+A Heroku release may fail during the relase page, use the [heroku-releases-retry](https://github.com/heroku/heroku-releases-retry) allows the latest deploy to be retried.
+
+> heroku plugins:install heroku-releases-retry
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/generators/rockstart/authorization/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Controls who can Rock and Roll
+
+Example:
+    rails generate rockstart:authorization
+
+    This will create:
+        Installs Devise for auth authentication
+        Installs Pundit for access authorization

data/lib/generators/rockstart/authorization/auth0/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Adds Auth0 authentication to a Ruby on Rails Application
+
+Example:
+    rails generate rockstart:authorization:auth0
+
+    This will create:
+        Installs omniauth-auth0 and configures it to run in rails
+        Adds an auth controller for handling session creation/deletion
+        Adds a PORO User model to represent a signed in user

data/lib/generators/rockstart/authorization/auth0/auth0_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "rockstart/base_generator"
+
+module Rockstart::Authorization
+  class Auth0Generator < Rockstart::BaseGenerator
+    include Rails::Generators::AppName
+
+    source_root File.expand_path("templates", __dir__)
+
+    def add_utils
+      template "auth0_util.rb", "lib/utils/auth0.rb"
+      copy_file "auth0_util_spec.rb", "spec/utils/auth0_spec.rb"
+    end
+
+    def add_translations
+      copy_file "auth0.en.yml", "config/locales/auth0.en.yml"
+    end
+
+    def add_initializer
+      copy_file "auth0_initializer.rb", "config/initializers/auth0.rb"
+    end
+
+    def add_controllers
+      directory "app"
+      directory "spec"
+    end
+
+    def add_session_auth_to_controllers
+      inject_into_file "app/controllers/application_controller.rb",
+                       "  include SessionAuth\n",
+                       before: /^end$/
+    end
+
+    def add_routes
+      route <<~ROUTE
+        # Auth0 Session Routes
+        get "auth/sign_in" => "auth#new", as: :auth_sign_in
+        get "auth/sign_out" => "auth#sign_out", as: :auth_sign_out
+        delete "auth/sign_out" => "auth#destroy"
+
+        get "callback" => "auth#callback"
+        get "auth/failure" => "auth#failure"
+
+      ROUTE
+      change_application_url("url_for_authentication", "auth_sign_in_path")
+    end
+  end
+end

data/lib/generators/rockstart/authorization/auth0/templates/app/controllers/auth_controller.rb.tt

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "utils/auth0"
+
+# Omniauth Controller for Auth0
+class AuthController < ApplicationController
+  # GET /auth/sign_in
+  def new
+    if user_signed_in?
+      redirect_to url_for_user_dashboard
+    else
+      render :new
+    end
+  end
+
+  # GET /auth/sign_out
+  def sign_out
+    if user_signed_in?
+      redirect_to url_for_user_dashboard
+    else
+      render :sign_out
+    end
+  end
+
+  # DELETE /auth/sign_out
+  def destroy
+    reset_session
+    redirect_to Utils::Auth0.logout_url(redirect_to: auth_sign_out_url).to_s
+  end
+
+  # GET /callback
+  def callback
+    # This stores all the user information that came from Auth0 and the IdP
+    session[:userinfo] = Utils::Auth0.filter_userinfo(request.env["omniauth.auth"])
+
+    # Redirect to the URL you want after successful auth
+    redirect_to url_for_user_dashboard
+  end
+
+  # GET /auth/failure
+  def failure
+    # show a failure page or redirect to an error page
+    error_key = params[:message].to_s.gsub(/[^\w-]/, "").presence || "generic"
+    error_message = t(error_key, scope: "auth0.omniauth_error", default: :generic)
+    redirect_to auth_sign_in_path, alert: error_message
+  end
+end

data/lib/generators/rockstart/authorization/auth0/templates/app/controllers/concerns/session_auth.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Provides methods for Authenticating via a Rails session
+module SessionAuth
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :current_user
+    helper_method :user_signed_in?
+  end
+
+  def current_user
+    User.new(session[:userinfo])
+  end
+
+  def user_signed_in?
+    session[:userinfo].present?
+  end
+
+  def authenticate_user!
+    redirect_to url_for_authentication unless user_signed_in?
+  end
+end

data/lib/generators/rockstart/authorization/auth0/templates/app/models/user.rb.tt

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# PORO Representaiton of an Authenticated Auth0 User
+class User
+  EMAIL_REGEX = /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i.freeze
+
+  def initialize(userinfo = nil)
+    @userinfo = userinfo.presence || {}
+  end
+
+  def id
+    if auth0?
+      @userinfo["uid"]
+    elsif @userinfo["uid"].present?
+      "#{@userinfo['provider']}|#{@userinfo['uid']}"
+    end
+  end
+
+  def image
+    @userinfo.dig("info", "image")
+  end
+
+  def name
+    name_or_email = @userinfo.dig("info", "name")
+    if name_or_email =~ EMAIL_REGEX
+      nickname
+    else
+      name_or_email
+    end
+  end
+
+  def nickname
+    @userinfo.dig("info", "nickname")
+  end
+
+  def first_name
+    namae.given
+  end
+
+  def admin?
+    roles.include? "admin"
+  end
+
+  def persisted?
+    @userinfo.present?
+  end
+
+  def to_h
+    @userinfo.to_h
+  end
+
+  def to_s
+    name
+  end
+
+  def ==(other)
+    if other.nil? || !other.instance_of?(User)
+      false
+    else
+      to_h == other.to_h
+    end
+  end
+  alias eql? ==
+
+  def hash
+    @userinfo.hash
+  end
+
+  private
+
+  def auth0?
+    @userinfo["provider"] == "auth0"
+  end
+
+  def namae
+    @namae ||= Namae::Name.parse(name)
+  end
+
+  def roles
+    @roles ||= (@userinfo.dig("extra", "raw_info", "http://<%= app_name %>/roles") || [])
+  end
+end

data/lib/generators/rockstart/authorization/auth0/templates/app/views/auth/new.html.erb

@@ -0,0 +1,3 @@
+<%= link_to "/auth/auth0", method: :post do %>
+  Sign in.
+<%- end -%>

data/lib/generators/rockstart/authorization/auth0/templates/app/views/auth/sign_out.html.erb

@@ -0,0 +1 @@
+Good bye.

data/lib/generators/rockstart/authorization/auth0/templates/auth0.en.yml

@@ -0,0 +1,5 @@
+en:
+  auth0:
+    omniauth_error:
+      unauthorized: "Your account has been blocked."
+      generic: "An unexpected error has occured, please try again!!!"

data/lib/generators/rockstart/authorization/auth0/templates/auth0_initializer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider(
+    :auth0,
+    ENV["AUTH0_CLIENT_ID"],
+    ENV["AUTH0_CLIENT_SECRET"],
+    ENV["AUTH0_DOMAIN"],
+    callback_path: "/callback",
+    authorize_params: {
+      scope: "openid profile"
+    }
+  )
+end
+
+# Allow Omniauth to function behind a NGINX reverse proxy
+OmniAuth.config.full_host = lambda do |env|
+  scheme         = env["rack.url_scheme"]
+  local_host     = env["HTTP_HOST"]
+  forwarded_host = env["HTTP_X_FORWARDED_HOST"]
+  forwarded_host.blank? ? "#{scheme}://#{local_host}" : "#{scheme}://#{forwarded_host}"
+end
+
+# Handle any failures with a failure page
+OmniAuth.config.on_failure = proc do |env|
+  OmniAuth::FailureEndpoint.new(env).redirect_to_failure
+end

data/lib/generators/rockstart/authorization/auth0/templates/auth0_util.rb.tt

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Utils
+  # Utilities for interacting with Auth0 generated by rockstart:auth0
+  module Auth0
+    class << self
+      # Generates a logout redirect url
+      def logout_url(redirect_to:)
+        domain = ENV.fetch("AUTH0_DOMAIN")
+        client_id = ENV.fetch("AUTH0_CLIENT_ID")
+        request_params = {
+          returnTo: redirect_to,
+          client_id: client_id
+        }
+        URI::HTTPS.build(host: domain, path: "/v2/logout", query: to_query(request_params))
+      end
+
+      # Remove all unused properties provided by OmniAuth
+      def filter_userinfo(raw_userinfo)
+        raw_userinfo.slice(:provider, :uid, :info, :extra).tap do |userinfo|
+          # Include basic user information
+          userinfo[:info] = userinfo.fetch(:info, {}).slice(:name, :nickname, :image)
+
+          # Include custom roles array provided by auth0
+          userinfo[:extra] = userinfo.fetch(:extra, {}).slice(:raw_info)
+          raw_info = userinfo[:extra].fetch(:raw_info, {})
+          userinfo[:extra][:raw_info] = raw_info.slice("http://<%= app_name %>/roles")
+        end.deep_stringify_keys
+      end
+
+      private
+
+      def to_query(hash)
+        hash.map { |k, v| "#{k}=#{CGI.escape(v)}" unless v.nil? }.reject(&:nil?).join("&")
+      end
+    end
+  end
+end

data/lib/generators/rockstart/authorization/auth0/templates/auth0_util_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "utils/auth0"
+require File.expand_path("../support/climate_control_helpers", __dir__)
+
+RSpec.describe Utils::Auth0 do
+  include ClimateControlHelpers
+
+  around do |example|
+    with_modified_env("AUTH0_DOMAIN" => "auth0-domain", "AUTH0_CLIENT_ID" => "auth0-client-id") do
+      example.run
+    end
+  end
+
+  describe ".logout_url" do
+    it "generates an auth0 logout url" do
+      logout_url = described_class.logout_url(redirect_to: "https://www.example.com")
+      expect(logout_url.to_s).to eq "https://auth0-domain/v2/logout?returnTo=https%3A%2F%2Fwww.example.com&client_id=auth0-client-id"
+    end
+  end
+end

data/lib/generators/rockstart/authorization/auth0/templates/spec/factories/users.rb.tt

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    uid { SecureRandom.hex(10) }
+
+    name { [nickname, Faker::Name.last_name].join(" ") }
+    nickname { Faker::Name.first_name }
+    image { "https://s.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?s=480" }
+    roles { [] }
+
+    skip_create
+    initialize_with do
+      require "utils/auth0"
+      filtered_attributes = Utils::Auth0.filter_userinfo(
+        provider: "factory_bot",
+        uid: attributes[:uid],
+        info: attributes.except(:uid, :roles).stringify_keys,
+        extra: {
+          raw_info: {
+            "http://<%= app_name %>/roles" => roles
+          }
+        }
+      )
+      new(filtered_attributes)
+    end
+
+    trait :admin do
+      roles { %w[admin] }
+    end
+  end
+end

data/lib/generators/rockstart/authorization/auth0/templates/spec/models/user_spec.rb.tt

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe User, type: :model do
+  context "with a userinfo hash" do
+    subject(:user) { described_class.new(userinfo) }
+
+    let(:userinfo) do
+      {
+        "provider" => "auth0",
+        "uid" => "auth0|1234",
+        "info" => {
+          "image" => "https://s.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?s=480",
+          "name" => "John Smith",
+          "nickname" => "jono65"
+        },
+        "extra" => {
+          "raw_info" => {
+            "http://<%= app_name %>/roles" => []
+          }
+        }
+      }
+    end
+
+    it { expect(user.image).to eq "https://s.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0?s=480" }
+
+    describe "#id" do
+      it { expect(user.id).to eq "auth0|1234" }
+
+      context "with an non-auth0 provider" do
+        before { userinfo["provider"] = "test" }
+
+        it { expect(user.id).to eq "test|auth0|1234" }
+      end
+    end
+
+    describe "#name" do
+      it { expect(user.name).to eq "John Smith" }
+
+      it "falls back to nickname when name is an email (Auth0 Database Provider Default)" do
+        userinfo.fetch("info")["name"] = "test@example.com"
+        expect(user.name).to eq "jono65"
+      end
+    end
+
+    describe "#first_name" do
+      it { expect(user.first_name).to eq "John" }
+
+      it "falls back to nickname when name is an email (Auth0 Database Provider Default)" do
+        userinfo.fetch("info")["name"] = "test@example.com"
+        expect(user.first_name).to eq "jono65"
+      end
+    end
+
+    describe "#admin?" do
+      context "with an admin role" do
+        before do
+          userinfo["extra"]["raw_info"]["http://<%= app_name %>/roles"] = ["admin"]
+        end
+
+        it { is_expected.to be_admin }
+      end
+
+      context "with no roles" do
+        before do
+          userinfo["extra"]["raw_info"]["http://<%= app_name %>/roles"] = []
+        end
+
+        it { is_expected.not_to be_admin }
+      end
+    end
+
+    it { expect(user.to_s).to eq "John Smith" }
+
+    it { is_expected.to be_persisted }
+  end
+
+  context "with no parameters" do
+    subject(:user) { described_class.new }
+
+    it { expect(user.id).to be_nil }
+    it { expect(user.name).to be_nil }
+    it { expect(user.first_name).to be_nil }
+    it { expect(user.image).to be_nil }
+
+    it { expect(user.to_s).to be_nil }
+
+    it { is_expected.not_to be_persisted }
+  end
+end