hephaestus 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec50cd2cc85932b748a97df9741291de3651b88ab8d06584f96d2a03ad474a73
-  data.tar.gz: ade4d54823ec4a179234a259dd4ac1ae05f6e9228aa52955529043a473d35821
+  metadata.gz: f53e25251ab0f4ba3f9150cee67fbf2f2002e892431c7c66d288d17887e86274
+  data.tar.gz: a8262fe4f7001373e62a48de343016a6787360d8a73c34510476ea45bc1d6703
 SHA512:
-  metadata.gz: 9c4c51dd65cb697d9eee304fd7a6915af8301cbf4fbab804fe17c06f0b50142f72d61914d2d10403f04de6f67b916f7f9b4b93b99d83833769fdf63860fa2fef
-  data.tar.gz: 4190712ab8505f2e450911a32bd860a0e811129934f817d1f3a6bb80297e0b9bc3b3fd2555a10df39a72c95548bfe044b974a75bf321b8ee51920b2f77401786
+  metadata.gz: 6a7389980993930ae1d91f62247767607f963a10ae25bf0ad8cf4c686db6dccf34972a7fd87f851e047a0917432a88d832c9ded9fe5873ef182f08785ca55cb3
+  data.tar.gz: 5fa77ba49059630eebb5a6f9ae45e478d8cde9bb3920bdd04bf238363b2aa20af19297ce5c8aedfaa5c1d29bbd972c9c79f73c5f0d9a975d7e3bd64c257b09d1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [v0.2.1] - 11-07-2023
+null
+## [v0.2.0] - 11-07-2023
+null
 # Changelog
 
 ## [v0.1.3](https://github.com/yettoapp/hephaestus/tree/v0.1.3) (2023-03-15)

data/README.md

@@ -10,12 +10,38 @@ gem install hephaestus
 hephaestus plug-app
 ```
 
-If you're working on updating this locally, you may also probably want:
+Where `app` represents the name of the platform you'd like to interact with `jira`, `notion`, `slack`, etc.
+
+If you're working on updating/testing this gem locally, you may also want:
 
 ```
 rm -rf plug-app && DEBUG=1 hephaestus/bin/hephaestus plug-app
 ```
 
+This way you can wipe the dir and quickly iterate on new changes.
+
+## Building upon it
+
+### Launching the server
+
+First, you'll note that you have a `script/ngrok` file, which launches an ngrok server at `https://plug-app.ngrok.io`, which maps locally to `http://localhost:6661`. This 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.
+
 ## Acknowledgements
 
 This project was heavily based on [thoughtbot/suspenders](https://github.com/thoughtbot/suspenders).

data/bin/hephaestus

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "pathname"
+require 'rainbow'
 
 source_path = (Pathname.new(__FILE__).dirname + "../lib").expand_path
 $LOAD_PATH << source_path
@@ -47,12 +48,17 @@ end
 
 path = ARGV.first
 if File.exist?(path)
-  puts "The directory #{path} already exists."
+  puts Rainbow("\nError: The directory #{path} already exists.").red
   exit 1
 end
 
 unless path.start_with?("plug-")
-  puts "The directory name must start with 'plug-'"
+  puts Rainbow("\nError: The directory name must start with 'plug-'").red
+  exit 1
+end
+
+unless path.length > "plug-".length
+  puts Rainbow("\nError: The directory name must start with 'plug-'").red
   exit 1
 end
 
@@ -64,5 +70,5 @@ ARGV.push("--minimal")
 ARGV.push("--no-skip-active-job")
 ARGV.push("--skip-asset-pipeline")
 ARGV.push("--skip-active-record")
-ARGV.push("--skip-active-record")
+
 Hephaestus::AppGenerator.start

data/lib/hephaestus/app_builder.rb

@@ -17,6 +17,7 @@ module Hephaestus
       copy_file("hephaestus_gitignore", ".gitignore")
     end
 
+    # it is, apparently, extraordinarly important to keep this as an erb
     def gemfile
       template("Gemfile.erb", "Gemfile")
     end
@@ -30,8 +31,7 @@ module Hephaestus
     end
 
     def copy_setup_scripts
-      source = File.join(Hephaestus::AppGenerator.source_root, "script")
-      directory(source, "script")
+      directory(Hephaestus.source_path("script"), "script")
       Dir.glob("script/**/*").each do |file|
         next if File.directory?(file)
 
@@ -81,6 +81,19 @@ module Hephaestus
       configure_environment("test", config)
     end
 
+    def setup_ssl
+      ssl = <<~SSL
+        config.force_ssl = true
+        config.ssl_options = { hsts: { subdomains: true, preload: true, expires: 1.year } }
+      SSL
+
+      replace_in_file(
+        "config/environments/production.rb",
+        "# config.force_ssl = true",
+        ssl,
+      )
+    end
+
     def setup_staging_environment
       FileUtils.cp(File.join(destination_root, "config/environments/production.rb"), File.join(destination_root, "config/environments/staging.rb"))
     end
@@ -95,6 +108,10 @@ module Hephaestus
       end
     end
 
+    def restore_gemfile
+      replace_in_file("Gemfile", /gem "hephaestus".+/, "gem \"hephaestus\"")
+    end
+
     def ruby_version
       create_file(".ruby-version", "#{Hephaestus::RUBY_VERSION}\n")
     end
@@ -104,7 +121,7 @@ module Hephaestus
     end
 
     def create_github_repo(repo_name)
-      run("gh repo create #{repo_name}")
+      run("gh repo create #{repo_name}", exit_on_failure: false)
     end
 
     def remove_config_comment_lines
@@ -139,12 +156,16 @@ module Hephaestus
     end
 
     def replace_generic_variables
-      replace_in_files(destination_root, "${APP}", short_app_name.capitalize)
-      replace_in_files(destination_root, "${app}", short_app_name.downcase)
+      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, "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)
       replace_in_files(destination_root, "plug_app", app_name.underscore)
+
+      # this is erroneously changed
+      replace_in_file("script/server", "/usr/src/#{short_app_name.downcase}", "/usr/src/app")
     end
 
     private

data/lib/hephaestus/exit_on_failure.rb

@@ -8,10 +8,10 @@ module Hephaestus
   module ExitOnFailure
     extend ActiveSupport::Concern
 
-    # def bundle_command(*args)
-    #   run("bundle", args)
-    #   exit(false) if $CHILD_STATUS.exitstatus.nonzero?
-    # end
+    def bundle_command(*)
+      super
+      exit(false) if $CHILD_STATUS.exitstatus.nonzero?
+    end
 
     module ClassMethods
       def exit_on_failure?

data/lib/hephaestus/generators/app_generator.rb

@@ -3,6 +3,7 @@
 
 require "rails/generators"
 require "rails/generators/rails/app/app_generator"
+require "tempfile"
 
 module Hephaestus
   class AppGenerator < Rails::Generators::AppGenerator
@@ -23,62 +24,123 @@ module Hephaestus
       desc: "Show this help message and quit"
 
     def finish_template
-      say("Invoking Hephaestus customization")
       invoke(:hephaestus_customization)
       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)
