rrx_api 0.1.0 → 8.0.3

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/auth/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RrxApi
+  module Auth
+    class TokenExpiredError < StandardError
+      def initialize
+        super('User token expired')
+      end
+    end
+
+    # Abstract authentication provider base class.
+    # Subclass and override {#id_from_token} (and optionally {#user_info}) to implement a provider.
+    class Base
+      # Verify a bearer token and return the provider user ID.
+      # @param _token [String]
+      # @return [String]
+      def id_from_token(_token)
+        raise NotImplementedError, "#{self.class}#id_from_token is not implemented"
+      end
+
+      # Fetch user info for a given provider UID (optional).
+      # @param _uid [String]
+      # @return [Object, nil]
+      def user_info(_uid)
+        nil
+      end
+    end
+  end
+end

data/lib/rrx_api/auth/firebase.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module RrxApi
+  module Auth
+    # Firebase authentication provider.
+    #
+    # Requires the +firebase-admin-sdk+ gem. It is intentionally not listed as a
+    # dependency of rrx_api — add it to your application's Gemfile when you want
+    # Firebase auth:
+    #
+    #   gem 'firebase-admin-sdk'
+    #
+    # Configuration is read from +RrxConfig.firebase+ (project_id, client_email,
+    # private_key, etc.).
+    class Firebase < Base
+      def id_from_token(id_token)
+        require_firebase!
+        verified = auth.verify_id_token(id_token)
+        verified['sub']
+      rescue LoadError
+        raise
+      rescue => e
+        # Lazily match the expired-token error so this file can be parsed before
+        # the firebase-admin-sdk gem is loaded.
+        raise TokenExpiredError if e.class.name == 'Firebase::Admin::Auth::ExpiredTokenError'
+
+        raise
+      end
+
+      def user_info(uid)
+        require_firebase!
+        auth.get_user(uid)
+      end
+
+      private
+
+      def require_firebase!
+        require 'firebase-admin-sdk'
+      rescue LoadError
+        raise LoadError,
+              "firebase-admin-sdk is required for Firebase authentication. " \
+              "Add `gem 'firebase-admin-sdk'` to your Gemfile."
+      end
+
+      def credentials
+        @credentials ||= ::Firebase::Admin::Credentials.from_json(config.to_json)
+      end
+
+      def app
+        @app ||= begin
+          app_config = ::Firebase::Admin::Config.new(
+            project_id:         config.project_id,
+            service_account_id: config.client_email
+          )
+          ::Firebase::Admin::App.new(credentials:, config: app_config)
+        end
+      end
+
+      def auth
+        @auth ||= ::Firebase::Admin::Auth::Client.new(app)
+      end
+
+      def config
+        RrxConfig.firebase
+      end
+    end
+  end
+end

data/lib/rrx_api/engine.rb

@@ -0,0 +1,111 @@
+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'
+require_relative 'auth/base'
+require_relative 'auth/firebase'
+
+module RrxApi
+  class Engine < ::Rails::Engine
+    CORS_LOCALHOST_PATTERN = /\Ahttp:\/\/localhost(?::\d{4})?\z/.freeze
+
+    config.cors_origins = []
+
+    # Checks whether +source+ matches any of the configured CORS origins.
+    # Each entry in +cors_origins+ may be:
+    # - a String for exact match (e.g. "https://app.example.com")
+    # - a String with a leading wildcard (e.g. "*.example.com" matches "https://foo.example.com")
+    # - a Regexp (e.g. /\.example\.com\z/)
+    def self.cors_origin_allowed?(source, origins)
+      origins.any? do |origin|
+        case origin
+        when Regexp then origin.match?(source)
+        when String
+          if origin.start_with?('*.')
+            # Wildcard subdomain: *.example.com matches any scheme+subdomain of example.com
+            suffix = origin[1..]  # => ".example.com"
+            source.end_with?(suffix)
+          else
+            source == origin
+          end
+        end
+      end
+    end
+    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
+              Engine.cors_origin_allowed?(source, app.config.cors_origins)
+            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.3'
+  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'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rrx_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 8.0.3
 platform: ruby
 authors:
 - Dan Drew
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack-action_caching
@@ -70,16 +69,16 @@ dependencies:
   name: jbuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +127,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 8.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 8.0.3
 - !ruby/object:Gem::Dependency
-  name: rails-healthcheck
+  name: rrx_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 8.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 8.0.3
+- !ruby/object:Gem::Dependency
+  name: rrx_logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.3
 - !ruby/object:Gem::Dependency
   name: rswag-api
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +192,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tzinfo-data
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +206,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rrx_logging
+  name: tzinfo-data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,13 +220,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rrx_config
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -221,7 +234,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rrx_dev
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -234,20 +247,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rrx_dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.3
 email:
 - dan.drew@hotmail.com
-executables:
-- rrx_api_setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".idea/.gitignore"
-- ".idea/inspectionProfiles/Project_Default.xml"
-- ".idea/modules.xml"
-- ".idea/rrx_api.iml"
-- ".idea/vcs.xml"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -256,13 +276,27 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/concerns/rrx_api/authenticatable.rb
 - app/controllers/rrx_api/controller.rb
+- app/controllers/rrx_api/health_controller.rb
+- app/models/concerns/arel_query.rb
 - app/models/rrx_api/record.rb
-- exe/rrx_api_setup
-- exe/sources/config/initializers/cors.rb
-- exe/sources/config/initializers/generators.rb
+- config/routes.rb
+- lib/generators/rrx_api/base.rb
+- lib/generators/rrx_api/docker_generator.rb
+- lib/generators/rrx_api/github_generator.rb
+- lib/generators/rrx_api/install_generator.rb
+- lib/generators/rrx_api/templates/docker/Dockerfile.tt
+- lib/generators/rrx_api/templates/github/build/workflows/build.yml.tt
+- lib/generators/rrx_api/templates/github/deploy/workflows/deploy.yml.tt
+- lib/generators/rrx_api/templates/terraform/aws/iam.tf.tt
+- lib/generators/rrx_api/templates/terraform/aws/main.tf.tt
+- lib/generators/rrx_api/templates/terraform/aws/service.tf.tt
+- lib/generators/rrx_api/terraform_generator.rb
 - lib/rrx_api.rb
-- lib/rrx_api/railtie.rb
+- lib/rrx_api/auth/base.rb
+- lib/rrx_api/auth/firebase.rb
+- lib/rrx_api/engine.rb
 - lib/rrx_api/version.rb
 - sig/rrx_api.rbs
 homepage: https://github.com/rails-rrx/rrx_api
@@ -271,23 +305,21 @@ licenses:
 metadata:
   homepage_uri: https://github.com/rails-rrx/rrx_api
   source_code_uri: https://github.com/rails-rrx/rrx_api
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Ruby on Rails core API support
 test_files: []

data/.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml