ib-api 10.33.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 935f3bd0a0fd4d93c9c3d602fe872cadab16d05b714ea361c80efc784f46e9aa
+  data.tar.gz: ffb84a6d0d631c783f1baa30d03125718365d7ee438aa6a4e2da2035ec463ac6
+SHA512:
+  metadata.gz: 852305cb2978fa5725238262398b53bb7b2a5e5ae7e44507042d02648db1ddb6868ad820f523aef17e68015a341b4d8b1a9606201ef6d6ef4b582440aa4811f4
+  data.tar.gz: 574f46966e87bcb2f2408cd811b913caf8387f9cd5dbddfc45b841aee010aeb8b2d8ed43feea4a2abe038305ddcf0208b1a894bf68a46e588ed16c0afdd9ca5b

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+*.swp
+*.swo
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/CLAUDE.md

@@ -0,0 +1,131 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**ib-api** is a Ruby gem providing a modular interface to Interactive Brokers' TWS API (Trader Workstation/Gateway). It's a modern reimplementation of ib-ruby designed for TWS version 10.19+ with Zeitwerk integration and an extensible plugin system.
+
+## Architecture
+
+The codebase follows an **event-driven, message-based architecture** with three main layers:
+
+1. **Connection Layer** (`lib/ib/connection.rb`): Manages TCP socket connection to TWS/Gateway, handles message queuing, and provides the primary API interface. Uses a workflow state machine (virgin → ready/gateway_mode/lean_mode → account_based_operations).
+
+2. **Message Layer** (`lib/ib/messages/`): Bidirectional message system using a `def_message` macro to dynamically generate message classes. Supports multiple IB API versions (currently client version 66, server version 165+). Messages are processed by `RawMessageParser` which decodes the binary protocol from IB.
+
+3. **Model Layer** (`models/ib/`, Zeitwerk-loaded): ActiveModel-based data models for contracts (Stock, Option, Future, etc.), orders, market data, and spreads.
+
+**Plugin Architecture**: Extensible system in `plugins/ib/` that adds automation capabilities. Plugins extend `IB::Connection` through mixins and are activated via `activate_plugin`. State machine manages plugin availability based on connection state.
+
+## Development Commands
+
+### Testing
+```bash
+# Run all tests
+bundle exec rake spec
+# or
+bundle exec rspec
+
+# Run with Guard (continuous testing)
+bundle exec guard
+
+# Run specific test file
+bundle exec rspec spec/ib/contract_spec.rb
+
+# Run focused tests (using fit/fdescribe/fcontext or :focus tag)
+bundle exec rspec --tag focus
+```
+
+### Interactive Console
+```bash
+# Connect to IB Gateway (default)
+./console g
+
+# Connect to TWS
+./console t
+
+# The console sets up C as the connection instance
+# C points to IB::Connection.current
+```
+
+### Build
+```bash
+# Install dependencies
+bundle install
+
+# Build the gem
+gem build ib-api.gemspec
+```
+
+## Testing Configuration
+
+Tests require `spec/spec.yml` with IB account details:
+```yaml
+:connection:
+  :port: 4002           # IB Gateway port (4001/4002) or TWS (7496/7497)
+  :host: 127.0.0.1      # IB server host
+  :account: DU123456    # Your paper account ID (required)
+  :base_currency: EUR   # Base currency
+  :market_data: false  # Include market-data dependent tests
+:stock:
+  :symbol: 'GE'         # Sample symbol for tests
+```
+
+The test suite is safe to run with a real (paper trading) account as integration tests on order placement are not included.
+
+## Key Patterns
+
+### Message Processing
+- Incoming messages are queued in `IB::Connection#received` hash by message type
+- Subscribe to messages: `ib.subscribe(:OrderStatus) { |msg| ... }`
+- Wait for messages: `ib.wait_for :OrderStatus`
+- Send messages: `ib.send_message :PlaceOrder, order: order, contract: contract`
+
+### Connection Workflow
+States: `virgin` → `lean_mode`/`gateway_mode`/`ready` → `account_based_operations` → `account_based_orderflow`
+
+- `lean_mode`: Minimal connection, no account data
+- `gateway_mode`: Multi-account gateway access
+- `ready`: Standard single-account connection
+- `account_based_operations`: Account data loaded, portfolio available
+- `account_based_orderflow`: Order processing active
+
+### Plugin Development
+Plugins are Ruby files in `plugins/ib/` that extend `IB::Connection`:
+```ruby
+# plugins/ib/my_plugin.rb
+module IB
+  module Connection
+    def my_method
+      # implementation
+    end
+  end
+end
+```
+
+Activate: `ib.activate_plugin :my_plugin`
+
+### Zeitwerk Autoloading
+Models in `models/ib/` are autoloaded by Zeitwerk. No explicit requires needed. Inflection rules are set in `lib/ib-api.rb`.
+
+## Testing Framework
+
+- **RSpec** with: `rspec-its`, `rspec-given`, `rspec-collection_matchers`
+- Test data: `SAMPLE` constant holds a test IB::Stock configured from `spec.yml`
+- Account shortcut: `ACCOUNT` constant holds the account ID from `spec.yml`
+- Focus tests: Use `fit`, `fdescribe`, `fcontext` or tag with `:focus`
+
+## Message Debugging
+
+When implementing new message types, uncomment line 37 in `lib/ib/messages/incoming/abstract_message.rb` to see raw TWS output. The console (`./console`) is useful for quick message testing - inspect `C.received` hash to see collected messages.
+
+## Important Files
+
+- `lib/ib/connection.rb`: Main connection and workflow management
+- `lib/ib/plugins.rb`: Plugin activation system
+- `lib/ib-api.rb`: Entry point, Zeitwerk setup
+- `lib/ib/messages/outgoing/` & `lib/ib/messages/incoming/`: Message definitions
+- `models/ib/`: Data models (Contract, Order, etc.)
+- `spec/spec_helper.rb`: Test configuration
+- `spec/howto.md`: Guide for implementing and testing messages

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@mailout.halfgarten-capital.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in api.gemspec
+gemspec
+
+# gem 'value_semantics'																	# models, future plans
+
+
+
+gem 'rspec'
+gem 'rspec-its'
+gem 'rspec-given'
+gem 'rspec-collection_matchers'
+gem 'guard'
+gem 'guard-rspec'

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    ib-api (10.33.1)
+      activemodel
+      activesupport (>= 6.0)
+      ox
+      terminal-table
+      workflow (~> 3.1)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    ffi (1.17.3-x86_64-linux-gnu)
+    formatador (1.1.0)
+    given_core (3.8.2)
+      sorcerer (>= 0.3.7)
+    guard (2.18.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.10)
+    method_source (1.1.0)
+    minitest (5.24.1)
+    mutex_m (0.2.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    ox (2.14.18)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-collection_matchers (1.2.1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-given (3.8.2)
+      given_core (= 3.8.2)
+      rspec (>= 2.14.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    shellany (0.0.1)
+    sorcerer (2.0.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    workflow (3.1.1)
+    zeitwerk (2.6.16)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  guard
+  guard-rspec
+  ib-api!
+  rake (~> 13.0)
+  rspec
+  rspec-collection_matchers
+  rspec-given
+  rspec-its
+
+BUNDLED WITH
+   2.4.6

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "ostruct"
+
+  # Generic Ruby apps
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
+
+
+#  watch(%r{^lib/models/ib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+#  watch(%r{^lib/ib/messages/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+#  watch(%r{^lib/ib/symbols/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+
+  watch(%r{^ib/(.+)\.rb$})  { |m| "spec/ib/#{m[1]}_spec.rb" }
+#  watch(%r{^models/(.+)\.rb$})  { |m| "spec/models/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')  { "spec" }
+#  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+