orionx-sdk-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed4c66070a8ad82ab878ad33243410552cd1851c1a76e4963c563fee933fd626
+  data.tar.gz: 1499809d859429c7e6cfac873f67cbf342c1808ffc95716b7f9e8bad21aebdf6
+SHA512:
+  metadata.gz: 44c135c8cfae47a8bce9421affd62caf2abeb7dd1f9f45b2e7bcde07bd80c15edd6a206047cc37674ab0a9109cbc81e961b26b5b552a31742d06fdfca9c7f79c
+  data.tar.gz: 47f9f5629c9280706ccea0b23f8223028b5ce862be08e44212039739f9a10f040bdac4d8c2c73d4e369737d09462c95a201486fc52cd7c7d8a2851f0b769a3d3

data/CHANGELOG.md

@@ -0,0 +1,64 @@
+# 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).
+
+## [1.0.0] - 2024-10-03
+
+### Added
+- Initial release of OrionX Ruby SDK
+- Complete GraphQL API coverage for OrionX exchange
+- HMAC-SHA512 authentication implementation
+- Comprehensive error handling with custom exception classes:
+  - `OrionX::AuthenticationError`
+  - `OrionX::ValidationError` 
+  - `OrionX::RateLimitError`
+  - `OrionX::NetworkError`
+  - `OrionX::APIError`
+- Debug mode with detailed HTTP request/response logging
+- Automatic retry mechanism with exponential backoff
+- Full endpoint coverage:
+  - User operations (`user.me`, `user.user_id`)
+  - Account management (`accounts.get_accounts`, `accounts.get_balance`)
+  - Market data (`markets.get_markets`, `markets.get_orderbook`)
+  - Order management (limit, market, stop-limit, stop-market orders)
+  - Transaction operations (`transactions.get_transactions`, `transactions.send_crypto`)
+- Configuration management with global and per-client settings
+- Comprehensive test suite with RSpec
+- Multiple usage examples:
+  - Basic usage demonstration
+  - Trading operations with safety comments
+  - Real-time market data monitoring
+  - Debug and error handling patterns
+- Complete documentation with API reference
+- Ruby gem packaging with proper dependencies
+- MIT license
+
+### Features
+- Thread-safe configuration
+- Configurable timeouts and retry policies
+- Flexible logging system with custom logger support
+- Input validation for all API methods
+- Proper handling of OrionX currency units and precision
+- Connection health checking with `ping` method
+- Market statistics aggregation helpers
+- Transaction history filtering and pagination
+
+### Documentation
+- Comprehensive README with quick start guide
+- Detailed API reference for all methods
+- Error handling best practices
+- Security recommendations
+- Development setup instructions
+- Contributing guidelines
+- Multiple working code examples
+
+### Dependencies
+- `faraday` ~> 2.0 for HTTP client
+- `faraday-net_http` ~> 3.0 for HTTP adapter  
+- `logger` ~> 1.5 for logging functionality
+- Development dependencies for testing and code quality
+
+[1.0.0]: https://github.com/orionx-dev/orionx-sdk-ruby/releases/tag/v1.0.0

data/CONTRIBUTING.md

