payment_kit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2f63c858885c4bf00426e709a6475f55231eb337acb424be9d8e7b565e1ce4b
+  data.tar.gz: b4abb4c5010b83a53cea2bfdb534b8899dfbdff7cc2085465c2004f05fed1918
+SHA512:
+  metadata.gz: 45f546f9b176b82079e97f13238175164ccced5dd719aafb6b605e144e9eb135babcd7ff64b00168911c2328590133449a3352fcfffafcf3a3214f8345f41d63
+  data.tar.gz: 006fdae0b337efd41a072f19295b6bdbfd6dd99edcc06845aef006702e2798a1232d78cbaccd19858cafb457d4e37739ac06c8bb1863a2e6f0ae0f5b277c780c

data/CHANGELOG.md

@@ -0,0 +1,102 @@
+## [1.0.0] - 2026-08-17
+
+First public release.
+
+### Added
+
+- Webhook event bus: `subscribe` / `all` / `instrument` / `process_webhook`
+- `PaymentKit::Webhook.construct_event` with multi-secret verification (supports
+  the `roll-secret` rotation grace period)
+- Optional `PaymentKit::Engine` + `WebhookController` (Rails)
+- `PaymentKit.event_retriever` hook to deduplicate redelivered webhooks, and
+  `PaymentKit.error_handler` to report subscriber failures without triggering
+  PaymentKit's 5-attempt retry schedule
+- `PaymentKit::CardError` (HTTP 402) and `PaymentKit::ConflictError` (HTTP 409)
+- Errors expose `error_code`, `retryable?`, `problem` and RFC 7807 extension
+  members such as `invoice_id` / `subscription_id`
+- `PaymentKit::Client::AuthenticationError` and friends as aliases of the
+  module-level error classes, for applications written against a nested namespace
+- `idempotency_key:` on every write method; `PUT`/`PATCH` now also send an
+  auto-generated key, reused across internal retries
+- Subscription endpoints: `schedule_cancellation`, `cancel_scheduled_cancellation`,
+  `cancel_scheduled_pause`, `cancel_pending_change`, `retrieve_change_request`,
+  `apply_subscription_changes`
+- Customer credit endpoints: `set_credit_balance`, `create_credit_note`,
+  `list_credit_notes`, `list_customers`
+- Invoice endpoints: `list_invoices`, `list_invoice_items`
+- Payment endpoints: `create_payment_method`, `deactivate_payment_method`,
+  `list_payment_intents`, `list_refunds_by_intent`, `list_attempts_by_intent`
+- Catalog endpoints: `retrieve_product`, `create_product`, `update_product`,
+  `list_product_prices`
+- `PaymentKit::Instrumentation` with `request_begin` / `request_end` hooks around
+  outbound API calls, carrying `method`, `path`, `status`, `duration`,
+  `num_retries` and `request_id`
+- `Client#raw_request` escape hatch for endpoints the gem does not wrap, with
+  `account_scoped: false` for surfaces outside the account prefix (customer portal)
+- `PaymentKit::PermissionError` (HTTP 403) and `PaymentKit::SignatureVerificationError`,
+  both subclasses of `AuthenticationError` so existing rescues keep working
+- `PaymentKit.subscriber_error_handler` for per-subscriber failure isolation,
+  complementing the request-scoped `error_handler`
+- `PaymentKit.configure` accepts a zero-arity block, evaluated against the module,
+  for registering subscribers without repeating the receiver
+
+### Changed
+
+- `409` is retried only when PaymentKit flags it (`retryable: true` or a known
+  side-effect-free `error_code` such as `invoice_locked`) instead of always
+- Collection paths now match the API reference (`/customers/`, `/prices/`,
+  `/products/`, `/payments/intents/`), avoiding a `307` round trip
+- A webhook body that verifies but fails to parse raises `InvalidRequestError`
+  rather than `AuthenticationError`, and is reported correctly when several
+  signing secrets are configured
+- `WebhookController` answers `401` for a bad signature (was `400`), `400` for an
+  unparseable body, and reads `request.raw_post` so verification sees the exact
+  bytes after middleware has consumed the stream
+- `instrument` raises `InvalidRequestError` for an event with no `type` instead
+  of dispatching it under the bare namespace
+- A `2xx` response with an unparseable body raises `APIError` instead of
+  silently returning `{}`
+- Endpoint methods moved into `PaymentKit::Resources::*` modules
+- HTTP 403 raises `PermissionError` rather than a bare `AuthenticationError`
+- A numeric `Retry-After` header now drives the retry delay (capped at 32s)
+  instead of the exponential backoff curve
+- `request_id` falls back to the `Request-Id` response header when the error body
+  does not carry one
+- Depend on `activesupport` for `ActiveSupport::Notifications`
+
+### Documentation
+
+- RDoc API reference: `rake rdoc` / `rake rerdoc` build into `doc/`, and the
+  gemspec carries `rdoc_options` + `extra_rdoc_files` so
+  `gem install payment_kit --document=rdoc` produces the same output. The doc
+  task degrades gracefully when RDoc is absent, so `rake spec` and `rake rubocop`
+  are unaffected
+- Every public class, module, constant, attribute and method now carries an RDoc
+  comment (100% documented, up from 45%); internal helpers are marked `:nodoc:`
+- Converted the remaining YARD-style `@param`/`@return`/`@raise`/`@deprecated`
+  tags and `{Reference}` links to RDoc markup, which RDoc rendered literally
+- README documents every implemented endpoint with a copy-paste Ruby example,
+  plus a method index mapping each client method to its HTTP verb and path
+- Endpoint parameters, required fields and enum values now follow the
+  [PaymentKit API reference](https://docs.paymentkit.com/api-reference/introduction):
+  customers use `first_name`/`last_name`, credit amounts use `amount_atom`,
+  `create_credit_note` documents its four `reason` values, `update_subscription_items`
+  documents `proration_behavior` as required, and change requests document
+  `item_changes` actions and `apply_at_end`
+- Removed third-party payment-provider terminology from the README, CHANGELOG and
+  source comments; the architecture is described in PaymentKit's own terms
+- Corrected the stated runtime dependencies: the gem requires `activesupport`
+  (Rails remains optional, needed only for the mountable webhook engine)
+- Corrected the client overview: `POST`/`PUT`/`PATCH` all send an automatic
+  `Idempotency-Key`, and `409` is retried only when flagged retryable
+
+### Deprecated
+
+- `create_balance_transaction` — use `set_credit_balance`. The endpoint sets an
+  absolute target balance, not a delta.
+- `change_plan` — PaymentKit documents it as the legacy single-call endpoint,
+  planned for deprecation. Use the change-request workflow.
+
+## [0.1.0] - 2026-08-16
+
+- Initial PaymentKit Ruby HTTP client (`Configuration`, `Client`, typed errors, webhook verification)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Ammad Javaid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.