rrx_api 0.1.0

data/Gemfile.lock

@@ -0,0 +1,402 @@
+PATH
+  remote: ../rrx_dev
+  specs:
+    rrx_dev (0.1.0)
+      active_record_query_trace
+      activesupport (~> 7.1.0)
+      bootsnap
+      debug
+      factory_bot_rails
+      listen
+      railties (~> 7.1.0)
+      rake (>= 13.0)
+      rspec (>= 3.0)
+      rspec-parameterized
+      rspec-rails
+      rswag-specs
+      rubocop (>= 1.21)
+      rubocop-rails
+      spring
+      thor
+
+PATH
+  remote: ../rrx_logging
+  specs:
+    rrx_logging (0.1.0)
+      activesupport
+      railties
+      rrx_config
+
+PATH
+  remote: .
+  specs:
+    rrx_api (0.1.0)
+      actionpack-action_caching
+      bootsnap
+      faraday
+      faraday_middleware
+      jbuilder
+      kaminari
+      puma
+      rack-cors
+      rails (~> 7.0)
+      rails-healthcheck
+      rrx_config
+      rrx_logging
+      rswag-api
+      rswag-ui
+      tzinfo-data
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.2)
+      actionpack (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionpack-action_caching (1.2.2)
+      actionpack (>= 4.0.0)
+    actiontext (7.1.2)
+      actionpack (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    active_record_query_trace (1.8.2)
+      activerecord (>= 6.0.0)
+    activejob (7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activesupport (= 7.1.2)
+      marcel (~> 1.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    bootsnap (1.17.0)
+      msgpack (~> 1.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    debug_inspector (1.2.0)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    factory_bot (6.4.5)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.4.3)
+      factory_bot (~> 6.4)
+      railties (>= 5.0.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    ffi (1.16.3)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.1)
+    irb (1.11.0)
+      rdoc
+      reline (>= 0.3.8)
+    jbuilder (2.11.5)
+      actionview (>= 5.0.0)
+      activesupport (>= 5.0.0)
+    json (2.7.1)
+    json-schema (4.1.1)
+      addressable (>= 2.8)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    msgpack (1.7.2)
+    multipart-post (2.3.0)
+    mutex_m (0.2.0)
+    net-imap (0.4.9)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    proc_to_ast (0.1.0)
+      coderay
+      parser
+      unparser
+    psych (5.1.2)
+      stringio
+    public_suffix (5.0.4)
+    puma (6.4.0)
+      nio4r (~> 2.0)
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-cors (2.0.1)
+      rack (>= 2.0.0)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.2)
+      actioncable (= 7.1.2)
+      actionmailbox (= 7.1.2)
+      actionmailer (= 7.1.2)
+      actionpack (= 7.1.2)
+      actiontext (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activemodel (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-healthcheck (1.4.0)
+      actionpack
+      railties
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rrx_config (0.1.0)
+      railties
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-parameterized (1.0.0)
+      rspec-parameterized-core (< 2)
+      rspec-parameterized-table_syntax (< 2)
+    rspec-parameterized-core (1.0.0)
+      parser
+      proc_to_ast
+      rspec (>= 2.13, < 4)
+      unparser
+    rspec-parameterized-table_syntax (1.0.1)
+      binding_of_caller
+      rspec-parameterized-core (< 2)
+    rspec-rails (6.1.0)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
+    rspec-support (3.12.1)
+    rswag-api (2.13.0)
+      activesupport (>= 3.1, < 7.2)
+      railties (>= 3.1, < 7.2)
+    rswag-specs (2.13.0)
+      activesupport (>= 3.1, < 7.2)
+      json-schema (>= 2.2, < 5.0)
+      railties (>= 3.1, < 7.2)
+      rspec-core (>= 2.14)
+    rswag-ui (2.13.0)
+      actionpack (>= 3.1, < 7.2)
+      railties (>= 3.1, < 7.2)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-rails (2.23.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    spring (4.1.3)
+    sqlite3 (1.7.0-x86_64-linux)
+    stringio (3.1.0)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2023.4)
+      tzinfo (>= 1.0.0)
+    unicode-display_width (2.5.0)
+    unparser (0.6.10)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.2.4)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rrx_api!
+  rrx_dev!
+  rrx_logging!
+  sqlite3
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Dan Drew
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# RrxApi
+
+Opinionated base library for simplifying development of Rails API projects.
+
+Note that this gem expects the [rrx_dev](https://github.com/rails-rrx/rrx_api/blob/main/CODE_OF_CONDUCT.md) but does
+not list it as a dependency as it is only needed for development and tests. Please add it to your Gemfile manually
+or as described below with the `bundle add` command.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+$ bundle add rrx_dev --group "development, test"
+$ bundle add rrx_api
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+$ gem install rrx_dev rrx_api
+```
+
+After installing, initialize your project with `rrx_api_setup`. Note this will also invoke `rrx_dev_setup app` to
+perform development and test setup.
+
+```shell
+$ rrx_api_setup
+```
+
+## Usage
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rails-rrx/rrx_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rails-rrx/rrx_api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RrxApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rrx_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/app/controllers/rrx_api/controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RrxApi
+  class Controller < ActionController::API
+    include AbstractController::Helpers
+
+    abstract!
+
+    # @return [RrxLogging::Logger]
+    def logger
+      RrxLogging.current || Rails.logger
+    end
+  end
+end

data/app/models/rrx_api/record.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RrxApi
+  class Record < ActiveRecord::Base
+    self.abstract_class = true
+
+    # @return [RrxLogging::Logger]
+    def logger
+      @logger ||= RrxLogging.current || Rails.logger
+    end
+  end
+end

data/exe/rrx_api_setup

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor'
+require 'pathname'
+
+class Setup < Thor
+  include Thor::Actions
+
+  default_command :app
+
+  #noinspection RubyMismatchedArgumentType
+  source_root Pathname(__dir__).join('sources')
+
+  desc 'app', 'Setup a new API app'
+  def app
+    rrx_dev
+    update_base_classes
+    rails
+  end
+
+  private
+
+  def rails
+    directory 'config/initializers'
+  end
+
+  def rrx_dev
+    run 'bundle exec rrx_dev_setup app'
+  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
+end
+
+Setup.start

data/exe/sources/config/initializers/cors.rb

@@ -0,0 +1,21 @@
+require 'rack/cors'
+
+LOCALHOST_PATTERN = /\Ahttp:\/\/localhost(?::\d{4})?\z/.freeze
+
+Rails.application.config.middleware.insert_before 0, Rack::Cors do
+  allow do
+    origins do |source, env|
+      if Rails.env.development?
+        LOCALHOST_PATTERN.match? source
+      else
+        # TODO
+        true
+      end
+    end
+
+    resource '*',
+             headers: :any,
+             credentials: true,
+             methods: [:get, :post, :put, :patch, :delete, :options, :head]
+  end
+end

data/exe/sources/config/initializers/generators.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+Rails.application.config.generators do |g|
+  g.orm :active_record, primary_key_type: :uuid
+end
+
+

data/lib/rrx_api/railtie.rb

@@ -0,0 +1,44 @@
+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 Railtie < ::Rails::Engine
+    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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RrxApi
+  VERSION = "0.1.0"
+  RAILS_VERSION = "~> 7.0"
+end

data/lib/rrx_api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'rrx_api/version'
+require_relative 'rrx_api/railtie'
+require 'rrx_config'
+require 'rrx_logging'
+require 'rack/cors'
+
+module RrxApi
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/rrx_api.rbs

@@ -0,0 +1,4 @@
+module RRXApi
+  VERSION: String
+  RAILS_VERSION: String
+end