nowpayments 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97ac8b5b89917ed020bf1fc5c887cc02ab236a65778433696826adbcf55298ab
+  data.tar.gz: 1faa8a8ef8abdb85c17e33c6f5ddfe7eb17f434a062784095c32627b924eac94
+SHA512:
+  metadata.gz: 41100692b84c8888da5c11292d1759c0b17c48027ab72fa15b4b755675402ad39fb36c441cd13cb12a526eb969126700e3c636e3df01de54f3d8e8e5bbe8e85b
+  data.tar.gz: 3e66866c39e02084cbfa8156d6b79160eeb962955cbafa1900d298321cb99759da60c43728dc1336b359c32bfbd69ef5f8827e40bbe67d96038268b6373eb2f7

data/.env.example

@@ -0,0 +1,4 @@
+# NOWPayments Sandbox API credentials for testing
+# Get these from: https://account-sandbox.nowpayments.io/
+NOWPAYMENTS_SANDBOX_API_KEY=your_sandbox_api_key_here
+NOWPAYMENTS_SANDBOX_IPN_SECRET=your_sandbox_ipn_secret_here

data/CHANGELOG.md

@@ -0,0 +1,122 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2025-11-01
+
+### Added - 100% API Coverage Achievement! 🎉
+- **JWT Authentication Module (5 methods)**: Complete token lifecycle management
+  - `authenticate(email:, password:)` - Get JWT token with 5-minute expiration
+  - `jwt_token(email:, password:)` - Get token with optional auto-refresh
+  - `jwt_expired?` - Check token validity
+  - `clear_jwt_token` - Manual token clearing
+  - `jwt_time_remaining` - Seconds until token expires
+  - Automatic Bearer token injection in Authorization header
+  - Connection reset mechanism on token change
+- **Fiat Payouts Module (8 methods)**: Beta - Crypto to fiat withdrawals
+  - `fiat_payout_payment_methods` - Get available payment methods
+  - `create_fiat_payout_account` - Create payout account
+  - `fiat_payout_accounts` - List payout accounts
+  - `update_fiat_payout_account` - Update account details
+  - `create_fiat_payout` - Create fiat payout
+  - `fiat_payout_status` - Get payout status
+  - `fiat_payouts` - List all payouts with 13 filter options
+  - `fiat_payout_rates` - Get conversion rates
+- **Invoice Status Method**: `invoice(invoice_id)` - Get invoice details and status
+- **Mass Payouts (8 methods)**: Batch withdrawals with 2FA verification
+  - `balance` - Get account balance
+  - `create_payout` - Create batch payout (JWT required)
+  - `verify_payout` - 2FA verification (JWT required)
+  - `payout_status` - Get payout status
+  - `list_payouts` - List all payouts (JWT required)
+  - `validate_payout_address` - Validate withdrawal address
+  - `min_payout_amount` - Get minimum payout amount
+  - `payout_fee` - Calculate payout fee
+- **Conversions Module (3 methods)**: Currency conversions (JWT required)
+  - `create_conversion` - Convert between cryptocurrencies
+  - `conversion_status` - Check conversion status
+  - `list_conversions` - List all conversions
+- **Custody/Sub-accounts Module (11 methods)**: User wallet management for marketplaces
+  - `create_sub_account` - Create user account
+  - `sub_account_balance` - Get user balance
+  - `sub_account_balances` - Get all balances
+  - `list_sub_accounts` - List all sub-accounts
+  - `transfer_between_sub_accounts` - Transfer between users (JWT required)
+  - `create_sub_account_deposit` - Generate deposit address
+  - `create_sub_account_payment_deposit` - Payment to sub-account
+  - `transfer_to_sub_account` - Deposit to user
+  - `withdraw_from_sub_account` - Withdraw from user (JWT required)
+  - `sub_account_transfer` - Get transfer details
+  - `sub_account_transfers` - List all transfers
+- **Subscriptions/Recurring Payments Module (9 methods)**: Complete subscription management
+  - `subscription_plans` - List all plans
+  - `create_subscription_plan` - Create new plan
+  - `update_subscription_plan` - Update plan
+  - `subscription_plan` - Get plan details
+  - `create_subscription` - Create subscription
+  - `list_recurring_payments` - List with filters
+  - `recurring_payment` - Get subscription details
+  - `delete_recurring_payment` - Cancel subscription (JWT required)
+  - `subscription_payments` - List subscription payments
+
+### Changed
+- **Complete API Coverage**: Now 57 methods across 11 modules (was 44 methods across 9 modules)
+- **Modular Architecture**: Split monolithic client (674 lines) into focused API modules (76-line client + 11 modules)
+- **Documentation**: Updated README to 578 lines with complete method list, usage examples, and guides
+- Version bump from 0.1.0 to 0.2.0 (minor version for new features)
+
+### Documentation
+- Added comprehensive API reference (docs/API.md - 950+ lines)
+- Added JWT authentication examples (examples/jwt_authentication_example.rb - 10 usage patterns)
+- Updated README with collapsible method lists and detailed usage guides
+- Added currency conversions examples
+- Added fiat payouts usage guide
+- Added internal documentation for gap analysis and sprint reports
+
+### Security
+- JWT Bearer token support for protected endpoints
+- Automatic token expiration management (5-minute lifetime)
+- Secure token storage and injection
+- All existing webhook security features maintained
+
+### Breaking Changes
+- None - All changes are additive and backward compatible
+
+## [0.1.0] - 2025-01-XX
+
+### Added
+- Complete API client implementation with all NOWPayments v1 endpoints
+- Payment API: create, retrieve, list with filters, update estimate
+- Invoice API: create hosted payment pages with success/cancel URLs
+- Subscription API: plans, create plan, get plan, create subscription, list payments
+- Payout API: mass withdrawals support
+- Estimation API: minimum amounts and price estimates
+- Status & utility endpoints: API status, currencies, full currency info, merchant coins
+- Comprehensive error handling with custom exception hierarchy (8 error types)
+- Secure IPN webhook verification with HMAC-SHA512 and recursive key sorting
+- Rack middleware for Rails/Sinatra webhook integration
+- Faraday ErrorHandler middleware for automatic HTTP error mapping
+- Sandbox environment support for testing
+- VCR cassette support for reliable integration testing
+- Complete RSpec test suite with WebMock integration
+- Example scripts: simple demo and webhook server (Sinatra)
+- Comprehensive API documentation (docs/API.md)
+- Professional README with usage examples
+
+### Changed
+- Upgraded to Faraday 2.x with built-in JSON support (no faraday-json dependency)
+- All API methods return raw Hash responses (no data models per design decision)
+
+### Security
+- Implemented constant-time signature comparison to prevent timing attacks
+- Recursive key sorting for consistent HMAC signature generation
+- Webhook signature verification with SecurityError on failure
+
+[Unreleased]: https://github.com/Sentia/nowpayments/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/Sentia/nowpayments/releases/tag/v0.1.0
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chayut Orapinpatipat
+
+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.