my_api_client 1.3.1 → 2.0.0

data/AGENTS.md

@@ -0,0 +1,128 @@
+# AGENTS.md
+
+## Branch Creation Rule
+
+- Always create a new branch from `master`.
+- Before creating a branch, update local `master` with the latest commits from `origin`.
+- After updating local `master`, reload and re-read `AGENTS.md` before starting any new task.
+- Example flow:
+  1. `git checkout master`
+  2. `git fetch origin`
+  3. `git pull --ff-only origin master`
+  4. Re-open `AGENTS.md` and confirm instructions
+  5. `git checkout -b codex/<new-branch-name>`
+
+## Development Version Policy
+
+- In development environments, always use the oldest versions among currently supported Ruby and Rails.
+- Current baseline: Ruby 3.2 and Rails 7.2.
+- Patch versions may be updated to the latest available releases within the selected baseline (e.g., Ruby 3.2.x and Rails 7.2.x).
+- When updating support policy, also update `.ruby-version`, `Dockerfile` (`ARG RUBY_VERSION` and `BUNDLE_GEMFILE`), and development Dockerfiles under `rails_app/`.
+
+## Support Matrix Update Procedure
+
+- Decide target support matrix first (Ruby and Rails versions to keep/add/remove).
+- Update `my_api_client.gemspec`:
+  - `required_ruby_version`
+  - `activesupport` minimum version
+- Update CI matrix in `.github/workflows/ci.yml`:
+  - `build_gem.strategy.matrix.ruby_version` / `rails_version`
+  - `verify_generator.strategy.matrix.ruby_version` / `rails_version`
+  - update representative matrix-gated conditions (e.g. coverage/upload conditions) to the intended runtime/framework pair
+- Check other workflows under `.github/workflows/` for fixed Ruby versions and align them when support policy changes.
+- Update supported versions in:
+  - `README.md`
+- Keep development baseline files aligned:
+  - `.ruby-version`
+  - `Dockerfile` (`ARG RUBY_VERSION`)
+  - `rails_app/*/Dockerfile` (`ARG RUBY_VERSION`) for supported Rails verification apps
+- Keep verification assets aligned with supported Rails:
+  - remove unsupported `gemfiles/rails_*.gemfile`
+  - remove unsupported `rails_app/rails_*` directories
+  - keep only supported Rails verification app directories
+- Validate before commit:
+  - `docker run --rm -v "$PWD":/app -w /app my_api_client-dev bundle exec rspec`
+  - `docker run --rm -v "$PWD":/app -w /app my_api_client-dev bundle exec rubocop`
+  - `docker run --rm -v "$PWD":/app -w /app my_api_client-dev bundle exec rake build`
+- If any `rails_app/rails_*/Gemfile.lock` drifts from gemspec constraints, sync at least the `my_api_client` entry (`version` and `activesupport` lower bound).
+
+## Docker Development Commands
+
+- Command selection policy:
+  - Use `docker compose` for integration specs that require the `my_api` server.
+  - Use `docker run` for lint, build, and local non-integration spec execution.
+- Build development image:
+  - `docker build -t my_api_client-dev .`
+- Open a shell in the container (mount local source):
+  - `docker run --rm -it -v "$PWD":/app -w /app my_api_client-dev bash`
+- Install/update gems:
+  - `docker run --rm -it -v "$PWD":/app -w /app my_api_client-dev bundle install`
+- Run all specs:
+  - `docker run --rm -it -v "$PWD":/app -w /app my_api_client-dev bundle exec rspec`
+- Run integration specs with real HTTP:
+  - `docker compose up -d --build my_api`
+  - `docker compose run --rm test bundle exec rspec`
+  - (integration only) `docker compose run --rm test bundle exec rspec spec/integrations/api_clients`
+  - (my_api request specs) `docker compose run --rm my_api bundle exec rspec spec/requests`
+  - `docker compose down --volumes --remove-orphans`
+- Run RuboCop:
+  - `docker run --rm -it -v "$PWD":/app -w /app my_api_client-dev bundle exec rubocop`
+- Build gem package:
+  - `docker run --rm -it -v "$PWD":/app -w /app my_api_client-dev bundle exec rake build`
+- Install gem locally in container:
+  - `docker run --rm -it -v "$PWD":/app -w /app my_api_client-dev bundle exec rake install`
+
+## Validation Rule
+
+- Run RuboCop and confirm there are no offenses only when `.rb` files are changed.
+
+## Retrospective Rule
+
+- Propose a KPT retrospective when a task reaches a completion point, such as after creating a Pull Request.
+- Based on the KPT results, propose updates to `AGENTS.md`.
+- The timing of the retrospective may be decided by Codex when it is appropriate.
+- Output destination rule: KPT content must be shared only in this Codex conversation unless the user explicitly requests another destination.
+- Do not post KPT content to GitHub comments/issues/PRs unless the user explicitly requests it.
+
+## README Update Checklist
+
+- When editing `README.md`, run a typo/consistency sweep before finishing.
+- Check common typo patterns: `api_clinet`, `erros`, `reqest`, `resouce`.
+- Verify sample request parameters match method signatures and examples (e.g. query/body keys).
+- Verify JSONPath examples match sample JSON structures (e.g. `links` vs `link`).
+- When removing or renaming documentation files, run `rg -n "<old-file-name>" --glob "*.md"` and resolve remaining references before finishing.
+
+## Documentation Language Policy
+
+- `README.md` is the single source of truth for repository documentation.
+- Do not add language-specific README copies (for example `README.jp.md`).
+- For Japanese reading support, rely on browser translation features instead of maintaining duplicate files.
+
+## Pull Request Description Rule
+
+- In PR descriptions, include a `Purpose of this change` section that explains why the change is needed, not only what changed.
+
+## GitHub CLI Body Safety
+
+- When using `gh pr create`, `gh pr comment`, or similar commands with markdown body text, avoid inline shell strings that include backticks.
+- Prefer one of the following:
+  - Use plain text without backticks in inline `--body`.
+  - Write the body to a temporary file and pass it via file-based options (or equivalent safe method) to prevent shell command substitution.
+
+## Runbook
+
+- Dependabot PR review and auto-merge operation steps are documented in `docs/runbooks/dependabot_pr_auto_merge.md`.
+
+## CHANGELOG Organization Rule
+
+- Follow the format of past versions in `CHANGELOG.md`.
+- Use `-` for bullet list items (not `*`).
+- Categorize entries under these headings, keeping only the headings that have entries (omit empty ones):
+  `Feature`, `Bugfix`, `Security`, `Breaking Change`, `Rubocop Challenge`, `Dependabot`, `Misc`.
+- Keep the category order above.
+- Dependabot section:
+  - List only bumps for the gem itself (root `Gemfile` / `.github/workflows`).
+  - Do NOT list bumps under `rails_app/*` or `my_api` (verification/test apps).
+  - When the same gem is bumped multiple times within a release, keep a single entry and merge the version range from the earliest `from` to the latest `to` (e.g. `Bump bugsnag from 6.27.1 to 6.30.0`).
+- Only a change that breaks backward compatibility goes under `Breaking Change`.
+  A rename that keeps backward compatibility (e.g. via an alias) is a `Feature`, not a breaking change.

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Change log
 
