my_api_client 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7d3471ad8b1b1fe955f65dee427f4456055a1608abbd1a6a66159a9971db727
-  data.tar.gz: 9f3d5aa9a5f84b7b3185b3948e2608f104775fd1a9833e534fea1970dcc99d25
+  metadata.gz: f8d67936b7bbacf5cfe58e3c642d532be762848659f1839a920ea40795414931
+  data.tar.gz: c290910ca41637527fac5461a280d6ce3a22ba680fccb67f5eff4593a0cbea96
 SHA512:
-  metadata.gz: 4b7240277aab4f9299fa362a5a7d60a33c8d0dc7a26f674164fea7ebd914655f18ad553a16d0a1516da9d02261d58248ec71c4596ce37ada569cd60ef7272ea5
-  data.tar.gz: d0460fffc5ca8d8c30db1b57be78c8e6ad28d4278d4c6cf5e79ef30f3681e9b63fbd2953abebdb80c100adacfcf0bc156643ef4bc03ca5d73f33203fc37a2d66
+  metadata.gz: dea3cf5c8b42477b130ea300427be44275c2e040ad167c0ff5052e77c5d8c41fd819d1352c15b7ce2051fe652114fb007e663e580ce08958f1c1a27400e4cdcb
+  data.tar.gz: 39d3f36f90c2e3f8c0099e9aa117e76430c9b72a20780edf0ebb21317e435b2f92abb16bbf6abe4b3eb147f6fe333d2e35fa4ad7de919def333993118597b202

data/.dockerignore

@@ -0,0 +1,8 @@
+.github
+.yardoc
+coverage
+tmp
+log
+vendor/bundle
+.bundle
+.rspec_status

data/.envrc.skeleton

@@ -1,2 +1 @@
 export GITHUB_ACCESS_TOKEN={GITHUB_ACCESS_TOKEN}
-export MY_API_ENDPOINT={API gateway endtpoint of "my_api" for integration testing}

data/.github/dependabot.yml

@@ -3,12 +3,10 @@ updates:
 - package-ecosystem: bundler
   directory: "/"
   schedule:
-    interval: daily
+    interval: weekly
     time: "08:00"
-    timezone: Japan
+    timezone: Asia/Tokyo
   open-pull-requests-limit: 10
-  reviewers:
-  - ryz310
   assignees:
   - ryz310
   labels:
@@ -17,15 +15,92 @@ updates:
   - dependency-name: rubocop
     versions:
     - 1.9.0
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "08:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10
+  assignees:
+  - ryz310
+  labels:
+  - dependabot
 - package-ecosystem: bundler
   directory: "/my_api"
   schedule:
-    interval: daily
+    interval: weekly
     time: "08:00"
-    timezone: Japan
+    timezone: Asia/Tokyo
   open-pull-requests-limit: 10
-  reviewers:
+  assignees:
   - ryz310
+  labels:
+  - dependabot
+- package-ecosystem: bundler
+  directory: "/rails_app/rails_7.2"
+  schedule:
+    interval: weekly
+    time: "08:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10
+  assignees:
+  - ryz310
+  labels:
+  - dependabot
+- package-ecosystem: github-actions
+  directory: "/rails_app/rails_7.2"
+  schedule:
+    interval: weekly
+    time: "08:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10
+  assignees:
+  - ryz310
+  labels:
+  - dependabot
+- package-ecosystem: bundler
+  directory: "/rails_app/rails_8.0"
+  schedule:
+    interval: weekly
+    time: "08:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10
+  assignees:
+  - ryz310
+  labels:
+  - dependabot
+- package-ecosystem: github-actions
+  directory: "/rails_app/rails_8.0"
+  schedule:
+    interval: weekly
+    time: "08:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10
+  assignees:
+  - ryz310
+  labels:
+  - dependabot
+- package-ecosystem: bundler
+  directory: "/rails_app/rails_8.1"
+  schedule:
+    interval: weekly
+    day: monday
+    time: "08:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10
+  assignees:
+  - ryz310
+  labels:
+  - dependabot
+- package-ecosystem: github-actions
+  directory: "/rails_app/rails_8.1"
+  schedule:
+    interval: weekly
+    day: monday
+    time: "08:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10
   assignees:
   - ryz310
   labels:

data/.github/workflows/ci.yml

