zai_payment 2.9.0 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68b76b84ea2dd83e23dd709f8e3e13f466b6c76288231422450aa51327c53fc8
-  data.tar.gz: ff828a44dbc6769aff37a705b184a7868c3610ad7580261806e511f57ffe5c6e
+  metadata.gz: 27a391c944632b4a4b72fe58a4e22d189304455cd4f9656966d010dd22719c6d
+  data.tar.gz: ad176a20efd417af6d0d7dd00de7842f4efdc4154d1c9321c766631c78937525
 SHA512:
-  metadata.gz: 1857326fecea58e66633a177f6322aa5c6cc7d93b71e51b93d768d30d470c031783ac35a2036dbc19680850554c0ea79b24cb907b16313966a0c199b1811a3f4
-  data.tar.gz: 4125e27bc20f280f4f9a02a8b4c8d989acb8df5a7859265ac474d7412c253f80fe466f91aeee19d8a3d69b3f98de2d5c6720cdcd524c2ba34cc32714f097b4cc
+  metadata.gz: '07248e63f96fd8223e21868c515492b3281935b9bc89854cc3df61526e28435e72842c397b9d050fe5f21a7fe73991aa3ff62ea48cfd2c36688bcdc1445b51b7'
+  data.tar.gz: 70e896447209679b5b75bc41b820910b074a1bda2d6f0e9b7c2679249681749634204d13b4519e3696b7150eba66e3539745da2c81485817fd9f95e4bc0c6949

data/lib/zai_payment/version.rb

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

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zai_payment
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.9.1
 platform: ruby
 authors:
 - Eddy Jaga
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -58,45 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".yardopts"
-- IMPLEMENTATION_SUMMARY.md
 - LICENSE.txt
-- RESPONSE_FORMAT_CORRECTION.md
-- Rakefile
-- badges/.gitkeep
-- badges/coverage.json
-- changelog.md
-- code_of_conduct.md
-- contributing.md
-- docs/architecture.md
-- docs/authentication.md
-- docs/bank_accounts.md
-- docs/batch_transactions.md
-- docs/bpay_accounts.md
-- docs/direct_api_usage.md
-- docs/items.md
-- docs/pay_ids.md
-- docs/readme.md
-- docs/token_auths.md
-- docs/user_id_field.md
-- docs/user_quick_reference.md
-- docs/users.md
-- docs/virtual_accounts.md
-- docs/wallet_accounts.md
-- docs/webhook_security_quickstart.md
-- docs/webhook_signature.md
-- docs/webhooks.md
-- examples/bank_accounts.md
-- examples/batch_transactions.md
-- examples/bpay_accounts.md
-- examples/items.md
-- examples/pay_ids.md
-- examples/rails_card_payment.md
-- examples/token_auths.md
-- examples/users.md
-- examples/virtual_accounts.md
-- examples/wallet_accounts.md
-- examples/webhooks.md
 - lib/zai_payment.rb
 - lib/zai_payment/auth/token_provider.rb
 - lib/zai_payment/auth/token_store.rb
@@ -116,8 +79,6 @@ files:
 - lib/zai_payment/resources/webhook.rb
 - lib/zai_payment/response.rb
 - lib/zai_payment/version.rb
-- readme.md
-- sig/zai_payment.rbs
 homepage: https://www.sentia.com.au
 licenses:
 - MIT
@@ -129,6 +90,7 @@ metadata:
   code_of_conduct_uri: https://github.com/Sentia/zai-payment/blob/main/code_of_conduct.md
   rubygems_mfa_required: 'true'
   documentation_uri: https://github.com/Sentia/zai-payment#readme
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -143,7 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby gem for Zai payment integration
 test_files: []

data/.yardopts

@@ -1,3 +0,0 @@
---markup markdown
---readme readme.md
-lib

data/IMPLEMENTATION_SUMMARY.md

