zai_payment 2.8.5 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8598e7bf2a63f176accff321924e733fe29e3c7ed6c1ce8885c128f057ede980
-  data.tar.gz: b5c3ad4634b980210f7239e8104be6e743834b8e45329bf00b6e52c00d0cc0f8
+  metadata.gz: 68b76b84ea2dd83e23dd709f8e3e13f466b6c76288231422450aa51327c53fc8
+  data.tar.gz: ff828a44dbc6769aff37a705b184a7868c3610ad7580261806e511f57ffe5c6e
 SHA512:
-  metadata.gz: eb5d3e5aa75f0ea46a6e12496c2ea79c6bd0f027aab3ea90d534c8b1d8b7401e0207a8c8b7eb71e02479c9fc67a405252b3a19d450618572e33407f1a3026143
-  data.tar.gz: dd3084f1c3a00676170401a1083eb9432e654390603cb677aed3545cd066a38501a9fa58ed2817890c7ff815e4196a9f5dc28baf5106cb178edf656292220c4b
+  metadata.gz: 1857326fecea58e66633a177f6322aa5c6cc7d93b71e51b93d768d30d470c031783ac35a2036dbc19680850554c0ea79b24cb907b16313966a0c199b1811a3f4
+  data.tar.gz: 4125e27bc20f280f4f9a02a8b4c8d989acb8df5a7859265ac474d7412c253f80fe466f91aeee19d8a3d69b3f98de2d5c6720cdcd524c2ba34cc32714f097b4cc

data/badges/coverage.json

@@ -1 +1 @@
-{"schemaVersion": 1, "label": "coverage", "message": "95.51%", "color": "brightgreen"}
+{"schemaVersion": 1, "label": "coverage", "message": "95.57%", "color": "brightgreen"}

data/changelog.md

@@ -1,5 +1,39 @@
 ## [Released]
 
+## [2.9.0] - 2025-12-16
+
+### Added
+- **Webhook Jobs API**: Retrieve and monitor webhook delivery jobs 📋
+  - `ZaiPayment.webhooks.list_jobs(webhook_id, limit:, offset:, status:, object_id:)` - List jobs associated with a webhook
+  - `ZaiPayment.webhooks.show_job(webhook_id, job_id)` - Get details of a specific webhook job
+  - Support for pagination with `limit` (1-200) and `offset` parameters
+  - Support for filtering by `status` ('success' or 'failed')
+  - Support for filtering by `object_id`
+  - Job details include: `uuid`, `webhook_uuid`, `object_id`, `payload`, `request_responses`, `created_at`, `updated_at`
+  - Request responses include delivery attempts with `response_code`, `message`, and timestamps
+  - Validation for status parameter (must be 'success' or 'failed')
+  - Full RSpec test suite with 21 test examples
+  - Comprehensive YARD documentation with examples
+
+### Enhanced
+- **Response Class**: Added `jobs` to `RESPONSE_DATA_KEYS` for automatic data extraction
+  - `response.data` now properly extracts jobs array from list_jobs responses
+  - Consistent with other resource response handling
+
+**Full Changelog**: https://github.com/Sentia/zai-payment/compare/v2.8.6...v2.9.0
+
+## [2.8.6] - 2025-12-12
+
+### Fixed
+- **Production API Endpoints**: Fixed incorrect production URL configuration 🔧
+  - Corrected `core_base` endpoint to use `https://secure.api.promisepay.com` (was incorrectly set to assemblypay.com)
+  - Corrected `va_base` endpoint to use `https://au-0000.api.assemblypay.com` (was incorrectly set to promisepay.com)
+  - Removed deprecated `webhook_base_endpoint` method from Config class
+  - Production environment now uses correct endpoints for core API and virtual accounts
+  - Ensures proper routing of production API requests to Zai servers
+
+**Full Changelog**: https://github.com/Sentia/zai-payment/compare/v2.8.5...v2.8.6
+
 ## [2.8.5] - 2025-12-12
 
 ### Fixed

data/lib/zai_payment/config.rb

@@ -31,26 +31,13 @@ module ZaiPayment
         }
       when :production
         {
-          core_base: 'https://au-0000.api.assemblypay.com',
-          va_base: 'https://secure.api.promisepay.com',
+          core_base: 'https://secure.api.promisepay.com',
+          va_base: 'https://au-0000.api.assemblypay.com',
           auth_base: 'https://au-0000.auth.assemblypay.com'
         }
       else
         raise "Unknown environment: #{environment}"
       end
     end
