ruby_api_pack_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f91aba38a51e699485d82617f5bc8178fe6719f716c1a0c496430a48a4de901b
+  data.tar.gz: 60bb0993675f97b91fda9e0eb95baf2b6030d22c64a7fbbe80e146ec9722c2e4
+SHA512:
+  metadata.gz: b4642e964ce9097c32f90fcb5a584fd9cc4ed3cdf3ab9105c1a7382fe6c52ff07c1508675e83cac4f78ff823e3fe556987c7335435612862fdd755b27e14e56c
+  data.tar.gz: b7d660cfb7a646bc97af006c66251a6a70a3262fcd48bef6ba48a6fbd05f4e7cd3a81486982afe9e14edacb68ce88f9a396f3b6ec92cd56587a5de699b721f0c

data/.all-contributorsrc

@@ -0,0 +1,23 @@
+{
+  "projectName": "ruby_api_pack_core",
+  "projectOwner": "phcdevworks",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "contributors": [
+    {
+      "login": "BradPotts",
+      "name": "Brad Potts",
+      "avatar_url": "https://avatars.githubusercontent.com/BradPotts",
+      "profile": "https://github.com/BradPotts",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "commitConvention": null
+}

data/.circleci/config.yml

@@ -0,0 +1,44 @@
+version: 2.1
+
+orbs:
+  codecov: codecov/codecov@6.0.0
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - bundle-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}
+      - run: bundle config set --local path 'vendor/bundle'
+      - run: bundle install
+      - save_cache:
+          key: bundle-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: bundle exec rspec
+          command: |
+            mkdir -p tmp/test-results
+            bundle exec rspec --format progress --format RspecJunitFormatter --out tmp/test-results/rspec.xml
+      - store_test_results:
+          path: tmp/test-results
+      - run: bundle exec rubocop
+      - codecov/upload:
+          files: coverage/.resultset.json
+      - codecov/upload:
+          files: tmp/test-results/rspec.xml
+          report_type: test_results
+
+workflows:
+  test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ['3.3.4', '3.4']

data/.claude/settings.json

@@ -0,0 +1,36 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(bundle install*)",
+      "Bash(bundle exec rspec*)",
+      "Bash(bundle exec rubocop*)",
+      "Bash(gem build*)",
+      "Bash(git status)",
+      "Bash(git diff*)",
+      "Bash(git log*)"
+    ],
+    "deny": [
+      "Bash(rm -rf*)",
+      "Bash(rm -fr*)",
+      "Bash(git commit*)",
+      "Bash(gh repo delete*)",
+      "Bash(gh repo archive*)",
+      "Bash(git push --force*)",
+      "Bash(git push -f*)",
+      "Bash(git reset --hard*)",
+      "Bash(git clean -f*)",
+      "Bash(git clean -d*)",
+      "Bash(git clean -x*)",
+      "Bash(git branch -D*)",
+      "Bash(git branch -d*)",
+      "Bash(git tag -d*)",
+      "Bash(git filter-branch*)",
+      "Bash(git filter-repo*)",
+      "Bash(git gc --prune*)",
+      "Bash(git rebase*)",
+      "Bash(gem yank*)",
+      "Bash(dd *)",
+      "Bash(mkfs*)"
+    ]
+  }
+}

data/.claude/settings.local.json

@@ -0,0 +1,36 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(bundle install*)",
+      "Bash(bundle exec rspec*)",
+      "Bash(bundle exec rubocop*)",
+      "Bash(gem build*)",
+      "Bash(git status)",
+      "Bash(git diff*)",
+      "Bash(git log*)"
+    ],
+    "deny": [
+      "Bash(rm -rf*)",
+      "Bash(rm -fr*)",
+      "Bash(git commit*)",
+      "Bash(gh repo delete*)",
+      "Bash(gh repo archive*)",
+      "Bash(git push --force*)",
+      "Bash(git push -f*)",
+      "Bash(git reset --hard*)",
+      "Bash(git clean -f*)",
+      "Bash(git clean -d*)",
+      "Bash(git clean -x*)",
+      "Bash(git branch -D*)",
+      "Bash(git branch -d*)",
+      "Bash(git tag -d*)",
+      "Bash(git filter-branch*)",
+      "Bash(git filter-repo*)",
+      "Bash(git gc --prune*)",
+      "Bash(git rebase*)",
+      "Bash(gem yank*)",
+      "Bash(dd *)",
+      "Bash(mkfs*)"
+    ]
+  }
+}

