hephaestus 0.8.11 → 0.8.12

data/templates/app/controllers/yetto_controller.rb

@@ -3,21 +3,20 @@
 
 class YettoController < ApplicationController
   include BodyParameter::YettoParameters
-  include PathParameter
-  include PathParameter::YettoParameters
-  include Authable
-
-  include Headers::Yetto
+  include Hephaestus::ValidatesFromYetto
 
   before_action :from_yetto?
 
   def event
-    case pparam_yetto_event
-    when Headers::Yetto::EVENT_AFTER_CREATE
-      case pparam_yetto_record_type
-      when Headers::Yetto::RECORD_TYPE_PLUG_INSTALLATION
+    event = params[:event]
+    record_type = params[:record_type]
+
+    case event
+    when Hephaestus::Headers::EVENT_AFTER_CREATE
+      case record_type
+      when Hephaestus::Headers::RECORD_TYPE_PLUG_INSTALLATION
         no_content
-      when Headers::Yetto::RECORD_TYPE_MESSAGE
+      when Hephaestus::Headers::RECORD_TYPE_MESSAGE
 
         no_content
       else

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

@@ -12,7 +12,7 @@ module BodyParameter
 
     sig { returns(String) }
     def bparam_inbox_id
-      plug_installation_params[:yetto][:inbox][:id]
+      plug_installation_params[:yetto][:message][:conversation][:inbox][:id]
     end
 
     sig { returns(String) }
@@ -32,34 +32,12 @@ module BodyParameter
 
     sig { returns(T::Hash[Symbol, String]) }
     def plug_installation_params
-      return {} if params.blank?
+      return {} if request.parameters.blank?
 
-      yetto_params = params.fetch(:yetto, {})
-      plug_installation = yetto_params.fetch(:plug_installation, {})
-
-      plug_installation_id = plug_installation.fetch(:id, "")
-      settings = plug_installation.fetch(:settings, {}).to_unsafe_hash
-
-      organization_id = yetto_params.fetch(:organization, {}).fetch(:id, "")
-      plug_id = yetto_params.fetch(:plug, {}).fetch(:id, "")
-      inbox_id = yetto_params.fetch(:inbox, {}).fetch(:id, "")
+      yetto_params = request.parameters.fetch(:yetto, {})
 
       {
-        yetto: {
-          plug_installation: {
-            id: plug_installation_id,
-            settings: settings,
-          },
-          organization: {
-            id: organization_id,
-          },
-          plug: {
-            id: plug_id,
-          },
-          inbox: {
-            id: inbox_id,
-          },
-        },
+        yetto: yetto_params,
       }
     end
 
@@ -95,9 +73,10 @@ module BodyParameter
 
     sig { returns(T::Hash[Symbol, String]) }
     def message_params
-      return {} if params.blank?
+      return {} if request.parameters.blank?
+
+      yetto_params = request.parameters.fetch(:yetto, {})
 
-      yetto_params = params.fetch(:yetto, {})
       message = yetto_params.fetch(:message, {})
       message_id = message.fetch(:id, "")
       text_content = message.fetch(:text_content, "")
@@ -108,7 +87,7 @@ module BodyParameter
       created_by_plug = message.fetch(:created_by_plug, {})
       author = created_by_membership.fetch(:user) || created_by_plug
       name = author.fetch(:name, "")
