my_api_client 1.3.1 → 2.0.0

data/my_api/app/controllers/header_controller.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
-# The header API
+# Header endpoint used to test response header-based error handling.
 class HeaderController < ApplicationController
-  # GET header
+  # GET /header
   def index
-    params.each do |header_name, header_value|
+    params.to_unsafe_h.each do |header_name, header_value|
+      next unless header_name.start_with?('X-')
+
       response.set_header(header_name, header_value)
     end
+
     render status: :ok, json: {}
   end
 end

data/my_api/app/controllers/pagination_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# A Pagination API
+# Pagination endpoint that serves three linked pages for paging tests.
 class PaginationController < ApplicationController
-  # GET pagination
+  # GET /pagination
   def index
     case params[:page]&.to_s
     when '1', nil
@@ -20,9 +20,7 @@ class PaginationController < ApplicationController
 
   def first_page
     {
-      links: {
-        next: page_link(2),
-      },
+      links: { next: page_link(2) },
       page: 1,
     }
   end
@@ -39,20 +37,12 @@ class PaginationController < ApplicationController
 
   def third_page
     {
-      links: {
-        previous: page_link(2),
-      },
+      links: { previous: page_link(2) },
       page: 3,
     }
   end
 
-  # NOTE: `#pagination_url` returns `http://xxxxx.execute-api.ap-northeast-1.amazonaws.com/pagination`
-  #       but it should be `https://xxxxx.execute-api.ap-northeast-1.amazonaws.com/dev/pagination`.
-  #       So this is workaround.
   def page_link(page)
-    query_strings = "?#{{ page: }.to_query}"
-    uri = File.join(ENV.fetch('JETS_HOST', nil), ENV.fetch('JETS_STAGE', nil), pagination_path)
-    uri.sub!('http://', 'https://')
-    URI.join(uri, query_strings)
+    "#{request.base_url}#{pagination_path(page: page)}"
   end
 end

data/my_api/app/controllers/rest_controller.rb

@@ -1,33 +1,31 @@
 # frozen_string_literal: true
 
-# A REST API
+# REST endpoints for integration test fixtures.
 class RestController < ApplicationController
-  # GET rest
+  # GET /rest
   def index
     result = params[:order] == 'desc' ? posts.reverse : posts
     render status: :ok, json: result
   end
 
-  # GET rest/:id
+  # GET /rest/:id
   def show
     render status: :ok, json: find_post(id:)
   end
 
-  # POST rest
+  # POST /rest
   def create
-    render status: :created,
-           json: create_post(title: params[:title])
+    render status: :created, json: create_post(title: params[:title])
   end
 
-  # POST/PUT/PATCH rest/:id
+  # PUT/PATCH /rest/:id
   def update
-    render status: :ok,
-           json: update_post(id:, title: params[:title])
+    render status: :ok, json: update_post(id:, title: params[:title])
   end
 
-  # DELETE rest/:id
-  def delete
-    render status: :no_content
+  # DELETE /rest/:id
+  def destroy
+    render status: :ok, json: nil
   end
 
   private
@@ -45,7 +43,7 @@ class RestController < ApplicationController
   end
 
   def find_post(id:)
-    posts.find { |p| p[:id] == id }
+    posts.find { |post| post[:id] == id }
   end
 
   def create_post(title:)
@@ -53,8 +51,6 @@ class RestController < ApplicationController
   end
 
   def update_post(id:, title:)
-    find_post(id:).tap do |post|
-      post[:title] = title
-    end
+    find_post(id:).tap { |post| post[:title] = title }
   end
 end

data/my_api/app/controllers/status_controller.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-# THe status API
+# Status endpoint that echoes requested HTTP status code.
 class StatusController < ApplicationController
-  # GET status/:status
+  # GET /status/:status
   def show
     status = params[:status].to_i
-    render status:,
-           json: { message: "You requested status code: #{status}" }
+    render status:, json: { message: "You requested status code: #{status}" }
   end
 end

data/my_api/config/application.rb

@@ -1,73 +1,18 @@
 # frozen_string_literal: true
 
-Jets.application.configure do
-  config.project_name = 'my_api'
-  config.mode = 'api'
+require_relative 'boot'
 
-  config.prewarm.enable = true # default is true
-  # config.prewarm.rate = '30 minutes' # default is '30 minutes'
-  # config.prewarm.concurrency = 2 # default is 2
-  # config.prewarm.public_ratio = 3 # default is 3
+require 'rails'
+require 'active_model/railtie'
+require 'active_job/railtie'
+require 'action_controller/railtie'
 
-  # config.env_extra = 2 # can also set this with JETS_ENV_EXTRA
-  # config.autoload_paths = []
+Bundler.require(*Rails.groups)
 