+## v2.0.0 (Jul 21, 2026)
+
+This major release marks the shift to an AI-assisted (agent-driven) development workflow.
+The development environment, CI/CD, and contribution guidelines were reorganized around AI
+coding agents (see `AGENTS.md`), which is the primary reason for the major version bump.
+
+### Feature
+
+- [#1153](https://github.com/ryz310/my_api_client/pull/1153) Rename from UnprocessableEntity to UnprocessableContent ([@ashimomura](https://github.com/ashimomura))
+
+### Bugfix
+
+- [#1276](https://github.com/ryz310/my_api_client/pull/1276) Stop stringifying the metadata left in the Bugsnag breadcrumb ([@masakiq](https://github.com/masakiq))
+
+### Dependabot
+
+- [#1111](https://github.com/ryz310/my_api_client/pull/1111) Bump rexml from 3.4.1 to 3.4.2 ([@ryz310](https://github.com/ryz310))
+- [#1114](https://github.com/ryz310/my_api_client/pull/1114) Bump faraday from 2.13.1 to 2.14.0 ([@ryz310](https://github.com/ryz310))
+- [#1117](https://github.com/ryz310/my_api_client/pull/1117) Bump rubocop-performance from 1.25.0 to 1.26.1 ([@ryz310](https://github.com/ryz310))
+- [#1119](https://github.com/ryz310/my_api_client/pull/1119) Bump rspec from 3.13.1 to 3.13.2 ([@ryz310](https://github.com/ryz310))
+- [#1121](https://github.com/ryz310/my_api_client/pull/1121) Bump sawyer from 0.9.2 to 0.9.3 ([@ryz310](https://github.com/ryz310))
+- [#1128](https://github.com/ryz310/my_api_client/pull/1128) Bump rubocop-rspec_rails from 2.31.0 to 2.32.0 ([@ryz310](https://github.com/ryz310))
+- [#1161](https://github.com/ryz310/my_api_client/pull/1161) Bump pry-byebug from 3.11.0 to 3.12.0 ([@ryz310](https://github.com/ryz310))
+- [#1184](https://github.com/ryz310/my_api_client/pull/1184) Bump actions/upload-artifact from 6 to 7 ([@ryz310](https://github.com/ryz310))
+- [#1183](https://github.com/ryz310/my_api_client/pull/1183) Bump actions/download-artifact from 4 to 8 ([@ryz310](https://github.com/ryz310))
+- [#1214](https://github.com/ryz310/my_api_client/pull/1214) Bump webmock from 3.25.1 to 3.26.2 ([@ryz310](https://github.com/ryz310))
+- [#1216](https://github.com/ryz310/my_api_client/pull/1216) Bump activesupport from 7.2.2.1 to 8.1.3 ([@ryz310](https://github.com/ryz310))
+- [#1236](https://github.com/ryz310/my_api_client/pull/1236) Bump bugsnag from 6.27.1 to 6.30.0 ([@ryz310](https://github.com/ryz310))
+- [#1235](https://github.com/ryz310/my_api_client/pull/1235) Bump rake from 13.3.0 to 13.4.1 ([@ryz310](https://github.com/ryz310))
+- [#1298](https://github.com/ryz310/my_api_client/pull/1298) Bump yard from 0.9.37 to 0.9.45 ([@ryz310](https://github.com/ryz310))
+
+### Misc
+
+- [#1133](https://github.com/ryz310/my_api_client/pull/1133) Migrate CI from CircleCI to GitHub Actions ([@ryz310](https://github.com/ryz310))
+- [#1134](https://github.com/ryz310/my_api_client/pull/1134) Set up Docker-based development environment ([@ryz310](https://github.com/ryz310))
+- [#1135](https://github.com/ryz310/my_api_client/pull/1135) Update support matrix (Ruby 3.2-4.0 / Rails 7.2-8.1) ([@ryz310](https://github.com/ryz310))
+- [#1136](https://github.com/ryz310/my_api_client/pull/1136) Migrate CI coverage upload from Code Climate to Qlty ([@ryz310](https://github.com/ryz310))
+- [#1137](https://github.com/ryz310/my_api_client/pull/1137) Add Dependabot auto-merge workflow for dev patch updates ([@ryz310](https://github.com/ryz310))
+- [#1142](https://github.com/ryz310/my_api_client/pull/1142) Adjust CI triggers and SimpleCov spec filtering ([@ryz310](https://github.com/ryz310))
+- [#1143](https://github.com/ryz310/my_api_client/pull/1143) Add KPT retrospective rule and extend Dependabot dev auto-merge ([@ryz310](https://github.com/ryz310))
+- [#1144](https://github.com/ryz310/my_api_client/pull/1144) Migrate my_api from Jets to Rails 8.1 with compose-based CI integration ([@ryz310](https://github.com/ryz310))
+- [#1155](https://github.com/ryz310/my_api_client/pull/1155) Fix my_api compose build to honor Gemfile.lock ([@ryz310](https://github.com/ryz310))
+- [#1156](https://github.com/ryz310/my_api_client/pull/1156) Enable PR CI for external contributors and split release workflow ([@ryz310](https://github.com/ryz310))
+- [#1157](https://github.com/ryz310/my_api_client/pull/1157) Fix Dependabot auto-merge workflow in non-checkout context ([@ryz310](https://github.com/ryz310))
+- [#1158](https://github.com/ryz310/my_api_client/pull/1158) Consolidate Dependabot config and remove redundant rails_app files ([@ryz310](https://github.com/ryz310))
+- [#1175](https://github.com/ryz310/my_api_client/pull/1175) Adjust Dependabot auto-merge conditions for rails_app ([@ryz310](https://github.com/ryz310))
+- [#1177](https://github.com/ryz310/my_api_client/pull/1177) Add runbook for Dependabot PR auto-merge workflow ([@ryz310](https://github.com/ryz310))
+- [#1178](https://github.com/ryz310/my_api_client/pull/1178) Refine dependabot auto-merge runbook procedure ([@ryz310](https://github.com/ryz310))
+- [#1179](https://github.com/ryz310/my_api_client/pull/1179) docs: clarify Dependabot rebase retry procedure ([@ryz310](https://github.com/ryz310))
+- [#1180](https://github.com/ryz310/my_api_client/pull/1180) docs: complete README WIP sections and refine wording ([@ryz310](https://github.com/ryz310))
+- [#1181](https://github.com/ryz310/my_api_client/pull/1181) Consolidate README docs and remove README.jp.md ([@ryz310](https://github.com/ryz310))
+- [#1187](https://github.com/ryz310/my_api_client/pull/1187) Split Dependabot auto-merge logic by ecosystem ([@ryz310](https://github.com/ryz310))
+- [#1308](https://github.com/ryz310/my_api_client/pull/1308) Switch release workflow to RubyGems Trusted Publishing ([@ryz310](https://github.com/ryz310))
+
 ## v1.3.1 (Jun 10, 2025)
 
 ### Misc
@@ -411,10 +465,8 @@ See: https://github.com/ryz310/my_api_client/blob/master/lib/my_api_client/defau
 ### Feature
 
 - [#220](https://github.com/ryz310/my_api_client/pull/220) Pageable HTTP request ([@ryz310](https://github.com/ryz310))
-
   - Add `#pageable_get` method (alias: `#pget`)
   - For example:
-
     - API client definition
 
       ```ruby

data/CLAUDE.md

@@ -0,0 +1,6 @@
+# CLAUDE.md
+
+This project shares its agent instructions across tools. Claude Code follows the
+same guidelines documented for Codex in `AGENTS.md`.
+
+@AGENTS.md

data/Dockerfile

@@ -0,0 +1,22 @@
+# syntax=docker/dockerfile:1
+
+ARG RUBY_VERSION=3.2.9
+FROM ruby:${RUBY_VERSION}-slim
+
+WORKDIR /app
+
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git && \
+    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 . /app
+
+RUN bundle install
+
+CMD ["bash"]

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 group :integrations, optional: true do
-  gem 'bugsnag', '>= 6.11.0'
+  gem 'bugsnag', '>= 6.19.0'
 end
 
 # Specify your gem's dependencies in my_api_client.gemspec

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    my_api_client (1.3.1)
-      activesupport (>= 6.1.0)
+    my_api_client (2.0.0)
+      activesupport (>= 7.2.0)
       faraday (>= 0.17.1)
       jsonpath
       sawyer (>= 0.8.2)
@@ -10,118 +10,126 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.2.1)
+    activesupport (8.1.3)
       base64
-      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
       logger (>= 1.4.2)
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+      uri (>= 0.13.1)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
-    benchmark (0.4.1)
-    bigdecimal (3.2.2)
-    bugsnag (6.27.1)
+    bigdecimal (4.1.2)
+    bugsnag (6.30.0)
       concurrent-ruby (~> 1.0)
-    byebug (12.0.0)
+    byebug (13.0.0)
+      reline (>= 0.6.0)
     coderay (1.1.3)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
-    crack (1.0.0)
+    concurrent-ruby (1.3.8)
+    connection_pool (3.0.2)
+    crack (1.0.1)
       bigdecimal
       rexml
     diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.3)
-    faraday (2.13.1)
+    faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.4.0)
-      net-http (>= 0.5.0)
-    hashdiff (1.2.0)
-    i18n (1.14.7)
+    faraday-net_http (3.4.4)
+      net-http (~> 0.5)
+    hashdiff (1.2.1)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
-    json (2.12.2)
+    io-console (0.8.2)
+    json (2.21.1)
     jsonpath (1.1.5)
       multi_json
-    language_server-protocol (3.17.0.5)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     method_source (1.1.0)
-    minitest (5.25.5)
-    multi_json (1.15.0)
-    net-http (0.6.0)
-      uri
-    parallel (1.27.0)
-    parser (3.3.8.0)
+    minitest (6.0.6)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    multi_json (1.21.1)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    parallel (1.28.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
-    prism (1.4.0)
-    pry (0.15.2)
+    prism (1.9.0)
+    pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.11.0)
-      byebug (~> 12.0)
-      pry (>= 0.13, < 0.16)
-    public_suffix (6.0.2)
+      reline (>= 0.6.0)
+    pry-byebug (3.12.0)
+      byebug (~> 13.0)
+      pry (>= 0.13, < 0.17)
+    public_suffix (7.0.5)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.0)
-    regexp_parser (2.10.0)
-    rexml (3.4.1)
-    rspec (3.13.1)
+    rake (13.4.2)
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.4)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
+    rspec-support (3.13.7)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.76.1)
+    rubocop (1.88.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.45.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.45.1)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-performance (1.25.0)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.6.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
-    rubocop-rspec_rails (2.31.0)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
+    rubocop-rspec_rails (2.32.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
       rubocop-rspec (~> 3.5)
     ruby-progressbar (1.13.0)
-    sawyer (0.9.2)
+    sawyer (0.9.3)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
     securerandom (0.4.1)
@@ -129,25 +137,25 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    uri (1.0.3)
-    webmock (3.25.1)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    webmock (3.26.2)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.37)
+    yard (0.9.45)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bugsnag (>= 6.11.0)
+  bugsnag (>= 6.19.0)
   bundler (>= 2.0)
   my_api_client!
   pry-byebug
@@ -164,4 +172,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.6.9
+  4.0.16