Merge pull request #13 from Sentia/feature/generate-token-promise-pay

Generate token

Author: eddyjaga

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zai_payment (2.0.2)
+    zai_payment (2.1.0)
       base64 (~> 0.3.0)
       faraday (~> 2.0)
       openssl (~> 3.3)

changelog.md

@@ -1,4 +1,32 @@
 ## [Released]
+## [2.1.0] - 2025-10-24
+### Added
+- **Token Auth API**: Token generation for bank and card accounts 🔐
+  - `ZaiPayment.token_auths.generate(user_id:, token_type:)` - Generate tokens for secure payment data collection
+  - Support for bank tokens (collecting bank account information)
+  - Support for card tokens (collecting credit card information)
+  - Token type validation (bank or card)
+  - User ID validation
+  - Full RSpec test suite for TokenAuth resource
+  - Comprehensive examples documentation in `examples/token_auths.md`
+
+### Documentation
+- Added detailed TokenAuth API examples with complete integration patterns
+- Frontend integration examples (PromisePay.js)
+- Rails controller integration examples
+- Service object pattern examples
+- Error handling and retry logic examples
+- Security best practices (token expiry management, audit logging, rate limiting)
+- Complete payment flow example
+
+### Testing
+- 20+ new test cases for TokenAuth resource
+- Validation error handling tested
+- Case-insensitive token type support tested
+- Default parameter behavior tested
+
+**Full Changelog**: https://github.com/Sentia/zai-payment/compare/v2.0.2...v2.1.0
+
 ## [2.0.2] - 2025-10-24
 ### Fixed
 - **Items API**: Fixed endpoint configuration to use `core_base` instead of `va_base`

docs/readme.md

@@ -14,6 +14,9 @@ Welcome to the Zai Payment Ruby gem documentation. This guide will help you find
 
 - [**architecture.md**](architecture.md) - System architecture and design principles
 - [**authentication.md**](authentication.md) - OAuth2 implementation, token management, two approaches
+- [**users.md**](users.md) - User management for payin (buyers) and payout (sellers/merchants)
+- [**items.md**](items.md) - Item management for transactions and payments
+- [**token_auths.md**](token_auths.md) - Token generation for secure bank and card data collection
 - [**webhooks.md**](webhooks.md) - Webhook implementation details, best practices, and patterns
 
 ## 🔐 Security Guides
@@ -23,6 +26,9 @@ Welcome to the Zai Payment Ruby gem documentation. This guide will help you find
 
 ## 📝 Examples
 
+- [**User Examples**](../examples/users.md) - User management examples and patterns
+- [**Item Examples**](../examples/items.md) - Transaction and payment workflows
+- [**Token Auth Examples**](../examples/token_auths.md) - Token generation and PromisePay.js integration
 - [**Webhook Examples**](../examples/webhooks.md) - Comprehensive webhook usage examples including:
   - Basic CRUD operations
   - Rails controller implementation
@@ -38,6 +44,21 @@ Welcome to the Zai Payment Ruby gem documentation. This guide will help you find
 - **Short Way**: `ZaiPayment.token` (one-liner)
 - **Long Way**: `TokenProvider.new(config: config).bearer_token` (full control)
 
+### Users
+- **Guide**: [User Management](users.md)
+- **Examples**: [User Examples](../examples/users.md)
+- **API Reference**: [Zai Users API](https://developer.hellozai.com/reference/getallusers)
+
+### Items
+- **Guide**: [Item Management](items.md)
+- **Examples**: [Item Examples](../examples/items.md)
+- **API Reference**: [Zai Items API](https://developer.hellozai.com/reference/listitems)
+
+### Token Auth
+- **Guide**: [Token Auth](token_auths.md)
+- **Examples**: [Token Auth Examples](../examples/token_auths.md)
+- **API Reference**: [Zai Generate Token API](https://developer.hellozai.com/reference/generatetoken)
+
 ### Webhooks
 - **Setup**: [Quick Start Guide](webhook_security_quickstart.md)
 - **Examples**: [Complete Examples](../examples/webhooks.md)
@@ -54,28 +75,37 @@ Welcome to the Zai Payment Ruby gem documentation. This guide will help you find
 ```
 docs/
 ├── readme.md                        # This file - documentation index
-├── authentication.md                # OAuth2 authentication guide (NEW!)
+├── authentication.md                # OAuth2 authentication guide
+├── users.md                         # User management guide
+├── items.md                         # Item management guide
+├── token_auths.md                   # Token generation guide (NEW!)
 ├── architecture.md                  # System architecture
 ├── webhooks.md                      # Webhook technical docs
 ├── webhook_security_quickstart.md   # Quick security setup
 └── webhook_signature.md             # Signature implementation
 
 examples/
-└── webhooks.md                      # Complete webhook examples
+├── users.md                         # User management examples
+├── items.md                         # Item examples
+├── token_auths.md                   # Token auth examples (NEW!)
+└── webhooks.md                      # Webhook examples
 ```
 
 ## 💡 Tips
 
 - **Getting tokens?** Check [authentication.md](authentication.md) for both approaches
-- **Looking for code examples?** Check [examples/webhooks.md](../examples/webhooks.md)
+- **Managing users?** See [users.md](users.md) for payin and payout user guides
+- **Creating transactions?** Review [items.md](items.md) for item management
+- **Collecting payment data?** See [token_auths.md](token_auths.md) for secure token generation
+- **Looking for code examples?** Check the [examples](../examples/) directory
 - **Need quick setup?** See [webhook_security_quickstart.md](webhook_security_quickstart.md)
 - **Want to understand the design?** Read [architecture.md](architecture.md)
 - **Security details?** Review [webhook_signature.md](webhook_signature.md)
 
 ## 🆘 Need Help?
 
 1. Check the relevant documentation section above
-2. Review the [examples](../examples/webhooks.md)
+2. Review the [examples](../examples/)
 3. Consult the [Zai API documentation](https://developer.hellozai.com/)
 4. Open an issue on GitHub