hephaestus 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b95d21bfd57de5966b0e84d88b1405b86858be61eba98db2540cd4321169fe3c
-  data.tar.gz: a1a812f73c093ec210675c9f5f736893c0170aece8f06ce92cb43ff9df39467c
+  metadata.gz: 35a7bffcd76ad59ed8a990221e201641e0931d5959d3a23eb1ff38e6cab6e196
+  data.tar.gz: 3a8041e10782f1feae394c607ff0b2884454bf2497973b204e1038d8318a8b19
 SHA512:
-  metadata.gz: d967799d74078769fe825e5b03cfae506da34b023ff2e07edbe97ec91283592a50e664d280a1c2394ceefdd2047952ca36628e602789d224758d9bc91b45952b
-  data.tar.gz: '08804720c39e023bfd1abc2ac87de38fc9badf9509fc8b3f161f0528862653bfb18727da01aab24ce56012e4346ef6abb2f6f78746c1e681a533787b49df2bd0'
+  metadata.gz: 343b21a22b01d3dec66e68ab5d807612930f2f46ed0fc5daa3d473745ce5db89978a3cd605b13ecb24cae51101e072dd5dbd891ed424855ce0724fd0233227c7
+  data.tar.gz: 8127efafa530a873c67a014ea0beef448b768c908bb4629a668eef1abcfe8b1527886447ad3757298d07f33483cab8e7a9c9b3f9839d7d0f88d7a04fb56f79ca

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [v0.4.0] - 29-09-2023
+## What's Changed
+* Yet more changes by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/10
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.3.1...v0.4.0
+## [v0.3.1] - 18-09-2023
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.3.0...v0.3.1
 ## [v0.3.0] - 12-09-2023
 ## What's Changed
 * Bump actions/checkout from 3 to 4 by @dependabot in https://github.com/yettoapp/hephaestus/pull/8

data/bin/hephaestus

@@ -70,5 +70,6 @@ ARGV.push("--minimal")
 ARGV.push("--no-skip-active-job")
 ARGV.push("--skip-asset-pipeline")
 ARGV.push("--skip-active-record")
+ARGV.push("--skip-docker")
 
 Hephaestus::AppGenerator.start

data/lib/hephaestus/app_builder.rb

@@ -73,7 +73,7 @@ module Hephaestus
     def setup_slack_logger
       config = <<~EOD
         config.after_initialize do
-          Rails.logger.extend(ActiveSupport::Logger.broadcast(SlackWebhookLogger.logger))
+          Rails.logger.broadcast_to(SlackWebhookLogger.logger)
         end
       EOD
       configure_environment("production", config)
@@ -158,14 +158,17 @@ module Hephaestus
     def replace_generic_variables
       say(set_color("Replacing generic variable names...", :cyan))
       replace_in_files(destination_root, /App(?!lication)/, short_app_name.capitalize)
-      replace_in_files(destination_root, %r{(?<!yetto)app(?!lication|/|roximate)}, short_app_name.downcase)
+      replace_in_files(destination_root, %r{(?<!yetto|sw|plugs\.yetto\.)app(?!lication|/|roximate)}, short_app_name.downcase)
       replace_in_files(destination_root, "PlugApp", app_name.underscore.camelcase)
       replace_in_files(destination_root, "plug-app", app_name.dasherize)
+      replace_in_files("destination_root}/.github/workflows/test.yml", "plug-app", app_name.dasherize)
       replace_in_files(destination_root, "PLUG_APP", app_name.underscore.upcase)
       replace_in_files(destination_root, "plug_app", app_name.underscore)
 
-      # this is erroneously changed
+      # these are erroneously changed
       replace_in_file("script/server", "/usr/src/#{short_app_name.downcase}", "/usr/src/app")
+      replace_in_file("vendor/fly/fly-production.toml", "#{short_app_name.downcase} = ", "app = ")
+      replace_in_file("vendor/fly/fly-staging.toml", "#{short_app_name.downcase} = ", "app =")
     end
 
     private

data/lib/hephaestus/generators/app_generator.rb

@@ -28,37 +28,10 @@ module Hephaestus
       super
     end
 
-    # NOTE: this function name is important as it overrides
-    # a Rails function of the same name (that function performs work
-    # that we don't want to do)
-    def leftovers
-      build(:replace_generic_variables)
-
-      say(set_color("Generating `hephaestus:license`...", :cyan))
-      capture_stdout do
-        generate("hephaestus:license")
-      end
-      say(set_color("Generating `hephaestus:rubocop`...", :cyan))
-      capture_stdout do
-        generate("hephaestus:rubocop")
-      end
-      say(set_color("Generating `hephaestus:sorbet`...", :cyan))
-      capture_stdout do
-        generate("hephaestus:sorbet")
-      end
-      say(set_color("Creating first commit...", :cyan))
-      capture_stdout do
-        invoke(:commit)
-      end
-
-      build(:restore_gemfile)
-      invoke(:outro)
-    end
-
     def hephaestus_customization
       say(set_color("Invoking Hephaestus customizations...", :cyan))
 
-      run("rails app:update:bin", capture: true)
+      run("rails app:update:bin")
       invoke(:customize_gemfile)
 
       invoke(:copy_github_actions)
@@ -79,6 +52,8 @@ module Hephaestus
       build(:replace_gemfile)
       capture_stdout do
         bundle_command("install")