-      generate("hephaestus:license")
-      generate("hephaestus:rubocop")
 
-      generate("hephaestus:sorbet")
-      invoke(:commit)
+      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)
       invoke(:customize_gemfile)
+
       invoke(:copy_github_actions)
+      invoke(:copy_vscode_settings)
+
       invoke(:setup_development_environment)
-      invoke(:setup_staging_environment)
       invoke(:setup_production_environment)
+      invoke(:setup_staging_environment)
       invoke(:setup_test_environment)
+      invoke(:setup_shared_environment_logic)
+
       invoke(:configure_app)
-      invoke(:purge_unneeded_files)
-      invoke(:copy_vscode_settings)
-      invoke(:generate_default)
       invoke(:create_github_repo)
     end
 
     def customize_gemfile
+      say(set_color("Customizing Gemfile...", :cyan))
       build(:replace_gemfile)
-      bundle_command("install")
-      bundle_command("lock --add-platform x86_64-linux")
+      capture_stdout do
+        bundle_command("install")
+        bundle_command("lock --add-platform x86_64-linux")
+      end
     end
 
     def copy_github_actions
-      source = File.join(Hephaestus::AppGenerator.source_root, ".github")
-      directory(source, ".github")
+      say(set_color("Copying GitHub Actions...", :cyan))
+
+      capture_stdout do
+        directory(Hephaestus.source_path(".github"), ".github")
+      end
+    end
+
+    def copy_vscode_settings
+      say(set_color("Copying .vscode/...", :cyan))
+
+      capture_stdout do
+        directory(Hephaestus.source_path(".vscode"), ".vscode")
+      end
     end
 
     def setup_development_environment
