hephaestus 0.8.12.2 → 0.8.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946513d5bfb959191872e0404f6eb0c95c4a6d4ded918425926ba0ca24f09dce
-  data.tar.gz: 0524cf36eb6e3717eb1c1b7fab0de51438cbce348b0882a77e50422d5c25747a
+  metadata.gz: c6f1564007f86900d81b992b6df2f93428859cb5a8c6c22a15a5cef29eb7d198
+  data.tar.gz: bd340377613e44ea895a03871835863cc059cd740c9800c64e56e19b481ecc4a
 SHA512:
-  metadata.gz: 15f88a25cfea5f83d2fb5ac629d163ab2d8b1205bc3b5a99cf38282b8628cac6da86a31f68c99e4e9eb0511e6a5f270ce562aada76e76db9eebf31a2f25073aa
-  data.tar.gz: 4271659d3c4302dcfa5cb991b8b9c01f20a8d2e8d13b3b554cfea8a79417117ee86ee2228188984bc1a78b7f42e5a81325386ebade0714c32dd14a7d8a5168c0
+  metadata.gz: 4b1399f84f3bb750c0b8de78a729d3e2b47c43bfb8abf5d6f611928162dd2a9c61b7044a39c4348626e2ff819f0eb9b4ff0e67f6dcb78a3c318616a3b42e452c
+  data.tar.gz: 855af63634afe1b2e6a6cb1af37358270f7508c2e8720426c512f0abb7c8b6e6b7eeae661b8237149906c3f86e806e08aeb53b7896f9eaff50c11b5ce4720d20

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [v0.8.14] - 19-12-2024
+## What's Changed
+* Add scripting logic to Hephaestus by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/102
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.13...v0.8.14
+# [v0.8.13] - 17-12-2024
+## What's Changed
+* Move content to clio by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/99
+* Remove outro, point to Clio by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/100
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.12.2...v0.8.13
 # [v0.8.12.2] - 17-12-2024
 ## What's Changed
 * Fixups by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/97

data/README.md

@@ -33,180 +33,6 @@ This way you can wipe the dir and quickly iterate on new changes.
 
 If you're having trouble connecting to the Internet, you can set `HEPHAESTUS_NO_EXTERNAL=1`.
 