+        bundle_command("update")
+        bundle_command("binstub foreman")
         bundle_command("lock --add-platform x86_64-linux")
       end
     end
@@ -171,6 +146,33 @@ module Hephaestus
       end
     end
 
+    # NOTE: this function name is important as it overrides
+    # a Rails function of the same name (that function performs work
+    # that we don't want to do)
+    def leftovers
+      build(:replace_generic_variables)
+
+      say(set_color("Generating `hephaestus:license`...", :cyan))
+      capture_stdout do
+        generate("hephaestus:license")
+      end
+      say(set_color("Generating `hephaestus:rubocop`...", :cyan))
+      capture_stdout do
+        generate("hephaestus:rubocop")
+      end
+      say(set_color("Generating `hephaestus:sorbet`...", :cyan))
+      capture_stdout do
+        generate("hephaestus:sorbet")
+      end
+      say(set_color("Creating first commit...", :cyan))
+      capture_stdout do
+        invoke(:commit)
+      end
+
+      build(:restore_gemfile)
+      invoke(:outro)
+    end
+
     def commit
       run("git add .")
       run("git commit -m 'Initial commit'", capture: true)
@@ -202,11 +204,12 @@ module Hephaestus
 
         * Set `settings/branches` to protect `production`
           * ✅ Require status checks to pass before merging
-          * 🖊️ Status checks that are required: `test`, `ruby / brakeman`, `ruby / bundle-audit`.
+          * 🖊️ Status checks that are required: `ruby / test_without_services`, `docker / test-build`, `ruby / brakeman`, `ruby / bundle-audit`.
+
             You can only set those 👆 after you've opened the first PR on GitHub. Crazy, I know!!
             But, doing so is *essential* for automerge to function properly.
 
-        * Speaking of which, in `/settings`
+        * In `/settings`:
           * ✅ Allow auto-merge
           * ✅ Automatically delete head branches
       OUTPUT
@@ -229,22 +232,22 @@ module Hephaestus
     end
 
     private def capture_stdout
-      stream = "stdout"
-      captured_stream = Tempfile.new(stream)
-      stream_io = eval("$#{stream}", binding, __FILE__, __LINE__)
-      origin_stream = stream_io.dup
-      stream_io.reopen(captured_stream)
+      # stream = "stdout"
+      # captured_stream = Tempfile.new(stream)
+      # stream_io = eval("$#{stream}", binding, __FILE__, __LINE__)
+      # origin_stream = stream_io.dup
+      # stream_io.reopen(captured_stream)
 
       yield
 
-      stream_io.rewind
-      captured_stream.read
-    ensure
-      unless captured_stream.nil?
-        captured_stream.close
-        captured_stream.unlink
-      end
-      stream_io.reopen(origin_stream) unless stream_io.nil?
+      # stream_io.rewind
+      # captured_stream.read
+
+      # unless captured_stream.nil?
+      #   captured_stream.close
+      #   captured_stream.unlink
+      # end
+      # stream_io.reopen(origin_stream) unless stream_io.nil?
     end
   end
 end

data/lib/hephaestus/generators/config_generator.rb

@@ -89,11 +89,10 @@ module Hephaestus
 
         # events into the plug, usually from yetto
         get "/api/2023-03-06/settings", to: "settings#new"
-        post "/api/2023-03-06/:event/:record_type", to: "yetto#event"
+        post "/api/2023-03-06/:record_type/:event", to: "yetto#event"
 
         # inbound message
-        post "/app/2023-03-06/webhook/:organization_id/:inbox_id/:plug_installation_id", to: "app#webhook"
-        # post "/app/2023-03-06/webhook/inbound", to: "app#process_inbound" # for generic inbound pings
+        post "/$app/2023-03-06/webhook/inbound", to: "app#webhook"
 
         # Staff pages
         get "staff", to: "staff#index"

data/lib/hephaestus/generators/core_generator.rb

@@ -19,7 +19,7 @@ module Hephaestus
     end
 
     def jobs
-      copy_file("app/jobs/application_job.rb", "app/jobs/application_job.rb")
+      copy_file("app/jobs/application_job.rb", "app/jobs/application_job.rb", force: true)
       copy_file("app/jobs/update_yetto_job.rb", "app/jobs/update_yetto_job.rb")
     end
 

data/lib/hephaestus/generators/deployment_generator.rb

@@ -20,5 +20,11 @@ module Hephaestus
       copy_file("Dockerfile", "Dockerfile")
       copy_file("bin/docker-entrypoint", "bin/docker-entrypoint")
     end
+
+    def fly
+      directory("vendor/fly", "vendor/fly")
+      copy_file("Dockerfile", "Dockerfile")
+      copy_file("bin/docker-entrypoint", "bin/docker-entrypoint")
+    end
   end
 end

data/lib/hephaestus/version.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Hephaestus
-  VERSION = "0.3.1"
+  VERSION = "0.5.0"
   RAILS_VERSION = "~> 7.0"
   RUBY_VERSION = File
     .read("#{File.dirname(__FILE__)}/../../.ruby-version")

data/lib/hephaestus.rb

@@ -11,10 +11,15 @@ require "debug" if debugging?
 
 require "hephaestus/version"
 require "hephaestus/exit_on_failure"
