my_api_client 1.3.1 → 2.1.0

data/docker-compose.yml

@@ -0,0 +1,29 @@
+services:
+  my_api:
+    build:
+      context: ./my_api
+      dockerfile: Dockerfile
+    environment:
+      RAILS_ENV: development
+    volumes:
+      - ./my_api:/app
+    ports:
+      - "38080:3000"
+    healthcheck:
+      test: ["CMD", "curl", "-fsS", "http://localhost:3000/status/200"]
+      interval: 5s
+      timeout: 3s
+      retries: 20
+
+  test:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      MY_API_ENDPOINT: http://my_api:3000
+    volumes:
+      - .:/app
+    depends_on:
+      my_api:
+        condition: service_healthy
+    command: bash

data/docs/runbooks/dependabot_pr_auto_merge.md

@@ -0,0 +1,122 @@
+# Dependabot PR Review and Auto-Merge Runbook
+
+## Purpose
+This runbook standardizes how to review Dependabot pull requests for GitHub Actions updates and safely enable auto-merge.
+
+## Scope
+- Target: PRs created by Dependabot that update GitHub Actions versions (for example, `actions/upload-artifact`).
+- Primary workflow file in this repository: `.github/workflows/ci.yml`.
+- This runbook is for PR operation only, so creating a dedicated local work branch is normally unnecessary.
+
+## Prerequisites
+- `gh` CLI is authenticated and can access `ryz310/my_api_client`.
+- You have permission to comment on and merge PRs.
+- Branch protection rules and required checks are configured on GitHub.
+- Before starting the runbook, update local `master` and re-read `AGENTS.md`.
+
+```bash
+git checkout master
+git fetch origin
+git pull --ff-only origin master
+sed -n '1,260p' AGENTS.md
+```
+
+## Auto-merge workflow policy
+- Keep `package-ecosystem` decisions separated in `.github/workflows/dependabot-auto-merge.yml`.
+- Apply independent conditions for each ecosystem to avoid cross-ecosystem condition mixing.
+- For `bundler` ecosystem auto-merge:
+  - Verification apps (`rails_app/*` and `my_api`) are always auto-merged regardless of update type
+    (including major), because bundle update failures there do not affect the published gem and are
+    gated by CI/branch protection.
+  - Exception: a major update of the `rails` gem itself under `rails_app/*` is NOT auto-merged,
+    because a Rails major bump is treated as an explicit support-matrix decision that requires manual
+    review. Other gems' major updates under `rails_app/*` are still auto-merged.
+  - The gem itself (root `Gemfile`) is auto-merged only for `direct:development` dependencies on
+    non-major updates (patch/minor).
+- For `github-actions` ecosystem auto-merge, require all of the following:
+  - GitHub official actions only (`actions/*` or `github/*`)
+  - non-major updates only (patch/minor)
+  - no changes related to `permissions` or `pull_request_target`
+- CI pass/fail gating is controlled by branch protection and required checks on GitHub.
+
+## Step-by-step
+1. Open PR metadata and changed files.
+
+```bash
+gh pr view <PR_NUMBER> --json number,title,author,baseRefName,headRefName,files,body
+```
+
+2. Validate that the PR is in scope.
+- Confirm `author.login` is `app/dependabot`.
+- Confirm changed files are GitHub Actions workflow/dependabot update files and the update target is GitHub Actions.
+- If either condition is not met, stop this runbook and notify the user that manual review is required.
+
+3. Review the exact diff and identify action version changes.
+
+```bash
+gh pr diff <PR_NUMBER>
+```
+
+4. Summarize impact from the diff and release notes.
+- Explain what functional changes are introduced by each action version bump.
+- Explain whether existing workflows are affected (runtime requirements, minimum runner version, breaking changes, behavior changes such as credential handling).
+- For major version updates, verify compatibility notes in the official release notes.
+- Post this summary to the user and ask for explicit approval to proceed.
+
+5. Only after user approval, enable auto-merge.
+- Use repository default merge method unless there is an explicit instruction to force squash merge.
+
+```bash
+gh pr merge <PR_NUMBER> --auto
+# Optional (only when squash is explicitly required):
+# gh pr merge <PR_NUMBER> --auto --squash
+```
+
+6. Check merge state.
+
+```bash
+gh pr view <PR_NUMBER> --json state,mergeStateStatus,autoMergeRequest
+```
+
+7. If `mergeStateStatus` is `BEHIND`, post a Dependabot rebase comment (also only after user approval from Step 4).
+
+```bash
+gh pr comment <PR_NUMBER> --body "@dependabot rebase"
+```
+
+8. Re-check status until the branch is up to date and required checks pass.
+- After posting `@dependabot rebase`, wait 1 minute before retrying.
+- If rebase has not started after 1 minute (for example, `mergeStateStatus` is still `BEHIND`), post `@dependabot rebase` again.
+- Retry comment posting up to 2 times in total. If it is still `BEHIND` after the second retry, stop and escalate for manual follow-up.
+- Run each command step-by-step and inspect output after each `gh pr view` call before deciding the next action.
+
+```bash
+# Check current state
+gh pr view <PR_NUMBER> --json state,mergeStateStatus,statusCheckRollup,autoMergeRequest
+
+# If mergeStateStatus is BEHIND, wait 1 minute
+sleep 60
+
+# Re-check after waiting
+gh pr view <PR_NUMBER> --json state,mergeStateStatus,statusCheckRollup,autoMergeRequest
+
+# If still BEHIND, post @dependabot rebase (up to 2 retries total)
+# gh pr comment <PR_NUMBER> --body "@dependabot rebase"
+```
+
+## Done criteria
+- `autoMergeRequest` is enabled.
+- `mergeStateStatus` is not `BEHIND`.
+- Required CI checks are green.
+- PR is merged automatically, or clearly waiting only on pending required checks.
+- The user-approved impact summary is recorded in the operation log/comment thread.
+
+## Failure handling
+- If rebase does not start, wait 1 minute, confirm `mergeStateStatus` is still `BEHIND`, then re-run comment (up to 2 retries total):
+  - `@dependabot rebase`
+- Execute checks and retries sequentially (check -> wait -> re-check -> comment) rather than chaining commands without inspection.
+- If it is still `BEHIND` after 2 retries, stop automated retries and notify the user for manual follow-up.
+- If checks fail, inspect failing jobs and decide:
+  - fix in a follow-up PR, or
+  - close/ignore that update version with Dependabot commands.
+- If the update introduces breaking changes, disable auto-merge and switch to manual review with explicit test evidence.

