hephaestus 0.8.11 → 0.8.12

data/lib/hephaestus/generators/config_generator.rb

@@ -5,121 +5,10 @@ require_relative "base"
 
 module Hephaestus
   class ConfigGenerator < Generators::Base
-    def application
-      config = <<~CONFIG
+    include Hephaestus::AppName
 
-
-        if ENV.fetch("DEBUG", false) && defined?(Rails::Server) && Rails.env.development?
-          require "debug/open_nonstop"
-        end
-
-      CONFIG
-
-      inject_into_file(
-        "config/application.rb",
-        config,
-        after: "require \"rails/test_unit/railtie\"",
-      )
-      inject_into_file(
-        "config/application.rb",
-        "\n  CURRENT_VERSION = \"2023-03-06\"\n\n",
-        before: "class Application < Rails::Application",
-      )
-
-      raltie_overload = <<~CONFIG
-
-        # Load dotenv only in development environment
-        Dotenv::Rails.overwrite = true 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 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
-
-        Rails.root.glob("app/lib/#{app_name.underscore}/middleware/*.{rb}").each { |file| require_relative file }
-
-        config.middleware.insert(0, PlugApp::Middleware::TracingAttributes)
-        config.middleware.insert(0, PlugApp::Middleware::MalformedRequest)
-
-        config.middleware.use(PlugApp::Middleware::OpenapiValidation)
-
-        GIT_SHA = %x(git rev-parse HEAD).chomp
-      CONFIG
-
-      inject_into_file(
-        "config/application.rb",
-        config,
-        before: "\n  end",
-      )
-
-      replace_in_file(
-        "config/application.rb",
-        "require \"rails\"\n",
-        "",
-      )
-
-      comment_lines("config/application.rb", "require \"active_model/railtie\"")
-      uncomment_lines("config/application.rb", "require \"active_job/railtie\"")
-    end
-
-    def boot
-      boot = "require \"bootsnap/setup\" # Speed up boot time by caching expensive operations."
-      inject_into_file(
-        "config/boot.rb",
-        boot,
-      )
-    end
-
-    def initializers
-      remove_dir("config/initializers")
-      directory("config/initializers", "config/initializers")
-    end
-
-    def configure_routes
-      routes = <<~ROUTES
-        root "root#index"
-
-        # events into the plug, usually from yetto
-        get "/api/2023-03-06/settings", to: "settings#new"
-        post "/api/2023-03-06/:record_type/:event", to: "yetto#event"
-
-        # inbound message
-        post "/$app/2023-03-06/webhook/inbound", to: "app#webhook"
-
-        # 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(
-        "config/routes.rb",
-        "# root \"articles#index\"",
-        routes,
-      )
-    end
-
-    def sidekiq
-      copy_file("config/sidekiq.yml", "config/sidekiq.yml")
+    def config_application
+      directory("config", "config", force: true, exclude_pattern: /blank.rb/)
     end
 
     def credentials

data/lib/hephaestus/generators/core_generator.rb

@@ -1,78 +1,38 @@
 # typed: false
 # frozen_string_literal: true
 
-require_relative "base"
+# require_relative "base"
 
 module Hephaestus
   class CoreGenerator < Generators::Base
-    def controllers
-      remove_file("app/controllers/application_controller.rb")
-      copy_file("app/controllers/application_controller.rb", "app/controllers/application_controller.rb")
-
-      copy_file("app/controllers/root_controller.rb", "app/controllers/root_controller.rb")
-      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
+    include Hephaestus::AppName
 
-    def jobs
-      copy_file("app/jobs/application_job.rb", "app/jobs/application_job.rb", force: true)
-      copy_file("app/jobs/update_yetto_job.rb", "app/jobs/update_yetto_job.rb")
+    def gemfile
+      # we do this to specify the template source, otherwise the generator wants to use Rails own `controllers` dir
+      source = File.join(Hephaestus::Engine.root, "templates", "Gemfile")
+      copy_file(source, "Gemfile", force: true)
     end
 
-    def libs
-      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}")
-
-      copy_file("app/lib/body_parameter.rb", "app/lib/body_parameter.rb")
-      copy_file("app/lib/headers.rb", "app/lib/headers.rb")
-      copy_file("app/lib/path_parameter.rb", "app/lib/path_parameter.rb")
+    def controllers
+      # we do this to specify the template source, otherwise the generator wants to use Rails own `controllers` dir
+      source = File.join(Hephaestus::Engine.root, "templates", "app", "controllers")
+      directory(source, "app/controllers", force: true)
     end
 