+
 require "hephaestus/generators/app_generator"
-Dir.glob(File.join(__dir__, "hephaestus", "generators", "*.rb")).each do |file|
-  require file
-end
+require "hephaestus/generators/config_generator"
+require "hephaestus/generators/core_generator"
+require "hephaestus/generators/deployment_generator"
+require "hephaestus/generators/lib_generator"
+require "hephaestus/generators/license_generator"
+require "hephaestus/generators/rubocop_generator"
+require "hephaestus/generators/sorbet_generator"
 
 require "hephaestus/actions"
 require "hephaestus/actions/strip_comments_action"

data/templates/.github/workflows/licenses.yml

@@ -13,7 +13,7 @@ jobs:
   verify:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
           token: ${{ secrets.GH_SISYPHUS_YETTO_REPO_TOKEN }}

data/templates/.github/workflows/lint.yml

@@ -12,7 +12,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: yettoapp/actions/pr-contains-files@main
         id: pr_contains_ruby

data/templates/.github/workflows/security.yml

@@ -12,4 +12,4 @@ jobs:
   ruby:
     uses: yettoapp/actions/.github/workflows/ruby_security_checks.yml@main
     secrets:
-      token: ${{ secrets.GITHUB_TOKEN }}
+      gh_token: ${{ secrets.GH_SISYPHUS_YETTO_REPO_TOKEN }}

data/templates/.github/workflows/sorbet.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
           token: ${{ secrets.GH_SISYPHUS_YETTO_REPO_TOKEN }}

data/templates/.licensed.yml

@@ -11,10 +11,16 @@ allowed:
 
 ignored:
   bundler:
+    - base64 # BSD-2-Clause ("This file is released under the same license as ruby.")
+    - bigdecimal # BSD-2-Clause ("This file is released under the same license as ruby.")
     - bundler-audit # GPL-3.0; but also, only used in CI/test
     - date # BSD-2-Clause
+    - drb # BSD-2-Clause ("This file is released under the same license as ruby.")
+    - io-console # BSD-2-Clause
+    - mutex_m # BSD-2-Clause ("This file is released under the same license as ruby.")
     - net-protocol # BSD-2-Clause
     - racc # BSD-2-Clause
+    - reline # BSD-2-Clause ("This file is released under the same license as ruby.")
     - ruby2_keywords # BSD-2-Clause; ignored because of custom LICENSE text
     - sidekiq # LGPL-3.0; ignored because of custom LICENSE text
 

data/templates/Dockerfile

@@ -4,8 +4,8 @@
 ARG RUBY_VERSION=3.2.1
 FROM ruby:$RUBY_VERSION-slim as base
 
-# Rails app lives here
-WORKDIR /plug-github
+# The plug-app code lives here
+WORKDIR /plug-app
 
 # Set production environment
 ARG RAILS_ENV="production"

data/templates/Gemfile.erb

@@ -44,6 +44,9 @@ gem "opentelemetry-instrumentation-active_job", "~> 0.5"
 gem "opentelemetry-instrumentation-redis", "~> 0.25"
 gem "opentelemetry-instrumentation-sidekiq", "~> 0.23"
 
+# massively improved JSON parsing
+gem "oj", "~> 3.16"
+
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
@@ -114,4 +117,4 @@ group :ci do
   gem "bundle-audit", "~> 0.1"
 end
 
-gem "hephaestus", group: [:development, :test]
+gem "hephaestus", group: [:development, :test]

data/templates/app/controllers/app_controller.rb

@@ -8,12 +8,12 @@ class AppController < ApplicationController
   include PathParameter::AppParameters
   include BodyParameter::AppParameters
 
-  before_action :from__app_?
+  before_action :from_app?
 
   # Inbound message from ${App}
   def webhook
-    # Error if necesary parameters from ${App} are missing
-    return bad_request unless has_inbound__app__params?
+    # Error if necessary parameters from ${App} are missing
+    return bad_request unless has_inbound_app_params?
 
     response = YettoService.get_plug_installation(pparam_organization_id, pparam_inbox_id, pparam_plug_installation_id)
 

data/templates/app/controllers/concerns/authable.rb

@@ -26,8 +26,8 @@ module Authable
 
     # status is annoyingly set to 401, but we want
     # to hide that an issue exists
-    response.status = PlugApp::HTTP::BAD_REQUEST_I
-    response.body = ::ErrorSerializer.format(PlugApp::HTTP::BAD_REQUEST)
+    self.status = PlugApp::HTTP::BAD_REQUEST_I
+    self.response_body = ::ErrorSerializer.format(PlugApp::HTTP::BAD_REQUEST)
   end
 
   sig { void }

data/templates/app/controllers/settings_controller.rb

@@ -6,6 +6,14 @@ class SettingsController < ApplicationController
 
   include PathParameter::SettingsParameters
 
+  before_action :ensure_json_request
+  sig { void }
+  def ensure_json_request
+    return if request.format.json?
+
+    not_acceptable
+  end
+
   sig { void }
   def new
     @step = T.let(params.fetch(:step, 1).to_i || 1, T.nilable(Integer))

data/templates/app/controllers/yetto_controller.rb

@@ -3,6 +3,7 @@
 
 class YettoController < ApplicationController
   include BodyParameter::YettoParameters
