tastytrade 0.2.0

data/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to Tastytrade
+
+First off, thank you for considering contributing to Tastytrade! It's people like you that make Tastytrade such a great tool.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:
+
+* **Use a clear and descriptive title**
+* **Describe the exact steps to reproduce the problem**
+* **Provide specific examples to demonstrate the steps**
+* **Describe the behavior you observed and what behavior you expected**
+* **Include Ruby version, gem version, and OS information**
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:
+
+* **Use a clear and descriptive title**
+* **Provide a step-by-step description of the suggested enhancement**
+* **Provide specific examples to demonstrate the steps**
+* **Describe the current behavior and explain the expected behavior**
+* **Explain why this enhancement would be useful**
+
+### Pull Requests
+
+1. Fork the repo and create your branch from `main`
+2. If you've added code that should be tested, add tests
+3. If you've changed APIs, update the documentation
+4. Ensure the test suite passes (`bundle exec rake`)
+5. Make sure your code follows the style guidelines (`bundle exec rubocop`)
+6. Issue that pull request!
+
+## Development Setup
+
+1. Fork and clone the repo
+2. Run `bin/setup` to install dependencies
+3. Run `bundle exec rake spec` to run the tests
+4. Run `bin/console` for an interactive prompt
+
+## Style Guidelines
+
+### Ruby Style Guide
+
+We use RuboCop with a few customizations. Run `bundle exec rubocop` to check your code.
+
+Key points:
+* Use double quotes for strings
+* Keep lines under 120 characters
+* Write descriptive commit messages
+
+### Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+
+## Testing
+
+* Write RSpec tests for all new functionality
+* Ensure all tests pass before submitting PR
+* Aim for high test coverage but focus on testing behavior, not implementation
+* Use descriptive test names that explain what is being tested
+
+## Documentation
+
+* Update the README.md with details of changes to the interface
+* Update the CHANGELOG.md following the Keep a Changelog format
+* Comment your code where necessary
+* Use YARD documentation for public APIs
+
+## Release Process
+
+Maintainers will handle releases, but for reference:
+
+1. Update version number in `lib/tastytrade/version.rb`
+2. Update CHANGELOG.md
+3. Run `bundle exec rake release`
+
+## Questions?
+
+Feel free to open an issue with the "question" label if you have any questions about contributing.

data/DISCLAIMER.md

@@ -0,0 +1,54 @@
+# DISCLAIMER
+
+## Unofficial SDK Notice
+
+This is an **UNOFFICIAL** Ruby SDK for the Tastytrade API. This project is:
+
+- ❌ NOT affiliated with Tastytrade or Tastyworks
+- ❌ NOT endorsed by Tastytrade or Tastyworks
+- ❌ NOT sponsored by Tastytrade or Tastyworks
+- ✅ An independent open-source project
+
+## Financial Risk Disclaimer
+
+**⚠️ IMPORTANT: PLEASE READ CAREFULLY**
+
+### Investment Risks
+- Trading securities, options, futures, and other financial instruments involves **substantial risk of loss**
+- You may lose some or **all of your invested capital**
+- Past performance is **not indicative** of future results
+- Options trading involves additional risks and is not suitable for all investors
+
+### No Financial Advice
+- This software is provided for **educational and informational purposes only**
+- Nothing in this software constitutes financial advice, investment advice, or trading recommendations
+- The authors are not financial advisors, brokers, or dealers
+- Always consult with a **qualified financial advisor** before making investment decisions
+
+### Your Responsibilities
+- You are **solely responsible** for your investment and trading decisions
+- You must understand the risks involved in trading before using this software
+- You should paper trade or use a demo account before trading with real money
+- You must comply with all applicable laws and regulations in your jurisdiction
+
+### Software Disclaimer
+- This software is provided "AS IS" without warranty of any kind
+- The authors assume no responsibility for errors or omissions
+- The authors are not liable for any losses or damages arising from the use of this software
+- There is no guarantee that this software will meet your requirements or be error-free
+
+### API Usage
+- You are responsible for complying with Tastytrade's Terms of Service
+- Excessive API usage may result in rate limiting or account suspension by Tastytrade
+- Your API credentials are your responsibility - keep them secure
+
+### Regulatory Compliance
+- Securities trading is regulated by various governmental and self-regulatory organizations
+- You are responsible for ensuring your trading activities comply with all applicable regulations
+- This software does not provide regulatory or compliance advice
+
+## Acceptance of Terms
+
+By using this software, you acknowledge that you have read, understood, and agree to be bound by these disclaimers and accept all risks associated with using this software for trading purposes.
+
+**If you do not agree with these terms, do not use this software.**

data/LICENSE.txt

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ryan Hamamura
+
+IMPORTANT: This software is subject to additional disclaimers.
+Please read DISCLAIMER.md before using this software.
+
+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.