@@ -0,0 +1,334 @@
+name: CI
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  build_gem:
+    name: build_on_ruby_${{ matrix.ruby_version }}_and_rails_${{ matrix.rails_version }}_${{ matrix.bundler_option.name }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ['3.2', '3.3', '3.4', '4.0']
+        rails_version: ['7.2', '8.0', '8.1']
+        bundler_option:
+          - name: with_integrations
+            with: integrations
+            without: ""
+          - name: without_integrations
+            with: ""
+            without: integrations
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: false
+
+      - name: Install Bundler 2.x
+        run: gem install bundler -v "~> 2.0"
+
+      - name: Configure Bundler options
+        env:
+          BUNDLE_WITH: ${{ matrix.bundler_option.with }}
+          BUNDLE_WITHOUT: ${{ matrix.bundler_option.without }}
+        run: |
+          if [ -n "${BUNDLE_WITH}" ]; then
+            bundle config set --local with "${BUNDLE_WITH}"
+          else
+            bundle config unset --local with || true
+          fi
+
+          if [ -n "${BUNDLE_WITHOUT}" ]; then
+            bundle config set --local without "${BUNDLE_WITHOUT}"
+          else
+            bundle config unset --local without || true
+          fi
+
+      - name: Use Rails ${{ matrix.rails_version }} appraisal
+        run: cp gemfiles/rails_${{ matrix.rails_version }}.gemfile Gemfile
+
+      - name: Update ActiveSupport
+        run: bundle update activesupport
+
+      - name: Execute RSpec
+        env:
+          SIMPLECOV_COMMAND_NAME: build_gem_ruby_${{ matrix.ruby_version }}_rails_${{ matrix.rails_version }}_${{ matrix.bundler_option.name }}
+        run: |
+          bundle exec rspec --format documentation \
+                            --color \
+                            --format RspecJunitFormatter
+
+      - name: Rake build
+        run: bundle exec rake build
+
+      - name: Prepare coverage artifact
+        if: ${{ always() && hashFiles('coverage/.resultset.json') != '' }}
+        run: cp coverage/.resultset.json coverage/resultset.json
+
+      - name: Upload coverage artifact
+        if: ${{ always() && hashFiles('coverage/resultset.json') != '' }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: simplecov-resultset-ruby_${{ matrix.ruby_version }}-rails_${{ matrix.rails_version }}-${{ matrix.bundler_option.name }}
+          path: coverage/resultset.json
+
+  verify_generator:
+    name: verify_generator_on_ruby_${{ matrix.ruby_version }}_and_rails_${{ matrix.rails_version }}
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_PATH: vendor/bundle
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ['3.2', '3.3', '3.4', '4.0']
+        rails_version: ['7.2', '8.0', '8.1']
+    defaults:
+      run:
+        working-directory: rails_app/rails_${{ matrix.rails_version }}
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: false
+
+      - name: Install Bundler 2.x
+        run: gem install bundler -v "~> 2.0"
+
+      - name: Bundle install
+        run: bundle install
+
+      - name: Add compatibility symlink for libffi
+        run: |
+          if [ ! -e /usr/lib/x86_64-linux-gnu/libffi.so.6 ]; then
+            latest_libffi="$(find /usr/lib/x86_64-linux-gnu -maxdepth 1 -type f -name 'libffi.so.*.*.*' | sort -V | tail -n 1)"
+            if [ -n "${latest_libffi}" ]; then
+              sudo ln -s "${latest_libffi}" /usr/lib/x86_64-linux-gnu/libffi.so.6
+            fi
+          fi
+
+      - name: Generate new API client files
+        run: |
+          bin/rails g api_client path/to/resource \
+            get:path/to/resource \
+            post:path/to/resource \
+            --endpoint https://example.com/myapi
+
+      - name: Check generated API client files
+        run: |
+          test -e "app/api_clients/application_api_client.rb" && \
+          test -e "app/api_clients/path/to/resource_api_client.rb" && \
+          test -e "spec/api_clients/path/to/resource_api_client_spec.rb"
+
+      - name: Run rspec with the generated spec file
+        run: bundle exec rspec -f d spec/api_clients/path/to
+
+  integration_api:
+    name: integration_api_via_docker_compose
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Build and start my_api
+        run: docker compose up -d --build my_api
+
+      - name: Run integration specs against my_api
+        env:
+          MY_API_ENDPOINT: http://my_api:3000
+          SIMPLECOV_COMMAND_NAME: integration_api
+        run: |
+          docker compose run --rm test bash -lc "
+            bundle config set --local with integrations &&
+            bundle install &&
+            bundle exec rspec spec/integrations/api_clients
+          "
+
+      - name: Fix coverage directory ownership
+        if: ${{ always() && hashFiles('coverage/.resultset.json') != '' }}
+        run: sudo chown -R "$(id -u):$(id -g)" coverage
+
+      - name: Prepare coverage artifact
+        if: ${{ always() && hashFiles('coverage/.resultset.json') != '' }}
+        run: cp coverage/.resultset.json coverage/resultset.json
+
+      - name: Upload coverage artifact
+        if: ${{ always() && hashFiles('coverage/resultset.json') != '' }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: simplecov-resultset-integration_api
+          path: coverage/resultset.json
+
+      - name: Show my_api logs when failed
+        if: ${{ failure() }}
+        run: docker compose logs my_api
+
+      - name: Shutdown compose services
+        if: ${{ always() }}
+        run: docker compose down --volumes --remove-orphans
+
+  my_api_request_specs:
+    name: my_api_request_specs_via_docker_compose
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Build and start my_api
+        run: docker compose up -d --build my_api
+
+      - name: Run my_api request specs
+        env:
+          SIMPLECOV_COMMAND_NAME: my_api_request_specs
+        run: docker compose run --rm my_api bundle exec rspec spec/requests
+
+      - name: Fix my_api coverage directory ownership
+        if: ${{ always() && hashFiles('my_api/coverage/.resultset.json') != '' }}
+        run: sudo chown -R "$(id -u):$(id -g)" my_api/coverage
+
+      - name: Prepare coverage artifact
+        if: ${{ always() && hashFiles('my_api/coverage/.resultset.json') != '' }}
+        run: cp my_api/coverage/.resultset.json my_api/coverage/resultset.json
+
+      - name: Upload coverage artifact
+        if: ${{ always() && hashFiles('my_api/coverage/resultset.json') != '' }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: simplecov-resultset-my_api_request_specs
+          path: my_api/coverage/resultset.json
+
+      - name: Show my_api logs when failed
+        if: ${{ failure() }}
+        run: docker compose logs my_api
+
+      - name: Shutdown compose services
+        if: ${{ always() }}
+        run: docker compose down --volumes --remove-orphans
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: false
+
+      - name: Install Bundler 2.x
+        run: gem install bundler -v "~> 2.0"
+
+      - name: Bundle install
+        run: bundle install
+
+      - name: Run RuboCop
+        run: bundle exec rubocop
+
+  yardoc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: false
+
+      - name: Install Bundler 2.x
+        run: gem install bundler -v "~> 2.0"
+
+      - name: Bundle install
+        run: bundle install
+
+      - name: Generate YARDoc
+        run: bundle exec yardoc -o ./yardoc
+
+      - name: Store YARDoc artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: yardoc
+          path: ./yardoc
+
+  upload_coverage:
+    name: upload-coverage
+    environment: coverage
+    # This job runs on pull_request as well.
+    # On fork-based pull requests, secrets are unavailable, so the Qlty upload
+    # step is skipped by its token guard. On same-repository pull requests,
+    # QLTY_COVERAGE_TOKEN is available and upload can run.
+    needs:
+      - build_gem
+      - verify_generator
+      - integration_api
+      - my_api_request_specs
+    runs-on: ubuntu-latest
+    env:
+      QLTY_COVERAGE_TOKEN: ${{ secrets.QLTY_COVERAGE_TOKEN }}
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: false
+
+      - name: Install Bundler 2.x
+        run: gem install bundler -v "~> 2.0"
+
+      - name: Bundle install
+        run: bundle install
+
+      - name: Download coverage artifacts
+        uses: actions/download-artifact@v8
+        with:
+          pattern: simplecov-resultset-*
+          path: tmp/simplecov-results
+
+      - name: Collate SimpleCov coverage
+        run: |
+          bundle exec ruby -e "
+            require 'simplecov'
+            require 'simplecov_json_formatter'
+
+            resultset_files = Dir['tmp/simplecov-results/**/resultset.json'].sort
+            abort('No SimpleCov resultset files found') if resultset_files.empty?
+
+            SimpleCov.collate(resultset_files) do
+              formatter SimpleCov::Formatter::JSONFormatter
+              coverage_dir('coverage')
+            end
+          "
+
+      - name: Upload merged coverage artifact
+        if: ${{ hashFiles('coverage/coverage.json') != '' }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: merged-simplecov-coverage
+          path: coverage/coverage.json
+
+      - name: Upload coverage to Qlty
+        if: ${{ env.QLTY_COVERAGE_TOKEN != '' && hashFiles('coverage/coverage.json') != '' }}
+        uses: qltysh/qlty-action/coverage@v2
+        with:
+          token: ${{ env.QLTY_COVERAGE_TOKEN }}
+          files: coverage/coverage.json
+
+      - name: Notify when Qlty token is missing
+        if: ${{ env.QLTY_COVERAGE_TOKEN == '' }}
+        run: |
+          echo "QLTY_COVERAGE_TOKEN is not set. Skipping coverage upload."

data/.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,96 @@
+name: Dependabot Auto Merge
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  enable-automerge-bundler:
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Enable auto-merge for bundler patch/minor updates (rails_app or direct development)
+        if: ${{ steps.metadata.outputs.package-ecosystem == 'bundler' && (steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor') && (contains(github.event.pull_request.head.ref, '/rails_app/') || steps.metadata.outputs.dependency-type == 'direct:development') }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+        run: gh pr merge --repo "$GITHUB_REPOSITORY" --auto --merge "$PR_NUMBER"
+
+  enable-automerge-github-actions:
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Validate GitHub Actions update safety
+        id: guard
+        if: ${{ steps.metadata.outputs.package-ecosystem == 'github-actions' }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          UPDATE_TYPE: ${{ steps.metadata.outputs.update-type }}
+          DEPENDENCY_NAME: ${{ steps.metadata.outputs.dependency-name }}
+          DEPENDENCY_NAMES: ${{ steps.metadata.outputs.dependency-names }}
+        run: |
+          set -euo pipefail
+
+          safe=true
+
+          if [[ "$UPDATE_TYPE" != "version-update:semver-patch" && "$UPDATE_TYPE" != "version-update:semver-minor" ]]; then
+            echo "Skip auto-merge: update type is not patch/minor ($UPDATE_TYPE)."
+            safe=false
+          fi
+
+          deps="$DEPENDENCY_NAMES"
+          if [[ -z "$deps" ]]; then
+            deps="$DEPENDENCY_NAME"
+          fi
+
+          if [[ -z "$deps" ]]; then
+            echo "Skip auto-merge: dependency name is missing."
+            safe=false
+          else
+            while IFS= read -r dep; do
+              dep="$(echo "$dep" | xargs)"
+              [[ -z "$dep" ]] && continue
+
+              if [[ ! "$dep" =~ ^actions/ && ! "$dep" =~ ^github/ ]]; then
+                echo "Skip auto-merge: non-GitHub official action detected ($dep)."
+                safe=false
+              fi
+            done < <(echo "$deps" | tr ',' '\n')
+          fi
+
+          files_json="$(gh api -H "Accept: application/vnd.github+json" "/repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER/files?per_page=100")"
+          if echo "$files_json" | jq -r '.[] | select((.patch // "") | test("(?m)^[+-]\\s*(permissions|pull_request_target)\\s*:")) | .filename' | grep -q .; then
+            echo "Skip auto-merge: permissions or pull_request_target changes were detected."
+            safe=false
+          fi
+
+          echo "safe=$safe" >> "$GITHUB_OUTPUT"
+
+      - name: Enable auto-merge for safe GitHub Actions patch/minor updates
+        if: ${{ steps.metadata.outputs.package-ecosystem == 'github-actions' && steps.guard.outputs.safe == 'true' }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+        run: gh pr merge --repo "$GITHUB_REPOSITORY" --auto --merge "$PR_NUMBER"

data/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - release
+  workflow_dispatch:
+
+concurrency:
+  group: release-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref_name }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+
+      - name: Release gem via Trusted Publishing
+        uses: rubygems/release-gem@v1

data/.github/workflows/rubocop_challenge.yml

@@ -0,0 +1,33 @@
+name: Rubocop Challenge
+
+on:
+  schedule:
+    - cron: "30 23 * * *" # 8:30am every day (JST)
+  workflow_dispatch:
+
+concurrency:
+  group: rubocop-challenge-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  rubocop_challenge:
+    if: ${{ github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/master' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+
+      - name: Rubocop Challenge
+        env:
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gem install rubocop_challenger
+          rubocop_challenger go --email=ryz310@gmail.com --name=ryz310

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.envrc

data/.rubocop.yml

@@ -7,7 +7,7 @@ plugins:
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.2
   NewCops: enable
   Exclude:
     - rails_app/**/*

data/.ruby-version

@@ -1 +1 @@
-3.1.6
+3.2.9