+  include PathParameter
   include PathParameter::YettoParameters
   include Authable
 
@@ -10,11 +11,21 @@ class YettoController < ApplicationController
 
   before_action :from_yetto?
 
+  AFTER_CREATE_MESSAGE_SWITCH = JSON.parse(Rails.root.join("app/lib/plug_app/switches/message_created.jsonc").read)
+
   def event
     case pparam_yetto_event
     when Headers::Yetto::EVENT_AFTER_CREATE
       case pparam_yetto_record_type
       when Headers::Yetto::RECORD_TYPE_PLUG_INSTALLATION
+        create_inbox_switch_data = {
+          type: "create_inbox_switch",
+          inbox: { id: bparam_inbox_id },
+          plug_installation: { id: bparam_plug_installation_id },
+          payload: AFTER_CREATE_MESSAGE_SWITCH,
+        }
+
+        UpdateYettoJob.perform_later(create_inbox_switch_data)
 
         no_content
       when Headers::Yetto::RECORD_TYPE_MESSAGE

data/templates/app/jobs/update_yetto_job.rb

@@ -5,22 +5,24 @@
 # This can be used to update installation data or message data
 
 class UpdateYettoJob < ApplicationJob
-  queue_as :default
+  queue_as :update_yetto
 
   def perform(params)
     type = params.delete(:type)
 
-    organization_id = params.fetch(:organization, {}).fetch(:id, nil)
     inbox_id = params.fetch(:inbox, {}).fetch(:id, nil)
     plug_installation_id = params.fetch(:plug_installation, {}).fetch(:id, nil)
+    message_id = params.fetch(:message, {}).fetch(:id, nil)
 
     case type
     when "update_plug_installation"
       YettoService.update_installation(plug_installation_id, params)
     when "create_inbox_switch"
       YettoService.create_inbox_switch(inbox_id, plug_installation_id, params)
-    when "create_message"
-      YettoService.create_message(inbox_id, plug_installation_id, params)
+    when "create_message_reply"
+      YettoService.create_message_reply(message_id, plug_installation_id, params)
+    when "add_message_metadata"
+      YettoService.update_message(message_id, plug_installation_id, params)
     end
   end
 end

data/templates/app/lib/body_parameter/yetto_parameters.rb

@@ -5,25 +5,47 @@ module BodyParameter
   module YettoParameters
     extend T::Sig
 
-    sig { returns(T::Boolean) }
-    def has_update_plug_installation_params?
-      return false if update_plug_installation_params.blank?
+    sig { returns(String) }
+    def bparam_organization_id
+      plug_installation_params[:organization][:id]
+    end
+
+    sig { returns(String) }
+    def bparam_inbox_id
+      plug_installation_params[:inbox][:id]
+    end
+
+    sig { returns(String) }
+    def bparam_plug_installation_id
+      plug_installation_params[:plug_installation][:id]
+    end
+
+    sig { returns(String) }
+    def bparam_plug_id
+      plug_installation_params[:plug][:id]
+    end
 
-      true
+    sig { returns(T::Hash[Symbol, String]) }
+    def bparam_plug_installation_settings
+      plug_installation_params[:plug_installation][:settings]
     end
 
     sig { returns(T::Hash[Symbol, String]) }
-    def update_plug_installation_params
+    def plug_installation_params
       return {} if params.blank?
 
-      return {} if (plug_installation_id = params.fetch(:plug_installation, {}).fetch(:id, "")).blank?
-      return {} if (organization_id = params.fetch(:organization, {}).fetch(:id, "")).blank?
-      return {} if (plug_id = params.fetch(:plug, {}).fetch(:id, "")).blank?
-      return {} if (inbox_id = params.fetch(:inbox, {}).fetch(:id, "")).blank?
+      plug_installation = params.fetch(:plug_installation, {})
+      plug_installation_id = plug_installation.fetch(:id, "")
+      settings = plug_installation.fetch(:settings, {}).to_unsafe_hash
+
+      organization_id = params.fetch(:organization, {}).fetch(:id, "")
+      plug_id = params.fetch(:plug, {}).fetch(:id, "")
+      inbox_id = params.fetch(:inbox, {}).fetch(:id, "")
 
       {
         plug_installation: {
           id: plug_installation_id,
+          settings: settings,
         },
         organization: {
           id: organization_id,
@@ -36,5 +58,67 @@ module BodyParameter
         },
       }
     end
+
+    sig { returns(String) }
+    def bparam_message_id
+      message_params[:message][:id]
+    end
+
+    sig { returns(String) }
+    def bparam_message_text_content
+      message_params[:message][:text_content]
+    end
+
+    sig { returns(String) }
+    def bparam_message_conversation_id
+      message_params[:message][:conversation][:id]
+    end
+
+    sig { returns(String) }
+    def bparam_message_conversation_title
+      message_params[:message][:conversation][:title]
+    end
+
+    sig { returns(String) }
+    def bparam_message_author_name
+      message_params[:message].fetch(:author, {}).fetch(:name, "Noone")
+    end
+
+    sig { returns(T::Hash[Symbol, String]) }
+    def bparam_message_metadata
+      message_params[:message][:metadata]
+    end
+
+    sig { returns(T::Hash[Symbol, String]) }
+    def message_params
+      return {} if params.blank?
+
+      message = params.fetch(:message, {})
+      message_id = message.fetch(:id, "")
+      text_content = message.fetch(:text_content, "")
+      conversation = message.fetch(:conversation, {})
+      conversation_id = conversation.fetch(:id, "")
+      title = conversation.fetch(:title, "")
+      created_by_user = message.fetch(:created_by_user, {})
+      created_by_plug = message.fetch(:created_by_plug, {})
+      author = (created_by_user.presence || created_by_plug)
+      name = author.fetch(:name, "")
+      metadata = message.fetch(:metadata, {}).to_unsafe_hash
+
+      {
+        message: {
+          id: message_id,
+          text_content: text_content,
+          conversation: {
+            id: conversation_id,
+            title: title,
+          },
+          author: {
+            name: name,
+          },
+          metadata: metadata,
+        },
+      }
+    end
   end
 end

