hephaestus 0.1.3 → 0.2.2

data/templates/config/locales/settings/en.yml

@@ -0,0 +1,5 @@
+en:
+  some_example_heading: "From name"
+  some_example_label: "Some example"
+  another_example_heading: "Reply-to email address"
+  another_example_label: "Another example"

data/templates/lib/plug_app/schemas/api/2023-03-06/components/schemas/yetto.json

@@ -1,5 +1,5 @@
 {
-    "Create${APP}Message": {
+    "CreateAppMessage": {
         "type": "object",
         "required": [
             "plug_installation",
@@ -98,7 +98,7 @@
         },
         "additionalProperties": false
     },
-    "Create${APP}": {
+    "CreateApp": {
         "type": "object",
         "required": [
             "plug_installation",

data/templates/lib/plug_app/schemas/api/2023-03-06/openapi.json

@@ -1,8 +1,8 @@
 {
     "openapi": "3.0.0",
     "info": {
-        "title": "${APP} Plug API",
-        "description": "An OpenAPI definition for the ${APP} Plug REST API.",
+        "title": "App Plug API",
+        "description": "An OpenAPI definition for the App Plug REST API.",
         "version": "2023-03-06",
         "termsOfService": "https://yetto.app/terms/",
         "license": {
@@ -23,8 +23,8 @@
         "/api/2023-03-06/after_create/message": {
             "$ref": "paths/yetto/after_create_message.json"
         },
-        "/${app}/2023-03-06/{plugInstallationId}": {
-            "$ref": "paths/${app}.json"
+        "/app/2023-03-06/{plugInstallationId}": {
+            "$ref": "paths/app.json"
         }
     }
 }

data/templates/lib/plug_app/schemas/api/2023-03-06/paths/plug.json

@@ -2,7 +2,7 @@
     "post": {
         "tags": [
             "Inbound",
-            "${APP}"
+            "App"
         ],
         "description": "This represents something",
         "operationId": "Post a Yetto message",

data/templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/after_create_message.json

@@ -4,13 +4,13 @@
             "Yetto"
         ],
         "description": "After a message is created in Yetto, this delivers it.",
-        "operationId": "Create a new ${APP}",
+        "operationId": "Create a new App",
         "requestBody": {
             "required": true,
             "content": {
                 "application/json": {
                     "schema": {
-                        "$ref": "../../components/schemas/yetto.json#/Create${APP}Message"
+                        "$ref": "../../components/schemas/yetto.json#/CreateAppMessage"
                     }
                 }
             }

data/templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/after_create_plug_installation.json

@@ -4,13 +4,13 @@
             "Yetto"
         ],
         "description": "After a plug installation is created, this executes",
-        "operationId": "Post a thing",
+        "operationId": "Post a plug installation",
         "requestBody": {
             "required": true,
             "content": {
                 "application/json": {
                     "schema": {
-                        "$ref": "../../components/schemas/yetto.json#/Create${APP}"
+                        "$ref": "../../components/schemas/yetto.json#/CreateAppSwitch"
                     }
                 }
             }

data/templates/lib/tasks/test_tasks.rake

@@ -4,7 +4,11 @@
 require "rake/testtask"
 
 if Rails.env.development? || Rails.env.test?
-  require "rubocop/rake_task"
+  begin
+    require "rubocop/rake_task"
 
-  RuboCop::RakeTask.new(:rubocop)
+    RuboCop::RakeTask.new(:rubocop)
+  rescue LoadError => e
+    warn("WARNING: rubocop is not available in this environment: #{e}")
+  end
 end

data/templates/script/edit-credentials

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+set -e
+
+# Initialize flags
+staging=false
+production=false
+
+# Check for and parse flags
+for arg in "$@"
+do
+    case $arg in
+        --staging)
+            staging=true
+        ;;
+        --production)
+            production=true
+        ;;
+        *)
+            # Unknown arguments can be ignored or handled here
+        ;;
+    esac
+done
+
+if [[ $staging == true ]]; then
+    RAILS_MASTER_KEY=$(op read op://Plug-App/staging-rails-master-key/...) bin/rails credentials:edit -e staging
+else
+    RAILS_MASTER_KEY=$(op read op://Plug-App/production-rails-master-key/...) bin/rails credentials:edit -e production
+fi

data/templates/script/hmac_text

@@ -19,4 +19,4 @@ elsif options[:parse_string].present?
 end
 
 puts "Parsing `#{body}` into HMAC"
-puts OpenSSL::HMAC.hexdigest(Authable::SHA256_DIGEST, YETTO_PLUG_APP_TOKEN, body)
+puts OpenSSL::HMAC.hexdigest(Authable::SHA256_DIGEST, SIGNING_SECRET, body)

data/templates/script/licenses

@@ -1,51 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
+# This script is "symlink"ed from our actions repo.
+# Not really, obviously, it's a real file.
 
 set -e
 
-function usage() {
-  echo "Usage:"
-  echo "$0 [options]"
-  echo ""
-  echo "  Options:"
-  echo "    -u/--update           Update license information"
-  echo "    -v/--verify           Verify license information"
-  echo "    -g/--generate         Generate CSV license data"
-  echo "    -h/--help             Display this help message"
-  echo ""
-  exit 1
-}
-
-while [ "$1" != "" ]; do
-    case $1 in
-    -v | --verify)
-        echo "Verifying dependency licenses ..."
-        bin/bundle exec licensed env -c .licensed.yml
-        bin/bundle exec licensed list -c .licensed.yml
-        bin/bundle exec licensed status -c .licensed.yml
-        RET=$?
-        if [ $RET -ne 0 ]; then
-        echo
-        echo "*** When fixed, please run 'script/licenses -c' to update the license cache. ***"
-        echo
-        fi
-
-        exit $RET
-        ;;
-    -u | --update)
-        echo "Caching dependency licenses ..."
-        bin/bundle exec licensed cache -c .licensed.yml
-        ;;
-    -g | --generate)
-        echo "Generating CSV licenses ..."
-        bin/bundle exec rake licenses:generate
-        ;;
-    -h | --help)
-        usage
-        ;;
-    *)
-        usage
-        exit 1
-        ;;
-    esac
-    shift
-done
+../actions/script/licenses "$@"

data/templates/script/server

@@ -1,5 +1,65 @@
-#!/bin/sh
+#!/usr/bin/env bash
 
 set -e
 
-bin/foreman start -f Procfile.dev
+# Initialize flags
+local_dev=true
+api_only=false
+debug=false
+
+function opr_cmd() {
+    if $local_dev; then
+        bin/opr $1
+    else
+        $1
+    fi
+}
+
+function cleanup() {
+    echo "Cleaning up attached services..."
+    docker compose down
+    echo "...Done"
+}
+
+# Check for and parse flags
+for arg in "$@"
+do
+    case $arg in
+        --api-only)
+            api_only=true
+        ;;
+        --docker)
+            local_dev=false
+        ;;
+        --debug)
+            export DEBUG=true
+            debug=true
+        ;;
+        *)
+            # Unknown arguments can be ignored or handled here
+        ;;
+    esac
+done
+
+# In non-local dev scenarios, change ownership of the application to the non-root 'plug-app' user
+if [[ $local_dev == false ]]; then
+    chown -R plug-app:plug-app /usr/src/app
+else
+    # In local dev scenarios, run attached compose services in detached mode
+    docker compose up --wait
+fi
+
+if $local_dev; then
+
+    # Ensure docker-compose goes down when the server is stopped
+    trap cleanup SIGINT
+    trap cleanup SIGTSTP
+
+    if $debug; then
+        bin/foreman start -f Procfile.debug
+    else
+        bin/foreman start -f Procfile.dev
+    fi
+else
+    bin/puma -C config/puma.rb
+fi