data/gemfiles/rails_7.2.gemfile

@@ -9,7 +9,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gem 'activesupport', '~> 7.2.0'
 
 group :integrations, optional: true do
-  gem 'bugsnag', '>= 6.11.0'
+  gem 'bugsnag', '>= 6.19.0'
 end
 
 gemspec

data/gemfiles/{rails_7.1.gemfile → rails_8.0.gemfile}

@@ -6,10 +6,10 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'activesupport', '~> 7.1.0'
+gem 'activesupport', '~> 8.0.0'
 
 group :integrations, optional: true do
-  gem 'bugsnag', '>= 6.11.0'
+  gem 'bugsnag', '>= 6.19.0'
 end
 
 gemspec

data/gemfiles/{rails_6.1.gemfile → rails_8.1.gemfile}

@@ -6,10 +6,10 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'activesupport', '~> 6.1.0'
+gem 'activesupport', '~> 8.1.0'
 
 group :integrations, optional: true do
-  gem 'bugsnag', '>= 6.11.0'
+  gem 'bugsnag', '>= 6.19.0'
 end
 
 gemspec

data/lib/my_api_client/default_error_handlers.rb

@@ -31,7 +31,7 @@ module MyApiClient
       error_handling status_code: 417, raise: ClientError::ExpectationFailed
       error_handling status_code: 418, raise: ClientError::IamTeapot
       error_handling status_code: 421, raise: ClientError::MisdirectedRequest
-      error_handling status_code: 422, raise: ClientError::UnprocessableEntity
+      error_handling status_code: 422, raise: ClientError::UnprocessableContent
       error_handling status_code: 423, raise: ClientError::Locked
       error_handling status_code: 424, raise: ClientError::FailedDependency
       error_handling status_code: 425, raise: ClientError::TooEarly

data/lib/my_api_client/errors/client_error.rb

@@ -63,9 +63,13 @@ module MyApiClient
     # 421 Misdirected Request
     class MisdirectedRequest < ClientError; end
 
-    # 422 Unprocessable Entity
+    # 422 Unprocessable Entity (Deprecated)
     class UnprocessableEntity < ClientError; end
 