data/templates/app/lib/headers/yetto.rb

@@ -6,7 +6,9 @@ module Headers
     YETTO_DELIVERY_ID = "HTTP_X_YETTO_DELIVERY_ID"
 
     HEADER_EVENT = "HTTP_X_YETTO_EVENT"
-    EVENT_AFTER_CREATE = "after_create"
+    EVENT_AFTER_CREATE = "created"
+    EVENT_AFTER_UPDATE = "updated"
+    EVENT_AFTER_DESTROY = "destroyed"
 
     HEADER_RECORD_TYPE = "HTTP_X_YETTO_RECORD_TYPE"
     RECORD_TYPE_PLUG_INSTALLATION = "plug_installation"

data/templates/app/lib/path_parameter/yetto_parameters.rb

@@ -15,11 +15,14 @@ module PathParameter
       yetto_path_params.fetch(:record_type, "")
     end
 
-    sig { returns(ActionController::Parameters) }
+    sig { returns(T::Hash[String, String]) }
     def yetto_path_params
-      return ActionController::Parameters.new if params.blank?
+      return {} if path_parameters.blank?
 
-      params.permit(:event, :record_type)
+      {
+        event: path_parameters.fetch(:event, ""),
+        record_type: path_parameters.fetch(:record_type, ""),
+      }
     end
   end
 end

data/templates/app/lib/plug_app/http.rb

@@ -13,6 +13,9 @@ module PlugApp
     NO_CONTENT = "No Content"
     NO_CONTENT_I = 204
 
+    FOUND = "Found"
+    FOUND_I = 302
+
     NOT_FOUND = "Not Found"
     NOT_FOUND_I = 404
     BAD_REQUEST = "Bad Request"

data/templates/app/lib/plug_app/switches/message_created.jsonc

@@ -0,0 +1,25 @@
+{
+    "name": "Send internal comments to App",
+    "configuration": {
+        "version": "2023-03-06",
+        "events": {
+            "message.created": {
+                "conditions": {
+                    "if": "{% data.message.visibility == 'internal' and data.message.text_content contains '@App' %}"
+                },
+                "actions": [
+                    {
+                        "name": "Send to App",
+                        "uses": "send_to_plug",
+                        "with": {
+                            "plug_id": "{{ data.switch.created_by_plug.id }}",
+                            "message": "{{ data.message }}",
+                            "plug_installation": "{{ data.plug_installation }}",
+                            "inbox": "{{ data.inbox }}"
+                        }
+                    }
+                ]
+            }
+        }
+    }
+}

data/templates/app/services/yetto_service.rb

@@ -6,48 +6,53 @@ class YettoService
     Httpsensible::Client.new(user_agent: "PlugApp/#{PlugApp::Application::GIT_SHA}")
   end
 
-  PROTOCOL = Rails.env.development? ? "http" : "https"
+  # explicitly different than what's in environment.rb, because local
+  # Yetto expects HTTP; environment.rb can use HTTPS because it passes through ngrok.io
+  PROTOCOL = Rails.env.development? ? "http://" : "https://"
   YETTO_API_VERSION_TLD = "#{PROTOCOL}://#{YETTO_API_TLD}/#{YETTO_API_VERSION}"
   JWT_ALGORITHM = "RS256"
 
   class << self
     def perform_token_exchange(plug_installation_id)
       encoded_jwt = Httpsensible::JWT.encode_jwt(YETTO_PLUG_PEM, YETTO_PLUG_ID)
-      response = yetto_client.with(headers: { "Authorization" => "Bearer #{encoded_jwt}" }).post("#{YETTO_API_VERSION_TLD}/plugs/installations/#{plug_installation_id}/access_tokens")
+      response = yetto_client.with_headers({ "Authorization" => "Bearer #{encoded_jwt}" }).post("#{YETTO_API_VERSION_TLD}/plug/installations/#{plug_installation_id}/access_tokens")
       body = response.parsed_json_body
       body["token"]
     end
 
     def get_plug_installation(plug_installation_id)
       token = perform_token_exchange(plug_installation_id)
-      yetto_client.with(headers: { "Authorization" => "Bearer #{token}" }).get("#{YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}")
+      yetto_client.with_headers("Authorization" => "Bearer #{token}").get("#{YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}")
     end
 
     def update_installation(plug_installation_id, params)
       plug_installation = {}