-  # config.asset_base_url = 'https://cloudfront.domain.com/assets' # example
-
-  # config.cors = true # for '*'' # defaults to false
-  # config.cors = '*.mydomain.com' # for specific domain
-
-  # config.function.timeout = 30 # defaults to 30
-  # config.function.role = "arn:aws:iam::#{Jets.aws.account}:role/service-role/pre-created"
-  # config.function.memory_size = 1536
-
-  # Default is 'EDGE'
-  # https://docs.aws.amazon.com/apigateway/api-reference/link-relation/restapi-create/#endpointConfiguration
-  # config.api.endpoint_type = 'PRIVATE'
-
-  # config.function.environment = {
-  #   global_app_key1: "global_app_value1",
-  #   global_app_key2: "global_app_value2",
-  # }
-  # More examples:
-  # config.function.dead_letter_config = { target_arn: "arn" }
-  # config.function.vpc_config = {
-  #   security_group_ids: %w[sg-1 sg-2],
-  #   subnet_ids: %w[subnet-1 subnet-2],
-  # }
-  # The config.function settings to the CloudFormation Lambda Function properties.
-  # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html
-  # Underscored format can be used for keys to make it look more ruby-ish.
-
-  # Assets settings
-  # The config.assets.folders are folders within the public folder that will be set
-  # to public-read on s3 and served directly. IE: public/assets public/images public/packs
-  # config.assets.folders = %w[assets images packs]
-  # config.assets.max_age = 3600 # when to expire assets
-  #
-  # # IE: "public, max-age=3600" # override max_age for more fine-grain control.
-  # config.assets.cache_control = nil
-  #
-  # IE: https://cloudfront.com/my/base/path, defaults to the s3 bucket url
-  # IE: https://s3-us-west-2.amazonaws.com/demo-dev-s3bucket-1inlzkvujq8zb
-  # config.assets.base_url = nil
-  #
-
-  # config.api.endpoint_type = 'PRIVATE' # Default is 'EDGE' https://amzn.to/2r0Iu2L
-  # config.api.authorization_type = "AWS_IAM" # default is 'NONE' https://amzn.to/2qZ7zLh
-
-  # More info: http://rubyonjets.com/docs/routing/custom-domain/
-  # config.domain.hosted_zone_name = "example.com"
-  # us-west-2 REGIONAL endpoint - takes 2 minutes
-  # config.domain.cert_arn = "arn:aws:acm:us-west-2:112233445566:certificate/8d8919ce-a710-4050-976b-b33da991e123"
-  # us-east-1 EDGE endpoint - takes 10-15 minutes
-  # config.domain.cert_arn = "arn:aws:acm:us-east-1:112233445566:certificate/d68472ba-04f8-45ba-b9db-14f839d57123"
-  # config.domain.endpoint_type = "EDGE"
-
-  # By default logger needs to log to $stderr for CloudWatch to receive Lambda messages, but for
-  # local testing environment you may want to log these messages to 'test.log' file to keep your
-  # testing suite output readable.
-  # config.logger = Jets::Logger.new($strerr)
-
-  config.controllers.default_protect_from_forgery = false
+module MyApi
+  # Rails API application used for integration testing endpoints.
+  class Application < Rails::Application
+    config.load_defaults 8.1
+    config.api_only = true
+  end
 end

data/{rails_app/rails_6.1 → my_api}/config/boot.rb

@@ -2,4 +2,4 @@
 
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
-require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bundler/setup'

data/{rails_app/rails_7.1 → my_api}/config/environment.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# Load the Rails application.
 require_relative 'application'
 
-# Initialize the Rails application.
 Rails.application.initialize!

data/my_api/config/environments/development.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-Jets.application.configure do
-  # Example:
-  # config.function.memory_size = 1536
-
-  # config.action_mailer.raise_delivery_errors = false
-  # Docs: http://rubyonjets.com/docs/email-sending/
+Rails.application.configure do
+  config.enable_reloading = true
+  config.eager_load = false
+  config.consider_all_requests_local = true
+  config.log_level = :debug
+  config.hosts.clear
 end

data/my_api/config/environments/production.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
-Jets.application.configure do
-  # Example:
-  # config.function.memory_size = 2048
-
-  # Ignore bad email addresses and do not raise email delivery errors.
-  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
-  # Docs: http://rubyonjets.com/docs/email-sending/
-  # config.action_mailer.raise_delivery_errors = false
+Rails.application.configure do
+  config.enable_reloading = false
+  config.eager_load = true
+  config.consider_all_requests_local = false
+  config.log_level = ENV.fetch('RAILS_LOG_LEVEL', 'info')
 end

data/my_api/config/environments/test.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-Jets.application.configure do
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  # Docs: http://rubyonjets.com/docs/email-sending/
-  config.action_mailer.delivery_method = :test
+Rails.application.configure do
+  config.enable_reloading = false
+  config.eager_load = ENV['CI'].present?
+  config.consider_all_requests_local = true
+  config.log_level = :warn
 end

