ib-extensions 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b31bb7c59e25916c0ebc180446628175867a793e0c1020c7937b4226d67bc6da
+  data.tar.gz: f3dbe5677eb8551819595134ed91fa08027d677863a0be778fe3a5011ca41235
+SHA512:
+  metadata.gz: 9238aac43cf451bfc78e6afade296423b48d0b7c361a38338d3cd3e121a22df5e5b216296f890fbbaeb9647fc7d96c2a2e86e55321ac09f538844f3f8cc13ea6
+  data.tar.gz: 477b5078b89583fcf8856a966e05558c53b85f0d746e036c11e4fd4ff8c08c0aca23c617044c3eea1f4f068b054d02622155aae7e4ebf9954c4dfc52da60b62b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

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 topofocus@gmaiol.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ib-extensions.gemspec
+gemspec
+gem "ib-api",   path: "../ib-api/"
+## move this to gemspec and include as development dependency after the gem is released
+gem "ib-symbols",   path: "../ib-symbols/"
+#gem "ib-api",  :git=> 'https://github.com/ib-ruby/ib-api.git'
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: ../ib-api
+  specs:
+    ib-api (972.0)
+      activemodel
+      activesupport (>= 6.0)
+
+PATH
+  remote: ../ib-symbols
+  specs:
+    ib-symbols (1.0)
+      ib-api
+      ox
+
+PATH
+  remote: .
+  specs:
+    ib-extensions (1.0)
+      ox
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      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.8.5)
+      concurrent-ruby (~> 1.0)
+    listen (3.3.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    ox (2.13.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-collection_matchers (1.2.0)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    shellany (0.0.1)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  guard
+  guard-rspec
+  ib-api!
+  ib-extensions!
+  ib-symbols!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-collection_matchers
+  rspec-its
+
+BUNDLED WITH
+   2.1.4

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
+

data/README.md

@@ -0,0 +1,99 @@
+# IB/Extensions
+
+Helpers and Macros that ease the usage of the TWS-API of Interactive Brokers
+
+**status:** A stable Gem-Release is in preparation.
+
+__Documentation: [https://ib-ruby.github.io/ib-doc/](https://ib-ruby.github.io/ib-doc/)__  
+
+to activate use
+```
+gem 'ib-extensions',  git: 'https://github.com/ib-ruby/ib-extensions.git'
+```
+in the Gemfile and require the extensions as needed
+
+## Include all
+```
+require 'ib-api'
+require 'ib/extensions'
+```
+
+## Verify
+```
+require 'ib-api'
+require 'ib/verify'
+```
+Verifies a given contract, for details refer to the [documentation](https://ib-ruby.github.io/ib-doc/Verify_contracts.html )
+
+## Market Price
+```
+require 'ib-api'
+require 'ib/market-price'
+```
+Returns the most recent market-price of a given contract  ( [documentation](https://ib-ruby.github.io/ib-doc/market_price.html) )
+
+## Historical Data (EOD)
+```
+require 'ib-api'
+require 'ib/eod'
+
+puts IB::Symbols.Index.estx.eod( duration: '10 d' )
+```
+Fetch historical data with just one line of code  ([documentation](https://ib-ruby.github.io/ib-doc/Historical_data.html) )
+
+## Order Prototypes
+```
+require 'ib-api'
+require 'ib/order-prototypes'
+
+order = IB::Limit.order size: 100, price: 10, action: :buy
+order = IB::StopLimit.order size: 100, price: 10, stop_price: 9.5
+```
+
+then transmit the order through  the [place_order](https://ib-ruby.github.io/ib-doc/order_placement.html)  method of IB::Connection or  Account-based  preview, place, modify and cancel methods of [IB::Gateway](https://ib-ruby.github.io/ib-doc/order_placement.html).
+
+More details in the [documentation](https://ib-ruby.github.io/ib-doc/order_prototypes.html) 
+
+
+## Spread Prototypes
+
+```
+require 'ib-api'
+require 'ib/spread-prototypes'
+```
+
+Compose most common spreads through
+
+```
+s = IB::Straddle.build from: IB::Symbols::Index.stoxx, 
+                            strike: 2400, 
+                            expiry: 202103 
+                            
+s = IB::Strangle.build from: IB::Symbols::Index.stoxx, 
+                            c: 2400, p: 2200, 
+                            expiry: 202103 
+
+```
+and use the speads like any other contract. ([documentation](https://ib-ruby.github.io/ib-doc/spreads.html)
+
+## Gateway 
+```
+require 'ib-gateway'
+```
+IB::Gateway is an alternative to IB::Connection. Upon initialization, it detects active accounts and stores them in a thread safe array. 
+Details in the [documentation](https://ib-ruby.github.io/ib-doc/gateway.html)
+
+Its used in [Simple Monitor](https://github.com/ib-ruby/simple-monitor)
+
+
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ib-ruby/ib-extensions. 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/[USERNAME]/ib-extensions/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Ib::Extensions project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ib-extensions/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+### loads the active-orient environment 
+### and starts an interactive shell
+###
+### Parameter: t)ws | g)ateway (or number of port ) Default: Gateway ,
+###							client_id , Default 2000
+###
+### Define Parameter in  file console.yml
+###
+require 'bundler/setup'
+require 'yaml'
+
+require 'logger'
+require "ib-api"
+require 'ib/extensions'
+require 'ib/symbols'
+
+class Array
+  # enables calling members of an array. which are hashes  by it name
+  # i.e
+  #
+  #  2.5.0 :006 > C.received[:OpenOrder].local_id
+  #   => [16, 17, 21, 20, 19, 8, 7] 
+  #   2.5.0 :007 > C.received[:OpenOrder].contract.to_human
+  #    => ["<Bag: IECombo SMART USD legs:  >", "<Stock: GE USD>", "<Stock: GE USD>", "<Stock: GE USD>", "<Stock: GE USD>", "<Stock: WFC USD>", "<Stock: WFC USD>"] 
+  #
+  # its included only in the console, for inspection purposes
+
+  def method_missing(method, *key)
+    unless method == :to_hash || method == :to_str #|| method == :to_int
+      return self.map{|x| x.public_send(method, *key)}
+    end
+
+  end
+end # Array
+
+
+# read items from console.yml 
+read_yml = -> (key) do
+		YAML::load_file( File.expand_path('../console.yml',__FILE__))[key]
+	end
+
+
+  puts 
+  puts ">> IB-Ruby Interactive Console <<" 
+  puts '-'* 45
+  puts 
+  puts "Namespace is IB ! "
+  puts
+  puts '-'* 45
+	include LogDev
+  include IB
+  require 'irb'
+  client_id = ARGV[1] || read_yml[:client_id]
+  specified_port = ARGV[0] || 'Gateway'
+	port =  case specified_port
+					when Integer
+						specified_port  # just use the number
+					when /^[gG]/ 
+						read_yml[:gateway]
+					when /^[Tt]/
+						read_yml[:tws]
+					end
+
+  ARGV.clear
+  logger = default_logger #  Logger.new  STDOUT
+	
+  ## The Block takes instructions which are executed  after initializing all instance-variables
+  ## and prior to the connection-process
+  ## Here we just subscribe to some events  
+  C =  Connection.new  client_id: client_id, port: port  do |c|  # future use__ , optional_capacities: "+PACEAPI"  do |c|
+
+    c.subscribe( :ContractData, :BondContractData) { |msg| logger.info { msg.contract.to_human } }
+    c.subscribe( :Alert, :ContractDataEnd, :ManagedAccounts, :OrderStatus ) {| m| logger.info { m.to_human } }
+    c.subscribe( :PortfolioValue, :AccountValue, :OrderStatus, :OpenOrderEnd, :ExecutionData ) {| m| logger.info { m.to_human }}
+#    c.subscribe :ManagedAccounts do  |msg|
+#        puts "------------------------------- Managed Accounts ----------------------------------"
+#				puts "Detected Accounts: #{msg.accounts.account.join(' -- ')} " 
+#				puts
+#    end
+
+    c.subscribe( :OpenOrder){ |msg|  "Open Order detected and stored: C.received[:OpenOrders] " }
+		c.logger.level = Logger::INFO 
+	end 
+  unless  C.received[:OpenOrder].blank?
+        puts "------------------------------- OpenOrders ----------------------------------"
+    puts C.received[:OpenOrder].to_human.join "\n"
+  end
+  puts  "Connection established on Port  #{port}, client_id #{client_id} used"
+  puts
+  puts  "----> C    points to the connection-instance"
+  puts
+  puts  "some basic Messages are subscribed and accordingly displayed"
+  puts '-'* 45
+
+  IRB.start(__FILE__)