-    def serializers
-      copy_file("app/serializers/error_serializer.rb", "app/serializers/error_serializer.rb")
+    def jobs
+      # we do this to specify the template source, otherwise the generator wants to use Rails own `jobs` dir
+      source = File.join(Hephaestus::Engine.root, "templates", "app", "jobs")
+      directory(source, "app/jobs", force: true)
     end
 
     def services
-      copy_file("app/services/yetto_service.rb", "app/services/yetto_service.rb")
+      source = File.join(Hephaestus::Engine.root, "templates", "app", "services")
+      directory(source, "app/services", force: true)
     end
 
     def views
-      copy_file("app/views/settings/new.json.jbuilder", "app/views/settings/new.json.jbuilder")
+      source = File.join(Hephaestus::Engine.root, "templates", "app", "views")
+      directory(source, "app/views", force: true)
     end
   end
 end

data/lib/hephaestus/generators/db_generator.rb

@@ -0,0 +1,12 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class DbGenerator < Generators::Base
+    def database
+      directory("db", "db")
+    end
+  end
+end

data/lib/hephaestus/generators/deployment_generator.rb

@@ -6,8 +6,7 @@ require_relative "base"
 module Hephaestus
   class DeploymentGenerator < Generators::Base
     def procfile
-      copy_file("Procfile.dev", "Procfile.dev")
-      copy_file("Procfile.debug", "Procfile.debug")
+      copy_file("Procfile", "Procfile")
     end
 
     def dotenv
@@ -16,15 +15,11 @@ module Hephaestus
     end
 
     def docker
-      copy_file("compose.yml", "compose.yml")
       copy_file("Dockerfile", "Dockerfile")
-      copy_file("bin/docker-entrypoint", "bin/docker-entrypoint")
     end
 
     def fly
       directory("vendor/fly", "vendor/fly")
-      copy_file("Dockerfile", "Dockerfile")
-      copy_file("bin/docker-entrypoint", "bin/docker-entrypoint")
     end
   end
 end

data/lib/hephaestus/generators/lib_generator.rb

@@ -5,18 +5,8 @@ require_relative "base"
 
 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
       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_app_name.underscore}.json")
-      remove_file("lib/#{app_name.underscore}/schemas/api/2023-03-06/paths/plug.json") # cleanup
-    end
   end
 end

data/lib/hephaestus/generators/license_generator.rb

@@ -10,7 +10,10 @@ module Hephaestus
     end
 
     def generate_licenses
-      run("script/licenses --update")
+      unless run("script/licenses --update", abort_on_failure: false)
+        say(set_color("Error generating licenses. When this is all over, run `script/licenses --update`.", :red))
+        sleep(3)
+      end
     end
   end
 end

data/lib/hephaestus/generators/rubocop_generator.rb

@@ -6,7 +6,7 @@ require_relative "base"
 module Hephaestus
   class RubocopGenerator < Generators::Base
     def rubocop
-      copy_file(".rubocop.yml", ".rubocop.yml")
+      copy_file(".rubocop.yml", ".rubocop.yml", force: true)
     end
 
     def lint

data/lib/hephaestus/version.rb

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

data/lib/hephaestus.rb

@@ -16,6 +16,7 @@ require "hephaestus/exit_on_failure"
 require "hephaestus/generators/app_generator"
 require "hephaestus/generators/config_generator"
 require "hephaestus/generators/core_generator"
+require "hephaestus/generators/db_generator"
 require "hephaestus/generators/deployment_generator"
 require "hephaestus/generators/lib_generator"
 require "hephaestus/generators/license_generator"
@@ -23,6 +24,7 @@ require "hephaestus/generators/rubocop_generator"
 require "hephaestus/generators/sorbet_generator"
 
 require "hephaestus/actions"
+require "hephaestus/app_name"
 require "hephaestus/actions/strip_comments_action"
 require "hephaestus/app_builder"
 

data/templates/Dockerfile

@@ -1,79 +1,11 @@
-# syntax = docker/dockerfile:1
+# syntax = docker/dockerfile:1.11
 
-# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
-ARG RUBY_VERSION=3.3.0
-FROM ruby:$RUBY_VERSION-slim as base
+ARG REGISTRY
 
-# The plug-app code lives here
-WORKDIR /plug-app
+# Base Rails Image
+FROM ${REGISTRY}yettoapp/base-rails:main AS builder
 
