hephaestus 0.0.1

data/templates/test/support/api.rb

@@ -0,0 +1,74 @@
+# typed: false
+# frozen_string_literal: true
+
+module API
+  module TestHelpers
+    include Rack::Test::Methods
+
+    def plug(method, path, headers: {}, version: nil, body: {})
+      version ||= PlugApp::CURRENT_VERSION
+      prepended_path = prepend_plug_path(version, path)
+
+      http_call(method, prepended_path, headers: headers, version: version, body: body)
+    end
+
+    def api(method, path, headers: {}, version: nil, body: {})
+      version ||= PlugApp::CURRENT_VERSION
+      prepended_path = prepend_api_path(version, path)
+
+      http_call(method, prepended_path, headers: headers, version: version, body: body)
+    end
+
+    def http_call(method, path, headers: {}, version: nil, body: {})
+      # explicitly assert headers cannot be nil
+      if headers.nil?
+        send(method, path, body.to_json)
+      else
+        headers["HTTP_ACCEPT"] ||= headers.fetch("HTTP_ACCEPT", "application/json")
+        headers["CONTENT_TYPE"] ||= headers.fetch("CONTENT_TYPE", "application/json")
+        send(method, path, body.to_json, headers)
+      end
+
+      JSON.parse(last_response.body) if last_response.body.present?
+    end
+
+    def assert_response(expected_status, expected_body = nil)
+      expected_status = case expected_status
+      when :not_found
+        PlugApp::HTTP::NOT_FOUND_I
+      when :not_acceptable
+        PlugApp::HTTP::NOT_ACCEPTABLE_I
+      when :ok, :okay
+        PlugApp::HTTP::OK_I
+      when :created
+        PlugApp::HTTP::CREATED_I
+      when :no_content
+        PlugApp::HTTP::NO_CONTENT_I
+      when :bad_request
+        PlugApp::HTTP::BAD_REQUEST_I
+      when :unauthorized
+        PlugApp::HTTP::UNAUTHORIZED_I
+      when :forbidden
+        PlugApp::HTTP::FORBIDDEN_I
+      when :service_unavailable
+        PlugApp::HTTP::SERVICE_UNAVAILABLE_I
+      else
+        raise ArgumentError, "Unknown status: #{expected_status}"
+      end
+
+      assert_equal(expected_status, last_response.status)
+    end
+
+    def prepend_plug_path(version, path)
+      "/plug/#{version}#{path}"
+    end
+
+    def prepend_api_path(version, path)
+      "/api/#{version}#{path}"
+    end
+
+    def app
+      Rails.application
+    end
+  end
+end

data/templates/test/support/rails.rb

@@ -0,0 +1,39 @@
+# typed: false
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../../config/environment"
+
+module ActiveSupport
+  class TestCase
+    extend T::Sig
+
+    # Run tests in parallel with specified workers
+    parallelize(workers: :number_of_processors)
+
+    def setup
+      @organization_id ||= "org_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
+      @plug_installation_id ||= "pli_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
+      @inbox_id ||= "ibx_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
+      @plug_id ||= "plg_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
+      @message_id ||= "msg_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
+      @conversation_id ||= "cnv_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}"
+    end
+
+    def file_fixture_path(dir, name)
+      Rails.root.join("test", "fixtures", "files", dir, name)
+    end
+
+    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]
+
+          assert_equal(expected_value, value)
+        end
+      end
+    end
+  end
+end

data/templates/test/support/webmocks/slack_webmock.rb

@@ -0,0 +1,24 @@
+# typed: false
+# frozen_string_literal: true
+
+module Webmocks
+  module SlackWebmock
+    extend T::Sig
+    extend T::Helpers
+
+    sig { returns(T.untyped) }
+    def assert_requested_send_to_slack_log
+      assert_requested(:post, "https://slack.com:80/the_log_room")
+    end
+
+    sig { returns(T.untyped) }
+    def stub_send_to_slack_log
+      stub_request(:post, "https://slack.com:80/the_log_room")
+        .to_return(
+          status: 200,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: {}.to_json,
+        )
+    end
+  end
+end

data/templates/test/support/webmocks/yetto.rb