+    # 422 Unprocessable Content
+    class UnprocessableContent < UnprocessableEntity; end
+    deprecate_constant :UnprocessableEntity
+
     # 423 Locked
     class Locked < ClientError; end
 

data/lib/my_api_client/integrations/bugsnag.rb

@@ -11,7 +11,7 @@ module MyApiClient
 
       Bugsnag.leave_breadcrumb(
         "#{self.class.name} occurred",
-        metadata&.transform_values(&:inspect),
+        metadata,
         Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
       )
     end

data/lib/my_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  VERSION = '1.3.1'
+  VERSION = '2.1.0'
 end

data/lib/my_api_client.rb

@@ -33,7 +33,7 @@ require 'my_api_client/sleeper'
 # Loads gems for feature of integrations
 begin
   require 'bugsnag'
-  require 'my_api_client/integrations/bugsnag' if defined?(Bugsnag) && Bugsnag::VERSION >= '6.11.0'
+  require 'my_api_client/integrations/bugsnag' if defined?(Bugsnag) && Bugsnag::VERSION >= '6.19.0'
 rescue LoadError
   nil
 end

data/my_api/.ruby-version

@@ -1 +1 @@
-3.0.6
+4.0

data/my_api/AGENTS.md

@@ -0,0 +1,35 @@
+# my_api AGENTS.md
+
+## Current Stack Policy
+
+- `my_api/` is a Rails 8.1 API-only application.
+- Use the latest supported Ruby version for `my_api/`.
+- Keep these files aligned when Ruby or runtime settings change:
+  - `my_api/.ruby-version`
+  - `my_api/Dockerfile`
+  - `docker-compose.yml`
+  - `.github/workflows/ci.yml` (integration job)
+
+## API Compatibility Policy
+
+- Keep endpoint behavior compatible with integration specs under `spec/integrations/api_clients/`.
+- If endpoint behavior changes, update both:
+  - `my_api/app/controllers/*`
+  - related specs in `spec/integrations/api_clients/*_spec.rb`
+- Keep an HTTP mapping comment above each controller action in this format:
+  - `# GET /path`
+  - `# POST /path`
+  - `# PUT/PATCH /path/:id`
+  - `# DELETE /path/:id`
+
+## Test Execution Policy
+
+- Run real HTTP integration tests with Docker Compose:
+  1. `docker compose up -d --build my_api`
+  2. `docker compose run --rm test`
+  3. `docker compose down --volumes --remove-orphans`
+
+## Implementation Scope Policy
+
+- Do not reintroduce Ruby on Jets specific dependencies or configuration.
+- Keep `my_api/` focused on fixture endpoints for `my_api_client` integration tests.

data/my_api/Dockerfile

@@ -0,0 +1,25 @@
+# syntax=docker/dockerfile:1
+
+ARG RUBY_VERSION=4.0
+FROM ruby:${RUBY_VERSION}-slim
+
+WORKDIR /app
+
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential curl git libyaml-dev pkg-config && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+ENV BUNDLE_PATH=/usr/local/bundle \
+    BUNDLE_JOBS=4 \
+    BUNDLE_RETRY=3
+
+RUN gem install bundler -v "~> 2.0"
+
+COPY Gemfile Gemfile.lock /app/
+RUN bundle install
+
+COPY . /app
+
+EXPOSE 3000
+
+CMD ["bundle", "exec", "rackup", "-o", "0.0.0.0", "-p", "3000"]

data/my_api/Gemfile

@@ -2,25 +2,14 @@
 
 source 'https://rubygems.org'
 
-gem 'jets', '~> 4.0.10'
+gem 'puma', '>= 6.0'
+gem 'rails', '~> 8.1.3'
 
-gem 'dynomite'
-
-# See: https://github.com/boltops-tools/jets/issues/523
-gem 'nokogiri', '~> 1.17.2'
-
-# development and test groups are not bundled as part of the deployment
 group :development, :test do
-  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
-  gem 'byebug', platforms: %i[mri mingw x64_mingw]
-  gem 'puma'
-  gem 'rack'
-  gem 'shotgun'
+  gem 'rspec-rails'
 end
 
 group :test do
-  gem 'capybara'
-  gem 'launchy'
-  gem 'rspec'
-  gem 'rspec_junit_formatter'
+  gem 'simplecov'
+  gem 'simplecov_json_formatter'
 end