-      say("Setting up the development environment")
-      build(:configure_local_mail)
-      build(:raise_on_delivery_errors)
-      build(:configure_dev_hosting)
-      build(:copy_setup_scripts)
+      say(set_color("Setting up the development environment...", :cyan))
+      capture_stdout do
+        build(:raise_on_delivery_errors)
+        build(:configure_dev_hosting)
+        build(:copy_setup_scripts)
+      end
     end
 
-    def copy_vscode_settings
-      source = File.join(Hephaestus::AppGenerator.source_root, ".vscode")
-      directory(source, ".vscode")
+    def setup_production_environment
+      say(set_color("Setting up the production environment...", :cyan))
+      capture_stdout do
+        build(:setup_asset_host)
+        build(:setup_ssl)
+      end
     end
 
-    def purge_unneeded_files
+    def setup_staging_environment
+      say(set_color("Setting up the staging environment...", :cyan))
+      capture_stdout do
+        build(:setup_staging_environment)
+      end
+    end
+
+    def setup_test_environment
+      say(set_color("Setting up the test environment...", :cyan))
+      capture_stdout do
+        build(:setup_test_environment)
+      end
+    end
+
+    def setup_shared_environment_logic
+      capture_stdout do
+        build(:setup_background_worker)
+        build(:setup_slack_logger)
+      end
+    end
+
+    def configure_app
+      say(set_color("Configuring app...", :cyan))
+
       remove_dir("app/assets")
-      remove_file("app/controllers/concerns/.keep")
       remove_dir("app/helpers")
       remove_dir("app/models")
       remove_dir("app/views/layouts")
@@ -87,56 +149,67 @@ module Hephaestus
       remove_dir("test/helpers")
       remove_dir("test/channels")
       remove_dir("test/models")
-    end
 
-    def setup_staging_environment
-      build(:setup_staging_environment)
-    end
+      build(:configure_time_formats)
 
-    def setup_production_environment
-      say("Setting up the production environment")
-      build(:setup_asset_host)
-      build(:setup_background_worker)
-      build(:setup_slack_logger)
-    end
+      bundle_command("binstubs bundler")
 
-    def setup_test_environment
-      say("Setting up the test environment")
-      build(:setup_test_environment)
-    end
+      capture_stdout do
+        generate("hephaestus:core")
+        generate("hephaestus:deployment")
+        generate("hephaestus:lib")
 
-    def configure_app
-      say("Configuring app")
-      build(:configure_time_formats)
+        # keep this at the end
+        generate("hephaestus:config")
+      end
     end
 
     def create_github_repo
       if !options[:skip_git] && options[:github]
-        say("Creating Github repo")
+        say(set_color("Creating repository via `gh repo`...", :cyan))
         build(:create_github_repo, options[:github])
       end
     end
 
-    def generate_default
-      run("spring stop > /dev/null 2>&1 || true")
-
-      generate("hephaestus:core")
-      generate("hephaestus:deployment")
-      generate("hephaestus:lib")
-
-      # keep this at the end
-      generate("hephaestus:config")
-    end
-
     def commit
       run("git add .")
-      run("git commit -m 'Initial commit'")
+      run("git commit -m 'Initial commit'", capture: true)
     end
 
     def outro