@@ -0,0 +1,152 @@
+# Contributing to OrionX Ruby SDK
+
+Thank you for your interest in contributing to the OrionX Ruby SDK! This document provides guidelines for contributing to this project.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
+
+## How to Contribute
+
+### Reporting Bugs
+
+Before creating bug reports, please check the existing issues to see if the problem has already been reported. When creating a bug report, please include:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected behavior
+- Actual behavior
+- Ruby version and gem version
+- Any relevant error messages or logs
+
+### Suggesting Features
+
+Feature requests are welcome! Please provide:
+
+- A clear and descriptive title
+- A detailed description of the proposed feature
+- Use cases and examples
+- Any relevant implementation details
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a feature branch from `main`
+3. Make your changes
+4. Add tests for new functionality
+5. Ensure all tests pass
+6. Run RuboCop and fix any style issues
+7. Update documentation as needed
+8. Submit a pull request
+
+## Development Setup
+
+```bash
+git clone https://github.com/PabloB07/orionx-sdk-ruby.git
+cd orionx-sdk-ruby
+bundle install
+```
+
+## Running Tests
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run with coverage report
+COVERAGE=true bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/client_spec.rb
+
+# Run specific test
+bundle exec rspec spec/client_spec.rb:15
+```
+
+## Code Style
+
+This project uses RuboCop for code formatting and style enforcement:
+
+```bash
+# Check for style issues
+bundle exec rubocop
+
+# Auto-fix issues where possible
+bundle exec rubocop -A
+
+# Check specific files
+bundle exec rubocop lib/orionx/client.rb
+```
+
+## Writing Tests
+
+- All new features must include tests
+- Tests should be written using RSpec
+- Use descriptive test names and contexts
+- Mock external API calls using WebMock
+- Aim for high test coverage
+
+Example test structure:
+
+```ruby
+RSpec.describe OrionX::NewFeature do
+  describe "#new_method" do
+    context "when given valid parameters" do
+      it "returns expected result" do
+        # Test implementation
+      end
+    end
+
+    context "when given invalid parameters" do
+      it "raises validation error" do
+        # Test implementation
+      end
+    end
+  end
+end
+```
+
+## Documentation
+
+- Update README.md for new features
+- Add YARD documentation for new methods
+- Include code examples where helpful
+- Update CHANGELOG.md following Keep a Changelog format
+
+## Commit Messages
+
+Use clear and meaningful commit messages:
+
+- Use present tense ("Add feature" not "Added feature")
+- Use imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit first line to 72 characters or less
+- Reference issues and pull requests liberally
+
+Examples:
+```
+Add retry mechanism for failed API requests
+
+Fix authentication error handling in API client
+
+Update README with new configuration options
+
+Refs #123
+```
+
+## Release Process
+
+1. Update version in `lib/orionx/version.rb`
+2. Update CHANGELOG.md with new version details
+3. Create release commit: `git commit -m "Release vX.X.X"`
+4. Create git tag: `git tag -a vX.X.X -m "Release vX.X.X"`
+5. Push changes and tags: `git push origin main --tags`
+
+## Questions?
+
+If you have questions about contributing, please:
+
+1. Check existing issues and discussions
+2. Create an issue for discussion
+3. Reach out to the maintainers
+
+Thank you for contributing to OrionX Ruby SDK!

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in orionx-sdk.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+
+group :development do
+  gem "pry"
+  gem "yard"
+  gem "simplecov"
+  gem "webmock"
+end

data/README.md

@@ -0,0 +1,408 @@
+# Unofficial OrionX Ruby SDK
+
+The unofficial OrionX SDK for Ruby - A comprehensive Ruby library for interacting with the OrionX cryptocurrency exchange API.
+
+[![Gem Version](https://badge.fury.io/rb/orionx-sdk.svg)](https://badge.fury.io/rb/orionx-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- 🔐 **Secure Authentication** - HMAC-SHA512 signature authentication
+- 🐛 **Debug Mode** - Comprehensive logging and debugging capabilities  
+- 🛡️ **Error Handling** - Robust error handling with custom exception classes
+- 🔄 **Auto Retry** - Automatic retry mechanism for failed requests
+- 📈 **Trading Operations** - Full support for limit, market, and stop orders
+- 💰 **Account Management** - Balance inquiries and account information
+- 📊 **Market Data** - Real-time market data and orderbook information
+- 💸 **Transactions** - Transaction history and cryptocurrency transfers
+- 🧪 **Comprehensive Tests** - Well-tested with RSpec
+- 📚 **Rich Examples** - Multiple usage examples included
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orionx-sdk'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install orionx-sdk
+```
+
+## Quick Start
+
+### 1. Get Your API Credentials
+
+First, you'll need to get your API credentials from OrionX:
+
+1. Log in to your [OrionX account](https://orionx.com)
+2. Go to API settings
+3. Generate your API Key and Secret
+4. Follow [this tutorial](http://docs.orionx.com/docs/getStarted.html) for detailed instructions
+
+### 2. Configuration
+
+Configure the SDK with your credentials:
+
+```ruby
+require 'orionx'
+
+# Global configuration (recommended)
+OrionX.configure do |config|
+  config.api_key = 'your-api-key'
+  config.api_secret = 'your-api-secret'  
+  config.debug = true  # Enable debug logging (optional)
+end
+
+# Create client instance
+client = OrionX::Client.new
+```
+
+Or configure per client instance:
+
+```ruby
+client = OrionX::Client.new(
+  api_key: 'your-api-key',
+  api_secret: 'your-api-secret',
+  debug: true
+)
+```
+
+### 3. Basic Usage
+
+```ruby
+# Test connection
+ping = client.ping
+puts ping  # => { status: "ok", message: "Connection successful" }
+
+# Get user information  
+user = client.me
+puts user['name']  # => "Your Name"
+
+# Get account balances
+balances = client.accounts.get_balances
+balances.each do |balance|
+  puts "#{balance[:currency]}: #{balance[:balance]}"
+end
+
+# Get market data
+market = client.markets.get_market('BTCCLP')
+puts "BTC/CLP Last Price: #{market.dig('lastTrade', 'price')}"
+```
+
+## API Reference
+
+### User Operations
+
+```ruby
+# Get current user information
+user = client.user.me
+# Returns: { "_id" => "...", "email" => "...", "name" => "...", ... }
+
+# Get user ID only
+user_id = client.user.user_id
+# Returns: "user_id_string"
+```
+
+### Account Management
+
+```ruby
+# Get all account balances
+balances = client.accounts.get_balances
+# Returns array of balance objects
+
+# Get specific currency account
+btc_account = client.accounts.get_account('BTC')
+# Returns: { "_id" => "...", "currency" => {...}, "balance" => 0, ... }
+
+# Get balance for specific currency
+btc_balance = client.accounts.get_balance('BTC')
+# Returns: { currency: "BTC", balance: 0, available_balance: 0, ... }
+```
+
+### Market Data
+
+```ruby
+# Get all available markets
+markets = client.markets.get_markets
+# Returns array of market objects
+
+# Get specific market information
+btc_market = client.markets.get_market('BTCCLP')
+# Returns: { "code" => "BTCCLP", "name" => "BTC/CLP", ... }
+
+# Get market orderbook
+orderbook = client.markets.get_orderbook('BTCCLP', limit: 10)
+# Returns: { "buy" => [...], "sell" => [...], "spread" => 0, "mid" => 0 }
+
+# Get market statistics (convenience method)
+stats = client.markets.get_market_stats('BTCCLP')
+# Returns: { code: "BTCCLP", last_price: 0, spread: 0, ... }
+```
+
+### Order Management
+
+```ruby
+# Get user's orders
+orders = client.orders.get_orders(onlyOpen: true, limit: 10)
+
+# Get specific order
+order = client.orders.get_order('order_id')
+
+# Place limit order
+limit_order = client.orders.place_limit_order(
+  market_code: 'BTCCLP',
+  amount: 10000,          # Amount in base currency units
+  limit_price: 50000000,  # Price in quote currency units  
+  sell: false             # true for sell, false for buy
+)
+
+# Place market order
+market_order = client.orders.place_market_order(
+  market_code: 'BTCCLP',
+  amount: 10000,
+  sell: false
+)
+
+# Place stop-limit order
+stop_order = client.orders.place_stop_limit_order(
+  market_code: 'BTCCLP',
+  stop_price_up: 52000000,    # Upper trigger price
+  stop_price_down: 48000000,  # Lower trigger price  
+  amount: 10000,
+  limit_price: 50000000,
+  sell: true
+)
+
+# Cancel order
+cancelled = client.orders.cancel_order('order_id')
+```
+
+### Transaction Operations
+
+```ruby
+# Get transaction history
+transactions = client.transactions.get_transactions(
+  limit: 20,
+  page: 1,
+  types: ['trade-in', 'trade-out']
+)
+
+# Get specific transaction
+transaction = client.transactions.get_transaction('transaction_id')
+
+# Get transaction history for specific currency
+btc_history = client.transactions.get_history('BTC', limit: 10)
+
+# Send cryptocurrency (requires additional setup)
+send_result = client.transactions.send_crypto(
+  wallet_id: 'wallet_id',
+  network: 'BTC', 
+  amount: 100000,
+  contact_id: 'contact_id'  # Optional
+)
+```
+
+## Error Handling
+
+The SDK provides comprehensive error handling with specific exception types:
+
+```ruby
+begin
+  result = client.me
+rescue OrionX::AuthenticationError => e
+  puts "Invalid API credentials: #{e.message}"
+rescue OrionX::ValidationError => e
+  puts "Invalid parameters: #{e.message}"
+rescue OrionX::RateLimitError => e
+  puts "Rate limit exceeded: #{e.message}"
+rescue OrionX::NetworkError => e
+  puts "Network error: #{e.message}"  
+rescue OrionX::APIError => e
+  puts "API error: #{e.message}"
+rescue OrionX::Error => e
+  puts "SDK error: #{e.message}"
+end
+```
+
+### Exception Types
+
+- `OrionX::AuthenticationError` - Invalid API credentials
+- `OrionX::ValidationError` - Invalid parameters or input validation failed
+- `OrionX::RateLimitError` - API rate limit exceeded
+- `OrionX::NetworkError` - Network connectivity issues
+- `OrionX::APIError` - General API errors
+- `OrionX::Error` - Base SDK error class
+
+## Debug Mode
+
+Enable debug mode to see detailed HTTP requests and responses:
+
+```ruby
+# Global configuration
+OrionX.configure do |config|
+  config.debug = true
+end
+
+# Or per client
+client.debug = true
+
+# The debug output includes:
+# - HTTP request headers and body
+# - GraphQL queries and variables  
+# - HTTP response status and body
+# - Request/response timing
+# - Signature generation details
+```
+
+## Configuration Options
+
+```ruby
+OrionX.configure do |config|
+  config.api_key = 'your-api-key'         # Required
+  config.api_secret = 'your-api-secret'   # Required  
+  config.api_endpoint = 'custom-endpoint' # Optional, defaults to OrionX API
+  config.debug = false                    # Optional, enables debug logging
+  config.timeout = 30                     # Optional, request timeout in seconds
+  config.retries = 3                      # Optional, number of retries for failed requests
+  config.logger = custom_logger           # Optional, custom logger instance
+end
+```
+
+## Examples
+
+The SDK includes several comprehensive examples:
+
+### Basic Usage Example
+```bash
+ruby examples/basic_usage.rb
+```
+Demonstrates connection testing, user information, balances, and market data.
+
+### Trading Operations Example  
+```bash
+ruby examples/trading_operations.rb
+```
+Shows how to place different order types, manage orders, and handle trading operations.
+
+### Market Data Monitor
+```bash  
+ruby examples/market_monitor.rb
+```
+Real-time market monitoring with price updates and orderbook data.
+
+### Debug and Error Handling
+```bash
+ruby examples/debug_and_errors.rb  
+```
+Comprehensive demonstration of debug features and error handling patterns.
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/orionx-dev/orionx-sdk-ruby.git
+cd orionx-sdk-ruby
+bundle install
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run with coverage
+COVERAGE=true bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/client_spec.rb
+```
+
+### Code Quality
+
+```bash  
+# Run RuboCop linter
+bundle exec rubocop
+
+# Auto-fix RuboCop issues
+bundle exec rubocop -A
+```
+
+## API Reference Documentation
+
+For detailed API documentation, visit:
+- [OrionX API Documentation](http://docs.orionx.com/)
+- [GraphQL Schema Reference](https://api.orionx.com/graphql)
+
+## Important Notes
+
+### Currency Units
+
+OrionX uses specific units for different currencies:
+- **BTC**: 8 decimal places (Satoshis) - 1 BTC = 100,000,000 units
+- **ETH**: 18 decimal places (Wei) - 1 ETH = 1,000,000,000,000,000,000 units  
+- **CLP**: 0 decimal places - 1 CLP = 1 unit
+- **USD**: 2 decimal places - 1 USD = 100 units
+
+### Rate Limits
+
+The OrionX API has rate limits. The SDK automatically handles retries with exponential backoff for rate-limited requests.
+
+### Security
+
+- Never commit your API credentials to version control
+- Use environment variables for credentials in production
+- Enable debug mode only in development environments
+- Regularly rotate your API keys
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Write tests for your changes
+4. Ensure all tests pass (`bundle exec rspec`)
+5. Run RuboCop (`bundle exec rubocop`)
+6. Commit your changes (`git commit -am 'Add amazing feature'`)
+7. Push to the branch (`git push origin feature/amazing-feature`)  
+8. Open a Pull Request
+
+## Changelog
+
+### Version 1.0.0
+- Initial release
+- Complete API coverage for OrionX GraphQL API
+- Comprehensive error handling and debug capabilities
+- Full test suite with RSpec
+- Multiple usage examples
+- Detailed documentation
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- **Issues**: [GitHub Issues](https://github.com/orionx-dev/orionx-sdk-ruby/issues)
+- **Documentation**: [OrionX API Docs](http://docs.orionx.com/)
+- **Email**: [support@orionx.com](mailto:support@orionx.com)
+
+## Acknowledgments
+
+- Inspired by the [official OrionX JavaScript SDK](https://github.com/orionx-dev/orionx-sdk-js)
+- Built with Ruby community best practices
+- Thanks to the OrionX development team for API support
+
+---
+
+Made with ❤️ by PabloB07

data/Rakefile

@@ -0,0 +1,10 @@
+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]