data/README.md

@@ -0,0 +1,235 @@
+# Tastytrade Ruby SDK (Unofficial)
+
+[![Gem Version](https://badge.fury.io/rb/tastytrade.svg)](https://badge.fury.io/rb/tastytrade)
+[![CI](https://github.com/ryanhamamura/tastytrade/actions/workflows/main.yml/badge.svg)](https://github.com/ryanhamamura/tastytrade/actions/workflows/main.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
+> An unofficial Ruby SDK for the Tastytrade API
+
+**⚠️ IMPORTANT DISCLAIMER**: This is an **unofficial** SDK and is not affiliated with, endorsed by, or sponsored by Tastytrade, Tastyworks, or any of their affiliates. This is an independent project created to help Ruby developers interact with the Tastytrade API.
+
+This Ruby gem provides a simple interface to interact with the Tastytrade API, allowing you to:
+- Authenticate with your Tastytrade account
+- Retrieve account information and balances
+- Access market data
+- Place and manage orders
+- Monitor positions and transactions
+
+## Features
+
+- Secure authentication with Tastytrade API
+- Real-time market data access
+- Account management and portfolio tracking
+- Order placement and management
+- Position monitoring
+- Transaction history
+
+## Roadmap
+
+See [ROADMAP.md](ROADMAP.md) for the detailed development roadmap. Track progress on our [GitHub Project Board](https://github.com/users/ryanhamamura/projects/1).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tastytrade'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install tastytrade
+```
+
+## Usage
+
+### Authentication
+
+```ruby
+require 'tastytrade'
+
+# Create a session
+session = Tastytrade::Session.new(
+  username: 'your_username',
+  password: 'your_password',
+  remember_me: true  # Optional: enables session refresh with remember token
+)
+
+# Login
+session.login
+
+# Check if authenticated
+session.authenticated? # => true
+
+# Session will automatically refresh when expired if remember_me was enabled
+```
+
+### CLI Usage
+
+The gem includes a command-line interface for common operations:
+
+```bash
+# Login to your account
+tastytrade login
+
+# Login with remember option for automatic session refresh
+tastytrade login --remember
+
+# View account balances
+tastytrade balance
+
+# View balances for all accounts
+tastytrade balance --all
+
+# List all accounts
+tastytrade accounts
+
+# Select an account
+tastytrade select
+
+# Check session status
+tastytrade status
+
+# Refresh session (requires remember token)
+tastytrade refresh
+
+# Logout
+tastytrade logout
+```
+
+### Account Information
+
+```ruby
+# Get all accounts
+accounts = Tastytrade::Models::Account.get_all(session)
+
+# Get specific account
+account = Tastytrade::Models::Account.get(session, 'account_number')
+
+# Check account status
+account.closed? # => false
+account.futures_approved? # => true
+```
+
+### Account Balances
+
+```ruby
+# Get account balance
+balance = account.get_balances(session)
+
+# Access balance information
+balance.cash_balance # => BigDecimal("10000.50")
+balance.net_liquidating_value # => BigDecimal("42001.00")
+balance.equity_buying_power # => BigDecimal("20000.00")
+balance.available_trading_funds # => BigDecimal("12000.00")
+
+# Check buying power usage
+balance.buying_power_usage_percentage # => BigDecimal("40.00")
+balance.high_buying_power_usage? # => false (checks if > 80%)
+
+# Calculate totals
+balance.total_equity_value # => BigDecimal("30001.00")
+balance.total_derivative_value # => BigDecimal("4500.00")
+balance.total_market_value # => BigDecimal("34501.00")
+```
+
+### Positions
+
+```ruby
+# Get all positions
+positions = account.get_positions(session)
+
+# Filter positions
+positions = account.get_positions(session, 
+  symbol: 'AAPL',
+  underlying_symbol: 'AAPL',
+  include_closed: false
+)
+
+# Work with positions
+positions.each do |position|
+  puts position.symbol
+  puts position.quantity
+  puts position.unrealized_pnl
+  puts position.unrealized_pnl_percentage
+  
+  # Check position type
+  position.equity? # => true
+  position.option? # => false
+  position.long? # => true
+  position.short? # => false
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies and verify your environment is configured correctly.
+
+Run tests with:
+```bash
+bundle exec rake spec
+```
+
+Run linting with:
+```bash
+bundle exec rake rubocop
+```
+
+For an interactive console:
+```bash
+bin/console
+```
+
+To install this gem onto your local machine:
+```bash
+bundle exec rake install
+```
+
+## Documentation
+
+TODO: Add links to additional documentation
+- [API Documentation](https://rubydoc.info/gems/tastytrade)
+- [Wiki](https://github.com/ryanhamamura/tastytrade/wiki)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryanhamamura/tastytrade. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ryanhamamura/tastytrade/blob/main/CODE_OF_CONDUCT.md).
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+
+## Security
+
+Please see our [security policy](SECURITY.md) for reporting vulnerabilities.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tastytrade project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryanhamamura/tastytrade/blob/main/CODE_OF_CONDUCT.md).
+
+## Legal Disclaimer
+
+**⚠️ IMPORTANT FINANCIAL DISCLAIMER**
+
+This software is provided for educational and informational purposes only. It is not intended to be used as financial advice, investment advice, or as a recommendation to buy, sell, or hold any securities or financial instruments.
+
+**TRADING RISKS**: Trading securities, options, futures, and other financial instruments involves substantial risk of loss and is not suitable for all investors. Past performance is not indicative of future results. You may lose some or all of your invested capital.
+
+**NO WARRANTY**: This software is provided "as is" without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, or non-infringement.
+
+**YOUR RESPONSIBILITY**: You are solely responsible for any investment and trading decisions you make using this software. You should consult with a qualified financial advisor before making any investment decisions.
+
+**API USAGE**: By using this SDK, you are responsible for complying with Tastytrade's Terms of Service and API usage guidelines. Excessive API usage may result in rate limiting or account suspension by Tastytrade.
+
+**NOT AFFILIATED**: This project is not affiliated with, endorsed by, or sponsored by Tastytrade, Tastyworks, or any of their affiliates. All trademarks and registered trademarks are the property of their respective owners.
+
+The authors and contributors of this software shall not be held liable for any losses, damages, or costs of any kind arising from the use of this software.

data/ROADMAP.md

@@ -0,0 +1,157 @@
+# Tastytrade Ruby SDK Roadmap
+
+This document outlines the development roadmap for the unofficial Tastytrade Ruby SDK. Track progress via [GitHub Projects](https://github.com/users/ryanhamamura/projects/1).
+
+## Project Goals
+
+- Port the Python Tastytrade SDK to Ruby with idiomatic Ruby patterns
+- Provide both synchronous and asynchronous API support
+- Include a powerful CLI tool within the same gem
+- Maintain comprehensive test coverage and documentation
+
+## Development Phases
+
+### Phase 1: Core SDK Foundation
+**Target: Q3 2025 (July - September)**
+
+#### Authentication & Session Management
+- [x] Basic session class with login/logout (closes #1)
+- [x] Token management and refresh (closes #2)
+- [x] Production/sandbox environment support (closes #3)
+- [x] Credentials storage (secure) (closes #4)
+- [x] Session validation and error handling (closes #5)
+
+#### Account Operations
+- [x] Fetch account info and balances (closes #6)
+- [x] Get positions
+- [ ] Get transaction history
+- [ ] Calculate buying power
+- [ ] Account status and trading permissions
+
+#### Basic Trading
+- [ ] Place equity orders (market, limit)
+- [ ] Cancel/replace orders
+- [ ] Get order status
+- [ ] Order validation
+- [ ] Basic order types (day, GTC)
+
+#### Core Infrastructure
+- [x] HTTP client setup (Faraday) (closes #16)
+- [x] Error handling framework (closes #17)
+- [ ] Logging system
+- [x] Configuration management (closes #19)
+- [x] Basic data models (using dry-struct) (closes #20)
+
+### Phase 2: Advanced SDK Features
+**Target: Q4 2025 (October - December)**
+
+#### Options Trading
+- [ ] Option chain retrieval
+- [ ] Options orders (single leg)
+- [ ] Multi-leg strategies (spreads, strangles, iron condors)
+- [ ] Greeks calculation
+- [ ] Options-specific validations
+
+#### Advanced Order Types
+- [ ] Stop/stop-limit orders
+- [ ] OCO (One-Cancels-Other)
+- [ ] Trailing stops
+- [ ] Conditional orders
+- [ ] Order grouping
+
+#### Market Data
+- [ ] Real-time quotes
+- [ ] Historical data
+- [ ] Market hours/calendar
+- [ ] Instrument search
+- [ ] Watchlist management
+
+#### Streaming Support
+- [ ] WebSocket connection management
+- [ ] Quote streaming (DXLink)
+- [ ] Account alerts streaming
+- [ ] Auto-reconnection logic
+- [ ] Event handling system
+
+### Phase 3: CLI Integration
+**Target: Q1 2026 (January - March)**
+
+#### Core CLI Commands
+- [ ] Authentication (`tt login`)
+- [ ] Account info (`tt account`)
+- [ ] Portfolio view (`tt portfolio`)
+- [ ] Basic trading (`tt trade`)
+- [ ] Order management (`tt orders`)
+
+#### Options CLI
+- [ ] Option chains (`tt option chain`)
+- [ ] Options trading (`tt option trade`)
+- [ ] Strategy builder
+- [ ] Greeks display
+
+#### Advanced CLI Features
+- [ ] Watchlist monitoring (`tt watch`)
+- [ ] Portfolio analysis (`tt analyze`)
+- [ ] Real-time quotes (`tt quote`)
+- [ ] Configuration management (`tt config`)
+- [ ] Interactive mode
+
+#### CLI Enhancements
+- [ ] Rich terminal output (TTY gems)
+- [ ] Progress indicators
+- [ ] Confirmation prompts
+- [ ] Output formatting (JSON, CSV, table)
+- [ ] Shell completion
+
+### Phase 4: Advanced Features & Polish
+**Target: Q2 2026 (April - June)**
+
+#### Advanced Analytics
+- [ ] Portfolio metrics calculation
+- [ ] Risk analysis
+- [ ] P&L tracking
+- [ ] Tax lot management
+- [ ] Performance reporting
+
+#### Async Support
+- [ ] Async HTTP client option
+- [ ] Concurrent operations
+- [ ] Batch operations
+- [ ] Rate limiting
+
+#### Developer Experience
+- [ ] Comprehensive documentation
+- [ ] Example applications
+- [ ] Video tutorials
+- [ ] API reference docs
+- [ ] Migration guide from Python
+
+#### Testing & Quality
+- [ ] 90%+ test coverage
+- [ ] Integration test suite
+- [ ] Performance benchmarks
+- [ ] Security audit
+- [ ] Load testing
+
+## Success Metrics
+
+- **Test Coverage**: Maintain >90% coverage
+- **Documentation**: 100% public API documented
+- **Performance**: <100ms average response time
+- **Reliability**: 99.9% uptime for streaming
+- **Community**: Active user base and contributors
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to help with development.
+
+## Notes
+
+- Each phase builds upon the previous one
+- Phases may overlap as development progresses
+- Community feedback will influence priorities
+- Breaking changes will be minimized after v1.0
+
+---
+
+Last Updated: 2025-07-30

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "bundler/audit/task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+end
+RuboCop::RakeTask.new
+Bundler::Audit::Task.new
+
+desc "Run all checks (tests, style, security)"
+task check: %i[spec rubocop bundle:audit]
+
+task default: :check

data/SECURITY.md

@@ -0,0 +1,48 @@
+# Security Policy
+
+## Supported Versions
+
+Currently supported versions for security updates:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+We take security vulnerabilities seriously. If you discover a security vulnerability within Tastytrade, please follow these steps:
+
+1. **DO NOT** create a public GitHub issue for the vulnerability
+2. Email your findings to `security@tastytrade.com` (replace with actual email)
+3. Include the following in your report:
+   - Description of the vulnerability
+   - Steps to reproduce
+   - Potential impact
+   - Suggested fix (if any)
+
+## Response Timeline
+
+- **Initial Response**: Within 48 hours
+- **Status Update**: Within 5 business days
+- **Resolution Target**: 
+  - Critical: 7 days
+  - High: 14 days
+  - Medium: 30 days
+  - Low: 60 days
+
+## Security Update Process
+
+1. Security patches will be released as soon as possible
+2. Announcements will be made through:
+   - GitHub Security Advisories
+   - RubyGems.org
+   - Project mailing list (if applicable)
+
+## Best Practices for Users
+
+- Keep your gem version up to date
+- Review the CHANGELOG for security updates
+- Follow the principle of least privilege
+- Report suspicious behavior
+
+Thank you for helping keep Tastytrade and its users safe!

data/docs/getting_started.md

@@ -0,0 +1,48 @@
+# Getting Started with Tastytrade Ruby SDK (Unofficial)
+
+## ⚠️ Important Notice
+
+This is an **UNOFFICIAL** SDK for the Tastytrade API. Please read the [DISCLAIMER](../DISCLAIMER.md) before proceeding.
+
+## Prerequisites
+
+Before you begin, ensure you have:
+- Ruby 3.2.0 or higher
+- Bundler gem installed
+
+## Installation
+
+### Via Gemfile
+
+Add to your application's Gemfile:
+
+```ruby
+gem 'tastytrade'
+```
+
+Then run:
+```bash
+bundle install
+```
+
+### Direct Installation
+
+```bash
+gem install tastytrade
+```
+
+## Quick Start
+
+TODO: Add quick start example
+
+```ruby
+require 'tastytrade'
+
+# Your first Tastytrade code
+```
+
+## Next Steps
+
+- Read the [API Documentation](https://rubydoc.info/gems/tastytrade)
+- Check out [examples](../examples)
+- Learn about [advanced features](advanced_usage.md)