rrx_api 0.1.0 → 8.0.2

data/lib/generators/rrx_api/github_generator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+require_relative 'base'
+
+module RrxApi
+  module Generators
+    class GithubGenerator < Base
+      init! 'Generates GitHub Actions workflows for building and deploying the application using Docker.'
+
+      class_option :deploy,
+                   type:    :boolean,
+                   default: false,
+                   desc:    'Include deployment workflow'
+
+      class_option :terraform_repo,
+                   type:    :string,
+                   default: 'terraform',
+                   desc:    'Terraform repository name (if using deployment workflow)'
+
+      class_option :terraform_module,
+                   type: :string,
+                   desc: 'Terraform module name (if using deployment workflow). Default is the application name.'
+
+      class_option :database,
+                   type:    :string,
+                   default: 'auto',
+                   enum:    %w[auto postgresql mysql mariadb sqlite none],
+                   desc:    'Database type'
+
+      def github
+        directory 'github/build', '.github'
+        directory 'github/deploy', '.github' if deploy?
+      end
+
+      private
+
+      def deploy?
+        options[:deploy]
+      end
+
+      def database
+        @database ||= options[:database] == 'auto' ? detect_database : options[:database]
+      end
+
+      def terraform_repo
+        options[:terraform_repo]
+      end
+
+      def terraform_module
+        options[:terraform_module] || app_name
+      end
+
+      def docker_packages
+        ''
+      end
+
+      def detect_database
+        config_path = destination_path.join('config/database.yml')
+        if config_path.exist?
+          # @type {Hash}
+          config  = YAML.safe_load(config_path.read, symbolize_names: true, aliases: true)
+          adapter = config.dig(:test, :adapter).to_s.downcase
+          case adapter
+          when /postgresql/, /psql/
+            'postgresql'
+          when /mysql/
+            if yes?('Detected MySQL adapter in database.yml. Are you using MariaDB? (Yn)')
+              'mariadb'
+            else
+              'mysql'
+            end
+          when /sqlite/
+            'sqlite'
+          else
+            say_error 'Unsupported database adapter detected in config/database.yml. Please specify the database type explicitly using --database option.'
+            exit 1
+          end
+        else
+          'none'
+        end
+      end
+    end
+  end
+end