-## Building upon the base
-
-Most of the files which Hephaestus creates for you shouldn't need much modification. The information below is part-informative, part-guidelines on how to extend the generated code for your specific plug.
-
-### Controllers
-
-#### `ApplicationController`
-
-Your application controller inherits from `Hephaestus::ApplicationController`, and handles the basics of request/response cycles. Two common callbacks to add here are:
-
-- `before_action :set_request_span_context`, which lets you add data to the `OpenTelemetry` trace before a request occurs
-- `after_action :set_response_span_context`, similarly, lets you add to the trace after the response is sent
-
-For examples on how to integrate with these, check out `plug-email`.
-
-#### `SettingsController`
-
-Typically, your settings inherit directly from Hephaestus. We'll discuss more about how this works in `routes.rb`. Either way, you'll define two files:
-
-- `app/views/settings/new.json.jbuilder`
-- `app/views/settings/edit.json.jbuilder`
-
-Define the settings UI in these files. See `plug-email` for an example of a settings page with no customizations.
-
-However, for multi-step plugs, it's common to expect customized steps. If you'd like to extend the settings controller, create a file with one of two methods:
-
-- `new`
-- `edit`
-
-You only need to define these methods if you're actually overriding the action—often, this only means `edit`. If you do define methods in this controller, remember to add `before_action :ensure_json_request` at the top. For examples on settings pages which have _some_ customization, see `plug-github` and `plug-linear`. For an example of a totally custom settings page, see `plug-zendesk`.
-
-#### `AppController`
-
-The logic to communicate with your platform sits in `AppController`. Every plug is unique, so the requirements for your platform varies!
-
-At a minimum, though, you should place all the logic which authenticates requests in the `Authable` concern. See `plug-github` and `plug-linear` for practical examples.
-
-#### `YettoController`
-
-Place the logic which receives webhooks from Yetto in the `YettoController`. This controller must `include Hephaestus::ValidatesFromYetto`, and must define `before_action :from_yetto?`. Beyond that, you can respond to events as they come in, and fire jobs to perform the actions your platform needs to integrate with Yetto.
-
-### Jobs
-
-Jobs are at the heart of plugs, because they perform time-sensitive work asynchronously. Since Hephaestus already creates an `ApplicationJob` which inherits from `Hephaestus::ApplicationJob`, there isn't much else you need to do, other than define your jobs.
-
-Whenever you need to integrate with Yetto, just pass the appropriate arguments to `Hephaestus::UpdateYettoJob`.
-
-The bulk of your plug logic should exist within these jobs. Keep the controllers as place to authenticate incoming requests and respond with appropriate status codes.
-
-### Constants
-
-Place any and all constants in the file called `lib/constants.rb`.
-
-Note that Hepheastus provides several convenience methods and constants for you. These are:
-
-- `plug_shortname`: the downcased version of the plug (e.g., `Slack => slack`, `GitHub => github`)
-- `plug_name`: The proper name of the plug (e.g., `Slack`, `GitHub`)
-- `plug_url`: The plug's URL (e.g., `email{.plugs.yetto.app,.plugs.yetto.dev,.ngrok.io}`)
-
-### Application Configuration
-
-The typical Rails' environment configs (`config/environments/{development.rb,test.rb,production.rb}`) are managed by Hephaestus. However, any plug can define their own environment files as well. These are added after Hephaestus' default configuration.
-
-The `test.rb` file in `plug-email` provides an example of this.
-
-#### Upgrading Rails
-
-Upgrading Rails always introduces breaking changes, even between minor releases. To ensure that a plug still works after a Rails upgrade, first, add
-
-```ruby
-rails "x"
-```
-
-to your plug's Gemfile (where `"x"` is the new Rails version.) Note that this means plugs can run Rails versions independently of what Hephaestus provides (although variance is not recommended, it can help during the upgrade process).
-
-Next, call `rails app:update:configs`. You can pretty much ignore every changed file, except the one that starts with `new_framework_defaults_`. Use these values to slowly reintroduce the new configuration changes, as described in [the Rails documentation](https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#configure-framework-defaults).
-
-### Integrating the Plug with the Engine
-
-There are certain times where the child application needs to "inject" data into Hephaestus. These are typically customizations that are unique to the plug. Place these customizations in `config/application.rb`, inside of an `initializer :engines_blank_point do` block.
-
-At a minimum, you'll need to define your plug's API version, and the version of the Yetto API it's communicating with:
-
-```ruby
-initializer :engines_blank_point do
-  config.yetto_api_version = "2023-03-06"
-  config.plug_api_version = "2023-03-06"
-end
-```
-
-You can also define several other customizations:
-
-- `config.tracing_body_filters`: use this to scrub out any sensitive data coming in from your platform, to prevent it from leaking in our metrics aggregator. See the override in `plug-email` for an example. The default is to simply log everything (after running it through [Rails' `ParameterFilter`](https://api.rubyonrails.org/v7.1/classes/ActiveSupport/ParameterFilter.html), of course), which may not be a good idea!
-- `config.enhance_update_yetto_job`: use this to include any plug-specific logic which needs to occur as part of issuing calls to the Yetto API
-
-For an example of both these customizations, see `plug-email`.
-
-There's also middleware you can use to protect any endpoint with an OpenAPI schema. To do so, add:
-
-```ruby
-require "hephaestus/middleware/openapi_validation"
-config.middleware.use(Hephaestus::Middleware::OpenapiValidation, match_path: "/app/2023-03-06/path/", limit_methods_to: ["POST"], spec: Rails.root.join("lib/schemas/path/2023-03-06/openapi.json"))
-```
-
-In this example, any `POST` to `match_path` is protected by the OpenAPI `spec` provided.
-
-### Services
-
-Place any HTTP communication necessary to communicate with your platform in this directory. All other code should which communicates to your plug should rely on methods defined in this file.
-
-See any of the plugs for an example of how to define this interaction, particularly with `httpsensible`.
-
-### Routes
-
-If you do not have any custom actions to perform in the settings controller, define your settings pages as:
-
-```ruby
-# you must always include this line when referring to `hephaestus_settings`
-HephaestusSettingsController = Hephaestus::SettingsController
-
-get "/api/#{Rails.application.config.plug_api_version}/settings", to: "hephaestus_settings#new"
-get "/api/#{Rails.application.config.plug_api_version}/settings/:organization_id/:inbox_id/:plug_installation_id/edit", to: "hephaestus_settings#edit"
-```
-
-Otherwise, be sure to refer to `hephaestus_settings` only for any default settings related actions:
-
-```ruby
-# you must always include this line when referring to `hephaestus_settings`
-HephaestusSettingsController = Hephaestus::SettingsController
-
-get "/api/#{Rails.application.config.plug_api_version}/settings", to: "hephaestus_settings#new"
-get "/api/#{Rails.application.config.plug_api_version}/settings/:organization_id/:inbox_id/:plug_installation_id/edit", to: "settings#edit"
-```
-
-Otherwise, you can add any other routes your plug needs to `config/routes.rb`.
-
-### Launching the server
-
-First, you'll note that you have a `script/ngrok` file, which launches an ngrok server at `https://${hostname}-plug-app.ngrok.io`, which maps locally to `http://localhost:6661`. Setting up ngrok can be essential when testing the platform locally for the first time. (Keep in mind that you still need to run `script/server` to actually start the local server—this is just to help facilitate communication with the platform.)
-
-### Setting up routes
-
-You should probably open up config/routes.rb to make modifications to any incoming (from the platform) or outgoing (for Yetto) HTTP flows.
-
-### Defining settings
-
-Next, you'll want to open `app/views/settings/new.json.jbuilder` and modify the JSON structure of the Settings form page users will see when they first install the plug. Note that this adheres to a strict schema.
-
-### Accepting events
-
-After a user submits a plug installation on the Yetto side, it'll send a POST payload to `/api/:version/:event/:record_type`--for example, `/api/2023-03-06/after/plug_installation`. Open up the `yetto_controller.rb` file and decide what happens next!
-
-### Creating services
-
-Any code which communicates with the third party should be placed in the `app/services` directory. A generic HTTP service is included.
-
-### Writing tests
-
-In addition to writing tests for your plug interacting with its platform, many of your tests will also need to cover your plug's interaction with Yetto.
-
-Writing these tests well comes with time; it's not an easy thing to cover in a pithy paragraph. Regardless, here's a bit of hopefully helpful advice.
-
-Be sure to tests requests before _and_ after they occur. Typically, this takes the form of a `stub_request` and `assert_requested`. Similarly, be sure to:
-
-- `include Hephaestus::Webmocks::SlackWebmock` whenever a plug action is expected to error out to Slack
-- `include Hephaestus::Webmocks::YettoWebmock` whenever a plug needs to issue a request to Yetto
-
-Use `include Hephaestus::API::TestHelpers` whenever you need to write a test which either
-
-- match `"/#{plug_shortname}` routes (by issuing calls to `plug`). These are routes which your external server is calling into.
-- match `/api` routes (by issuing calls to `api`). These are routes which Yetto is calling into.
-
-For examples on when and how to use these methods, see `plug-github`.
-
 ## Acknowledgements
 
 The template generation for this project was heavily based on [thoughtbot/suspenders](https://github.com/thoughtbot/suspenders).

data/bin/hephaestus

@@ -97,4 +97,12 @@ config.keys.each do |key|
   config.delete(key) if delete_keys
 end
 
-Hephaestus::AppGenerator.start
+
+case ARGV[0]
+when "run"
+  ENV["HEPHAESTUS_CAPITAL_PLUG_NAME"] = `grep 'module Plug\S*' config/application.rb | sed -E 's/module Plug//'`.strip
+  script_dir = File.join(ENGINE_ROOT, "script")
+  puts `#{File.join(script_dir, ARGV[1..-1].join(' '))}`
+else
+  Hephaestus::AppGenerator.start
+end

data/lib/hephaestus/app_name.rb

@@ -10,22 +10,22 @@ module Hephaestus
       "plug-#{Rails.application.class.module_parent.name.underscore[5..-1]}"
     end
 
-    # like, `slack`
+    # like, `slack`, github, or `html_proofer`
     def plug_name
       app_name.split("-", 2).last
     end
 
-    # like, `Slack`, or `html_proofer => HtmlProofer`
+    # like, `Slack`, `GitHub`, or `html_proofer
     def capital_plug_name
       plug_name.camelcase
     end
 
-    # like, `SLACK`
+    # like, `SLACK` `GITHUB`, or `HTML_PROOFER`
     def upcase_plug_name
       plug_name.upcase
     end
 
-    # like, `slack`, or `HTMLProofer => html_proofer``
+    # like, `slack`, `github`, or `html_proofer`
     def underscore_plug_name
       plug_name.underscore
     end

data/lib/hephaestus/generators/app_generator.rb

@@ -142,7 +142,7 @@ module Hephaestus
         directory(source, "test", force: true)
 
         # This must be here, rather than a generator, because generators are run in a Rails environment,
-        # and the OpenAPI middleware, which is loaded when the app boots, requires the schema files to be present.
+        # and the OpenAPI middleware, which is loaded when the app boots, requires the lib/schemas files to be present.
         directory("lib/schemas/api/2023-03-06", "lib/schemas/api/2023-03-06")
 
         # we do this to specify the template source, otherwise the generator wants to use Rails own `bin` dir
@@ -151,7 +151,7 @@ module Hephaestus
         chmod_dir("bin")
 
         # we do this to specify the template source, otherwise the generator wants to use Rails' own dir
-        ["controllers", "jobs", "services", "views"].each do |dir|
+        ["controllers", "jobs", "lib", "services", "views"].each do |dir|
           source = File.join(Hephaestus::Engine.root, "templates", "app", dir)
           directory(source, "app/#{dir}", force: true)
         end
@@ -182,7 +182,9 @@ module Hephaestus
       File.rename(File.join(destination_root, "lib", "schemas", "api", "2023-03-06", "paths", "app.json"), File.join(destination_root, "lib", "schemas", "api", "2023-03-06", "paths", "#{plug_name}.json"))
 
       Dir.chdir(shell.base.result_dir) do
-        unless ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") == "1"
+        if ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") == "1"
+          say(set_color("Not installing gems...", :yellow))
+        else
           say(set_color("Installing gems...", :cyan))
           capture_stdout do
             run("bundle install", abort_on_failure: false)
@@ -232,52 +234,33 @@ module Hephaestus
     def first_commit
       say(set_color("Creating first commit...", :cyan))
 
+      result = nil
       Dir.chdir(shell.base.result_dir) do
-        capture_stdout do
-          run("git init")
-          run("git remote add origin https://github.com/yettoapp/#{app_name}.git")
-          run("git branch -m production")
+        # capture_stdout do
+        run("git init")
+        run("git branch -m production")
 
-          run("git add .")
-          run("git commit -m 'Initial commit'", capture: true)
-        end
+        run("git add .")
+        run("git commit -m 'Initial commit'", capture: true)
+
+        result = run("gh repo create yettoapp/#{app_name} --private --source . --push")
+        # end
+      end
+
+      unless result
+        say(set_color("Could not create repository on GitHub! Do you have the `gh` cli installed? ", :red))
+        sleep(3)
       end
     end
 
     def outro
       say(<<~OUTPUT)
 
-        #{set_color("Congratulations!", :green)} You just made a Yetto plug.
-
-        You'll need to `cd #{ARGV.first}` and run the following commands--I can't do it for you!
-
-        * `bin/rails credentials:edit --environment development`
-
-        #{set_color("WAIT!", :red)} After running this command, note that Rails credited a file called development.key in the config/credentials directory.
-        Store this in 1Password, then change the .env file to use this value. Generate keys for staging/production, too:
-
-        * `bin/rails credentials:edit --environment staging`
-          `bin/rails credentials:edit --environment production`
-
-        Store this in 1Password too; you don't need the .env file for staging/production.
-
-        For `YETTO_SIGNING_SECRET` and `YETTO_PLUG_ID`, you'll need to generate those values yourself.
-
-        Then, try running `bin/rails c` to ensure that everything was set up correctly.
-        Running `rake test` is also a good idea.
-
-        #{set_color("Also, after pushing to GitHub:", :yellow)}
-
-        * Set `settings/branches` to protect `production`
-          * ✅ Require status checks to pass before merging
-          * 🖊️ Status checks that are required: `ruby / test_without_services`, `docker / test-build`, `ruby / brakeman`, `ruby / bundle-audit`.
+        #{set_color("Congratulations! You just made a Yetto plug.", :green)}
 
-            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.
+        You'll need to `cd #{shell.base.result_dir}` and run some more commands--I can't do it for you!
 
-        * In `/settings`:
-          * ✅ Allow auto-merge
-          * ✅ Automatically delete head branches
+        Check out the appropriate documentation on Clio for more information: engineering/plugs/building.md
       OUTPUT
     end
 

data/lib/hephaestus/version.rb

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

data/{templates/script → script}/edit-credentials

@@ -27,11 +27,11 @@ do
 done
 
 if [[ $development == true ]]; then
-    RAILS_MASTER_KEY=$(op read "op://Plug-Email/Development Secrets/Common/RAILS_MASTER_KEY") bin/rails credentials:edit -e development
+    RAILS_MASTER_KEY=$(op read "op://Plug-$HEPHAESTUS_CAPITAL_PLUG_NAME/Development Secrets/Common/RAILS_MASTER_KEY") bin/rails credentials:edit -e development
 elif [[ $staging == true ]]; then
-    RAILS_MASTER_KEY=$(op read "op://Plug-Email/Staging Secrets/Common/RAILS_MASTER_KEY") bin/rails credentials:edit -e staging
+    RAILS_MASTER_KEY=$(op read "op://Plug-$HEPHAESTUS_CAPITAL_PLUG_NAME/Staging Secrets/Common/RAILS_MASTER_KEY") bin/rails credentials:edit -e staging
 elif [[ $production == true ]]; then
-    RAILS_MASTER_KEY=$(op read "op://Plug-Email/Production Secrets/Common/RAILS_MASTER_KEY") bin/rails credentials:edit -e production
+    RAILS_MASTER_KEY=$(op read "op://Plug-$HEPHAESTUS_CAPITAL_PLUG_NAME/Production Secrets/Common/RAILS_MASTER_KEY") bin/rails credentials:edit -e production
 else
     echo "Please specify a target environment with one of the following flags: --development, --staging, --production"
     exit 1

data/script/setup-vault

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+set -e
+
+
+# Get the current file location and its parent directory
+current_file_location=$(realpath "$0")
+parent_dir=$(dirname "$current_file_location")
+
+vault_name="Plug-$HEPHAESTUS_CAPITAL_PLUG_NAME"
+op vault create "$vault_name"
+
+op item create \
+    --template="$parent_dir/vault.json" \
+    --vault "$vault_name" \
+    --title "Development secrets" \
+    --tags 'development'
+
+op item create \
+    --template="$parent_dir/vault.json" \
+    --vault "$vault_name" \
+    --title "Staging secrets" \
+    --tags 'staging'
+
+op item create \
+    --template="$parent_dir/vault.json" \
+    --vault "$vault_name" \
+    --title "Production secrets" \
+    --tags 'production'

data/script/vault.json

@@ -0,0 +1,68 @@
+{
+  "title": "",
+  "vault": {
+    "name": ""
+  },
+  "category": "SECURE_NOTE",
+  "sections": [
+    {
+      "id": "Yetto",
+      "label": "Yetto"
+    },
+    {
+      "id": "Unique",
+      "label": "Unique"
+    },
+    {
+      "id": "Common",
+      "label": "Common"
+    }
+  ],
+  "fields": [
+    {
+      "id": "YETTO_SIGNING_SECRET",
+      "section": {
+        "id": "Yetto"
+      },
+      "type": "CONCEALED",
+      "label": "YETTO_SIGNING_SECRET",
+      "value": "xxx"
+    },
+    {
+      "id": "YETTO_PLUG_PEM",
+      "section": {
+        "id": "Yetto"
+      },
+      "type": "CONCEALED",
+      "label": "YETTO_PLUG_PEM",
+      "value": "xxx"
+    },
+    {
+      "id": "YETTO_PLUG_ID",
+      "section": {
+        "id": "Yetto"
+      },
+      "type": "CONCEALED",
+      "label": "YETTO_PLUG_ID",
+      "value": "xxx"
+    },
+    {
+      "id": "NONCE",
+      "section": {
+        "id": "Unique"
+      },
+      "type": "CONCEALED",
+      "label": "NONCE",
+      "value": "xxx"
+    },
+    {
+      "id": "RAILS_MASTER_KEY",
+      "section": {
+        "id": "Common"
+      },
+      "type": "CONCEALED",
+      "label": "RAILS_MASTER_KEY",
+      "value": "xxx"
+    }
+  ]
+}

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

@@ -15,7 +15,6 @@ module Authable
   sig { void }
   def <%= plug_name %>_calling_back?
     state = params.fetch(:state, "")
-    state = params.fetch(:state, "")
 
     state_obj = parse_state(state)
     nonce = state_obj.fetch(:nonce, "")

data/templates/app/jobs/application_job.rb

@@ -1,10 +1,7 @@
 # typed: false
 # frozen_string_literal: true
 
-class ApplicationJob < ActiveJob::Base
-  # Automatically retry jobs that encountered a deadlock
-  # retry_on ActiveRecord::Deadlocked
-
-  # Most jobs are safe to ignore if the underlying records are no longer available
-  # discard_on ActiveJob::DeserializationError
+class ApplicationJob < Hephaestus::ApplicationJob
+  # TODO: Add whatever configuration you need here;
+  # note that Hephaestus sets some defaults for you already.
 end

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

@@ -0,0 +1,5 @@
+# Files in the config/locales directory are used for internationalization and
+# are automatically loaded by Rails. If you want to use locales other than
+# English, add the necessary files in this directory.
+
+en:

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

@@ -0,0 +1,6 @@
+en:
+  new_step_one_heading: "Before you continue..."
+  new_step_one_text: "This plug will ask you if the Yetto app can authorize with your <%= capital_plug_name %> account. Make sure you're an admin who is able to install apps."
+  new_step_two_heading: "Authenticate with Yetto's <%= capital_plug_name %> app"
+  new_step_two_text: "This will connect our <%= capital_plug_name %> app with your Yetto org"
+  new_step_two_oauth_button: "Click to auth with <%= capital_plug_name %>"

data/templates/root/Procfile

@@ -1,2 +1,3 @@
 web: $SERVER_CMD # defined in script/server
 supervisor: bin/jobs -c "$(bundle show hephaestus)/config/queue.yml"
+ngrok: script/ngrok

data/templates/root/README.md.tt

@@ -1 +1,5 @@
 # <%= app_name.titlecase %>
+
+Start your server with `script/server`, or `script/server --debug` to enable debugging.
+
+Your plug is available at `${hostname}-plug-<%= plug_name %>.ngrok.io:6661`.

data/templates/root/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hephaestus
 version: !ruby/object:Gem::Version
-  version: 0.8.12.2
+  version: 0.8.14
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2024-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootsnap
@@ -445,6 +445,9 @@ files:
 - lib/hephaestus/version.rb
 - lib/tasks/hephaestus_tasks.rake
 - lib/tasks/rubocop.rake
+- script/edit-credentials
+- script/setup-vault
+- script/vault.json
 - templates/app/controllers/app_controller.rb.tt
 - templates/app/controllers/application_controller.rb
 - templates/app/controllers/concerns/authable.rb.tt
@@ -470,8 +473,8 @@ files:
 - templates/config/environment.rb
 - templates/config/environments/blank.rb
 - templates/config/initializers/environment.rb
-- templates/config/locales/en.yml
-- templates/config/locales/settings/en.yml
+- templates/config/locales/en.yml.tt
+- templates/config/locales/settings/en.yml.tt
 - templates/config/puma.rb
 - templates/config/routes.rb.tt
 - templates/db/queue_schema.rb
@@ -488,15 +491,6 @@ files:
 - templates/hephaestus_vscode/extensions.json
 - templates/hephaestus_vscode/launch.json
 - templates/hephaestus_vscode/settings.json
-- templates/lib/plug_app/schemas/api/2023-03-06/components/parameters/headers/yetto.json
-- templates/lib/plug_app/schemas/api/2023-03-06/components/parameters/plugInstallation.json
-- templates/lib/plug_app/schemas/api/2023-03-06/components/schemas/plug.json
-- templates/lib/plug_app/schemas/api/2023-03-06/components/schemas/responses.json
-- 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/message_created.json
-- templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/plug_installation_created.json
 - templates/lib/schemas/api/2023-03-06/components/parameters/headers/yetto.json
 - templates/lib/schemas/api/2023-03-06/components/parameters/plugInstallation.json
 - templates/lib/schemas/api/2023-03-06/components/schemas/plug.json
@@ -511,6 +505,7 @@ files:
 - templates/root/Gemfile
 - templates/root/Procfile
 - templates/root/README.md.tt
+- templates/root/Rakefile
 - templates/root/compose.yml
 - templates/root/config.ru
 - templates/root/hephaestus_dockerignore
@@ -520,16 +515,13 @@ files:
 - templates/root/hephaestus_licensed.yml
 - templates/root/hephaestus_rubocop.yml
 - templates/root/hephaestus_ruby-version
-- templates/script/ci
 - templates/script/docker-build-prod.tt
 - templates/script/docker-run.tt
-- templates/script/edit-credentials
 - templates/script/hmac_text
 - templates/script/licenses
 - templates/script/ngrok.tt
 - templates/script/server
 - templates/script/sorbet
-- templates/script/test
 - templates/sorbet/custom.rbi
 - templates/test/controllers/app_controller_test.rb.tt
 - templates/test/controllers/application_controller_test.rb

data/templates/config/locales/en.yml

@@ -1,6 +0,0 @@
-en:
-  new_step_one_heading: "Before you continue..."
-  new_step_one_text: "This plug can only be installed"
-  new_step_two_heading: "Authenticate"
-  new_step_two_text: "This will connect your previously installed app with your Yetto org"
-  new_step_two_oauth_button: "Click to auth with"

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

@@ -1,5 +0,0 @@
-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/parameters/headers/yetto.json

@@ -1,42 +0,0 @@
-{
-    "Event": {
-        "name": "X-Yetto-Event",
-        "in": "header",
-        "description": "The event from Yetto",
-        "required": true,
-        "schema": {
-            "type": "string",
-            "pattern": "^{created|updated|destroyed}$"
-        }
-    },
-    "RecordType": {
-        "name": "X-Yetto-RecordType",
-        "in": "header",
-        "description": "The record type from Yetto",
-        "required": true,
-        "schema": {
-            "type": "string",
-            "pattern": "^[a-z_]+$"
-        }
-    },
-    "DeliveryID": {
-        "name": "X-Yetto-DeliveryID",
-        "in": "header",
-        "description": "The delivery ID from Yetto",
-        "required": true,
-        "schema": {
-            "type": "string",
-            "pattern": "^[a-z0-9-]+$"
-        }
-    },
-    "Signature": {
-        "name": "X-Yetto-Signature",
-        "in": "header",
-        "description": "The signature from Yetto",
-        "required": true,
-        "schema": {
-            "type": "string",
-            "pattern": "^sha256=[a-f0-9]{64}$"
-        }
-    }
-}

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

@@ -1,12 +0,0 @@
-{
-    "plugInstallationId": {
-        "name": "plugInstallationId",
-        "in": "path",
-        "description": "The plug installation's unique ID",
-        "required": true,
-        "schema": {
-            "type": "string",
-            "pattern": "^pli_[A-Z0-9]{26}$"
-        }
-    }
-}

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

@@ -1,9 +0,0 @@
-{
-    "InboundWebhook": {
-        "type": "object",
-        "required": [
-            "From"
-        ],
-        "properties": {}
-    }
-}

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

@@ -1,64 +0,0 @@
-{
-    "202": {
-        "type": "object",
-        "required": [
-            "message"
-        ],
-        "properties": {
-            "message": {
-                "type": "string",
-                "value": "Accepted"
-            }
-        }
-    },
-    "204": {
-        "type": "object",
-        "required": [
-            "message"
-        ],
-        "properties": {
-            "message": {
-                "type": "string",
-                "value": "No Content"
-            }
-        }
-    },
-    "400": {
-        "type": "object",
-        "required": [
-            "errors"
-        ],
-        "properties": {
-            "errors": {
-                "type": "array",
-                "items": {
-                    "type": "object",
-                    "properties": {
-                        "message": {
-                            "type": "string"
-                        }
-                    }
-                }
-            }
-        }
-    },
-    "404": {
-        "type": "object",
-        "required": [
-            "errors"
-        ],
-        "properties": {
-            "errors": {
-                "type": "array",
-                "items": {
-                    "type": "object",
-                    "properties": {
-                        "message": {
-                            "type": "string"
-                        }
-                    }
-                }
-            }
-        }
-    }
-}

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

@@ -1,116 +0,0 @@
-{
-    "CreateAppMessage": {
-        "type": "object",
-        "required": [
-            "yetto"
-        ],
-        "properties": {
-            "yetto": {
-                "type": "object",
-                "required": [
-                    "plug_installation",
-                    "message"
-                ],
-                "properties": {
-                    "plug_installation": {
-                        "type": "object",
-                        "required": [
-                            "id",
-                            "settings"
-                        ],
-                        "properties": {
-                            "id": {
-                                "type": "string",
-                                "pattern": "^(?:pli)_[A-Z0-9]{26}$"
-                            },
-                            "settings": {
-                                "type": "object",
-                                "required": [],
-                                "properties": {}
-                            }
-                        }
-                    },
-                    "message": {
-                        "type": "object",
-                        "required": [
-                            "id",
-                            "conversation",
-                            "text_content",
-                            "metadata"
-                        ],
-                        "properties": {
-                            "id": {
-                                "type": "string",
-                                "pattern": "^(?:msg)_[A-Z0-9]{26}$"
-                            },
-                            "text_content": {
-                                "type": "string"
-                            },
-                            "metadata": {
-                                "type": "object"
-                            },
-                            "conversation": {
-                                "type": "object",
-                                "required": [
-                                    "id",
-                                    "title",
-                                    "metadata"
-                                ],
-                                "properties": {
-                                    "id": {
-                                        "type": "string",
-                                        "pattern": "^(?:cnv)_[A-Z0-9]{26}$"
-                                    },
-                                    "title": {
-                                        "type": "string"
-                                    },
-                                    "metadata": {
-                                        "type": "object"
-                                    }
-                                }
-                            }
-                        }
-                    }
-                },
-                "additionalProperties": false
-            }
-        },
-        "additionalProperties": false
-    },
-    "ConfigureApp": {
-        "type": "object",
-        "required": [
-            "yetto"
-        ],
-        "properties": {
-            "yetto": {
-                "type": "object",
-                "required": [
-                    "plug_installation",
-                ],
-                "properties": {
-                    "plug_installation": {
-                        "type": "object",
-                        "required": [
-                            "id",
-                            "settings"
-                        ],
-                        "properties": {
-                            "id": {
-                                "type": "string",
-                                "pattern": "^(?:pli)_[A-Z0-9]{26}$"
-                            },
-                            "settings": {
-                                "type": "object",
-                                "required": [],
-                                "properties": {}
-                            }
-                        }
-                    }
-                },
-                "additionalProperties": false
-            }
-        },
-        "additionalProperties": false
-    }
-}

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

@@ -1,30 +0,0 @@
-{
-    "openapi": "3.0.0",
-    "info": {
-        "title": "App Plug API",
-        "description": "An OpenAPI definition for the App Plug REST API.",
-        "version": "2023-03-06",
-        "termsOfService": "https://yetto.app/terms/",
-        "license": {
-            "name": "Apache 2.0",
-            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-        }
-    },
-    "servers": [
-        {
-            "url": "https://yetto.app/2023-03-06",
-            "description": "Production basepath"
-        }
-    ],
-    "paths": {
-        "/api/2023-03-06/plug_installation/created": {
-            "$ref": "paths/yetto/plug_installation_created.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/plug.json

@@ -1,90 +0,0 @@
-{
-    "post": {
-        "tags": [
-            "Inbound",
-            "App"
-        ],
-        "description": "This represents something",
-        "operationId": "Post a Yetto message",
-        "parameters": [
-            {
-                "$ref": "../components/parameters/plugInstallation.json#/plugInstallationId"
-            }
-        ],
-        "requestBody": {
-            "required": true,
-            "content": {
-                "application/json": {
-                    "schema": {
-                        "$ref": "../components/schemas/plug.json#/something"
-                    }
-                },
-                "example": {
-                    "message": {
-                        "text_content": "Hello _World_",
-                        "is_public": true,
-                        "author": {
-                            "name": "John Doe"
-                        },
-                        "metadata": {}
-                    },
-                    "creator": {
-                        "id": "usr_1234567890"
-                    }
-                }
-            }
-        },
-        "responses": {
-            "202": {
-                "description": "Accepted",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../components/schemas/responses.json#/202"
-                        }
-                    }
-                }
-            },
-            "204": {
-                "description": "No Content",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../components/schemas/responses.json#/204"
-                        }
-                    }
-                }
-            },
-            "400": {
-                "description": "Bad Request",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../components/schemas/responses.json#/400"
-                        }
-                    }
-                }
-            },
-            "403": {
-                "description": "Forbidden",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../components/schemas/responses.json#/403"
-                        }
-                    }
-                }
-            },
-            "503": {
-                "description": "Service Unavailable",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../components/schemas/responses.json#/502"
-                        }
-                    }
-                }
-            }
-        }
-    }
-}

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