data/my_api/config/routes.rb

@@ -1,18 +1,10 @@
 # frozen_string_literal: true
 
-Jets.application.routes.draw do
-  root 'jets/public#show'
-
-  resources 'rest', only: %i[index show create update delete]
+Rails.application.routes.draw do
+  resources :rest, only: %i[index show create update destroy]
 
   get 'status/:status', to: 'status#show'
   get 'header', to: 'header#index'
   get 'error/:code', to: 'error#show'
   get 'pagination', to: 'pagination#index'
-
-  # The jets/public#show controller can serve static utf8 content out of the public folder.
-  # Note, as part of the deploy process Jets uploads files in the public folder to s3
-  # and serves them out of s3 directly. S3 is well suited to serve static assets.
-  # More info here: https://rubyonjets.com/docs/extras/assets-serving/
-  any '*catchall', to: 'jets/public#show'
 end

data/my_api/config.ru

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# This file is used by Rack-based servers to start the application.
+require_relative 'config/environment'
 
-require 'jets'
-Jets.boot
-run Jets.application
+run Rails.application

data/my_api/public/index.html

@@ -1,91 +1,11 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Ruby on Jets</title>
-  <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width">
-  <style type="text/css" media="screen" charset="utf-8">
-    body {
-      text-align: center;
-      margin: 0;
-    }
-    img {
-      max-width: 320px;
-    }
-    .container {
-      max-width: 648px;
-    }
-    @media (min-width: 768px) {
-      img {
-        max-width: none;
-      }
-      .container {
-        max-width: none;
-      }
-    }
-
-    .header {
-      padding: 20px;
-      /*background-color: #b81513;*/
-      /*color: white;*/
-    }
-    .title {
-      font-size: 1.5em;
-    }
-    @media (max-width: 500px) {
-      .title {
-        font-size: 1.3em;
-      }
-    }
-    .intro {
-      text-align: left;
-      font-size: large;
-      margin: 0 auto;
-      padding: 0 20px;
-      max-width: 640px;
-    }
-    pre, code {
-      padding: 0;
-      margin: 0;
-    }
-    pre {
-      margin-left: 20px;
-      width: 99%;
-      overflow: auto;
-    }
-    @media (max-width: 500px) {
-      pre {
-        margin-left: -30px;
-        font-size: 0.8em;
-      }
-    }
-  </style>
-</head>
-
-<body>
-  <div class="container">
-    <header class="header">
-      <img src="https://s3.amazonaws.com/jets-public/jets/images/jets.png" class="logo" alt="logo" />
-      <h1 class="title">Welcome and congrats!<br /> Jets is running.</h1>
-    </header>
-    <div class="intro">
-      <p>
-        To get started:
-      </p>
-      <div class="code"><pre><code>
-        $ jets generate scaffold post title:string
-        $ jets db:create db:migrate
-        $ jets server
-        $ open http://localhost:8888/posts
-        $ jets help
-      </code></pre></div>
-      <p>More on info: <a href="http://rubyonjets.com">rubyonjets.com</a></p>
-      <p>Also check out the <a href="http://rubyonjets.com/reference">Jets CLI reference</a>.</p>
-    </div>
-    <p class="version">
-      <strong>Jets version:</strong> 4.0<br />
-      <strong>Ruby version:</strong> 3.2
-    </p>
-  </div>
-</body>
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>My API</title>
+  </head>
+  <body>
+    <h1>My API is running</h1>
+  </body>
 </html>

data/{rails_app/rails_7.0 → my_api}/spec/rails_helper.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../config/environment', __dir__)
+require_relative '../config/environment'
 abort('The Rails environment is running in production mode!') if Rails.env.production?
+
 require 'rspec/rails'
-require 'my_api_client/rspec'
 
 RSpec.configure do |config|
-  # config.use_active_record = false # [Workaround] See: https://github.com/rspec/rspec-rails/issues/2417
+  config.use_transactional_fixtures = false
   config.infer_spec_type_from_file_location!
   config.filter_rails_from_backtrace!
 end

data/my_api/spec/requests/error_controller_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe ErrorController do
+  # GET /error/:code
+  it 'returns bad request with error payload' do
+    get '/error/10'
+
+    expect(response).to have_http_status(:bad_request)
+    expect(JSON.parse(response.body)).to eq(
+      'error' => {
+        'code' => 10,
+        'message' => 'You requested error code: 10',
+      }
+    )
+  end
+end