@@ -1,183 +0,0 @@
-# Batch Transactions Implementation Summary
-
-## Overview
-
-Successfully implemented prelive-only batch transaction endpoints for the Zai Payment Ruby gem. These endpoints allow testing and simulation of batch transaction processing flows in the prelive environment.
-
-## Files Created
-
-### 1. Resource Implementation
-**File:** `lib/zai_payment/resources/batch_transaction.rb`
-
-Implements the `BatchTransaction` resource class with the following methods:
-- `export_transactions` - Exports pending batch transactions to batched state
-- `update_transaction_states` - Updates batch transaction states (12700 or 12000)
-- `process_to_bank_processing` - Convenience method for state 12700
-- `process_to_successful` - Convenience method for state 12000 (triggers webhooks)
-
-**Key Features:**
-- Environment validation (prelive-only)
-- Comprehensive parameter validation
-- Clear error messages
-- Full YARD documentation
-
-### 2. Spec File
-**File:** `spec/zai_payment/resources/batch_transaction_spec.rb`
-
-Comprehensive test coverage including:
-- Export transactions functionality
-- Update transaction states with both state codes
-- Convenience methods (process_to_bank_processing, process_to_successful)
-- Environment validation (prelive vs production)
-- Parameter validation for all methods
-- Multiple transaction ID handling
-- Integration with ZaiPayment module
-
-### 3. Documentation
-
-#### Examples
-**File:** `examples/batch_transactions.md`
-- Complete workflow examples
-- Step-by-step usage guide
-- Error handling examples
-- Multiple transaction processing
-- Webhook testing guide
-
-#### Technical Documentation
-**File:** `docs/batch_transactions.md`
-- Complete method reference with signatures
-- Parameter descriptions and types
-- Return value specifications
-- Error handling details
-- State code documentation
-- Lifecycle diagrams
-- Integration examples
-
-## Files Modified
-
-### 1. Main Module
-**File:** `lib/zai_payment.rb`
-- Added require for batch_transaction resource
-- Added `batch_transactions` accessor method
-
-### 2. Response Class
-**File:** `lib/zai_payment/response.rb`
-- Added "batches" to RESPONSE_DATA_KEYS array
-
-### 3. README
-**File:** `readme.md`
-- Added batch transactions to Features section
-- Added new Quick Start section with example
-- Added to Roadmap as completed feature
-- Added to Examples & Patterns section
-- Added documentation links
-
-## API Endpoints Implemented
-
-### 1. Export Transactions
-**Method:** `GET /batch_transactions/export_transactions`
-**Purpose:** Move all pending batch_transactions to batched state
-**Returns:** Array of transactions with batch_id and transaction id
-
-### 2. Update Transaction States
-**Method:** `PATCH /batches/:id/transaction_states`
-**Purpose:** Move batch transactions between states
-**Supports:**
-- State 12700 (bank_processing)
-- State 12000 (successful - triggers webhooks)
-
-## Usage Example
-
-```ruby
-# Configure for prelive
-ZaiPayment.configure do |config|
-  config.environment = :prelive
-  config.client_id = 'your_client_id'
-  config.client_secret = 'your_client_secret'
-  config.scope = 'your_scope'
-end
-
-# Export transactions
-export_response = ZaiPayment.batch_transactions.export_transactions
-batch_id = export_response.data.first['batch_id']
-transaction_ids = export_response.data.map { |t| t['id'] }
-
-# Move to bank_processing
-ZaiPayment.batch_transactions.process_to_bank_processing(
-  batch_id,
-  exported_ids: transaction_ids
-)
-
-# Complete processing (triggers webhook)
-ZaiPayment.batch_transactions.process_to_successful(
-  batch_id,
-  exported_ids: transaction_ids
-)
-```
-
-## Error Handling
-
-### ConfigurationError
-Raised when attempting to use batch transaction endpoints outside prelive environment.
-
-### ValidationError
-Raised for:
-- Blank or nil batch_id
-- Empty or nil exported_ids array
-- exported_ids not an array
-- exported_ids containing nil or empty values
-- Invalid state codes (not 12700 or 12000)
-
-## Key Design Decisions
-
-1. **Prelive-Only Enforcement**: Environment check in every method to prevent accidental production use
-2. **Convenience Methods**: Separate methods for common operations (process_to_bank_processing, process_to_successful)
-3. **Array Support**: All methods support processing multiple transactions at once
-4. **State Code Constants**: Clear documentation of state codes (12700, 12000)
-5. **Comprehensive Validation**: All parameters validated with clear error messages
-6. **Consistent API**: Follows same patterns as other resources in the gem
-
-## Testing
-
-The implementation includes comprehensive RSpec tests covering:
-- ✅ Happy path for all methods
-- ✅ Error cases (invalid environment, invalid parameters)
-- ✅ Multiple transaction handling
-- ✅ Response structure validation
-- ✅ Integration with main module
-
-## Documentation
-
-Three levels of documentation provided:
-1. **YARD Comments**: Inline documentation in the code
-2. **Examples**: Practical usage examples (`examples/batch_transactions.md`)
-3. **Technical Guide**: Complete reference documentation (`docs/batch_transactions.md`)
-
-## Next Steps
-
-The implementation is complete and ready for use. To use it:
-
-1. Ensure your environment is set to `:prelive`
-2. Access via `ZaiPayment.batch_transactions`
-3. Follow the workflow: export → bank_processing → successful
-4. Handle webhooks triggered by the successful state
-
-## Files Summary
-
-**Created:**
-- `lib/zai_payment/resources/batch_transaction.rb` (172 lines)
-- `spec/zai_payment/resources/batch_transaction_spec.rb` (443 lines)
-- `examples/batch_transactions.md` (276 lines)
-- `docs/batch_transactions.md` (434 lines)
-
-**Modified:**
-- `lib/zai_payment.rb` (added 2 lines)
-- `lib/zai_payment/response.rb` (added "batches" key)
-- `readme.md` (added sections and examples)
-
-**Total:** 1,325+ lines of code, tests, and documentation added.
-
-## No Linter Errors
-
-All files pass linting checks with no errors or warnings.
-