data/templates/script/sorbet

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# This script is "symlink"ed from our actions repo.
+# Not really, obviously, it's a real file.
+
+set -e
+
+../actions/script/sorbet "$@"

data/templates/test/controllers/application_controller_test.rb

@@ -0,0 +1,32 @@
+# typed: false
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ApplicationControllerTest < ActionDispatch::IntegrationTest
+  test "renders a 404" do
+    get "/asdasdasdasd"
+
+    assert_response :not_found
+    assert_match(/Not Found/, response.body)
+  end
+
+  test "bogus js does not 500" do
+    get "/js/admin.js"
+
+    assert_response :not_found
+    assert_match(/Not Found/, response.body)
+  end
+
+  test "bogus routes do not 500" do
+    post "/"
+
+    assert_response :not_found
+    assert_match(/Not Found/, response.body)
+
+    put "/asdads"
+
+    assert_response :not_found
+    assert_match(/Not Found/, response.body)
+  end
+end

data/templates/test/controllers/settings_controller_test.rb

@@ -6,7 +6,7 @@ require "test_helper"
 class SettingsControllerTest < ActionDispatch::IntegrationTest
   include API::TestHelpers
 
-  include Webmocks::Yetto
+  include Webmocks::YettoWebmock
 
   test "GET /settings without asking for JSON fails" do
     api(:get, "/settings", headers: nil)

