hephaestus 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 371b5a8acd1794fe2317f9f6e6c94de073e3790198d3f9f5871b149df137602e
-  data.tar.gz: ba0f8d0dfe79c043782610058fcebbe74f8c05d2c3edc472200841b769aeaf6a
+  metadata.gz: 91109351951b2ac1514f251751c9311dd55028f4fdcfa8e0140fc2c4efa014c9
+  data.tar.gz: 452d4065cdfb605092c41c5677e87b85fe4070c6b21d2c28d8cd4649cadbfbb4
 SHA512:
-  metadata.gz: a3b51205a5048ca0c67d5121fa477bb3b5053125968c0c31dd04386f5b224016e3a02dd08f5fcd74390b87f0dccbb253304e13f6c8da0f79584b137aa988231d
-  data.tar.gz: 1d59384fc58c249d0b964a1dbe0d26a3c29109febaebd2ba12f9cea745c34d889fe674a992bfb42611c6a27b9b5fef6226b827399d65c7a75e128367684c2bce
+  metadata.gz: 31f32e5f396ae5b519bde7f6c30b7b796ae26f0db150e6ed1717eb2aaf153079f1755b0d8da36312bb3e5c151f2c7534fbfcf81c8d9efcf11e6f7769b2a5f2cd
+  data.tar.gz: d1b3456db78f30e7d62c20731cd1fcb3925bc39e1e8653fff9a2bfa693b8b38db0a6c48fffc1df86d8417a50098a4f195570f63387f412ba22b4b88855d29507

data/.ruby-version