-# Set production environment
-ARG RAILS_ENV="production"
-ENV RAILS_ENV=${RAILS_ENV} \
-  BUNDLE_WITHOUT="staging:development:test" \
-  BUNDLE_DEPLOYMENT="1"
+# App Plug Image
+FROM ${REGISTRY}yettoapp/app-plug-ruby:main AS base
 
-# Update gems and bundler
-RUN gem update --system --no-document && \
-  gem install -N bundler
-
-
-# Throw-away build stages to reduce size of final image
-FROM base as prebuild
-
-# Install packages needed to build gems
-RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
-  --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
-  apt-get update -qq && \
-  apt-get install --no-install-recommends -y build-essential curl git libpq-dev libvips pkg-config python-is-python3 ca-certificates iptables iproute2
-
-
-FROM prebuild as build
-
-# Install application gems
-COPY --link Gemfile Gemfile.lock .ruby-version ./
-RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
-  bundle config set app_config .bundle && \
-  bundle config set path /srv/vendor && \
-  bundle install && \
-  bundle exec bootsnap precompile --gemfile && \
-  bundle clean && \
-  mkdir -p vendor && \
-  bundle config set path vendor && \
-  cp -ar /srv/vendor .
-
-# Copy application code
-COPY --link . .
-
-# Precompile bootsnap code for faster boot times
-RUN bundle exec bootsnap precompile app/ lib/
-
-# Adjust binfiles to set current working directory
-RUN grep -l '#!/usr/bin/env ruby' /plug-app/bin/* | xargs sed -i '/^#!/aDir.chdir File.expand_path("..", __dir__)'
-
-# Final stage for app image
-FROM base
-
-# Install packages needed for deployment
-RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
-  --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
-  apt-get update -qq && \
-  apt-get install --no-install-recommends -y imagemagick libvips postgresql-client sudo git
-
-# Copy built artifacts: gems, application
-COPY --from=build /usr/local/bundle /usr/local/bundle
-COPY --from=build /plug-app /plug-app
-
-# Deployment options
-ENV RAILS_LOG_TO_STDOUT="1" \
-  RAILS_SERVE_STATIC_FILES="true" \
-  RUBY_YJIT_ENABLE="1" \
-  LD_PRELOAD=${LD_PRELOAD_PATH} \
-  MALLOC_CONF="dirty_decay_ms:1000,narenas:2,background_thread:true"
-
-# Entrypoint sets up the container.
-ENTRYPOINT ["/plug-app/bin/docker-entrypoint"]
-
-# Start the server by default, this can be overwritten at runtime
-EXPOSE 3000
-CMD ["./bin/rails", "server"]
+USER app

data/templates/Gemfile

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" if repo_name.exclude?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+ruby File.read(".ruby-version").strip
+
+gem "hephaestus", "~> 0.8"
+
+# !!! TODO: put your platform's dependencies here !!!
+
+# the one and only
+gem "octokit", "~> 9.1"
+gem "faraday-retry", "~> 2.2"
+
+group :development, :test do
+  # better debug output with `ap`
+  gem "amazing_print"
+
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: [:mri, :mingw, :x64_mingw], require: false
+
+  gem "faker", "~> 3.4"
+  gem "rubocop", require: false
+  gem "rubocop-standard", require: false
+end
+
+group :development do
+  gem "dotenv-rails"
+
+  gem "foreman", "~> 0.88"
+
+  gem "licensed", "~> 4.4"
+
+  gem "ruby-lsp", "~> 0.17", require: false
+
+  gem "spoom"
+  gem "sorbet"
+  gem "tapioca", require: false
+end
+gem "sorbet-runtime"
+
+group :test do
+  gem "simplecov", "~> 0.18", require: false
+  gem "simplecov-console", "~> 0.7", require: false
+
+  # track down flakey tests
+  gem "minitest-bisect"
+
+  # mocking lib
+  gem "mocha"
+
+  # allow easier middleware testing
+  gem "rack-test", "~> 2.0"
+
+  # navigate website
+  gem "selenium-webdriver"
+
+  # jump around through time
+  gem "timecop", "~> 0.9"
+
+  # prevents real http requests
+  gem "webmock", "~> 3.23"
+end
+
+group :ci do
+  gem "brakeman", "~> 6.1"
+  gem "bundle-audit", "~> 0.1"
+end

data/templates/Procfile

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

data/templates/app/controllers/app_controller.rb.tt

@@ -0,0 +1,35 @@
+# typed: false
+# frozen_string_literal: true
+
+class <%= capital_plug_name %>Controller < ApplicationController
+  include Authable
+
+  include Constants
+
+  before_action :webhook_from_<%= plug_name %>?, only: [:webhook]
+  before_action :<%= plug_name %>_calling_back?, only: [:callback]
+
+  def webhook
+    body = request.body.read
+
+    payload = JSON.parse(body, symbolize_names: true)
+    # TODO: Get the event and action that triggered the webhook
+    #
+    # Then, queue up some work to be done in a background job
+
+    okay
+  end
+
+  def callback
+    code = params[:code]
+    state = params[:state]
+
+    state_obj = parse_state(state)
+    plug_installation_id = state_obj.fetch(:plug_installation_id, "")
+    redirect_to = state_obj.fetch(:redirect_to, "")
+
+    # TODO: Store access credentials you've been given back in Yetto
+
+    redirect_to(redirect_to, allow_other_host: true)
+  end
+end

data/templates/app/controllers/application_controller.rb

@@ -1,13 +1,7 @@
 # typed: false
 # frozen_string_literal: true
 
-class ApplicationController < ActionController::Base
-  include ActionController::MimeResponds
-
-  include Hephaestus::Responses
-
-  rescue_from ActionController::UnknownFormat, with: :not_acceptable
-
+class ApplicationController < Hephaestus::ApplicationController
   before_action :set_request_span_context
   def set_request_span_context
   end

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

@@ -0,0 +1,50 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Authable
+  extend T::Sig
+
+  include ActionDispatch::Http::Cache::Response
+
+  include ActionController::Helpers::ClassMethods
+  include ActionController::HttpAuthentication::Basic::ControllerMethods
+  include BodyParameter::YettoParameters
+
+  SHA256_DIGEST = OpenSSL::Digest.new("sha256")
+
+  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, "")
+
+    return true if ActiveSupport::SecurityUtils.secure_compare(nonce, <%= upcase_plug_name %>_APP_NONCE)
+
+    self.status = Hephaestus::HTTP::BAD_REQUEST_I
+    self.response_body = ::Hephaestus::ErrorSerializer.format(Hephaestus::HTTP::BAD_REQUEST)
+  end
+
+  sig { void }
+  def webhook_from_<%= plug_name %>?
+    # TODO: do whatever needs to be done to ensure that the webhook is coming from <%= plug_name %>
+
+    # github_header = request.headers[::Constants::GITHUB_HTTP_X_HUB_SIGNATURE_256_HEADER]
+
+    # if github_header.blank?
+    #   self.status = Hephaestus::HTTP::NOT_FOUND_I
+    #   self.response_body = ::Hephaestus::ErrorSerializer.format(Hephaestus::HTTP::NOT_FOUND)
+
+    #   return false
+    # end
+
+    # body = request.body.read
+    # signature = "sha256=#{OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha256"), GITHUB_SECRET_TOKEN, body)}"
+
+    # return true if Rack::Utils.secure_compare(signature, github_header)
+
+    # self.status = Hephaestus::HTTP::BAD_REQUEST_I
+    # self.response_body = ::Hephaestus::ErrorSerializer.format(Hephaestus::HTTP::BAD_REQUEST)
+  end
+end

data/templates/app/controllers/settings_controller.rb

@@ -1,45 +1,22 @@
-# typed: strict
+# typed: false
 # frozen_string_literal: true
 
 class SettingsController < ApplicationController
   extend T::Sig
 
-  include PathParameter::SettingsParameters
-
   before_action :ensure_json_request
-  sig { void }
-  def ensure_json_request
-    return if request.format.json?
-
-    not_acceptable
-  end
-
-  sig { void }
-  def new
-    @step = T.let(params.fetch(:step, 1).to_i || 1, T.nilable(Integer))
-  end
 
   sig { void }
   def edit
     @step = params.fetch(:step, 1).to_i || 1
 
-    response = YettoService.get_plug_installation(pparam_plug_installation_id)
+    plug_installation_id = params[:plug_installation_id]
+    response = ::Hephaestus::YettoService.get_plug_installation(plug_installation_id)
 
     if response.unavailable?
-      logger.error("Fetching Yetto inbox failed: `#{response}`")
-
-      return not_acceptable
-    end
+      logger.error("Fetching plug installation failed: `#{response}`")
 
-    plug_installation = response.parsed_json_body
-    access_token = plug_installation.fetch("credentials", {}).fetch("access_token", "")
-
-    if access_token.blank?
-      logger.error("Fetching Yetto access_token failed: `#{response}`")
-
-      return not_acceptable
+      not_acceptable
     end
-
-    not_found
   end
 end