Modernize the gem and add the V2 client (2.0.0)

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - run: bundle exec rubocop
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.3", "3.4"]
+        gemfile: [faraday_1, faraday_2]
+    runs-on: ubuntu-latest
+    # BUNDLE_GEMFILE must be job-level so setup-ruby installs and
+    # caches against the matrix gemfile instead of the root Gemfile.
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec
+
+  # Every public object under lib/amazon_sp_clients/v2 must carry a
+  # doc comment; .yardopts scopes the check.
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - run: bundle exec rake yard:verify
+
+  # Regenerates vendor/ at the pinned Amazon spec revision and fails
+  # if the committed files drift from what the generator produces.
+  verify-generated:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - run: bundle exec rake generate:verify

.github/workflows/release.yml

@@ -0,0 +1,57 @@
+name: Release
+
+# A version tag is the only release path. It builds the gem, pushes it
+# to rubygems.org through Trusted Publishing (no API key stored anywhere)
+# and opens a GitHub Release with that version's CHANGELOG entry.
+# rubygems.org trusts this workflow file by name; see README, "Releasing".
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: write # the GitHub Release
+  id-token: write # the OIDC token rubygems.org exchanges for a push key
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+
+      # The tag must be "v" plus AmazonSpClients::VERSION.
+      - name: Check the tag against version.rb
+        run: |
+          version=$(ruby -Ilib -e 'require "amazon_sp_clients/version"; puts AmazonSpClients::VERSION')
+          if [ "v${version}" != "${GITHUB_REF_NAME}" ]; then
+            echo "Tag ${GITHUB_REF_NAME} does not match version ${version}" >&2
+            exit 1
+          fi
+
+      # The release notes are the CHANGELOG section for this version.
+      - name: Extract the CHANGELOG entry
+        run: |
+          awk -v v="${GITHUB_REF_NAME#v}" '$0 ~ "^## \\[" v "\\]" {p=1; next} /^## \[/ {p=0} p' CHANGELOG.md > release_notes.md
+          if [ ! -s release_notes.md ]; then
+            echo "CHANGELOG.md has no entry for ${GITHUB_REF_NAME#v}" >&2
+            exit 1
+          fi
+
+      - run: bundle exec rspec
+      - run: gem build sp_api_clients.gemspec
+
+      # Trades this job's OIDC token for a short-lived rubygems.org key
+      # that can push only this gem. Needs the trusted publisher set up
+      # on rubygems.org for repository dropstream/amazon_sp_clients and
+      # workflow release.yml.
+      - uses: rubygems/configure-rubygems-credentials@v2.1.0
+      - name: Push the gem to rubygems.org
+        run: gem push sp_api_clients-*.gem
+
+      - name: Create the GitHub Release
+        run: gh release create "${GITHUB_REF_NAME}" sp_api_clients-*.gem --title "${GITHUB_REF_NAME}" --notes-file release_notes.md
+        env:
+          GH_TOKEN: ${{ github.token }}

.github/workflows/update-models.yml