@@ -1 +1 @@
-3.1.1
+3.2.1

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [v0.1.1](https://github.com/yettoapp/hephaestus/tree/v0.1.1) (2023-03-15)
+
+[Full Changelog](https://github.com/yettoapp/hephaestus/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/yettoapp/hephaestus/tree/v0.1.0) (2023-03-15)
+
+[Full Changelog](https://github.com/yettoapp/hephaestus/compare/v0.0.2...v0.1.0)
+
+**Merged pull requests:**
+
+- Various updates [\#2](https://github.com/yettoapp/hephaestus/pull/2) ([gjtorikian](https://github.com/gjtorikian))
+
+## [v0.0.2](https://github.com/yettoapp/hephaestus/tree/v0.0.2) (2023-03-01)
+
+[Full Changelog](https://github.com/yettoapp/hephaestus/compare/v0.0.1...v0.0.2)
+
 ## [v0.0.1](https://github.com/yettoapp/hephaestus/tree/v0.0.1) (2023-02-28)
 
 [Full Changelog](https://github.com/yettoapp/hephaestus/compare/b33ebb8ab3188b8689b10d4649d3f29ea7ca1f2a...v0.0.1)

data/README.md

@@ -1,17 +1,19 @@
 # Hephaestus
 
-A plug template for Yetto.
+A plug template for Yetto. Use this to quickly spin up new plugs with a set of defaults.
 
 ## Usage
 
 ```
-rails new plug-app --api -m hephaestus/template.rb
+gem install hephaestus
+
+hephaestus plug-app
 ```
 
-If you're working on updating this locally, you'll also probably want:
+If you're working on updating this locally, you may also probably want:
 
 ```
-rm -rf plug-app && DEBUG=1 rails new plug-app --api -m hephaestus/template.rb
+rm -rf plug-app && DEBUG=1 hephaestus/bin/hephaestus plug-app
 ```
 
 ## Acknowledgements

data/bin/hephaestus

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
-require 'pathname'
+# frozen_string_literal: true
 
-source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+require "pathname"
+
+source_path = (Pathname.new(__FILE__).dirname + "../lib").expand_path
 $LOAD_PATH << source_path
 
 activate_rails_version = ->(rails_version) do
@@ -10,7 +12,7 @@ activate_rails_version = ->(rails_version) do
   $LOAD_PATH.unshift(rails_path)
 end
 
-if str = ARGV.first
+if (str = ARGV.first)
   str = str.b[/\A_(.*)_\z/, 1]
 
   if str && Gem::Version.correct?(str)
@@ -20,7 +22,7 @@ if str = ARGV.first
     begin
       activate_rails_version.call(rails_version)
     rescue Gem::GemNotFoundException
-      abort "Hephaestus error: Unable to find Rails version #{rails_version}"
+      abort("Hephaestus error: Unable to find Rails version #{rails_version}")
     end
   else
     require "hephaestus/version"
@@ -38,13 +40,24 @@ if ARGV.empty?
   puts
   puts "See --help for more info"
   exit 0
-elsif ["-v", "--version"].include? ARGV[0]
+elsif ["-v", "--version"].include?(ARGV[0])
   puts Hephaestus::VERSION
   exit 0
 end
 
+path = ARGV.first
+if File.exist?(path)
+  puts "The directory #{path} already exists."
+  exit 1
+end
+
+unless path.start_with?("plug-")
+  puts "The directory name must start with 'plug-'"
+  exit 1
+end
+
 templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
-Hephaestus::AppGenerator.source_root templates_root
+Hephaestus::AppGenerator.source_root(templates_root)
 Hephaestus::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
 
 ARGV.push("--minimal")

data/lib/hephaestus/app_builder.rb

@@ -6,6 +6,7 @@ require "forwardable"
 module Hephaestus
   class AppBuilder < ::Rails::AppBuilder
     include Hephaestus::Actions
+
     extend Forwardable
 
     def readme
@@ -138,7 +139,8 @@ module Hephaestus
     end
 
     def replace_generic_variables
-      replace_in_files(destination_root, "${APP}", app_name.titlecase)
+      replace_in_files(destination_root, "${APP}", short_appname.capitalize)
+      replace_in_files(destination_root, "${app}", short_appname.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, "PLUG_APP", app_name.underscore.upcase)
@@ -147,6 +149,10 @@ module Hephaestus
 
     private
 
+    def short_appname
+      app_name.split("_").last
+    end
+
     def root_path
       @root_path ||= Pathname(__dir__).join("..", "..").expand_path
     end

data/lib/hephaestus/generators/base.rb

@@ -37,6 +37,10 @@ module Hephaestus
         Rails.app_class.module_parent_name.demodulize.underscore.dasherize
       end
 
+      def short_appname
+        app_name.sub(/plug-/i, "")
+      end
+
       def empty_directory_with_keep_file(destination)
         empty_directory(destination, {})
         keep_file(destination)

data/lib/hephaestus/generators/config_generator.rb

@@ -35,10 +35,10 @@ module Hephaestus
 
         Rails.root.glob("app/lib/#{app_name.underscore}/middleware/*.{rb}").each { |file| require_relative file }
 
-        config.middleware.insert(0, PlugEmail::Middleware::TracingAttributes)
-        config.middleware.insert(0, PlugEmail::Middleware::MalformedRequest)
+        config.middleware.insert(0, PlugApp::Middleware::TracingAttributes)
+        config.middleware.insert(0, PlugApp::Middleware::MalformedRequest)
 
-        config.middleware.use(PlugEmail::Middleware::OpenapiValidation)
+        config.middleware.use(PlugApp::Middleware::OpenapiValidation)
 
         GIT_SHA = %x(git rev-parse HEAD).chomp
       CONFIG

data/lib/hephaestus/generators/core_generator.rb

@@ -23,9 +23,8 @@ module Hephaestus
     end
 
     def libs
-      bare_app_name = app_name.split("-").last
       copy_file("app/lib/body_parameter/yetto_parameters.rb", "app/lib/body_parameter/yetto_parameters.rb")
-      copy_file("app/lib/constants/app.rb", "app/lib/constants/#{bare_app_name}.rb")
+      copy_file("app/lib/constants/app.rb", "app/lib/constants/#{app_name}.rb")
       copy_file("app/lib/headers/yetto.rb", "app/lib/headers/yetto.rb")
       copy_file("app/lib/path_parameter/yetto_parameters.rb", "app/lib/path_parameter/yetto_parameters.rb")
       directory("app/lib/plug_app", "app/lib/#{app_name.underscore}")

data/lib/hephaestus/generators/lib_generator.rb

@@ -12,5 +12,10 @@ module Hephaestus
     def lib_tasks
       directory("lib/tasks", "lib/tasks")
     end
+
+    def plug_schema
+      copy_file("lib/plug_app/schemas/api/2023-03-06/paths/plug.json", "lib/#{app_name.underscore}/schemas/api/2023-03-06/paths/#{short_appname.underscore}.json")
+      remove_file("lib/#{app_name.underscore}/schemas/api/2023-03-06/paths/plug.json") # cleanup
+    end
   end
 end

data/lib/hephaestus/generators/sorbet_generator.rb

@@ -9,6 +9,7 @@ module Hephaestus
       copy_file("sorbet/custom.rbi", "sorbet/custom.rbi")
       Bundler.with_unbundled_env do
         run("bundle exec tapioca init")
+        run("bundle exec tapioca require")
         run("script/typecheck --update")
       end
     end

data/lib/hephaestus/version.rb

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

data/templates/.env.test

@@ -0,0 +1,4 @@
+PLUG_APP_URL="plug-app.ngrok.io"
+YETTO_API_VERSION_TLD="yetto.ngrok.io/api"
+
+SLACK_LOG_URL=http://slack.com/the_log_room

data/templates/.github/actions/license/action.yml

@@ -0,0 +1,11 @@
+name: "Run License Check"
+description: "Validates that all the licenses are up to date."
+
+runs:
+  using: "composite"
+  steps:
+    - uses: ./.github/actions/setup
+
+    - name: Run license check
+      shell: bash
+      run: script/licenses --update

data/templates/.github/actions/setup/action.yml

@@ -0,0 +1,10 @@
+name: "Set up Plug"
+description: "Do whatever is necessary to setup the plug."
+
+runs:
+  using: "composite"
+  steps:
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        rubygems: latest

data/templates/.github/actions/sisyphus/action.yml

@@ -0,0 +1,11 @@
+name: "Configure git"
+description: "Sets up Git creds for Sisyphus"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Run git config
+      shell: bash
+      run: |
+        git config --local user.email "sisyphus@yetto.app"
+        git config --local user.name "Sisyphus"

data/templates/.github/actions/sorbet/action.yml

@@ -0,0 +1,19 @@
+name: "Run Sorbet Check"
+description: "Validates that all the Sorbet types are up to date."
+
+inputs:
+  gh_token:
+    description: 'A GitHub PAT'
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - uses: ./.github/actions/setup
+
+    - name: Update RBI files
+      shell: bash
+      id: update
+      env:
+        GITHUB_TOKEN: ${{ inputs.gh_token }}
+      run: script/typecheck --update

data/templates/.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "09:00"
+      timezone: "Etc/UTC"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "09:00"
+      timezone: "Etc/UTC"
+    open-pull-requests-limit: 10
+    allow:
+      - dependency-name: "*"
+        dependency-type: "production"
+      - dependency-name: "sorbet*"
+        dependency-type: "all"

data/templates/.github/workflows/automerge.yml

@@ -0,0 +1,97 @@
+name: PR auto-{approve,merge}
+
+on:
+  pull_request_target:
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    name: Dependabot
+    runs-on: ubuntu-latest
+
+    env:
+      RAILS_ENV: test
+      REDIS_URL: redis://localhost:6379/0
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      SLACK_LOG_URL: http://slack.com/the_log_room
+
+    # Service containers to run; note that this is duplicated
+    # in test.yml due to a limitation in GitHub Actions
+    # (services can only be defined per job)
+    services:
+      redis:
+        # Docker Hub image name
+        image: redis:6.2-alpine
+        ports: ["6379:6379"]
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout
+          5s --health-retries 5
+
+    if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' }}
+    steps:
+      - name: Fetch Dependabot metadata
+        id: dependabot-metadata
+        uses: dependabot/fetch-metadata@v1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - uses: ./.github/actions/sisyphus
+
+      - uses: ./.github/actions/license
+
+      - name: Commit licenses
+        run: |
+          git add .
+          git commit -m "[auto-license]: Update license information" || true
+          git push
+
+      - uses: ./.github/actions/sorbet
+
+      - name: Commit Sorbet
+        run: |
+          git add .
+          git commit -m "[auto-rbi]: Update RBI files" || true
+          git push
+
+      - name: Approve Dependabot PR
+        if: ${{steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major'}}
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Merge Dependabot PR
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  sisyphusbot:
+    name: Automated PRs
+    runs-on: ubuntu-latest
+
+    if: ${{ github.event.pull_request.user.login == 'sisyphusbot' }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Approve Automated PR
+        if: startsWith(github.event.pull_request.title, '[auto')
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Merge Automated PR
+        if: startsWith(github.event.pull_request.title, '[auto')
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,43 @@
+name: Update licenses
+
+on:
+  push:
+    paths:
+      - "**/Gemfile.lock"
+    branches:
+      - production
+      - staging
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  license-cache:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+
+      - uses: ./.github/actions/license
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.GH_SISYPHUS_YETTO_REPO_TOKEN }}
+          commit-message: "[auto-license] Update license information"
+          title: "[auto-license] Update license information"
+          body: |
+            - Update license information
+
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          branch: update-licenses
+          committer: Sisyphus <sisyphus@yetto.app>
+          author: Sisyphus <sisyphus@yetto.app>
+          delete-branch: true
+          labels: 'chore, github action'

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

@@ -0,0 +1,52 @@
+name: Linting
+
+on:
+  pull_request:
+
+env:
+  RAILS_ENV: test
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      # reads from .ruby-version
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          rubygems: latest
+
+      - name: Rubocop
+        run: bundle exec rake rubocop
+
+  ruby-types:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      # reads from .ruby-version
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          rubygems: latest
+
+      - name: Sorbet
+        id: sorbet_tc
+        run: bundle exec srb tc
+
+      - name: Provide error message
+        if: failure() && steps.sorbet_tc.outcome == 'failure'
+        run: |
+          echo "Run 'bundle exec srb tc -a' to auto-correct Sorbet checks."
+
+      - name: Verifying Tapioca
+        id: tapioca_verify
+        run: script/typecheck --verify
+
+      - name: Provide error message
+        if: failure() && steps.tapioca_verify.outcome == 'failure'
+        run: |
+          echo "Run 'script/typecheck --update' to update Tapioca's RBI files."
+          echo "Run 'script/typecheck --verify' to verify that Tapioca's RBI files are up-to-date."

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

@@ -0,0 +1,38 @@
+name: Security
+
+on:
+  pull_request:
+
+env:
+  RAILS_ENV: test
+  BUNDLE_WITH: "ci"
+
+jobs:
+  bundle-audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          rubygems: latest
+
+      # Patch-level verification for bundler.
+      - name: Run bundle-audit
+        run: |
+          script/security_checks/bundle-audit
+
+  brakeman: # A static analysis security vulnerability scanner for Ruby on Rails applications
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          rubygems: latest
+
+      - name: brakeman report
+        run: |
+          script/security_checks/brakeman
+          cat security-results.json

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

@@ -0,0 +1,49 @@
+name: Update Sorbet files
+
+on:
+  pull_request:
+    paths:
+      - '**.rb'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  trigger_tapioca_pr:
+    runs-on: ubuntu-latest
+
+    env:
+      RAILS_ENV: test
+      REDIS_URL: redis://localhost:6379/0
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      SLACK_LOG_URL: http://slack.com/the_log_room
+
+    # Service containers to run; note that this is duplicated
+    # in test.yml due to a limitation in GitHub Actions
+    # (services can only be defined per job)
+    services:
+      redis:
+        # Docker Hub image name
+        image: redis:6.2-alpine
+        ports: ["6379:6379"]
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout
+          5s --health-retries 5
+
+    if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - uses: ./.github/actions/sisyphus
+
+      - uses: ./.github/actions/sorbet
+
+      - name: Commit Sorbet
+        run: |
+          git add .
+          git commit -m "[auto-rbi]: Update RBI files" || true
+          git push

data/templates/.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Test
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    env:
+      RAILS_ENV: test
+      REDIS_URL: redis://localhost:6379/0
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      SLACK_LOG_URL: http://slack.com/the_log_room
+
+   # Service containers to run; note that this is duplicated
+   # in sorbet.yml due to a limitation in GitHub Actions
+   # (services can only be defined per job)
+    services:
+      redis:
+        # Docker Hub image name
+        image: redis:6.2-alpine
+        ports: ["6379:6379"]
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout
+          5s --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{github.ref}} # checkout branch not SHA
+          fetch-depth: 0
+
+      - uses: ./.github/actions/setup
+
+      - name: Run tests
+        run: |
+          script/ci
+
+  test-licenses:
+    needs: test
+    runs-on: ubuntu-latest
+
+    if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: ./.github/actions/setup
+
+      - name: Verifying licenses
+        run: script/licenses --verify
+

data/templates/.licensed.yml

@@ -0,0 +1,33 @@
+cache_path: vendor/.licenses
+
+allowed:
+  - apache-2.0
+  - bsd-2-clause
+  - bsd-3-clause
+  - isc
+  - mit
+  - cc0-1.0
+  - unlicense
+
+ignored:
+  bundler:
+    - bundler-audit # GPL-3.0; but also, only used in CI/test
+    - ruby2_keywords # BSD-2-Clause; ignored because of custom LICENSE text
+    - sidekiq # LGPL-3.0; ignored because of custom LICENSE text
+
+reviewed:
+  bundler:
+    - activerecord # MIT
+    - brakeman # BRAKEMAN PUBLIC USE LICENSE
+    - concurrent-ruby # MIT
+    - date # BSD-2-Clause
+    - dry-transformer # MIT
+    - json # BSD-2-Clause
+    - net-imap # BSD-2-Clause
+    - net-pop # BSD-2-Clause
+    - net-protocol # BSD-2-Clause
+    - net-smtp # BSD-2-Clause
+    - racc # BSD-2-Clause
+    - timeout # BSD-2-Clause
+    - websocket-driver # Apache-2.0
+    - websocket-extensions # Apache-2.0

data/templates/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rubocop-standard:
+    - config/default.yml
+    - config/minitest.yml
+    - config/rails.yml

data/templates/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "shopify.ruby-extensions-pack",
+    "bradlc.vscode-tailwindcss",
+    "johnpapa.vscode-peacock",
+    "manuelpuyol.erb-linter",
+    "esbenp.prettier-vscode"
+  ]
+}

data/templates/.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "rdbg",
+      "name": "Attach rdbg",
+      "request": "attach"
+    },
+  ]
+}

data/templates/.vscode/settings.json

@@ -0,0 +1,52 @@
+{
+  "files.associations": {
+    "*.css": "tailwindcss",
+    "*.rbi": "ruby",
+    "*.rbupdated": "ruby",
+    "*.rbedited": "ruby"
+  },
+  "tailwindCSS.includeLanguages": {
+    "plaintext": "html"
+  },
+  "tailwindCSS.emmetCompletions": true,
+  "rubyLsp.enabledFeatures": {
+    "documentHighlights": true,
+    "documentLink": true,
+    "documentSymbols": true,
+    "foldingRanges": true,
+    "selectionRanges": true,
+    "semanticHighlighting": true,
+    "formatting": true,
+    "diagnostics": true,
+    "codeActions": true,
+    "onTypeFormatting": true
+  },
+  "[javascript]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+  },
+  "peacock.color": "#26FF9A",
+  "workbench.colorCustomizations": {
+    "activityBar.activeBackground": "#59ffb2",
+    "activityBar.background": "#59ffb2",
+    "activityBar.foreground": "#15202b",
+    "activityBar.inactiveForeground": "#15202b99",
+    "activityBarBadge.background": "#c480ff",
+    "activityBarBadge.foreground": "#15202b",
+    "commandCenter.border": "#15202b99",
+    "sash.hoverBorder": "#59ffb2",
+    "statusBar.background": "#26ff9a",
+    "statusBar.foreground": "#15202b",
+    "statusBarItem.hoverBackground": "#00f281",
+    "statusBarItem.remoteBackground": "#26ff9a",
+    "statusBarItem.remoteForeground": "#15202b",
+    "titleBar.activeBackground": "#26ff9a",
+    "titleBar.activeForeground": "#15202b",
+    "titleBar.inactiveBackground": "#26ff9a99",
+    "titleBar.inactiveForeground": "#15202b99"
+  }
+}

data/templates/app/lib/plug_app/middleware/tracing_attributes.rb

@@ -13,6 +13,7 @@ module PlugApp
       attr_reader :app
 
       HTTP_REQUEST_BODY = "http.request.body"
+      PLUG_APP_PATH_PREFIX = "/${app}/"
 
       sig { params(app: T.untyped).void }
       def initialize(app)
@@ -35,7 +36,11 @@ module PlugApp
 
       def filtered_params(request)
         params = request.params
-        @filterer.filter(params).to_json
+        if request.path.starts_with?(PLUG_APP_PATH_PREFIX)
+          {}
+        else
+          @filterer.filter(params)
+        end.to_json
       end
     end
   end

data/templates/config/initializers/environment.rb

@@ -1,7 +1,7 @@
 # typed: false
 # frozen_string_literal: true
 
-PLUG_APP_URL = ENV.fetch("PLUG_APP_URL", "yetto.email")
+PLUG_APP_URL = ENV.fetch("PLUG_APP_URL", "")
 
 YETTO_URL = if Rails.env.production?
   "yetto.app"

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

@@ -1 +1,167 @@
-{}
+{
+    "Create${APP}Message": {
+        "type": "object",
+        "required": [
+            "plug_installation",
+            "message",
+            "inbox"
+        ],
+        "properties": {
+            "plug_installation": {
+                "type": "object",
+                "required": [
+                    "id",
+                    "settings"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "pattern": "^(?:pli)_[A-Z0-9]{26}$"
+                    },
+                    "settings": {
+                        "type": "object",
+                        "required": [],
+                        "properties": {}
+                    }
+                }
+            },
+            "inbox": {
+                "type": "object",
+                "required": [
+                    "id",
+                    "organization"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "pattern": "^(?:ibx)_[A-Z0-9]{26}$"
+                    },
+                    "organization": {
+                        "type": "object",
+                        "required": [
+                            "id",
+                            "status"
+                        ],
+                        "properties": {
+                            "id": {
+                                "type": "string",
+                                "pattern": "^(?:org)_[A-Z0-9]{26}$"
+                            },
+                            "status": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            },
+            "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
+    },
+    "Create${APP}": {
+        "type": "object",
+        "required": [
+            "plug_installation",
+            "organization",
+            "plug",
+            "inbox"
+        ],
+        "properties": {
+            "plug_installation": {
+                "type": "object",
+                "required": [
+                    "id",
+                    "settings"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "pattern": "^(?:pli)_[A-Z0-9]{26}$"
+                    },
+                    "settings": {
+                        "type": "object",
+                        "required": [],
+                        "properties": {}
+                    }
+                }
+            },
+            "organization": {
+                "type": "object",
+                "required": [
+                    "id"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "pattern": "^(?:org)_[A-Z0-9]{26}$"
+                    }
+                }
+            },
+            "plug": {
+                "type": "object",
+                "required": [
+                    "id"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "pattern": "^(?:plg)_[A-Z0-9]{26}$"
+                    }
+                }
+            },
+            "inbox": {
+                "type": "object",
+                "required": [
+                    "id"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "pattern": "^(?:ibx)_[A-Z0-9]{26}$"
+                    }
+                }
+            }
+        },
+        "additionalProperties": false
+    }
+}

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

