solidgate-ruby-sdk 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c09e01ee5693446c15395118e8cfbdaa984a116958ea3ca0b40571edfc792dc
-  data.tar.gz: 350e5a68b64c761e858dfe43b1be5543737cd439e9a3e7c008a42bd1ccceee05
+  metadata.gz: d423d0cbeef1718913f59ff786575342486d81d6eb73cfb3f5da06c475221f4a
+  data.tar.gz: c3768b1d3340a88db3c6496a25c5f37a7736fc6dd22ffbc57bf0f661c2b529a7
 SHA512:
-  metadata.gz: de3b3b8769772bd367f27bea5be25afa57c4e469e3ee267ca02d3dc930e47d34dff03f0f133e25b7ea48083c1efc4c5134aa617a8a60a36738188dfe5377216b
-  data.tar.gz: 9170f1bca57c7dc5b9a0a5f73cb5b05a0c9668b1bb564c59f9dfcc576d647fa7e81169cdf7016e6a8f69b89a90d9fe1170f576e9bb2d982886e84e2ee645b742
+  metadata.gz: ca06ec82f66d554752912b12b30125dfcdf8fab9ee83260adc3ab2149c5b135ec8c0a0ae03e8f7f1e7285a67ea66e63fd1fb9f7b42ca4577d32483d98e9c050d
+  data.tar.gz: 84852a85d4426c447fa50c8aeb33c4aa7afc1b3e31b6419d67c806d0d64fc522417e18bb2dab1963e894200906ab5d90f75f36a9999c2df15d76a0d4be220d62

data/AGENTS.md