data/templates/test/controllers/yetto_controller_test.rb

@@ -6,7 +6,7 @@ require "test_helper"
 class YettoControllerTest < ActionDispatch::IntegrationTest
   include API::TestHelpers
 
-  include Webmocks::Yetto
+  include Webmocks::YettoWebmock
 
   def setup
     super

data/templates/test/fixtures/files/fake_pem_file/fake.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEAljw3p40+fSF5QkoVWnof6J3UVH8NRu80CZWLK+FXH/yEzfZj
+5ZQdbLRZzbhd24PIqbyCKJe0JS82ya9AbElT7VkfTGrj/smqepgv1FuhxWsTYGSy
+kIBST06mZGnzaOLzP0H2CEHZwQtIX3W9vgqBrUYu5RCz3zUI7z7MwE2J8lZ6I9hy
+pUzPFK3FIAar8sgA0FNTK2I3P5MWUGwGW+8BiudpNz3dMMHJVQ7dRuNj/PazCv4p
+DIF0ZSwzaqTP+XBaaLRAwOD24dZWbiJNLKR6l2CU/xpIABHqk6WoO7FZcfn2sI8c
+Bey7YoJOvGe8+AB7MYPJ2IXOdgFihr4WVX74ZQIDAQABAoIBAQCEomc0KnOnv1yx
+lHwjo7v1/xlM+9o57MbRS1BSDiCAIc0RlNx++/O6W8MI5yMdwMvwZne25K/rQDKr
+fmhu8ZIB8nO6YIgnEd3LW/6mCbvZcf3qVRx8jH2efL5T2mJGEE9WYqKWiaR4VMCx
+Xl6En/v6gQK3wrY6cjUQGy5i/FG0OyBIQZDucIc4b4TdLBUzo85xbXvodX9hWCvm
+qGoZlrmKWxn/Ro+Hi0NJbKPR0DUAfQVBzg9QqJTVvQtdVeAnisgYVUUDKevFV7sm
+jyryJ2vKzvPNOHYsBMD/bRlj1loHlpqIddEsBoxSeq8aNJ5nEz31qG7AHBLu+TK+
+ZGILRnDhAoGBAMdiMSz1jrur55dDHoclciPFbKop6j/HmpU85LuMsi1nXejog9Bs
+uir75boKgd3P51rbEruOPVZqf6bkPhO3da1YI2x8j0B+V/kDXbPLYPxfVmfOo/ct
+cxBqXloe0036ZO96y/IJlRPvSY2H/mXiNCnGzej6ROgH4t+vR0iEl2/NAoGBAMDl
+R9IRjdB4bemZEMAoeORpsD7esb0dLA7W7/ObJxBRFuUcQOJq/JNb7SYFdXrLAeUd
+QWevXsS2ZjqmxlEWwGtqy0D548Rh4F3SpWiDh7hG3hePtC/XC57t00/cWYe2kTWQ
+0662y00qwsWCo4Uy++iIiNx44ilWhcE5phCowiL5AoGAUQKwgFf1eoNKQcdfrAGm
+8qnQkQMeznNHd8OaHCn6a0BIg82VYSYMLlLS8Fg8k+dZVS0V22bbvTTgUOsD3fb4
+tUnOetHRUp8DF4YqmFbWPTRvYxYuwMuSqOTPGUbVDCXkxPjbzKfgDo13ES5kSvkx
+wJeqKjMltDEgGUqaZ/iXnzECgYArMKs+G/QW44Aot78KZ4V6DzgJO6+sWmXNBM9B
+SlIa0y0/K25TxAS9se2Nf9doISBRfpVwc9HSVczaARGSgnefFZBhAhK/m/Kyz0F9
+/0VaO3Pq7qA3vfy6HyIbVYkuW/Bzf/QFwKQQqSxnMPMQFfRVgoyyYNayzs6wDwph
+3IdrcQKBgQC+VpUU/04AD9qFk+6GwXer69i3NQJ+LtYEsJ8yeKzS5MUOt3s+C2T6
+uKLdq/j5XwzIIulcBQEJOoa1A3KcaIpkiWgvAbAKrirH9IobHvVLk9RxQ4EMihhU
+/GBStICbD54zeJmrEJx+yxa4HYx/aKViPpt6xg3WJdBJplTmCq181g==
+-----END RSA PRIVATE KEY-----