@@ -1,51 +0,0 @@
-{
-    "post": {
-        "tags": [
-            "Yetto"
-        ],
-        "description": "After a message is created in Yetto, this delivers it.",
-        "operationId": "Create a new message",
-        "requestBody": {
-            "required": true,
-            "content": {
-                "application/json": {
-                    "schema": {
-                        "$ref": "../../components/schemas/yetto.json#/CreateAppMessage"
-                    }
-                }
-            }
-        },
-        "responses": {
-            "204": {
-                "description": "No Content",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../../components/schemas/responses.json#/204"
-                        }
-                    }
-                }
-            },
-            "400": {
-                "description": "Bad Request",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../../components/schemas/responses.json#/400"
-                        }
-                    }
-                }
-            },
-            "404": {
-                "description": "Not Found",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../../components/schemas/responses.json#/404"
-                        }
-                    }
-                }
-            }
-        }
-    }
-}

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

@@ -1,51 +0,0 @@
-{
-    "post": {
-        "tags": [
-            "Yetto"
-        ],
-        "description": "After a plug installation is created, this executes",
-        "operationId": "Post a plug installation",
-        "requestBody": {
-            "required": true,
-            "content": {
-                "application/json": {
-                    "schema": {
-                        "$ref": "../../components/schemas/yetto.json#/ConfigureApp"
-                    }
-                }
-            }
-        },
-        "responses": {
-            "204": {
-                "description": "No Content",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../../components/schemas/responses.json#/204"
-                        }
-                    }
-                }
-            },
-            "400": {
-                "description": "Bad Request",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../../components/schemas/responses.json#/400"
-                        }
-                    }
-                }
-            },
-            "404": {
-                "description": "Not Found",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../../components/schemas/responses.json#/404"
-                        }
-                    }
-                }
-            }
-        }
-    }
-}

data/templates/script/ci

@@ -1,7 +0,0 @@
-#!/bin/sh
-
-set -e
-
-export CI=true
-
-script/test

data/templates/script/test

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -e
-
-bin/rails test "$@"