@@ -0,0 +1,148 @@
+# Solidgate Ruby SDK - Agent Documentation
+# This file provides context for AI coding assistants about the codebase structure and conventions
+
+## Overview
+Solidgate Ruby SDK is an unofficial Ruby library for integrating with the Solidgate payment gateway API.
+It provides a clean, object-oriented interface for payment processing, subscription management, and webhook handling.
+
+## Project Structure
+
+### Core Components
+
+#### `lib/solidgate-ruby-sdk.rb`
+- Main entry point for the SDK
+- Defines the `Solidgate` module with global configuration
+- Provides `Solidgate.configure` and `Solidgate.configuration` methods
+- Loads all core components
+
+#### `lib/solidgate/configuration.rb`
+- `Solidgate::Configuration` class for managing API credentials and settings
+- Key attributes:
+  - `public_key` / `private_key` - API authentication credentials
+  - `sandbox` - Boolean for environment switching
+  - `api_url` - Custom API endpoint (defaults to sandbox/production based on sandbox setting)
+  - `timeout` / `open_timeout` - HTTP connection settings
+  - `user_agent` - Custom user agent string
+  - `webhook_public_key` / `webhook_private_key` - Webhook authentication
+- Production URL: `https://subscriptions.solidgate.com`
+- Sandbox URL: `https://subscriptions.solidgate.com`
+
+#### `lib/solidgate/client.rb`
+- `Solidgate::Client` class - Low-level HTTP client for API interactions
+- Handles authentication via HMAC-SHA512 signatures
+- Provides methods for all Solidgate API endpoints:
+  - Payment operations: `create_payment`, `get_payment`, `capture_payment`, `void_payment`, `refund_payment`, `settle_payment`
+  - Subscription operations: `create_subscription`, `subscription_status`, `switch_subscription_product`, `update_subscription_pause`, `create_subscription_pause`, `delete_subscription_pause`, `cancel_subscription`, `restore_subscription`
+  - Product operations: `create_product`, `create_price`, `products`, `product_prices`, `update_product_price`
+  - Utility methods: `generate_intent`, `generate_signature`, `refund`, `order_status`
+- Private methods for HTTP operations: `get`, `post`, `patch`, `delete`, `request`
+- Encryption: `encrypt_payload` for payment intent generation (AES-256-CBC)
+
+#### `lib/solidgate/payment.rb`
+- `Solidgate::Payment` class - High-level payment resource wrapper
+- Provides a more Ruby-idiomatic interface around `Solidgate::Client`
+- Includes validation for payment parameters
+- Methods: `create`, `get`, `capture`, `void`, `refund`
+
+#### `lib/solidgate/webhook.rb`
+- `Solidgate::Webhook` class - Webhook signature validation
+- Validates incoming webhook requests using configured webhook keys
+- Method: `validate_signature(payload, signature)`
+
+#### `lib/solidgate/errors.rb`
+- Custom error hierarchy:
+  - `Solidgate::Error` - Base error class
+  - `Solidgate::ConfigurationError` - Missing/invalid configuration
+  - `Solidgate::APIError` - General API errors (includes http_status)
+  - `Solidgate::AuthenticationError` - 401 responses
+  - `Solidgate::InvalidRequestError` - 400 responses
+  - `Solidgate::ConnectionError` - Network failures
+  - `Solidgate::TimeoutError` - Request timeouts
+  - `Solidgate::RateLimitError` - 429 responses
+  - `Solidgate::ValidationError` - Parameter validation (includes errors hash)
+
+#### `lib/solidgate/version.rb`
+- Version constant: `Solidgate::VERSION = "0.1.13"`
+
+### Test Structure
+
+#### `spec/spec_helper.rb`
+- RSpec configuration with WebMock and VCR
+- Disables real HTTP connections
+- Filters sensitive data (keys, signatures) from test recordings
+- Provides `:configured` metadata for tests requiring configuration
+
+#### `spec/solidgate/`
+- `client_spec.rb` - Client HTTP method tests
+- `configuration_spec.rb` - Configuration validation tests
+- `payment_spec.rb` - Payment resource tests
+
+### Utilities
+
+#### `bin/console`
+- Interactive Ruby console with SDK preloaded
+- Uses environment variables for credentials if available
+
+#### `bin/setup`
+- Automated setup script (runs bundle install)
+
+#### `Rakefile`
+- Default task runs specs
+- Uses bundler/gem_tasks for gem-related tasks
+
+#### `examples/basic_usage.rb`
+- Example demonstrating common SDK usage patterns
+- Shows error handling for different error types
+
+## Key Conventions
+
+### Authentication
+- All API requests require HMAC-SHA512 signature
+- Signature format: `Base64(HMAC_SHA516(private_key, public_key + json + public_key))`
+- Headers: `Merchant` (public key) and `Signature`
+
+### Error Handling
+- Use specific error classes for different failure scenarios
+- API errors include `code`, `details`, and `http_status`
+- Validation errors include detailed `errors` hash
+
+### API URL Selection
+- Uses `sandbox?` flag to choose between sandbox/production
+- Can override with custom `api_url` for testing
+
+### Payment Amounts
+- All amounts in minor units (cents for USD)
+- Currency codes are 3-letter ISO 4217
+
+### Webhook Security
+- Validate signatures using `webhook_public_key` and `webhook_private_key`
+- Never trust webhook data without validation
+
+## Development Notes
+
+### Adding New API Endpoints
+1. Add method to `Solidgate::Client` with proper documentation
+2. Follow existing naming conventions (snake_case for Ruby, kebab-case for API paths)
+3. Add corresponding tests in `spec/solidgate/client_spec.rb`
+4. Update README.md with usage examples
+
+### Code Style
+- Frozen string literals: `# frozen_string_literal: true`
+- 2-space indentation
+- YARD documentation for public methods
+- Follow Ruby conventions (snake_case for methods/variables)
+
+### Versioning
+- Follows Semantic Versioning (semver.org)
+- Version defined in `lib/solidgate/version.rb`
+- Update CHANGELOG.md for each release
+
+## Environment Variables
+- `SOLIDGATE_PUBLIC_KEY` - Public API key
+- `SOLIDGATE_PRIVATE_KEY` - Private API key
+- `SOLIDGATE_WEBHOOK_PUBLIC_KEY` - Webhook public key
+- `SOLIDGATE_WEBHOOK_PRIVATE_KEY` - Webhook private key
+
+## Dependencies
+- Runtime: `faraday`, `faraday-multipart`
+- Development: `rspec`, `webmock`, `vcr`, `rubocop`, `pry`