@@ -22,6 +22,9 @@
         },
         "/api/2023-03-06/after_create/message": {
             "$ref": "paths/yetto/after_create_message.json"
+        },
+        "/${app}/2023-03-06/{plugInstallationId}": {
+            "$ref": "paths/${app}.json"
         }
     }
 }

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

@@ -23,11 +23,10 @@
                     "message": {
                         "text_content": "Hello _World_",
                         "is_public": true,
-                        "metadata": {
-                            "author": {
-                                "name": "John Doe"
-                            }
-                        }
+                        "author": {
+                            "name": "John Doe"
+                        },
+                        "metadata": {}
                     },
                     "creator": {
                         "id": "usr_1234567890"

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

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

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

@@ -5,6 +5,16 @@
         ],
         "description": "After a plug installation is created, this executes",
         "operationId": "Post a thing",
+        "requestBody": {
+            "required": true,
+            "content": {
+                "application/json": {
+                    "schema": {
+                        "$ref": "../../components/schemas/yetto.json#/Create${APP}"
+                    }
+                }
+            }
+        },
         "responses": {
             "204": {
                 "description": "No Content",

data/templates/script/typecheck

@@ -25,6 +25,8 @@ while [ "$1" != "" ]; do
         bin/tapioca todo
         ;;
     -v | --verify)
+        echo "Verify Sorbet types..."
+        bin/bundle exec srb tc
         echo "Verify gem RBIs are up-to-date ..."
         bin/tapioca gem --verify
         echo "Verify duplicates in shims ..."

data/templates/test/controllers/settings_controller_test.rb

@@ -22,6 +22,6 @@ class SettingsControllerTest < ActionDispatch::IntegrationTest
     settings = settings_json["settings"]
 
     assert_equal "2023-03-06", settings_json["version"]
-    assert_equal 3, settings.length
+    assert_equal 2, settings.length
   end
 end

data/templates/test/controllers/yetto_controller_test.rb

@@ -14,7 +14,6 @@ class YettoControllerTest < ActionDispatch::IntegrationTest
       plug_installation: {
         id: @plug_installation_id,
         settings: {
-          from_name: "it me",
           from_email: "new@from.company",
           reply_to_email: "new@from.company",
         },

data/templates/test/support/api.rb

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

data/templates/test/support/rails.rb

@@ -26,12 +26,13 @@ module ActiveSupport
 
     def assert_expected_args(expected_args)
       lambda do |job_args_arr|
-        expected_args.each do |expected_arg|
-          key = expected_arg.first
-          value = expected_arg.second
-          expected_value = job_args_arr.first[key]
+        job_args_arr.first.each do |actual_args|
+          actual_key = actual_args.first
+          actual_value = actual_args.second
 
-          assert_equal(expected_value, value)
+          expected_value = expected_args[actual_key]
+
+          assert_equal(expected_value, actual_value)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hephaestus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,23 @@ files:
 - lib/hephaestus/generators/rubocop_generator.rb
 - lib/hephaestus/generators/sorbet_generator.rb
 - lib/hephaestus/version.rb
+- templates/.env.test
+- templates/.github/actions/license/action.yml
+- templates/.github/actions/setup/action.yml
+- templates/.github/actions/sisyphus/action.yml
+- templates/.github/actions/sorbet/action.yml
+- templates/.github/dependabot.yml
+- templates/.github/workflows/automerge.yml
+- templates/.github/workflows/licenses.yml
+- templates/.github/workflows/lint.yml
+- templates/.github/workflows/security.yml
+- templates/.github/workflows/sorbet.yml
+- templates/.github/workflows/test.yml
+- templates/.licensed.yml
+- templates/.rubocop.yml
+- templates/.vscode/extensions.json
+- templates/.vscode/launch.json
+- templates/.vscode/settings.json
 - templates/Gemfile.erb
 - templates/Procfile.debug
 - templates/Procfile.dev
@@ -175,7 +192,10 @@ files:
 - templates/test/controllers/root_controller_test.rb
 - templates/test/controllers/settings_controller_test.rb
 - templates/test/controllers/yetto_controller_test.rb
+- templates/test/fixtures/files/.keep
+- templates/test/integration/.keep
 - templates/test/jobs/update_yetto_job_test.rb
+- templates/test/mailers/.keep
 - templates/test/support/api.rb
 - templates/test/support/rails.rb
 - templates/test/support/webmocks.rb
@@ -195,14 +215,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.1
+      version: 3.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: 3.4.7
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.8
 signing_key: 
 specification_version: 4
 summary: Generate a Rails app that can be used to create plugs for Yetto.