data/.coderabbit.yaml

@@ -0,0 +1,75 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+language: "en-US"
+early_access: false
+reviews:
+  profile: "assertive"
+  request_changes_workflow: false
+  high_level_summary: true
+  high_level_summary_placeholder: "@coderabbitai summary"
+  auto_title_placeholder: "@coderabbitai"
+  review_status: true
+  commit_status: true
+  collapse_walkthrough: false
+  changed_files_summary: true
+  sequence_diagrams: true
+  assess_linked_issues: true
+  related_issues: true
+  related_prs: true
+  suggested_labels: true
+  auto_apply_labels: false
+  suggested_reviewers: false
+  poem: false
+  abort_on_close: true
+  auto_review:
+    enabled: true
+    auto_incremental_review: true
+    drafts: false
+  finishing_touches:
+    docstrings:
+      enabled: true
+  tools:
+    rubocop:
+      enabled: true
+    markdownlint:
+      enabled: true
+    gitleaks:
+      enabled: true
+    github-checks:
+      enabled: true
+      timeout_ms: 90000
+    yamllint:
+      enabled: true
+    languagetool:
+      enabled: true
+      level: default
+    actionlint:
+      enabled: true
+    semgrep:
+      enabled: true
+  path_instructions:
+    - path: "**/*.rb"
+      instructions: "Apply Ruby best practices. Flag: missing frozen_string_literal: true magic comment; unhandled HTTParty response error paths; Law of Demeter violations. This gem must stay free of vendor-specific knowledge (API tokens, endpoint paths, resource classes) -- flag any such addition as out of scope."
+    - path: "lib/ruby_api_pack_core/connection/base.rb"
+      instructions: "This is the shared template-method connection class every ruby_api_pack_* gem subclasses. Verify it stays vendor-agnostic (no hardcoded auth scheme beyond the #auth_headers abstract hook), JSON parsing failures are handled distinctly from non-2xx responses, and no request or response body is logged directly. Flag any public method name change as breaking -- every consuming gem depends on api_get/api_post/api_put/api_delete."
+    - path: "lib/ruby_api_pack_core/handlers/response_validator.rb"
+      instructions: "Verify validate_response's expected_type contract (:any/:array/:hash) stays stable, since every ruby_api_pack_* gem's resource classes call it directly. Flag any signature change as breaking."
+    - path: "lib/ruby_api_pack_core/configurable.rb"
+      instructions: "Verify the configure/configuration singleton pattern stays consistent with how RubyApiPackActiveCampaign, RubyApiPackCloudways, and RubyApiPackWordpress already use it. Flag any signature change as breaking."
+    - path: "spec/**"
+      instructions: "Enforce RSpec best practices: descriptive describe/context/it blocks, let over instance variables, and expectations that verify behavior rather than internal state. All specs must exercise a dummy subclass or dummy module -- never a real vendor API. Flag any fixture containing realistic-looking API tokens or credentials."
+    - path: "Gemfile"
+      instructions: "Flag overly permissive version constraints (>= x with no upper bound). Ensure test and development gems are in the correct group. Verify no gems with known CVEs are being introduced."
+    - path: "*.gemspec"
+      instructions: "Verify required_ruby_version is set, runtime dependencies are actually used in lib/ (no orphaned dependencies), summary and description are informative, and version follows semver."
+    - path: "CHANGELOG.md"
+      instructions: "Verify entries follow Keep a Changelog format with correct categorization (Added/Changed/Fixed/Removed) and link to a version tag. Breaking changes must note the required follow-up in the three consuming gems."
+chat:
+  auto_reply: true
+knowledge_base:
+  opt_out: false
+  learnings:
+    scope: auto
+  issues:
+    scope: auto
+  pull_requests:
+    scope: auto

data/.codex/README.md