-      plug_installation[:settings] = params[:plug_installation].fetch(:settings, {})
-      plug_installation[:credentials] = params[:plug_installation].fetch(:credentials, {})
+      plug_installation[:settings] = params.fetch(:settings, {})
+      plug_installation[:credentials] = params.fetch(:credentials, {})
 
       token = perform_token_exchange(plug_installation_id)
-      yetto_client.with(headers: { "Authorization" => "Bearer #{token}" }).patch("#{YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}", json: plug_installation)
+      yetto_client.with_headers("Authorization" => "Bearer #{token}").patch("#{YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}", json: plug_installation)
     end
 
     def create_inbox_switch(inbox_id, plug_installation_id, params)
-      inbox_id = params.fetch(:inbox).fetch(:id)
+      payload = params[:payload]
+      token = perform_token_exchange(plug_installation_id)
 
-      payload = {
-        name: "After install",
-      }
+      yetto_client.with_headers("Authorization" => "Bearer #{token}").post("#{YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/switches", json: payload)
+    end
 
+    def update_message(message_id, plug_installation_id, params)
+      payload = params[:payload]
       token = perform_token_exchange(plug_installation_id)
-      yetto_client.with(headers: { "Authorization" => "Bearer #{token}" }).post("#{YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/switches", json: payload)
+
+      yetto_client.with_headers("Authorization" => "Bearer #{token}").patch("#{YETTO_API_VERSION_TLD}/messages/#{message_id}", json: payload)
     end
 
-    def create_message(inbox_id, plug_installation_id, params)
+    def create_message_reply(message_id, plug_installation_id, params)
       payload = params[:payload]
-
       token = perform_token_exchange(plug_installation_id)
-      yetto_client.with(headers: { "Authorization" => "Bearer #{token}" }).post("#{YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/messages", json: payload)
+
+      yetto_client.with_headers("Authorization" => "Bearer #{token}").post("#{YETTO_API_VERSION_TLD}/messages/#{message_id}/replies", json: payload)
     end
   end
 end

data/templates/compose.yml

@@ -4,4 +4,4 @@ services:
   redis-db:
     image: redis:7-bookworm
     ports:
-      - "6389:6379"
+      - "6402:6402"

data/templates/config/initializers/000-oj.rb

@@ -0,0 +1,6 @@
+# typed: false
+# frozen_string_literal: true
+
+Oj.default_options = { mode: :rails }
+
+Oj.optimize_rails

data/templates/config/initializers/environment.rb

@@ -16,7 +16,7 @@ YETTO_API_VERSION = ENV.fetch("YETTO_API_VERSION", "2023-03-06")
 
 SLACK_LOG_URL = Rails.application.credentials.fetch(:SLACK_LOG_URL, ENV.fetch("SLACK_LOG_URL", "https://slack.com/the_log_room"))
 
-PROTOCOL = Rails.env.development? ? "http://" : "https://"
+PROTOCOL = "https"
 PLUG_APP_URL = if Rails.env.production?
   "app.plugs.yetto.app"
 elsif Rails.env.staging?
@@ -34,3 +34,7 @@ YETTO_PLUG_ID = Rails.application.credentials.fetch(:YETTO_PLUG_ID, ENV.fetch("Y
 def productionish?
   Rails.env.production? || Rails.env.staging?
 end
+
+def print_user_api_errors?
+  (Rails.env.development? || Rails.env.staging?) || ENV.fetch("DEBUG", false)
+end

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

@@ -6,7 +6,7 @@
         "required": true,
         "schema": {
             "type": "string",
-            "pattern": "^after_{create|update|destroy}$"
+            "pattern": "^{created|updated|destroyed}$"
         }
     },
     "RecordType": {

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

@@ -98,7 +98,7 @@
         },
         "additionalProperties": false
     },