-
-    # Returns the appropriate webhook base endpoint based on environment
-    # Production uses core_base, prelive uses va_base
-    def webhook_base_endpoint
-      case environment.to_sym
-      when :production
-        :core_base
-      when :prelive
-        :va_base
-      else
-        raise "Unknown environment: #{environment}"
-      end
-    end
   end
 end

data/lib/zai_payment/resources/webhook.rb

@@ -133,6 +133,62 @@ module ZaiPayment
         client.delete("/webhooks/#{webhook_id}")
       end
 
+      # List jobs associated with a webhook
+      #
+      # Retrieves an ordered and paginated list of jobs garnered from a webhook.
+      #
+      # @param webhook_id [String] the webhook ID (UUID)
+      # @param limit [Integer] number of records to retrieve (1-200, default: 10)
+      # @param offset [Integer] number of records to skip (default: 0)
+      # @param status [String] filter by status ('success', 'failed', or nil for all)
+      # @param object_id [String] filter by object_id
+      # @return [Response] the API response containing jobs array
+      #
+      # @example List all jobs for a webhook
+      #   webhooks = ZaiPayment::Resources::Webhook.new
+      #   response = webhooks.list_jobs("webhook_uuid")
+      #   response.data # => [{"id" => "...", "status" => "success", ...}, ...]
+      #
+      # @example Filter jobs by status
+      #   response = webhooks.list_jobs("webhook_uuid", status: "failed")
+      #
+      # @example Paginate through jobs
+      #   response = webhooks.list_jobs("webhook_uuid", limit: 50, offset: 100)
+      #
+      # @see https://developer.hellozai.com/reference/getjobs
+      def list_jobs(webhook_id, limit: 10, offset: 0, status: nil, object_id: nil)
+        validate_id!(webhook_id, 'webhook_id')
+        validate_job_status!(status) if status
+
+        params = {
+          limit: limit,
+          offset: offset
+        }
+        params[:status] = status if status
+        params[:object_id] = object_id if object_id
+
+        client.get("/webhooks/#{webhook_id}/jobs", params: params)
+      end
+
+      # Show a specific job associated with a webhook
+      #
+      # @param webhook_id [String] the webhook ID (UUID)
+      # @param job_id [String] the job ID
+      # @return [Response] the API response containing job details
+      #
+      # @example
+      #   webhooks = ZaiPayment::Resources::Webhook.new
+      #   response = webhooks.show_job("webhook_uuid", "job_id")
+      #   response.data # => {"id" => "job_id", "status" => "success", ...}
+      #
+      # @see https://developer.hellozai.com/reference/getjob
+      def show_job(webhook_id, job_id)
+        validate_id!(webhook_id, 'webhook_id')
+        validate_id!(job_id, 'job_id')
+
+        client.get("/webhooks/#{webhook_id}/jobs/#{job_id}")
+      end
+
       # Create a secret key for webhook signature verification
       #
       # @param secret_key [String] the secret key to use for HMAC signature generation
@@ -262,6 +318,14 @@ module ZaiPayment
         raise Errors::ValidationError, 'secret_key must be at least 32 bytes in size'
       end
 
+      def validate_job_status!(status)
+        valid_statuses = %w[success failed]
+        return if valid_statuses.include?(status)
+
+        raise Errors::ValidationError,
+              "status must be one of: #{valid_statuses.join(', ')}"
+      end
+
       def parse_signature_header(header)
         # Format: "t=1257894000,v=signature1,v=signature2"
         parts = header.split(',').map(&:strip)

data/lib/zai_payment/response.rb

@@ -6,7 +6,7 @@ module ZaiPayment
     attr_reader :status, :body, :headers, :raw_response
 
     RESPONSE_DATA_KEYS = %w[
-      webhooks users items fees transactions
+      webhooks users items fees transactions jobs
       batch_transactions batches bpay_accounts bank_accounts card_accounts
       wallet_accounts virtual_accounts disbursements pay_ids
     ].freeze

data/lib/zai_payment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZaiPayment
-  VERSION = '2.8.5'
+  VERSION = '2.9.0'
 end

data/lib/zai_payment.rb

@@ -46,7 +46,7 @@ module ZaiPayment
     # --- Resource accessors ---
     # @return [ZaiPayment::Resources::Webhook] webhook resource instance
     def webhooks
-      @webhooks ||= Resources::Webhook.new(client: Client.new(base_endpoint: config.webhook_base_endpoint))
+      @webhooks ||= Resources::Webhook.new(client: Client.new(base_endpoint: :va_base))
     end
 
     # @return [ZaiPayment::Resources::User] user resource instance

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zai_payment
 version: !ruby/object:Gem::Version
-  version: 2.8.5
+  version: 2.9.0
 platform: ruby
 authors:
 - Eddy Jaga