data/my_api/spec/requests/pagination_controller_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe PaginationController do
+  # GET /pagination
+  it 'returns first page with next link' do
+    get '/pagination', params: { page: 1 }
+
+    expect(response).to have_http_status(:ok)
+    json = JSON.parse(response.body)
+    expect(json.fetch('page')).to eq(1)
+    expect(json.dig('links', 'next')).to end_with('/pagination?page=2')
+  end
+
+  # GET /pagination
+  it 'returns not found for unsupported pages' do
+    get '/pagination', params: { page: 4 }
+
+    expect(response).to have_http_status(:not_found)
+  end
+end

data/my_api/spec/requests/rest_controller_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RestController do
+  # GET /rest
+  it 'returns posts in ascending order by default' do
+    get '/rest'
+
+    expect(response).to have_http_status(:ok)
+    json = JSON.parse(response.body)
+    expect(json.map { |post| post['id'] }).to eq([1, 2, 3])
+  end
+
+  # DELETE /rest/:id
+  it 'returns null payload for delete endpoint' do
+    delete '/rest/1'
+
+    expect(response).to have_http_status(:ok)
+    expect(JSON.parse(response.body)).to be_nil
+  end
+end

data/my_api/spec/requests/status_controller_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe StatusController do
+  # GET /status/:status
+  it 'echoes requested status and message' do
+    get '/status/200'
+
+    expect(response).to have_http_status(:ok)
+    expect(JSON.parse(response.body)).to eq('message' => 'You requested status code: 200')
+  end
+
+  # GET /status/:status
+  it 'returns requested non-200 status code' do
+    get '/status/404'
+
+    expect(response).to have_http_status(:not_found)
+  end
+end

data/my_api/spec/spec_helper.rb

@@ -1,31 +1,23 @@
 # frozen_string_literal: true
 
-ENV['JETS_TEST'] = '1'
-ENV['JETS_ENV'] ||= 'test'
-ENV['JETS_STAGE'] ||= 'test'
-# Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
-ENV['HOME'] = 'spec/fixtures/home'
+require 'simplecov'
+require 'simplecov_json_formatter'
 
-require 'byebug'
-require 'fileutils'
-require 'jets'
+SimpleCov.command_name(ENV.fetch('SIMPLECOV_COMMAND_NAME', 'my_api_rspec'))
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::JSONFormatter,
+]
+SimpleCov.start
 
-abort('The Jets environment is running in production mode!') if Jets.env == 'production'
-Jets.boot
-
-require 'jets/spec_helpers'
-
-# Rspec helper module
-module Helpers
-  def payload(name)
-    JSON.parse(File.read("spec/fixtures/payloads/#{name}.json"))
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
-end
 
-RSpec.configure do |c|
-  c.include Helpers
-end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
 
-Jets.application.configure do
-  config.helpers.host = 'https://example.com'
+  config.shared_context_metadata_behavior = :apply_to_host_groups
 end

data/my_api_client.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 3.1.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
-  spec.add_dependency 'activesupport', '>= 6.1.0'
+  spec.add_dependency 'activesupport', '>= 7.2.0'
   spec.add_dependency 'faraday', '>= 0.17.1'
   spec.add_dependency 'jsonpath'
   spec.add_dependency 'sawyer', '>= 0.8.2'

data/rails_app/AGENTS.md

@@ -0,0 +1,13 @@
+# AGENTS.md (rails_app)
+
+## Rails Verification App Policy
+- For a new Rails major/minor verification environment, generate it with `rails new` first instead of copying from another version directory.
+- Keep the generated app close to Rails defaults, then apply only the minimum project-specific changes needed for CI verification.
+- Minimum project-specific changes:
+  - Add `gem 'my_api_client', path: '../..'` to the app Gemfile.
+  - Add `gem 'rspec-rails'` and required `spec/` helpers so `verify_generator` can run RSpec.
+  - For Ruby 4.0+ compatibility in generator verification, add `gem 'benchmark'` and `gem 'cgi'` to the app Gemfile when required by Rails/runtime.
+  - Remove nested `.git` created by `rails new` under `rails_app/rails_*`.
+- Development baseline rule in this repository also applies here:
+  - Use the oldest supported Ruby/Rails major-minor.
+  - Patch versions can be the latest available within that baseline.

data/rails_app/rails_7.2/Dockerfile

@@ -5,7 +5,7 @@
 # docker run -d -p 80:80 -p 443:443 --name my-app -e RAILS_MASTER_KEY=<value from config/master.key> my-app
 
 # Make sure RUBY_VERSION matches the Ruby version in .ruby-version
-ARG RUBY_VERSION=3.1.6
+ARG RUBY_VERSION=3.2.9
 FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
 
 # Rails app lives here

data/rails_app/rails_7.2/Gemfile

@@ -3,6 +3,8 @@
 source 'https://rubygems.org'
 
 gem 'my_api_client', path: '../..'
+gem 'benchmark'
+gem 'cgi'
 gem 'puma', '>= 5.0'
 gem 'rails', '~> 7.2.1'
 gem 'sqlite3', '>= 1.4'