data/RESPONSE_FORMAT_CORRECTION.md

@@ -1,75 +0,0 @@
-# Batch Transactions API Response Correction
-
-## Response Format for PATCH /batches/:id/transaction_states
-
-### ✅ Correct Response Format
-
-The actual API response for `PATCH /batches/:id/transaction_states` contains:
-
-```json
-{
-  "aggregated_jobs_uuid": "c1cbc502-9754-42fd-9731-2330ddd7a41f",
-  "msg": "1 jobs have been sent to the queue.",
-  "errors": []
-}
-```
-
-### Response Fields
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `aggregated_jobs_uuid` | String | UUID identifying the batch of jobs sent to the queue |
-| `msg` | String | Success message indicating how many jobs were queued |
-| `errors` | Array | Array of any errors (typically empty on success) |
-
-### Ruby Usage Example
-
-```ruby
-response = ZaiPayment.batch_transactions.update_transaction_states(
-  'batch_id',
-  exported_ids: ['439970a2-e0a1-418e-aecf-6b519c115c55'],
-  state: 12700
-)
-
-# Access response data
-response.body['aggregated_jobs_uuid'] # => "c1cbc502-9754-42fd-9731-2330ddd7a41f"
-response.body['msg']                   # => "1 jobs have been sent to the queue."
-response.body['errors']                # => []
-
-# Check for success
-if response.success? && response.body['errors'].empty?
-  puts "Successfully queued #{response.body['msg']}"
-  puts "Job UUID: #{response.body['aggregated_jobs_uuid']}"
-end
-```
-
-### Multiple Transactions
-
-When processing multiple transactions, the message reflects the count:
-
-```ruby
-response = ZaiPayment.batch_transactions.update_transaction_states(
-  'batch_id',
-  exported_ids: ['id1', 'id2', 'id3'],
-  state: 12000
-)
-
-response.body['msg'] # => "3 jobs have been sent to the queue."
-```
-
-## Updated Files
-
-All documentation and specs have been updated to reflect the correct response format:
-
-1. ✅ `lib/zai_payment/resources/batch_transaction.rb` - YARD documentation
-2. ✅ `spec/zai_payment/resources/batch_transaction_spec.rb` - Test expectations
-3. ✅ `examples/batch_transactions.md` - Example code
-4. ✅ `docs/batch_transactions.md` - Technical documentation
-
-## Key Points
-
-- The response is **asynchronous** - jobs are queued for processing
-- The `aggregated_jobs_uuid` can be used to track the batch of jobs
-- Check the `errors` array to ensure no errors occurred
-- The `msg` field contains a human-readable description of what was queued
-

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/badges/.gitkeep

@@ -1,2 +0,0 @@
-# This directory stores coverage badge JSON
-

data/badges/coverage.json

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