-    "CreateApp": {
+    "ConfigureApp": {
         "type": "object",
         "required": [
             "plug_installation",

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

@@ -17,11 +17,11 @@
         }
     ],
     "paths": {
-        "/api/2023-03-06/after_create/plug_installation": {
-            "$ref": "paths/yetto/after_create_plug_installation.json"
+        "/api/2023-03-06/plug_installation/created": {
+            "$ref": "paths/yetto/plug_installation_created.json"
         },
-        "/api/2023-03-06/after_create/message": {
-            "$ref": "paths/yetto/after_create_message.json"
+        "/api/2023-03-06/message/created": {
+            "$ref": "paths/yetto/message_created.json"
         },
         "/app/2023-03-06/{plugInstallationId}": {
             "$ref": "paths/app.json"

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

@@ -4,7 +4,7 @@
             "Yetto"
         ],
         "description": "After a message is created in Yetto, this delivers it.",
-        "operationId": "Create a new App",
+        "operationId": "Create a new message",
         "requestBody": {
             "required": true,
             "content": {

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

@@ -10,7 +10,7 @@
             "content": {
                 "application/json": {
                     "schema": {
-                        "$ref": "../../components/schemas/yetto.json#/CreateAppSwitch"
+                        "$ref": "../../components/schemas/yetto.json#/ConfigureApp"
                     }
                 }
             }

data/templates/test/controllers/yetto_controller_test.rb

@@ -60,37 +60,37 @@ class YettoControllerTest < ActionDispatch::IntegrationTest
 
   def headers(body)
     {
-      Headers::Yetto::HEADER_EVENT => "after_create",
+      Headers::Yetto::HEADER_EVENT => "created",
       Headers::Yetto::HEADER_RECORD_TYPE => "plug_installation",
       Headers::Yetto::HEADER_SIGNATURE => yetto_auth_header(body),
     }
   end
 
   test "it handles null headers" do
-    api(:post, "/after_create/plug_installation", headers: nil)
+    api(:post, "/plug_installation/created", headers: nil)
 
     assert_response :bad_request
   end
 
   test "it handles missing headers" do
-    api(:post, "/after_create/plug_installation", headers: {})
+    api(:post, "/plug_installation/created", headers: {})
 
     assert_response :bad_request
   end
 
   test "it handles incorrect headers" do
-    api(:post, "/after_create/plug_installation", headers: { "X-Yetto-Signature" => "Basic jabroni:lies" })
+    api(:post, "/plug_installation/created", headers: { "X-Yetto-Signature" => "Basic jabroni:lies" })
 
     assert_response :bad_request
 
-    api(:post, "/after_create/plug_installation", headers: { "X-Yetto-Signature" => "sha256=123456" })
+    api(:post, "/plug_installation/created", headers: { "X-Yetto-Signature" => "sha256=123456" })
 
     assert_response :bad_request
   end
 
   test "it handles missing body" do
     body = {}
-    api(:post, "/after_create/plug_installation", headers: headers(body), body: body)
+    api(:post, "/plug_installation/created", headers: headers(body), body: body)
 
     assert_response :bad_request
   end
@@ -122,7 +122,7 @@ class YettoControllerTest < ActionDispatch::IntegrationTest
         id: "inbx_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}",
       },
     }
-    api(:post, "/after_create/plug_installation", headers: headers_with_one_body, body: body_two)
+    api(:post, "/plug_installation/created", headers: headers_with_one_body, body: body_two)
 
     assert_response :bad_request
   end

data/templates/test/fixtures/files/plug_installation_settings/invalid.json

@@ -0,0 +1,3 @@
+{
+    "token_type": "bearer"
+}

data/templates/test/fixtures/files/plug_installation_settings/valid.json

@@ -0,0 +1,3 @@
+{
+    "github_installations": "gh_installation_id"
+}

data/templates/test/fixtures/plug_installation_settings/invalid.json

@@ -0,0 +1,3 @@
+{
+    "token_type": "bearer"
+}

data/templates/test/fixtures/plug_installation_settings/valid.json

@@ -0,0 +1,3 @@
+{
+    "github_installations": "gh_installation_id"
+}

data/templates/test/support/api.rb

@@ -5,11 +5,11 @@ module API
   module TestHelpers
     include Rack::Test::Methods
 
-    def plug(method, path, headers: {}, version: nil, body: {})
+    def plug(method, path, headers: {}, version: nil, body: {}, parse: true)
       version ||= PlugApp::CURRENT_VERSION
       prepended_path = prepend_plug_path(version, path)
 
-      http_call(method, prepended_path, headers: headers, version: version, body: body)
+      http_call(method, prepended_path, headers: headers, version: version, body: body, parse: parse)
     end
 
     def api(method, path, headers: {}, version: nil, body: {})
@@ -19,7 +19,7 @@ module API
       http_call(method, prepended_path, headers: headers, version: version, body: body)
     end
 
-    def http_call(method, path, headers: {}, version: nil, body: {})
+    def http_call(method, path, headers: {}, version: nil, body: {}, parse: true)
       # explicitly assert headers cannot be nil
       if headers.nil?
         send(method, path, body.to_json)
@@ -29,7 +29,7 @@ module API
         send(method, path, body.to_json, headers)
       end
 
-      JSON.parse(last_response.body) if last_response.body.present?
+      JSON.parse(last_response.body) if last_response.body.present? && parse
     end
 
     def assert_response(expected_status, expected_body = nil)
@@ -42,6 +42,8 @@ module API
         PlugApp::HTTP::OK_I
       when :created
         PlugApp::HTTP::CREATED_I
+      when :redirect
+        PlugApp::HTTP::FOUND_I
       when :no_content
         PlugApp::HTTP::NO_CONTENT_I
       when :bad_request

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

@@ -8,28 +8,30 @@ module Webmocks
     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")
+      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/plug/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")
+      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/plug/installations/#{plug_installation_id}/access_tokens")
         .to_return(
           body: response.to_json,
         )
     end
 
-    def assert_requested_get_plug_installation(plug_installation_id)
+    def assert_requested_get_inbox_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)
+    def stub_get_inbox_plug_installation(organization_id, inbox_id, plug_installation_id, response = {}, valid: true, status: 200, expires_at: 8.hours.from_now)
       stub_post_access_token(plug_installation_id)
 
-      response ||= {
+      github_installations = JSON.parse(file_fixture_path("plug_installation_settings", valid ? "valid.json" : "invalid.json").read).deep_symbolize_keys
+
+      response = {
         installed_on_inbox: {
           id: inbox_id,
           organization: {
@@ -40,10 +42,13 @@ module Webmocks
         plug: {
           id: "plg_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}",
         },
-        settings: {
-          from_email: "new@from.company",
+        settings: github_installations,
+        credentials: {
+          access_token: Faker::Alphanumeric.alphanumeric(number: 26).upcase,
+          refresh_access_token: "refresher",
+          expires_at: expires_at.iso8601,
         },
-      }
+      }.merge(response)
 
       stub_request(:get, "#{::YettoService::YETTO_API_VERSION_TLD}/installations/#{plug_installation_id}")
         .to_return(
@@ -73,16 +78,34 @@ module Webmocks
         )
     end
 
-    def assert_requested_create_message(inbox_id)
+    def assert_requested_create_message(plug_installation_id, message_id)
       assert_requested_post_access_token(plug_installation_id)
 
-      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/messages")
+      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/messages/#{message_id}/replies")
     end
 
-    def stub_create_message(inbox_id, payload)
+    def stub_create_message(plug_installation_id, message_id, payload)
       stub_post_access_token(plug_installation_id)
 
-      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/messages")
+      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/messages/#{message_id}/replies")
+      #   .with(
+      #     body: payload,
+      #   )
+      #   .to_return(
+      #     status: 200,
+      #     headers: { content_type: "application/json; charset=utf-8" },
+      #     body: {}.to_json,
+      #   )
+    end
+
+    def assert_requested_update_message_metadata(plug_installation_id, message_id)
+      assert_requested_post_access_token(plug_installation_id)
+      assert_requested(:patch, "#{::YettoService::YETTO_API_VERSION_TLD}/messages/#{message_id}")
+    end
+
+    def stub_update_message_metadata(plug_installation_id, message_id, payload)
+      stub_post_access_token(plug_installation_id)
+      stub_request(:patch, "#{::YettoService::YETTO_API_VERSION_TLD}/messages/#{message_id}")
         .with(
           body: payload,
         )
@@ -98,13 +121,9 @@ module Webmocks
       assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/inboxes/#{inbox_id}/switches")
     end
 
-    def stub_create_inbox_switch(inbox_id, plug_installation_id, params)
+    def stub_create_inbox_switch(inbox_id, plug_installation_id, payload)
       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,

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

@@ -1,4 +1,3 @@
-# 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.
 #
@@ -7,32 +6,35 @@ app = "plug-app-production"
 primary_region = "iad"
 
 [env]
-  RAILS_ENV = "production"
-  LD_PRELOAD_PATH = "/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
+RAILS_ENV = "production"
+LD_PRELOAD_PATH = "/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
 
 [processes]
-  web = "./bin/rails server"
-  worker = "bundle exec sidekiq"
+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
+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"
+[checks.alive]
+type = "tcp"
+interval = "15s"
+timeout = "2s"
+grace_period = "5s"
 
 [[statics]]
-  guest_path = "/plug-app/public"
-  url_prefix = "/"
+guest_path = "/plug-app/public"
+url_prefix = "/"
+
+[deploy]
+strategy = "bluegreen"

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

@@ -2,32 +2,35 @@ 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"
+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"
+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
+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"
+[checks.alive]
+type = "tcp"
+interval = "15s"
+timeout = "2s"
+grace_period = "5s"
 
 [[statics]]
-  guest_path = "/plug-app/public"
-  url_prefix = "/"
+guest_path = "/plug-app/public"
+url_prefix = "/"
+
+[deploy]
+strategy = "immediate"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hephaestus
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,6 +171,7 @@ files:
 - templates/app/lib/plug_app/middleware/not_found.rb
 - templates/app/lib/plug_app/middleware/openapi_validation.rb
 - templates/app/lib/plug_app/middleware/tracing_attributes.rb
+- templates/app/lib/plug_app/switches/message_created.jsonc
 - templates/app/lib/query_parameter.rb
 - templates/app/serializers/error_serializer.rb
 - templates/app/services/http_service.rb
@@ -178,6 +179,7 @@ files:
 - templates/app/views/settings/new.json.jbuilder
 - templates/bin/docker-entrypoint
 - templates/compose.yml
+- templates/config/initializers/000-oj.rb
 - templates/config/initializers/cors.rb
 - templates/config/initializers/environment.rb
 - templates/config/initializers/filter_parameter_logging.rb
@@ -197,8 +199,8 @@ files:
 - templates/lib/plug_app/schemas/api/2023-03-06/components/schemas/yetto.json
 - templates/lib/plug_app/schemas/api/2023-03-06/openapi.json
 - templates/lib/plug_app/schemas/api/2023-03-06/paths/plug.json
-- templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/after_create_message.json
-- templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/after_create_plug_installation.json
+- templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/message_created.json
+- templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/plug_installation_created.json
 - templates/lib/tasks/test_tasks.rake
 - templates/script/ci
 - templates/script/edit-credentials
@@ -214,6 +216,10 @@ files:
 - templates/test/controllers/settings_controller_test.rb
 - templates/test/controllers/yetto_controller_test.rb
 - templates/test/fixtures/files/fake_pem_file/fake.pem
+- templates/test/fixtures/files/plug_installation_settings/invalid.json
+- templates/test/fixtures/files/plug_installation_settings/valid.json
+- templates/test/fixtures/plug_installation_settings/invalid.json
+- templates/test/fixtures/plug_installation_settings/valid.json
 - templates/test/integration/.keep
 - templates/test/jobs/update_yetto_job_test.rb
 - templates/test/mailers/.keep
@@ -245,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.4.7
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
 summary: Generate a Rails app that can be used to create plugs for Yetto.