-      metadata = message.fetch(:metadata, {}).to_unsafe_hash
+      metadata = message.fetch(:metadata, {})
 
       {
         yetto: {

data/templates/app/lib/{constants/app.rb → constants.rb}

@@ -2,7 +2,5 @@
 # frozen_string_literal: true
 
 module Constants
-  module PlugApp
-    PLUG_APP_API_VERSION = "2023-03-06"
-  end
+  # TODO: put all app constants here
 end

data/templates/app/services/{http_service.rb → app_service.rb.tt}

@@ -1,17 +1,17 @@
-# typed: strict
+# typed: false
 # frozen_string_literal: true
 
-class HTTPService
+require "httpsensible"
+
+class <%= capital_plug_name %>Service
   extend T::Sig
 
   class << self
     extend T::Sig
 
-    CACHE_VERSION = "1"
-
-    sig { returns(T.untyped) }
+    sig { returns(Httpsensible::Client) }
     def http_client
-      Httpsensible::Client.new(user_agent: "PlugApp/#{PlugApp::Application::GIT_SHA}")
+      Httpsensible::Client.new(user_agent: "Plug<%= capital_plug_name %>/#{Hephaestus::Engine::GIT_SHA}")
     end
 
     sig { params(url: String, params: T::Hash[Symbol, T.untyped]).returns(T.untyped) }

data/templates/app/views/settings/new.json.jbuilder.tt

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+json.version("2023-03-06")
+json.settings do
+  json.step do
+    case @step
+    when 1
+      json.heading(t(:new_step_one_heading))
+      json.text(t(:new_step_one_text))
+    when 2
+      json.heading(t(:new_step_two_heading))
+      json.text(t(:new_step_two_text))
+      json.state(<%= upcase_plug_name %>_NONCE)
+      json.button_text(t(:new_step_two_oauth_button))
+      json.button_oauth_link("")
+    end
+  end
+end

data/templates/bin/bundle

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($PROGRAM_NAME) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/o
+
+      bundler_version = Regexp.last_match(1)
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile.present?
+
+    File.expand_path("../Gemfile", __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/o
+
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem("bundler", bundler_requirement)
+    end
+    return if gem_error.nil?
+
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+
+    warn("Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`")
+    exit(42)
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/templates/bin/docker-entrypoint

@@ -1,14 +1,24 @@
 #!/bin/bash -e
 
-# Add any container initialization steps here
-git config --global --add safe.directory /plug-app
-
-# allocate swap space
-fallocate -l 2GB /swapfile
-chmod 0600 /swapfile
-mkswap /swapfile
-echo 10 > /proc/sys/vm/swappiness
-swapon /swapfile
-echo 1 > /proc/sys/vm/overcommit_memory
+# Set SOLID_QUEUE_CONFIG environment variable
+SOLID_QUEUE_CONFIG="$(bundle show hephaestus | tr -d '\n')/config/queue.yml"
+export SOLID_QUEUE_CONFIG
+
+if [ "$(id -u)" -eq 0 ] && [ ! -f /swapfile ]; then
+    # allocate swap space
+    fallocate -l 2GB /swapfile
+    chmod 0600 /swapfile
+    mkswap /swapfile
+    echo 10 > /proc/sys/vm/swappiness
+    swapon /swapfile
+    echo 1 > /proc/sys/vm/overcommit_memory
+    # rerun this script as nobody
+    exec su nobody -s "$SHELL" -c "$0 $@"
+fi
+
+if [ "${1}" == "/app/bin/rails" ] && [ "${2}" == "server" ] && [ "$FLY_REGION" == "$PRIMARY_REGION" ]; then
+    # run the db migrations
+    /app/bin/rails db:migrate
+fi
 
 exec "${@}"

data/templates/bin/foreman

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'foreman' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("foreman", "foreman")

data/templates/bin/jobs

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../config/environment"
+require "solid_queue/cli"
+
+SolidQueue::Cli.start(ARGV)

data/templates/bin/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/templates/bin/rake

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/templates/bin/setup

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fileutils"
+
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args, exception: true)
+end
+
+FileUtils.chdir(APP_ROOT) do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system("bundle check") || system!("bundle install")
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  if ARGV.exclude?("--skip-server")
+    puts "\n== Starting development server =="
+    $stdout.flush # flush the output before exec(2) so that it displays
+    exec "bin/dev"
+  end
+end

data/templates/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/templates/config/application.rb.tt

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "boot"
+
+# Pick the frameworks you want:
+# require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Plug<%= capital_plug_name %>
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults(Rails::VERSION::STRING.to_f)
+
+    config.paths["config/database"] << Hephaestus::Engine.root.join("config/database.yml")
+
+    Hephaestus::Engine.load_environment
+
+    initializer :engines_blank_point do
+      config.yetto_api_version = "2023-03-06"
+      config.plug_api_version = "2023-03-06"
+    end
+  end
+end

data/templates/config/boot.rb

@@ -0,0 +1,7 @@
+# typed: false
+# frozen_string_literal: true
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.
+require "bootsnap/setup" # Speed up boot time by caching expensive operations.

data/templates/config/environment.rb

@@ -0,0 +1,8 @@
+# typed: false
+# frozen_string_literal: true
+
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/templates/config/environments/blank.rb

@@ -0,0 +1,7 @@
+# typed: false
+# frozen_string_literal: true
+
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+end

data/templates/config/initializers/environment.rb

@@ -1,40 +1,6 @@
 # typed: false
 # frozen_string_literal: true
 
-YETTO_URL = if Rails.env.production?
-  "web.yetto.app"
-elsif Rails.env.staging?
-  "web.yetto.dev"
-elsif Rails.env.development?
-  "localhost:3000"
-elsif Rails.env.test?
-  "web.yetto.test"
-end
+# TODO: put global environment variables here, like:
 
-YETTO_API_TLD = ENV.fetch("YETTO_API_TLD", "#{YETTO_URL}/api")
-YETTO_API_VERSION = ENV.fetch("YETTO_API_VERSION", "2023-03-06")
-
-SLACK_LOG_URL = Rails.application.credentials.fetch(:SLACK_LOG_URL, ENV.fetch("SLACK_LOG_URL", "https://slack.com/the_log_room"))
-
-PROTOCOL = "https"
-PLUG_APP_URL = if Rails.env.production?
-  "app.plugs.yetto.app"
-elsif Rails.env.staging?
-  "app.plugs.yetto.dev"
-elsif Rails.env.development?
-  "plug-app.ngrok.io"
-elsif Rails.env.test?
-  "app.plugs.yetto.test"
-end
-
-YETTO_PLUG_PEM = Rails.application.credentials.fetch(:YETTO_PLUG_PEM, ENV.fetch("YETTO_PLUG_PEM", Rails.root.join("test/fixtures/files/fake_pem_file/fake.pem").read))
-SIGNING_SECRET = Rails.application.credentials.fetch(:SIGNING_SECRET, ENV.fetch("SIGNING_SECRET", "super-secret"))
-YETTO_PLUG_ID = Rails.application.credentials.fetch(:YETTO_PLUG_ID, ENV.fetch("YETTO_PLUG_ID", "super-secret"))
-
-def productionish?
-  Rails.env.production? || Rails.env.staging?
-end
-
-def print_user_api_errors?
-  (Rails.env.development? || Rails.env.staging?) || ENV.fetch("DEBUG", false)
-end
+# APP_CLIENT_ID = fetch_vault_secret(label: "APP_CLIENT_ID", default: "super-secret")

data/templates/config/locales/en.yml

@@ -1,32 +1,6 @@
-# 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.
-#
-# To use the locales, use `I18n.t`:
-#
-#     I18n.t "hello"
-#
-# In views, this is aliased to just `t`:
-#
-#     <%= t("hello") %>
-#
-# To use a different locale, set it with `I18n.locale`:
-#
-#     I18n.locale = :es
-#
-# This would use the information in config/locales/es.yml.
-#
-# The following keys must be escaped otherwise they will not be retrieved by
-# the default I18n backend:
-#
-# true, false, on, off, yes, no
-#
-# Instead, surround them with single quotes.
-#
-# en:
-#   "true": "foo"
-#
-# To learn more, please read the Rails Internationalization guide
-# available at https://guides.rubyonrails.org/i18n.html.
-
 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/puma.rb

@@ -0,0 +1,5 @@
+# typed: false
+# frozen_string_literal: true
+
+# Load Hephaestus' config
+load Hephaestus::Engine.root.join("config", "puma.rb").to_s

data/templates/config/routes.rb.tt

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  # Reveal health status on /up that returns 200 if the linear boots with no exceptions, otherwise 500.
+  # Can be used by load balancers and uptime monitors to verify that the linear is live.
+  get "up" => "rails/health#show", as: :rails_health_check
+
+  # Defines the root path route ("/")
+  root "root#index"
+
+  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"
+
+  post "/api/#{Rails.application.config.plug_api_version}/:record_type/:event", to: "yetto#event"
+
+  # inbound message
+  post "/<%= plug_name %>/#{Rails.application.config.plug_api_version}/webhook", to: "<%= plug_name %>#webhook"
+  # for return from oauth approval
+  get "/<%= plug_name %>/#{Rails.application.config.plug_api_version}/callback", to: "<%= plug_name %>#callback"
+  # shows after the oauth dance successfully completes
+  get "/<%= plug_name %>/#{Rails.application.config.plug_api_version}/post-install", to: "<%= plug_name %>#show_post_install"
+end
+
+Hephaestus::Engine.insert_routes

data/templates/config.ru

@@ -0,0 +1,9 @@
+# typed: false
+# frozen_string_literal: true
+
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server