data/lib/generators/rrx_api/install_generator.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+# frozen_string_literal: true
+require_relative 'base'
+
+module RrxApi
+  module Generators
+    class InstallGenerator < Base
+      init! 'Installs the RRX API gem and its dependencies.'
+
+      class_option :skip_rrx_dev, type: :boolean, default: false, hide: true
+
+      # Updates the application configuration file with specific dependencies and settings.
+      # The method performs the following operations:
+      # - Reads the application configuration file located at 'config/application.rb'.
+      # - Removes existing comments and unnecessary `require` statements from the file.
+      # - Includes necessary `require` directives for the application's gem dependencies.
+      # - Injects or updates the Bundler require statement to include the necessary gems.
+      # - Cleans up unwanted whitespace in the file content.
+      # - Rewrites the configuration file with the updated content.
+      # - Appends additional configuration settings for time zone, schema format, and session management.
+      #
+      # @return [void] Since the primary purpose is file modification, it does not return a value directly.
+      def update_application
+        # @type [Pathname]
+        app_file = Pathname(destination_root).join('config', 'application.rb')
+        app_code = app_file.read
+
+        # Assume full replace if we've never modified before.
+        # Otherwise, create_file will prompt to replace it.
+        remove_file app_file unless app_code =~ /rrx_api/
+
+        app_code.gsub!(/^\s*#.*\r?\n/, '')
+        app_code.gsub!(/^(?:#\s+)?require ["'].*\r?\n/, '')
+
+        requires = application_gems.map do |gem|
+          "require '#{gem}'"
+        end.join("\n")
+
+        app_code.sub!(/^(Bundler.require.*)$/) do |str|
+          <<~REQ
+            #{requires}
+
+            #{str}
+          REQ
+        end
+
+        # Remove existing application config lines
+        APPLICATION_CONFIG.each do |line|
+          app_code.gsub!(/^\s*#{line}\W*.*\n/, '')
+        end
+
+        # Remove unnecessary whitespace
+        app_code.lstrip!
+        app_code.gsub!(/^\s*\r?\n(\s*\r?\n)+/, "\n")
+
+        # puts app_code
+        create_file app_file, app_code
+      end
+
+      def update_base_classes
+        gsub_file 'app/models/application_record.rb',
+                  /ApplicationRecord.*/,
+                  'ApplicationRecord < RrxApi::Record'
+
+        gsub_file 'app/controllers/application_controller.rb',
+                  /ApplicationController.*/,
+                  'ApplicationController < RrxApi::Controller'
+      end
+
+      def routes
+        inject_into_file 'config/routes.rb',
+                         after: "Rails.application.routes.draw do\n" do
+          <<~RUBY
+            mount RrxApi::Engine => '/'
+          RUBY
+        end
+      end
+
+      def rrx_dev
+        generate 'rrx_dev:install' unless options[:skip_rrx_dev]
+      end
+
+      def asdf_versions
+        create_file '.tool-versions', <<~VERSIONS
+          ruby #{ruby_version}
+        VERSIONS
+      end
+
+      private
+
+      # Configs to remove from the application.rb file
+      APPLICATION_CONFIG = <<~CONFIG.split("\n").map(&:strip).freeze
+        config.time_zone
+        config.active_support.to_time_preserves_timezone
+        config.active_record.schema_format
+        config.session_store
+        config.middleware.use ActionDispatch::Cookies
+        config.middleware.use ActionDispatch::Session::CookieStore
+      CONFIG
+
+      # @return [Array<String>] The list of application gem names that are dependencies
+      def application_gems
+        gems = %w[rrx_api]
+        gems.concat(%w[rrx_jobs active_job].select { |name| gem?(name) })
+      end
+
+      # @param [String] name
+      # @return [Boolean] True if gem is a dependency
+      def gem?(name)
+        bundle_gems.include?(name)
+      end
+
+      # @return [Set<String>]
+      def bundle_gems
+        @bundle_gems ||= bundle.dependencies.map(&:name).to_set
+      end
+
+    end
+  end
+end

data/lib/generators/rrx_api/templates/docker/Dockerfile.tt

@@ -0,0 +1 @@
+FROM ddrew555/rrx_docker:<%= ruby_version %>

data/lib/generators/rrx_api/templates/github/build/workflows/build.yml.tt

@@ -0,0 +1,71 @@
+name: Build
+
+on:
+  workflow_dispatch:
+<% if deploy? %>
+    inputs:
+      dev_deploy:
+        type: boolean
+        default: true
+        description: 'Deploy build to development environment'
+<% end %>
+
+  push:
+    branches: [main]
+
+env:
+  image_name: '<%= app_name %>'
+  major_version: 1
+  minor_version: 0
+  development: ${{ github.ref_name != 'main' }}
+
+permissions: write-all
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: dan-drew/asdf-actions/tool-versions@v1
+
+      - name: Test
+        uses: rails-rrx/actions/test@main
+        with:
+          ruby_version: <%= ruby_version %>
+          database: <%= database %>
+
+      - uses: dan-drew/actions/next-version@main
+        with:
+          suffix: ${{ env.development && '-dev' || '' }}
+
+      - name: Build
+        uses: rails-rrx/actions/docker-build@main
+        with:
+          repository: ${{ vars.DOCKER_REPOSITORY }}
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          image_name: $${{ env.image_name }}
+          image_version: ${{ env.next_version }}
+          database: <%= database %>
+          latest: true
+          packages: '<%= docker_packages %>'
+
+      - uses: dan-drew/actions/push-version@main
+        if: ${{ ! env.development }}
+<% if deploy? %>
+      - name: Deploy Development
+        uses: actions/github-script@v7
+        condition: ${{ inputs.dev_deploy }}
+        with:
+          script: |
+            github.rest.actions.createWorkflowDispatch({
+              owner:        context.repo.owner,
+              repo:         context.repo.repo,
+              workflow_id:  'deploy.yml',
+              ref:          context.ref,
+              inputs:       { version: '${{ env.next_version }}' }
+            });
+<% end %>

data/lib/generators/rrx_api/templates/github/deploy/workflows/deploy.yml.tt

@@ -0,0 +1,62 @@
+name: Deploy
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        required: true
+        type: string
+        description: 'Version to deploy'
+      environment:
+        default: development
+        type: string
+        description: 'Environment to deploy'
+
+env:
+  image_name: '<%= app_name %>'
+  image_tag: "${{ inputs.version }}"
+  terraform_repo: '<%= terraform_repo %>'
+  terraform_module: '<%= terraform_module %>'
+  repository: ${{ vars.DOCKER_REPOSITORY }}
+  username: ${{ secrets.DOCKER_USERNAME }}
+  password: ${{ secrets.DOCKER_PASSWORD }}
+
+permissions: write-all
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Tag Docker Image
+        run: |
+          readonly image_ref="${repository}/${image_name}"
+          readonly source_image="${image_ref}:${image_tag}"
+          readonly dest_image="${image_ref}:${{ inputs.environment }}"
+
+          echo ::group::Login
+          cat <<-PASSWORD | docker login "$repository" -u "$username" --password-stdin
+          ${password}
+          PASSWORD
+          echo ::endgroup::
+
+          echo ::group::Tag
+          docker pull -q "${source_image}"
+          docker tag "${source_image}" "${dest_image}"
+          docker push -q "${dest_image}"
+          echo ::endgroup::
+
+      - name: Trigger Terraform
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.TERRAFORM_GITHUB_TOKEN }}
+          script: |
+            github.rest.repos.createDispatchEvent({
+              owner:        context.repo.owner,
+              repo:         'terraform',
+              event_type:   'apply',
+
+              client_payload: {
+                path:         '${{ env.terraform_module }}',
+                environment:  '${{ inputs.environment }}'
+              }
+            });

data/lib/generators/rrx_api/templates/terraform/aws/iam.tf.tt

@@ -0,0 +1,37 @@
+data "aws_iam_policy_document" "app_policy" {
+  source_policy_documents = [module.rrx_config.role_policy.json]
+
+  statement {
+    sid       = "webrtc"
+    resources = ["*"]
+    actions = [
+      "ivs:CreateStage",
+      "ivs:CreateParticipantToken",
+      "ivs:DeleteStage",
+      "ivs:DisconnectParticipant",
+      "ivs:GetStage",
+      "ivs:GetStageSession",
+      "ivs:ListStages",
+      "ivs:ListStageSessions",
+      "ivs:TagResource",
+      "cloudwatch:DescribeAlarms",
+      "cloudwatch:GetMetricData",
+      "servicequotas:ListAWSDefaultServiceQuotas",
+      "servicequotas:ListRequestedServiceQuotaChangeHistoryByQuota",
+      "servicequotas:ListServiceQuotas",
+      "servicequotas:ListServices",
+      "servicequotas:ListTagsForResource"
+    ]
+  }
+}
+
+resource "aws_iam_user" "app" {
+  name          = local.app_env_name
+  path          = "/${module.tagging.environment}/services/"
+  force_destroy = true
+}
+
+resource "aws_iam_user_policy" "api" {
+  user   = aws_iam_user.app.name
+  policy = data.aws_iam_policy_document.api.json
+}

data/lib/generators/rrx_api/templates/terraform/aws/main.tf.tt

@@ -0,0 +1,44 @@
+terraform {
+  required_version = "<%= terraform_version %>"
+
+  required_providers {
+    aws = {}
+  }
+
+<% if s3_bucket.present? %>
+  # Configure the backend to store the state file in S3
+  backend "s3" {
+    bucket  = "<%= s3_bucket %>"
+    key     = "<%= s3_key %>"
+  <% if aws_profile %>
+    profile = "<%= aws_profile %>"
+  <% end %>
+    region  = "<%= aws_region %>"
+    encrypt = true
+  }
+<% end %>
+}
+
+provider "aws" {
+<% if aws_profile %>
+  profile = "<%= aws_profile %>"
+<% end %>
+  region  = "<%= aws_region %>"
+  default_tags {
+    tags = module.tagging.default_tags
+  }
+}
+
+module "aws" {
+  source = "github.com/tfext/terraform-aws-base"
+}
+
+module "tagging" {
+  source       = "github.com/tfext/terraform-utilities-tagging"
+  environments = <%= environments? %>
+}
+
+locals {
+  app_name     = "<%= app_name %>"
+  app_env_name = "${local.app_name}${module.tagging.environment_suffix}"
+}

data/lib/generators/rrx_api/templates/terraform/aws/service.tf.tt

@@ -0,0 +1,67 @@
+module "rrx_config" {
+  source = "github.com/tfext/terraform-rrx-config"
+  environment = terraform.workspace
+  # aws_secret  = "..."
+
+  db = {
+    resource_id = data.aws_db_instance.db.resource_id
+    type        = "mariadb"
+    host        = data.aws_db_instance.db.address
+    port        = data.aws_db_instance.db.port
+    name        = "liaisun"
+    user        = "liaisun_api"
+    iam         = true
+  }
+
+  config = {
+    default_identity_provider = {
+      user_pool_id = "us-west-2_Q8lbwSDZ3"
+      client_id    = "27j0fkk6jdnc8fdcf1psuechtd"
+      domain       = "auth-dev.liaisun.com"
+    }
+  }
+}
+
+resource "aws_cloudwatch_log_group" "service" {
+  name              = "/${module.tagging.environment}/<%= app_name %>"
+  retention_in_days = module.tagging.production ? 3 : 1
+}
+
+module "container_definition" {
+  source          = "github.com/tfext/terraform-aws-ecs-container-definition"
+  name            = local.app_env_name
+  repository      = module.ilibrium.docker_repository
+  image           = "<%= app_name %>"
+  image_tag       = "latest" # terraform.workspace
+  cpu             = 1
+  memory_required = 512
+  environment     = module.rrx_config.environment
+
+  ports = [{
+    port         = 3000
+    public_port  = 443
+    health_check = { path = "/healthcheck" }
+  }]
+
+  aws_logging = {
+    group = aws_cloudwatch_log_group.service.name
+  }
+}
+
+module "service" {
+  source              = "github.com/tfext/terraform-aws-ecs-service"
+  name                = local.app_env_name
+  cluster             = <%= ecs_cluster %>
+  containers          = [module.container_definition]
+  role_policy         = data.aws_iam_policy_document.app.json
+  target_group_prefix = "<%= app_name %>${module.tagging.environment_suffix}"
+  wait_for_stable     = false
+
+  load_balancers = [{
+    name          = module.tagging.environment
+    short_name    = module.tagging.short_env
+    dns_zone      = "liaisun.com"
+    dns_subdomain = "api${module.tagging.environment_suffix}"
+    vpc           = module.tagging.environment
+  }]
+}

data/lib/generators/rrx_api/terraform_generator.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+require_relative 'base'
+
+module RrxApi
+  module Generators
+    class TerraformGenerator < Base
+      init! 'Generates Terraform scripts for deploying the service as a docker container.'
+
+      class_option :cloud,
+                   default: 'aws',
+                   enum:    %w[aws],
+                   desc:    'Cloud provider for deployment (currently only AWS is supported)'
+
+      class_option :bucket,
+                   type: :string,
+                   desc: 'S3 bucket name for storing Terraform state files (default: store state locally)'
+
+      class_option :key,
+                   type: :string,
+                   desc: 'S3 key for the Terraform state file (default: app name)'
+
+      class_option :aws_profile,
+                   type: :string,
+                   desc: 'AWS profile to use for deployment (default: current profile)'
+
+      class_option :aws_region,
+                   type:    :string,
+                   default: 'us-west-2',
+                   desc:    'AWS region for deployment (default: us-west-2)'
+
+      class_option :ecs_cluster,
+                   type: :string,
+                   desc: 'ECS cluster name for deployment (default: deployment environment name)'
+
+      class_option :environments,
+                   type:    :boolean,
+                   default: false,
+                   aliases: '-e',
+                   desc:    'Generate terraform files that targets multiple environments (default: false)'
+
+      def terraform
+        directory "terraform/#{options[:cloud]}", 'terraform'
+      end
+
+      private
+
+      def environments?
+        options[:environments]
+      end
+
+      def terraform_version
+        '1.9'
+      end
+
+      def s3_bucket
+        options[:bucket]
+      end
+
+      def s3_key
+        options[:key] || app_name
+      end
+
+      def aws_profile
+        options[:aws_profile]
+      end
+
+      def aws_region
+        options[:aws_region]
+      end
+
+      def ecs_cluster
+        options.include?(:ecs_cluster) ? "'#{options[:ecs_cluster]}'" : 'terraform.workspace'
+      end
+    end
+  end
+end

data/lib/rrx_api/engine.rb

@@ -0,0 +1,88 @@
+require 'rails'
+require 'active_model/railtie'
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_text/engine'
+require 'action_view/railtie'
+require 'jbuilder'
+require 'rack/cors'
+require 'actionpack/action_caching'
+
+module RrxApi
+  class Engine < ::Rails::Engine
+    CORS_LOCALHOST_PATTERN = /\Ahttp:\/\/localhost(?::\d{4})?\z/.freeze
+
+    config.cors_origins = []
+    config.healthcheck = nil
+    config.healthcheck_route = 'healthcheck'
+
+    initializer 'rrx.active_support', before: 'active_support.set_configs' do |app|
+      app.config.active_support.to_time_preserves_timezone = :zone
+    end
+
+    initializer 'rrx.application', before: :initialize do |app|
+      app.config.time_zone                                 = :utc
+      app.config.active_support.to_time_preserves_timezone = :zone
+      app.config.active_record.schema_format               = :sql # Use SQL schema format for UUID support
+
+      app.config.generators.orm :active_record, primary_key_type: :uuid
+      app.config.session_store :cookie_store, key: '_rrx_session' # Make configurable in the future?
+      app.config.middleware.use ActionDispatch::Cookies # Required for all session management
+      app.config.middleware.use ActionDispatch::Session::CookieStore, app.config.session_options
+    end
+
+    initializer 'rrx.cors', before: :load_config_initializers do |app|
+      require 'rack/cors'
+
+      Rails.application.config.middleware.insert_before 0, Rack::Cors do
+        allow do
+          origins do |source, _env|
+            if Rails.env.development?
+              CORS_LOCALHOST_PATTERN.match? source
+            else
+              app.config.cors_origins.include?(source)
+            end
+          end
+
+          resource '*',
+                   headers:     :any,
+                   credentials: true,
+                   methods:     [:get, :post, :put, :patch, :delete, :options, :head]
+        end
+      end
+
+    end
+
+    initializer 'rrx.api_docs_config', before: :load_config_initializers do |_app|
+      Rails.configuration.api_docs = { 'API' => 'swagger.yaml' }
+    end
+
+    initializer 'rrx.api_docs', after: :load_config_initializers do |app|
+      # Setup Swagger endpoints if docs exist
+      if swagger_root?
+        require 'rswag/api'
+        require 'rswag/ui'
+
+        Rswag::Api.configure do |c|
+          c.swagger_root = Rails.root.join('swagger')
+        end
+
+        Rswag::Ui.configure do |c|
+          app.config.api_docs.each_pair do |name, file|
+            c.swagger_endpoint "/api-docs/#{file}", name
+          end
+        end
+      end
+    end
+
+    private
+
+    def swagger_root
+      @swagger_root ||= Rails.root.join('swagger')
+    end
+
+    def swagger_root?
+      swagger_root.exist?
+    end
+  end
+end

data/lib/rrx_api/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module RrxApi
-  VERSION = "0.1.0"
-  RAILS_VERSION = "~> 7.0"
+  VERSION = '8.0.2'
+  DEPENDENCY_VERSION = "~> #{VERSION}"
+  RAILS_VERSION = DEPENDENCY_VERSION
 end

data/lib/rrx_api.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'rrx_api/version'
-require_relative 'rrx_api/railtie'
+require_relative 'rrx_api/engine'
 require 'rrx_config'
 require 'rrx_logging'
 require 'rack/cors'