@@ -0,0 +1,31 @@
+# Codex Workspace Notes
+
+This folder keeps Codex-facing operational notes for `ruby_api_pack_core`.
+
+## Default Checks
+
+```bash
+bundle exec rspec
+bundle exec rubocop
+gem build ruby_api_pack_core.gemspec
+```
+
+## Documentation Standard
+
+Keep these files synchronized:
+
+- `README.md`
+- `CONTRIBUTING.md`
+- `SECURITY.md`
+- `CHANGELOG.md`
+- `ROADMAP.md`
+- `TODO.md`
+- `AGENTS.md`
+- `CLAUDE.md`, `CODEX.md`, `COPILOT.md`, `JULES.md`
+- `.github/codex-instructions.md`, `.github/copilot-instructions.md`
+
+## Security Reminder
+
+Do not include real API tokens, credentials, or vendor response bodies in
+docs, specs, logs, or examples. This gem carries no vendor credentials of its
+own by design.

data/.codex/change-watch.md

@@ -0,0 +1,19 @@
+# Change Watch
+
+Use this file as a lightweight review log when preparing a documentation,
+release, or stabilization handoff.
+
+## Current Watch Points
+
+- Any change to `Connection::Base`, `Handlers::ResponseValidator`, or
+  `Configurable` public method names is breaking for every consuming gem —
+  check for downstream coordination before merging.
+- Vendor-specific knowledge (API tokens, endpoint paths, resource classes)
+  showing up in this gem is a scope violation, not a feature.
+- Release changes should keep `VERSION`, `CHANGELOG.md`, gem build output, and
+  RubyGems publishing state aligned.
+
+## Validation Notes
+
+Record command results here only when useful for a release or PR handoff. Do
+not paste secrets or live vendor response payloads.

data/.codex/release-readiness.md

@@ -0,0 +1,35 @@
+# Release Readiness
+
+Use this checklist before a maintainer publishes `ruby_api_pack_core`.
+
+## Validation
+
+- [ ] `bundle exec rspec` passes.
+- [ ] `bundle exec rubocop` passes.
+- [ ] `gem build ruby_api_pack_core.gemspec` succeeds.
+
+## Release Records
+
+- [ ] `lib/ruby_api_pack_core/version.rb` has the intended version.
+- [ ] `CHANGELOG.md` has a dated entry for the intended version.
+- [ ] README usage reflects the current public contract.
+- [ ] Security guidance is current.
+
+## Downstream Coordination
+
+- [ ] If the change is anything other than additive, confirm
+      `ruby_api_pack_active_campaign`, `ruby_api_pack_cloudways`, and
+      `ruby_api_pack_wordpress` still pass their own validation gates against
+      this version.
+
+## Safety
+
+- [ ] No real API tokens or credentials are present in source, docs, logs,
+      examples, or fixtures.
+- [ ] No vendor response bodies are committed.
+
+## Handoff
+
+- [ ] Summarize change classification.
+- [ ] Include validation results.
+- [ ] Note any known release risks or skipped checks.

data/.editorconfig

@@ -0,0 +1,22 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 88
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_size = 2
+
+[*.gemspec]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,70 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "db/schema.rb"
+    - "db/migrate/**/*"
+    - "bin/**/*"
+    - "node_modules/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  SuggestExtensions: false
+
+Lint/RedundantCopDisableDirective:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - "db/schema.rb"
+    - "db/migrate/**/*"
+    - "Gemfile"
+    - "Guardfile"
+    - "Rakefile"
+    - "config.ru"
+    - "package.json"
+    - "*.yml"
+    - "*.md"
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+  AutoCorrect: true
+
+Layout/LineLength:
+  Max: 130
+  AllowHeredoc: true
+  AllowURI: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 150
+
+Naming/VariableNumber:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 15
+
+RSpec/ExampleLength:
+  Max: 15

data/AGENTS.md