@@ -0,0 +1,94 @@
+# typed: false
+# frozen_string_literal: true
+
+module Webmocks
+  module Yetto
+    SHA256_DIGEST = OpenSSL::Digest.new("sha256")
+
+    def yetto_auth_header(payload)
+      "sha256=#{OpenSSL::HMAC.hexdigest(SHA256_DIGEST, YETTO_PLUG_APP_TOKEN, payload.to_json)}"
+    end
+
+    def assert_requested_get_plug_installation(organization_id, inbox_id, plug_installation_id)
+      assert_requested(:get, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{organization_id}/inboxes/#{inbox_id}/plug_installations/#{plug_installation_id}")
+    end
+
+    def stub_get_plug_installation(organization_id, inbox_id, plug_installation_id, response = nil, status: 200)
+      response ||= {
+        installed_on_inbox: {
+          id: inbox_id,
+          organization: {
+            id: organization_id,
+            status: "active",
+          },
+        },
+        plug: {
+          id: "plg_#{Faker::Alphanumeric.alphanumeric(number: 26).upcase}",
+        },
+        settings: {
+          from_email: "new@from.company",
+        },
+      }
+
+      stub_request(:get, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{@organization_id}/inboxes/#{@inbox_id}/plug_installations/#{plug_installation_id}")
+        .to_return(
+          status: status,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: response.to_json,
+        )
+    end
+
+    def assert_requested_update_installation(organization_id, inbox_id, plug_installation_id)
+      assert_requested(:patch, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{@organization_id}/inboxes/#{@inbox_id}/plug_installations/#{plug_installation_id}")
+    end
+
+    def stub_update_installation(organization_id, inbox_id, plug_installation_id, params, response: {}, status: 200)
+      stub_request(:patch, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{@organization_id}/inboxes/#{@inbox_id}/plug_installations/#{plug_installation_id}")
+        .with(
+          body: params,
+        )
+        .to_return(
+          status: 200,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: response.to_json,
+        )
+    end
+
+    def assert_requested_create_message(organization_id, inbox_id)
+      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{organization_id}/inboxes/#{inbox_id}/messages")
+    end
+
+    def stub_create_message(organization_id, inbox_id, creator_id, payload)
+      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{organization_id}/inboxes/#{inbox_id}/messages")
+        .with(
+          body: payload,
+        )
+        .to_return(
+          status: 200,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: {}.to_json,
+        )
+    end
+
+    def assert_requested_create_switch(organization_id, inbox_id)
+      assert_requested(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{organization_id}/inboxes/#{inbox_id}/switches")
+    end
+
+    def stub_create_switch(organization_id, inbox_id, creator_id, params)
+      payload = {
+        name: "After install",
+        creator: { id: creator_id },
+      }
+
+      stub_request(:post, "#{::YettoService::YETTO_API_VERSION_TLD}/organizations/#{organization_id}/inboxes/#{inbox_id}/switches")
+        .with(
+          body: payload,
+        )
+        .to_return(
+          status: 200,
+          headers: { content_type: "application/json; charset=utf-8" },
+          body: {}.to_json,
+        )
+    end
+  end
+end

data/templates/test/support/webmocks.rb

@@ -0,0 +1,5 @@
+# typed: false
+# frozen_string_literal: true
+
+module Webmocks
+end

data/templates/test/test_helper.rb

@@ -0,0 +1,24 @@
+# typed: false
+# frozen_string_literal: true
+
+require "debug" if ENV.fetch("DEBUG", false)
+
+require "httpx"
+require "webmock/minitest"
+require "httpx/adapters/webmock"
+WebMock.enable!
+WebMock.disable_net_connect!(allow_localhost: true)
+
+require "dotenv"
+Dotenv.load(".env.test")
+
+require_relative "./support/rails"
+
+require "minitest/pride"
+
+require "webmock/minitest"
+# Load everything else from test/support
+Dir[File.expand_path("support/**/*.rb", __dir__)].each { |rb| require(rb) }
+
+# https://github.com/freerange/mocha#rails
+require "mocha/minitest"

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: hephaestus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  force_ruby_platform: false
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  force_ruby_platform: false
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 'Hephaestus is a Rails generator to create plugs for Yetto.
+
+  '
+email: 
+executables:
+- hephaestus
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/hephaestus
+- lib/hephaestus.rb
+- lib/hephaestus/actions.rb
+- lib/hephaestus/actions/strip_comments_action.rb
+- lib/hephaestus/app_builder.rb
+- lib/hephaestus/exit_on_failure.rb
+- lib/hephaestus/generators/app_generator.rb
+- lib/hephaestus/generators/base.rb
+- lib/hephaestus/generators/config_generator.rb
+- lib/hephaestus/generators/core_generator.rb
+- lib/hephaestus/generators/deployment_generator.rb
+- lib/hephaestus/generators/lib_generator.rb
+- lib/hephaestus/generators/license_generator.rb
+- lib/hephaestus/generators/rubocop_generator.rb
+- lib/hephaestus/generators/sorbet_generator.rb
+- lib/hephaestus/version.rb
+- templates/Gemfile.erb
+- templates/Procfile.debug
+- templates/Procfile.dev
+- templates/README.md.erb
+- templates/app/controllers/application_controller.rb
+- templates/app/controllers/concerns/authable.rb
+- templates/app/controllers/root_controller.rb
+- templates/app/controllers/settings_controller.rb
+- templates/app/controllers/staff_controller.rb
+- templates/app/controllers/yetto_controller.rb
+- templates/app/jobs/application_job.rb
+- templates/app/jobs/update_yetto_job.rb
+- templates/app/lib/body_parameter.rb
+- templates/app/lib/body_parameter/yetto_parameters.rb
+- templates/app/lib/constants/app.rb
+- templates/app/lib/headers.rb
+- templates/app/lib/headers/yetto.rb
+- templates/app/lib/path_parameter.rb
+- templates/app/lib/path_parameter/yetto_parameters.rb
+- templates/app/lib/plug_app/http.rb
+- templates/app/lib/plug_app/middleware/malformed_request.rb
+- templates/app/lib/plug_app/middleware/not_found.rb
+- templates/app/lib/plug_app/middleware/openapi_validation.rb
+- templates/app/lib/plug_app/middleware/tracing_attributes.rb
+- templates/app/lib/query_parameter.rb
+- templates/app/serializers/error_serializer.rb
+- templates/app/services/yetto_service.rb
+- templates/app/views/settings/index.json.jbuilder
+- templates/config/initializers/cors.rb
+- templates/config/initializers/environment.rb
+- templates/config/initializers/filter_parameter_logging.rb
+- templates/config/initializers/inflections.rb
+- templates/config/initializers/lograge.rb
+- templates/config/initializers/open_telemetry.rb
+- templates/config/initializers/sidekiq.rb
+- templates/config/initializers/slack_webhook_logger.rb
+- templates/config/sidekiq.yml
+- templates/hephaestus_gitignore
+- templates/lib/plug_app/schemas/api/2023-03-06/components/parameters/headers/yetto.json
+- templates/lib/plug_app/schemas/api/2023-03-06/components/parameters/plugInstallation.json
+- templates/lib/plug_app/schemas/api/2023-03-06/components/schemas/plug.json
+- templates/lib/plug_app/schemas/api/2023-03-06/components/schemas/responses.json
+- templates/lib/plug_app/schemas/api/2023-03-06/components/schemas/yetto.json
+- templates/lib/plug_app/schemas/api/2023-03-06/openapi.json
+- templates/lib/plug_app/schemas/api/2023-03-06/paths/plug.json
+- templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/after_create_message.json
+- templates/lib/plug_app/schemas/api/2023-03-06/paths/yetto/after_create_plug_installation.json
+- templates/lib/tasks/test_tasks.rake
+- templates/script/ci
+- templates/script/hmac_text
+- templates/script/licenses
+- templates/script/ngrok
+- templates/script/security_checks/brakeman
+- templates/script/security_checks/bundle-audit
+- templates/script/server
+- templates/script/server-debug
+- templates/script/test
+- templates/script/typecheck
+- templates/sorbet/custom.rbi
+- templates/test/controllers/root_controller_test.rb
+- templates/test/controllers/settings_controller_test.rb
+- templates/test/controllers/yetto_controller_test.rb
+- templates/test/jobs/update_yetto_job_test.rb
+- templates/test/support/api.rb
+- templates/test/support/rails.rb
+- templates/test/support/webmocks.rb
+- templates/test/support/webmocks/slack_webmock.rb
+- templates/test/support/webmocks/yetto.rb
+- templates/test/test_helper.rb
+homepage: http://github.com/yettoapp/hephaestus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Generate a Rails app that can be used to create plugs for Yetto.
+test_files: []