@@ -0,0 +1,76 @@
+name: Update models
+
+on:
+  schedule:
+    # First day of every month at 2:00 UTC. Run manually via
+    # workflow_dispatch when needed.
+    - cron: "0 2 1 * *"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  update-models:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+
+      - name: Pull latest Amazon specs and regenerate
+        run: bundle exec rake generate:update
+
+      # Uses a machine-user PAT (not GITHUB_TOKEN) so the PR triggers CI.
+      - name: Create pull request
+        uses: actions/github-script@v8
+        env:
+          MACHINE_USER_NAME: ${{ secrets.MACHINE_USER_NAME }}
+          MACHINE_USER_EMAIL: ${{ secrets.MACHINE_USER_EMAIL }}
+        with:
+          github-token: ${{ secrets.MACHINE_USER_PAT }}
+          script: |
+            const { execSync } = require('child_process');
+
+            const status = execSync('git status --porcelain', { encoding: 'utf8' });
+            if (!status.trim()) {
+              console.log('No changes');
+              return;
+            }
+
+            execSync(`git config user.name "${process.env.MACHINE_USER_NAME}"`);
+            execSync(`git config user.email "${process.env.MACHINE_USER_EMAIL}"`);
+
+            // One fixed branch; recreate it on every run.
+            const branchName = 'update-api-models';
+            try {
+              execSync(`git push origin --delete ${branchName}`, { stdio: 'ignore' });
+            } catch (e) { /* branch did not exist */ }
+            try {
+              execSync(`git branch -D ${branchName}`, { stdio: 'ignore' });
+            } catch (e) { /* branch did not exist */ }
+
+            execSync(`git checkout -b ${branchName}`);
+            execSync('git add -A');
+            execSync('git commit -m "Update Amazon models"');
+            execSync(`git push --set-upstream origin ${branchName}`);
+
+            const { data: pr } = await github.rest.pulls.create({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              title: 'Update Amazon models',
+              body: 'Nightly regeneration against the latest Amazon SP-API specs. ' +
+                    'Review the pin change in selling-partner-api-models.sha and the regenerated files.',
+              head: branchName,
+              base: 'master'
+            });
+
+            console.log(`Created PR #${pr.number}: ${pr.html_url}`);

.gitignore

@@ -10,3 +10,6 @@
 .env
 # rspec failure tracking
 .rspec_status
+
+# Local clone of amzn/selling-partner-api-models (managed by lib/generator)
+/amzn-models/

.rubocop.yml

@@ -0,0 +1,32 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+  SuggestExtensions: false
+  Exclude:
+    - vendor/**/*
+    - amzn-models/**/*
+    - tmp/**/*
+    - bin/**/*
+    # CI matrix gemfiles, not gem code.
+    - gemfiles/**/*
+    # Autogenerated require shims; the Rakefile writes them.
+    - lib/amazon_sp_clients/sp_*.rb
+    # Generated V2 API classes and their entry file; the generator writes them.
+    - lib/amazon_sp_clients/v2/apis/**/*
+    - lib/amazon_sp_clients/v2/apis.rb
+
+# Start permissive on the handwritten code; tighten later.
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Grouping accessors would detach them from their doc comments.
+Style/AccessorGrouping:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100

.rubocop_todo.yml

@@ -0,0 +1,120 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2026-08-31 19:00:44 UTC using RuboCop version 1.86.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+# Configuration parameters: EnforcedStyle, AllowedGems.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'sp_api_clients.gemspec'
+
+# Offense count: 10
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'Rakefile'
+    - 'lib/amazon_sp_clients/session.rb'
+    - 'spec/amazon_sp_clients/uploader_spec.rb'
+    - 'spec/amazon_sp_clients_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/amazon_sp_clients_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/amazon_sp_clients/configuration.rb'
+
+# Offense count: 4
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/amazon_sp_clients/configuration.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowKeywordBlockArguments.
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - 'lib/amazon_sp_clients/api_client.rb'
+
+# Offense count: 2
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/amazon_sp_clients/configuration.rb'
+
+# Offense count: 1
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 17
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/GlobalStdStream:
+  Exclude:
+    - 'Rakefile'
+    - 'lib/amazon_sp_clients/configuration.rb'
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: short, verbose
+Style/PreferredHashMethods:
+  Exclude:
+    - 'lib/amazon_sp_clients/api_client.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/RedundantInterpolation:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/amazon_sp_clients/api_error.rb'
+    - 'lib/amazon_sp_clients/configuration.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/StructInheritance:
+  Exclude:
+    - 'lib/amazon_sp_clients/api_error.rb'
+    - 'lib/amazon_sp_clients/token_exchange_auth.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments.
+# AllowedMethods: define_method
+Style/SymbolProc:
+  Exclude:
+    - 'spec/amazon_sp_clients/api_client_spec.rb'

.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--list-undoc
+lib/amazon_sp_clients/v2.rb
+lib/amazon_sp_clients/v2/**/*.rb