data/templates/test/jobs/update_yetto_job_test.rb

@@ -4,30 +4,15 @@
 require "test_helper"
 
 class UpdateYettoJobTest < ActiveJob::TestCase
-  include Webmocks::Yetto
+  include Webmocks::YettoWebmock
 
   def setup
     super
 
     @update_installation_body = {
-      plug_installation: {
-        credentials: {},
-        settings: {},
-      },
+      credentials: {},
+      settings: {},
     }
-
-    @installation_params = {
-      type: "installation",
-      inbox: {
-        id: @inbox_id,
-      },
-      organization: {
-        id: @organization_id,
-      },
-    }
-
-    @installation_params[:plug_installation] = @update_installation_body[:plug_installation].dup
-    @installation_params[:plug_installation][:id] = @plug_installation_id
   end
 
   test "does nothing if type is not supported" do

data/templates/test/support/api.rb

@@ -60,7 +60,7 @@ module API
     end
 
     def prepend_plug_path(version, path)
-      "/${app}/#{version}#{path}"
+      "/app/#{version}#{path}"
     end
 
     def prepend_api_path(version, path)

data/templates/test/support/rails.rb

@@ -32,7 +32,7 @@ module ActiveSupport
 
           expected_value = expected_args[actual_key]
 
-          assert_equal(expected_value, actual_value)
+          assert_equal(expected_value, actual_value, "Expected `#{actual_key}` to be `#{expected_value.nil? ? "nil" : expected_value}`, but was `#{actual_value.nil? ? "nil" : actual_value}`")
         end
       end
     end

data/templates/test/support/webmocks/slack_webmock.rb

@@ -8,12 +8,12 @@ module Webmocks
 
     sig { returns(T.untyped) }
     def assert_requested_send_to_slack_log
-      assert_requested(:post, "https://slack.com:80/the_log_room")
+      assert_requested(:post, "https://slack.com/the_log_room")
     end
 
     sig { returns(T.untyped) }
     def stub_send_to_slack_log