-      say("\nCongratulations! You just made a plug.")
-      say("\nTry running `rails c` to ensure that everything was set up correctly.")
-      say("\nRunning `rake test` is also a good idea.")
+      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 `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: `test`, `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`
+          * ✅ Allow auto-merge
+          * ✅ Automatically delete head branches
+      OUTPUT
     end
 
     class << self
@@ -154,5 +227,24 @@ module Hephaestus
     def using_active_record?
       !options[:skip_active_record]
     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)
+
+      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?
+    end
   end
 end

data/lib/hephaestus/generators/config_generator.rb

@@ -26,9 +26,20 @@ module Hephaestus
         before: "class Application < Rails::Application",
       )
 
+      raltie_overload = <<~CONFIG
+
+        # Load dotenv only in development environment
+        Dotenv::Railtie.overload if Rails.env.development?
+      CONFIG
+      inject_into_file(
+        "config/application.rb",
+        raltie_overload,
+        after: "Bundler.require(*Rails.groups)",
+      )
+
       config = <<~CONFIG
 
-        # Only loads a smaller set of middleware suitable for API only apps.
+        # Only loads a smaller set of middleware suitable for API-only Rails.
         # Middleware like session, flash, cookies can be added back manually.
         # Skip views, helpers and assets when generating a new resource.
         config.api_only = true
@@ -77,15 +88,28 @@ module Hephaestus
         root "root#index"
 
         # events into the plug, usually from yetto
-        get "/api/2023-03-06/settings", to: "settings#index"
+        get "/api/2023-03-06/settings", to: "settings#new"
         post "/api/2023-03-06/:event/:record_type", 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
+
         # Staff pages
         get "staff", to: "staff#index"
         require "sidekiq/web"
         constraints ->(request) { StaffController.staff_request?(request) } do
           mount Sidekiq::Web => "staff/sidekiq"
         end
+
+        #############################################
+        # error pages -- these MUST be at the end! ##
+        #############################################
+
+        get "/500", to: "application#render500" if Rails.env.production? || Rails.env.staging?
+
+        match "/", to: "application#not_found", via: :all
+        match "/*unmatched_route", to: "application#not_found", via: :all
       ROUTES
 
       replace_in_file(
@@ -98,5 +122,9 @@ module Hephaestus
     def sidekiq
       copy_file("config/sidekiq.yml", "config/sidekiq.yml")
     end
+
+    def credentials
+      remove_file("config/credentials.yml.enc")
+    end
   end
 end

data/lib/hephaestus/generators/core_generator.rb

@@ -13,6 +13,7 @@ module Hephaestus
       copy_file("app/controllers/settings_controller.rb", "app/controllers/settings_controller.rb")
       copy_file("app/controllers/staff_controller.rb", "app/controllers/staff_controller.rb")
       copy_file("app/controllers/yetto_controller.rb", "app/controllers/yetto_controller.rb")
+      copy_file("app/controllers/app_controller.rb", "app/controllers/#{short_app_name}_controller.rb")
 
       copy_file("app/controllers/concerns/authable.rb", "app/controllers/concerns/authable.rb")
     end
@@ -26,6 +27,34 @@ module Hephaestus
       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/plug_#{short_app_name}.rb")
       copy_file("app/lib/headers/yetto.rb", "app/lib/headers/yetto.rb")
+
+      path_parameters_content = <<~CONTENT
+        # typed: false
+        # frozen_string_literal: true
+
+        module PathParameter
+          module AppParameters
+            extend T::Sig
+          end
+        end
+      CONTENT
+
+      create_file("app/lib/path_parameter/#{short_app_name}_parameters.rb", path_parameters_content)
+
+      body_parameters_content = <<~CONTENT
+        # typed: false
+        # frozen_string_literal: true
+
+        module BodyParameter
+          module AppParameters
+            extend T::Sig
+          end
+        end
+      CONTENT
+
+      create_file("app/lib/body_parameter/#{short_app_name}_parameters.rb", body_parameters_content)
+
+      copy_file("app/lib/path_parameter/settings_parameters.rb", "app/lib/path_parameter/settings_parameters.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}")
 
@@ -43,7 +72,7 @@ module Hephaestus
     end
 
     def views
-      copy_file("app/views/settings/index.json.jbuilder", "app/views/settings/index.json.jbuilder")
+      copy_file("app/views/settings/new.json.jbuilder", "app/views/settings/new.json.jbuilder")
     end
   end
 end

data/lib/hephaestus/generators/deployment_generator.rb

@@ -10,9 +10,15 @@ module Hephaestus
       copy_file("Procfile.debug", "Procfile.debug")
     end
 
-    def sample_env
-      copy_file(".env.test", ".env.test")
-      copy_file(".env.test", ".env")
+    def dotenv
+      copy_file(".env.sample", ".env")
+      copy_file(".env.sample", ".env.sample")
+    end
+
+    def docker
+      copy_file("compose.yml", "compose.yml")
+      copy_file("Dockerfile", "Dockerfile")
+      copy_file("bin/docker-entrypoint", "bin/docker-entrypoint")
     end
   end
 end

data/lib/hephaestus/generators/lib_generator.rb

@@ -7,6 +7,7 @@ module Hephaestus
   class LibGenerator < Generators::Base
     def lib_plug
       directory("lib/plug_app", "lib/#{app_name.underscore}")
+      remove_file("lib/constants/plug-#{short_app_name}.rb")
     end
 
     def lib_tasks

data/lib/hephaestus/generators/sorbet_generator.rb

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

data/lib/hephaestus/version.rb

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

data/lib/hephaestus.rb

@@ -19,3 +19,11 @@ end
 require "hephaestus/actions"
 require "hephaestus/actions/strip_comments_action"
 require "hephaestus/app_builder"
+
+module Hephaestus
+  class << self
+    def source_path(root)
+      File.join(Hephaestus::AppGenerator.source_root, root)
+    end
+  end
+end