@@ -0,0 +1,117 @@
+# Ruby API Pack Core Agent Guide
+
+## Repository Snapshot
+
+| Field | Value |
+|-------|-------|
+| Project team | `project-ruby` |
+| Repository role | Shared HTTP client foundation for all `ruby_api_pack_*` gems |
+| Package/artifact | `ruby_api_pack_core` |
+| Validation gate | `bundle exec rspec` + `bundle exec rubocop` + `gem build ruby_api_pack_core.gemspec` |
+
+## Standard Authority Model
+
+| Agent | Role | Authority |
+|-------|------|-----------|
+| Claude Code | Lead implementation and validation | [CLAUDE.md](CLAUDE.md) |
+| OpenAI Codex | Documentation, release readiness, stabilization, and repo hygiene | [CODEX.md](CODEX.md) |
+| ChatGPT | Strategy, coordination, prompt design, and external review | Support only |
+| GitHub Copilot | Development assistance | [COPILOT.md](COPILOT.md) |
+| Google Jules | Bounded automated maintenance | [JULES.md](JULES.md) |
+
+Bradley Potts holds final authority for commits, merges, tags, publishing, and
+releases.
+
+## Standard Handoff
+
+Every AI-prepared change should report files changed, validation performed,
+public behavior or contract impact, and unresolved risks. Do not edit generated
+outputs directly. Do not update [CHANGELOG.md](CHANGELOG.md) unless the change
+is release-relevant.
+
+This repository is maintained by PHCDevworks and contains the
+`ruby_api_pack_core` Ruby gem: the shared connection wrapper, response
+validator, and configuration pattern consumed by every other
+`ruby_api_pack_*` gem in this project team.
+
+## Upstream Requests and Roadmap Self-Expansion
+
+Full directive: project-team [AGENTS.md](../AGENTS.md) "Upstream Requests and
+Roadmap Self-Expansion." Applied to this repo:
+
+- This gem is **upstream** of `ruby_api_pack_active_campaign`,
+  `ruby_api_pack_cloudways`, and `ruby_api_pack_wordpress` — those gems depend
+  on this one. This repo has no dependency on any other repo in this
+  workspace.
+- Any breaking change to `Connection::Base`, `Handlers::ResponseValidator`, or
+  `Configurable`'s public method names must be coordinated with those three
+  consuming gems before or alongside release. Do not treat a breaking change
+  here as "docs/config only" — it has real downstream blast radius.
+- If a consuming gem requests new shared behavior (e.g. a new HTTP verb, a new
+  validator mode), record it in this repo's own `TODO.md` under `## Requested
+  by Downstream`, kept visible and separate from self-planned work.
+- This repo's own `ROADMAP.md` may be proactively expanded with new or
+  reordered phases by the agent's own analysis — but never mark a phase
+  delivered without `bundle exec rspec`, `bundle exec rubocop`, and
+  `gem build ruby_api_pack_core.gemspec` all passing.
+- Surface any new TODO request or roadmap expansion in the handoff for Bradley
+  Potts in the same change it was made, and reflect cross-repo-relevant
+  changes in the project-team's own ROADMAP.md/TODO.md.
+
+## Shared Source Rules
+
+| Path | Status | Notes |
+| --- | --- | --- |
+| `lib/ruby_api_pack_core.rb` | May edit carefully | Public gem entry point |
+| `lib/ruby_api_pack_core/configurable.rb` | May edit carefully | Shared configure/configuration mixin used by every consuming gem |
+| `lib/ruby_api_pack_core/connection/base.rb` | May edit carefully | Shared HTTParty/Oj connection template — every consuming gem subclasses this |
+| `lib/ruby_api_pack_core/handlers/response_validator.rb` | May edit carefully | Shared response-shape validator used by every consuming gem |
+| `lib/ruby_api_pack_core/version.rb` | May edit for releases | Gem version authority |
+| `spec/` | May edit | Required for behavior changes |
+| `README.md`, `CHANGELOG.md`, docs | May edit | Keep public guidance synchronized |
+| Credentials, secrets, tokens | Never commit | This gem has no vendor credentials of its own; keep it that way |
+
+Full validation command:
+
+```bash
+bundle exec rspec
+bundle exec rubocop
+gem build ruby_api_pack_core.gemspec
+```
+
+## Core Rules
+
+1. Treat `Connection::Base`, `Handlers::ResponseValidator`, `Configurable`,
+   and specs as the public behavior contract — every `ruby_api_pack_*` gem
+   depends on this surface staying stable.
+2. Keep this gem free of any vendor-specific knowledge (API tokens, endpoint
+   paths, resource classes). If a change needs to know which third-party API
+   is being called, it belongs in a consuming gem instead.
+3. `Connection::Base` subclasses in consuming gems should only need to
+   override `#auth_headers` — do not grow vendor-specific public methods on
+   `Base` itself.
+4. Do not log or document real API tokens, response bodies, or credentials —
+   this gem's specs use synthetic fixtures only.
+5. Update README and changelog when public usage changes.
+6. Add focused tests for changed connection, validator, or configurable
+   behavior.
+7. Preserve unrelated local changes.
+
+## Agent-Specific Guides
+
+- `CLAUDE.md` - primary implementation workflow.
+- `CODEX.md` - documentation, release readiness, and stabilization workflow.
+- `COPILOT.md` and `.github/copilot-instructions.md` - IDE support workflow.
+- `JULES.md` - bounded automated maintenance workflow.
+
+## Pull Request Creation
+
+Every agent that opens a PR must populate every section of the repository PR
+template:
+
+- Linked issue - issue number (`#N`) or `N/A`
+- Summary of changes - one or two bullets
+- Change type - additive, behavior change, breaking, or docs/config only
+- Checklist - completed items checked; blocked items left unchecked with a note
+
+Never submit a PR with an empty body or only template headings.

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to this project will be documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the versioning
+reflects gem releases published to RubyGems.
+
+## [0.1.0] - 2026-07-11 — Phase 0 - Shared Foundations
+
+Change type: additive (initial extraction)
+
+### Added
+
+- Initial extraction of `ruby_api_pack_core` from the shared architecture
+  already converged on by `ruby_api_pack_active_campaign`,
+  `ruby_api_pack_cloudways`, and `ruby_api_pack_wordpress`:
+  - `RubyApiPackCore::Connection::Base`, a template-method HTTParty/Oj
+    connection wrapper providing `api_get`/`api_post`/`api_put`/`api_delete`,
+    shared URL building, `200..299` status handling, content-type-checked
+    JSON parsing, and descriptive error messages. Subclasses implement only
+    `#auth_headers`.
+  - `RubyApiPackCore::Handlers::ResponseValidator`, a generic response-shape
+    validator (`expected_type: :array`/`:hash`) with Rails-aware error
+    logging, matching the validator already used by
+    `ruby_api_pack_active_campaign` and `ruby_api_pack_wordpress`.
+  - `RubyApiPackCore::Configurable`, a mixin extracted from the
+    `configure`/`configuration` singleton pattern duplicated across all
+    three existing gems.
+- Full RSpec coverage (19 examples, 100% line coverage) for the connection
+  base class, response validator, and configurable mixin, exercised against
+  synthetic dummy subclasses/modules.
+- Standard PHCDevworks documentation scaffold: `README.md`, `AGENTS.md`,
+  `CLAUDE.md`, `CODEX.md`, `COPILOT.md`, `JULES.md`, `CONTRIBUTING.md`,
+  `SECURITY.md`, `CODE_OF_CONDUCT.md`, `MIT-LICENSE`, `ROADMAP.md`,
+  `TODO.md`, GitHub issue/PR templates, CI workflows, and `.coderabbit.yaml`.
+
+### Changed
+
+- Bumped `httparty` to `~> 0.24.0` (from `~> 0.22.0`) and `rubocop-rake` to
+  `~> 0.7.0` (from `~> 0.6.0`) to track current RubyGems releases.
+- Reverted an attempted development `bundler` bump to `~> 4.0`; kept `~> 2.5`
+  after CI failed to resolve/install the newer major version.
+- Raised `required_ruby_version` to `>= 3.3.0` (from `>= 3.1.0`), matching
+  Rails 8's own Ruby floor. `httparty` and `rubocop` both carry unbounded
+  transitive dependencies (`multi_xml`, `parallel`) whose newer majors
+  require Ruby >= 3.2 and >= 3.3 respectively; rather than pin those
+  transitive deps indefinitely, dropped support for Ruby versions below what
+  Rails 8 itself requires. Updated the CI matrix to `['3.3.4', '3.4']`
+  accordingly.