-      stub_request(:post, "https://slack.com:80/the_log_room")
+      stub_request(:post, "https://slack.com/the_log_room")
         .to_return(
           status: 200,
           headers: { content_type: "application/json; charset=utf-8" },

data/templates/test/support/webmocks/yetto_webmock.rb

@@ -0,0 +1,119 @@
+# typed: false
+# frozen_string_literal: true
+
+module Webmocks
+  module YettoWebmock
+    def yetto_auth_header(payload, signing_secret = "super-secret")
+      "sha256=#{OpenSSL::HMAC.hexdigest(Authable::SHA256_DIGEST, signing_secret, payload.to_json)}"
+    end
+
+    def assert_requested_post_access_token(plug_installation_id)
+      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/plugs/installations/#{plug_installation_id}/access_tokens")
+    end
+
+    def stub_post_access_token(plug_installation_id)
+      response = {
+        token: Faker::Alphanumeric.alphanumeric(number: 26).upcase,
+      }
+      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/plugs/installations/#{plug_installation_id}/access_tokens")
+        .to_return(
+          body: response.to_json,
+        )
+    end
+
+    def assert_requested_get_plug_installation(plug_installation_id)
+      assert_requested_post_access_token(plug_installation_id)
+      assert_requested(:get, "#{::YettoService::YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}")
+    end
+
+    def stub_get_plug_installation(plug_installation_id, response = nil, status: 200)
+      stub_post_access_token(plug_installation_id)
+
+      response ||= {
+        installed_on_inbox: {
+          id: inbox_id,
+          organization: {
+            id: organization_id,
+            status: "active",
+          },
+        },
+        plug: {
+          id: "plg_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}",
+        },
+        settings: {
+          from_email: "new@from.company",
+        },
+      }
+
+      stub_request(:get, "#{::YettoService::YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}")
+        .to_return(
+          status: status,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: response.to_json,
+        )
+    end
+
+    def assert_requested_update_installation(plug_installation_id)
+      assert_requested_post_access_token(plug_installation_id)
+
+      assert_requested(:patch, "#{::YettoService::YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}")
+    end
+
+    def stub_update_installation(plug_installation_id, params, response: {}, status: 200)
+      stub_post_access_token(plug_installation_id)
+
+      stub_request(:patch, "#{::YettoService::YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}")
+        .with(
+          body: params,
+        )
+        .to_return(
+          status: status,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: response.to_json,
+        )
+    end
+
+    def assert_requested_create_message(inbox_id)
+      assert_requested_post_access_token(plug_installation_id)
+
+      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/messages")
+    end
+
+    def stub_create_message(inbox_id, payload)
+      stub_post_access_token(plug_installation_id)
+
+      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/messages")
+        .with(
+          body: payload,
+        )
+        .to_return(
+          status: 200,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: {}.to_json,
+        )
+    end
+
+    def assert_requested_create_inbox_switch(inbox_id, plug_installation_id)
+      assert_requested_post_access_token(plug_installation_id)
+      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/switches")
+    end
+
+    def stub_create_inbox_switch(inbox_id, plug_installation_id, params)
+      stub_post_access_token(plug_installation_id)
+
+      payload = {
+        name: "After install",
+      }
+
+      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/switches")
+        .with(
+          body: payload,
+        )
+        .to_return(
+          status: 200,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: {}.to_json,
+        )
+    end
+  end
+end

data/templates/test/test_helper.rb

@@ -3,15 +3,28 @@
 
 require "debug" if ENV.fetch("DEBUG", false)
 
+if ENV["COVERAGE"] == "1"
+  require "simplecov"
+  require "simplecov-console"
+
+  SimpleCov.start("rails")
+
+  # do not crash on failure; we want a distinct job to report the coverage error
+  module SimpleCov
+    class << self
+      def result_exit_status(_)
+        SimpleCov::ExitCodes::SUCCESS
+      end
+    end
+  end
+end
+
 require "httpx"
 require "webmock/minitest"
 require "httpx/adapters/webmock"
 WebMock.enable!
 WebMock.disable_net_connect!(allow_localhost: true)
 
-require "dotenv"
-Dotenv.load(".env.test")
-
 require_relative "./support/rails"
 
 require "minitest/pride"

data/templates/vendor/fly/fly-production.toml

@@ -0,0 +1,38 @@
+# fly.toml app configuration file generated for plug-app on 2023-05-05T07:11:14-04:00
+#
+# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
+#
+
+app = "plug-app-production"
+primary_region = "iad"
+
+[env]
+  RAILS_ENV = "production"
+  LD_PRELOAD_PATH = "/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
+
+[processes]
+  web = "./bin/rails server"
+  worker = "bundle exec sidekiq"
+
+[http_service]
+  internal_port = 3000
+  force_https = true
+  auto_stop_machines = true
+  auto_start_machines = true
+  min_machines_running = 1
+  processes = ["web"]
+  [http_service.concurrency]
+    type = "requests"
+    soft_limit = 200
+    hard_limit = 250
+
+[checks]
+  [checks.alive]
+    type = "tcp"
+    interval = "15s"
+    timeout = "2s"
+    grace_period = "5s"
+
+[[statics]]
+  guest_path = "/plug-app/public"
+  url_prefix = "/"

data/templates/vendor/fly/fly-staging.toml

@@ -0,0 +1,33 @@
+app = "plug-app-staging"
+primary_region = "iad"
+
+[env]
+  RAILS_ENV = "plug-app-staging"
+  LD_PRELOAD_PATH = "/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
+
+[processes]
+  web = "./bin/rails server"
+  worker = "bundle exec sidekiq"
+
+[http_service]
+  internal_port = 3000
+  force_https = true
+  auto_stop_machines = true
+  auto_start_machines = true
+  min_machines_running = 0
+  processes = ["web"]
+  [http_service.concurrency]
+    type = "requests"
+    soft_limit = 200
+    hard_limit = 250
+
+[checks]
+  [checks.alive]
+    type = "tcp"
+    interval = "15s"
+    timeout = "2s"
+    grace_period = "5s"
+
+[[statics]]
+  guest_path = "/plug-app/public"
+  url_prefix = "/"