data/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.13] - 2026-02-13
+### Added
+- `order_status` endpoint to check order/payment status on `pay.solidgate.com` (`Solidgate::Client#order_status`).
+- README: expanded examples and documentation (order status, payment/refund examples).
+
+### Changed
+- Documentation and minor client docstring improvements.
+
+## [0.1.12] - 2026-02-13
+### Added
+- `update_product_price` endpoint (`Solidgate::Client#update_product_price`) to modify product price attributes.
+
+### Changed
+- Bumped packaged version to `0.1.12` and updated `Gemfile.lock`.
+- Tests updated for product/price management.
+
+## [0.1.11] - 2026-02-06
+### Added
+- `update_subscription_payment_method` endpoint to update a subscription's stored payment token.
+- README examples and RSpec coverage for subscription payment-method updates.
+
 ## [0.1.10] - 2026-02-03
 - Added refund method example to README
 
@@ -43,5 +64,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Thread-safe configuration
 - Comprehensive documentation and examples
 
-[Unreleased]: https://github.com/carrfane/solidgate-ruby-sdk/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/carrfane/solidgate-ruby-sdk/compare/v0.1.13...HEAD
+[0.1.13]: https://github.com/carrfane/solidgate-ruby-sdk/releases/tag/v0.1.13
+[0.1.12]: https://github.com/carrfane/solidgate-ruby-sdk/releases/tag/v0.1.12
+[0.1.11]: https://github.com/carrfane/solidgate-ruby-sdk/releases/tag/v0.1.11
+[0.1.10]: https://github.com/carrfane/solidgate-ruby-sdk/releases/tag/v0.1.10
 [0.1.0]: https://github.com/carrfane/solidgate-ruby-sdk/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solidgate-ruby-sdk (0.1.13)
+    solidgate-ruby-sdk (0.1.14)
       faraday
       faraday-multipart
 

data/README.md

@@ -103,6 +103,12 @@ client.capture_payment('payment_id_123', amount: 500)
 # Void an authorized payment (before settlement)
 client.void_payment('payment_id_123')
 
+# Refund a captured payment by payment ID
+client.refund_payment('payment_id_123')
+
+# Partial refund by payment ID
+client.refund_payment('payment_id_123', amount: 500, reason: 'Customer requested')
+
 # Refund by order ID (pay.solidgate.com)
 client.refund(order_id: 'order_123', amount: 1000)
 
@@ -173,6 +179,17 @@ client.update_subscription_pause('subscription_id_123',
 client.delete_subscription_pause('subscription_id_123')
 ```
 
+### Payment Settlement
+
+Settle a payment for final processing:
+
+```ruby
+client = Solidgate::Client.new
+
+# Settle a payment (note: current implementation may have issues)
+client.settle_payment
+```
+
 ### Product & Price Management
 
 ```ruby

data/lib/solidgate/client.rb

@@ -117,14 +117,14 @@ module Solidgate
     end
 
     # Settles a payment for final processing.
-    # Note: This method appears to have a bug and returns config.api_url instead of making an API call.
+    # Note: This method currently has a bug and returns config.api_url instead of making an API call.
     #
     # @param params [Hash] settlement parameters
     # @return [String] currently returns the API URL (likely unintended behavior)
     # @todo Fix this method to properly call the settlement endpoint
     #
     def settle_payment(params = {})
-      conifg.api_url
+      config.api_url
     end
 
     # Creates a new recurring subscription.
@@ -387,6 +387,10 @@ module Solidgate
       post('/api/v1/status', body: params, base_url: "https://pay.solidgate.com")
     end
 
+    def make_card_recurring(params)
+      post('/api/v1/recurring', body: params, base_url: "https://pay.solidgate.com")
+    end
+
     private
 
     # Builds a Configuration object from the provided options.

data/lib/solidgate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solidgate
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidgate-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Hector Carrillo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-13 00:00:00.000000000 Z
+date: 2026-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".ruby-version"
+- AGENTS.md
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock