Ver 10

.gitignore

@@ -1,5 +1,7 @@
 *.gem
 *.rbc
+*.swp
+*.swo
 /.config
 /coverage/
 /InstalledFiles

Gemfile

@@ -11,6 +11,7 @@ gemspec
 
 gem 'rspec'
 gem 'rspec-its'
+gem 'rspec-given'
 gem 'rspec-collection_matchers'
 gem 'guard'
 gem 'guard-rspec'

README.md

@@ -1,19 +1,18 @@
 # ib-api
 Ruby interface to Interactive Brokers' TWS API 
 
-Reimplementation of the basic functions of ib-ruby
+Reimplementation of ib-ruby
 
 ---
-__STATUS:  Preparing for a new GEM-Release, scheduled for  July__  (delayed to August)
+__STATUS: Gem-Release is still pending
+
 ---
 
 
 __Documentation: [https://ib-ruby.github.io/ib-doc/](https://ib-ruby.github.io/ib-doc/)__  (_work in progress_)
 
 ----
-`ib-ruby`   offers a modular access to the TWS-API-Interface of Interactive Brokers.
-
-`ib-api`    provides a simple interface to low-level TWS API-calls.  
+`ib-api`   offers a modular access to the TWS-API-Interface of Interactive Brokers.
 
 ----
 
@@ -23,7 +22,7 @@ Install in the usual way
 $ gem install ib-api
 ```
 
-In its plain vanilla usage, it just exchanges messages with the TWS. Any response is stored in the `recieved-Array`.
+In its plain vanilla usage, it just exchanges messages with the TWS. Any response is stored in the `received-array`.
 
 It needs just a few lines of code to place an order
 
@@ -52,53 +51,43 @@ puts ib.recieved[:OrderStatus].to_human
 
 ```
 
-##### User-specific Actions
-Besides storing any TWS-response in an array, callbacks are implemented.
+## Plugins
+
+**IB-API** ships with simple plugins to facilitate automations 
 
-The user subscribes to a certain response and defines the actions in a typically ruby manner. These actions
-can be defined globaly
 ```ruby
-ib =  IB::Connection.new do |tws|
-      # Subscribe to TWS alerts/errors and order-related messages
-	tws.subscribe(:Alert, :OpenOrder, :OrderStatus, :OpenOrderEnd) { |msg| puts msg.to_human }
-     end
+require 'ib-api'
+# connect with default parameters 
+ib =  IB::Connection.new do | c |
+  c.activate_plugin "verify"
+end
 
+g =  IB::Stock.new symbol: 'GE'
+puts g.verify.first.attributes
+{:symbol=>"GE", :sec_type=>"STK", :last_trading_day=>"", :strike=>0.0, :right=>"", :exchange=>"SMART", :currency=>"USD", :local_symbol=>"GE", :trading_class=>"GE", :con_id=>498843743, :multiplier=>0, :primary_exchange=>"NYSE", }
 ```
 
-or occationally
+Currently implemented plugins
+
+* connection-tools: ensure that a connection is established and active
+* verify:  get contract details from the tws
+* symbols: use predefined symbols 
+* managed-accounts: fetch and organize account- and portfoliovalues
+* advanced-account: perform account-based previewing, opening, modifying and closing of Positions
+* process-orders: account-based bookkeeping of orders
+* auto-adjust: properly adjust the orderprice to the next valid min-tick of the contract
+* market-price: fetch the current market-price of a contract
+* eod:  retrieve EOD-Data for the given contract
+* greeks: read current option greeks
+* roll: easy rolling of futures and options
+* option-chain: build option-chains for given strikes and expiries 
+* spread-prototypes:  create limit, stop, market, etc. orders through prototypes
+* probability-of-expiring: calculate the probability of expiring for the option-contract
+
 
-```ruby
-        # first define actions
-	q =  Queue.new    # Initialize as Queue
-	request_id = nil  # declare variable
-	a = ib.subscribe(:Alert, :ContractData, :ContractDataEnd ) do |msg| 
-		case msg
-		when Messages::Incoming::Alert
-			q.close if msg.code == 200   # No security found 
-		when Messages::Incoming::ContractData  # security returned
-			q.push msg.contract if msg.request_id == request_id
-	        when Messages::Incoming::ContractDataEnd
-		       q.close if msg.request_id == request_id
-		end  # case
-	end
-        # perform request
-        request_id = ib.send_message :RequestContractData, :contract => Stock.new(symbol: 'T')
-
-	while contract = q.pop 
-	  puts contract.as_table 
-	end
-┌───────┬────────┬──────────┬──────────┬────────┬────────────┬───────────────┬───────┬────────┬──────────┐
-│       │ symbol │ con_id   │ exchange │ expiry │ multiplier │ trading-class │ right │ strike │ currency │
-╞═══════╪════════╪══════════╪══════════╪════════╪════════════╪═══════════════╪═══════╪════════╪══════════╡
-│ Stock │ T      │ 37018770 │  SMART   │        │            │       T       │       │        │   USD    │
-└───────┴────────┴──────────┴──────────┴────────┴────────────┴───────────────┴───────┴────────┴──────────┘
-
-        ib.unsubscribe a    # release subscriptions
-
-```
 ## Minimal TWS-Version
 
-`ib-api` is tested via the _stable IB-Gateway_ (Version 9.72) and should work with any current tws-installation. 
+`ib-api` is tested via the _stable IB-Gateway_ (Version 10.19) and should work with any current tws-installation. 
 
 ## Tests
 

VERSION

@@ -1 +1 @@
-972.5
+10.19.1

api.gemspec

@@ -42,4 +42,12 @@ Gem::Specification.new do |spec|
 	spec.add_dependency 'activemodel'
 	spec.add_dependency 'ox'
 	spec.add_dependency 'terminal-table'
+	spec.add_dependency 'zeitwerk'
+  spec.add_dependency 'workflow', '~> 3.1'
+#  spec.add_dependency 'dry-schema'
+#  spec.add_dependency 'dry-struct'
+#  spec.add_dependency 'dry-core'
+#  spec.add_dependency 'dry-configurable'
+#  spec.add_dependency 'dry-monads'  # future use
+
 end

bin/console

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-### loads the active-orient environment 
+### loads the active-orient environment
 ### and starts an interactive shell
 ###
 ### Parameter: t)ws | g)ateway (or number of port ) Default: Gateway ,
@@ -17,9 +17,9 @@ class Array
   # i.e
   #
   #  2.5.0 :006 > C.received[:OpenOrder].local_id
-  #   => [16, 17, 21, 20, 19, 8, 7] 
+  #   => [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>"] 
+  #    => ["<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
 
@@ -31,61 +31,66 @@ class Array
   end
 end # Array
 
+class Object
+  def inspect
+    respond_to?(:to_human) ? to_human : super
+  end
+end
 
-# read items from console.yml 
-read_yml = -> (key) do
+# read items from console.yml
+  read_yml = -> (key) do
 		YAML::load_file( File.expand_path('../console.yml',__FILE__))[key]
 	end
 
-
-  puts 
-  puts ">> IB-Core Interactive Console <<" 
+  puts
+  puts ">> IB-API Interactive Console <<"
   puts '-'* 45
-  puts 
+  puts
   puts "Namespace is IB ! "
   puts
   puts '-'* 45
   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
+  specified_host = ARGV[0] || 'Gateway'
+	host =  case specified_host
 					when /^[gG]/ 
 						read_yml[:gateway]
 					when /^[Tt]/
 						read_yml[:tws]
+          else
+            raise "Specify target from console.yml: `g|t` instead of #{specified_host}"
 					end
-
   ARGV.clear
-
-  ## 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| c.logger.info { msg.contract.to_human } }
-    c.subscribe( :Alert, :ContractDataEnd, :ManagedAccounts, :OrderStatus ) {| m| c.logger.info { m.to_human } }
-    c.subscribe( :PortfolioValue, :AccountValue, :OrderStatus, :OpenOrderEnd, :ExecutionData ) {| m| c.logger.info { m.to_human }}
-#    c.subscribe :ManagedAccounts do  |msg|
-#        puts "------------------------------- Managed Accounts ----------------------------------"
-#				puts "Detected Accounts: #{msg.accounts.account.join(' -- ')} " 
-#				puts
-#    end
+  C =  Connection.new  client_id: client_id, host: host
+  C.logger.level = Logger::WARN
+
+  C.subscribe(:Alert){ |m| puts "A: "+ m.message }
+  C.subscribe(:AccountUpdateTime){  }
+
+  C.received = true
+  C.activate_plugin :connection_tools, :symbols, :market_price,
+                    "order-prototypes", "spread-prototypes",
+                    "advanced_account", 'process_orders'
+  C.logger.level = Logger::INFO
+  puts C.workflow_state
+  C.get_account_data
+  C.request_open_orders
+  C.logger.level = Logger::ERROR
+  puts  "Connection established on  #{host}"
 
-    c.subscribe( :OpenOrder){ |msg|  "Open Order detected and stored: C.received[:OpenOrders] " }
-	end 
-  #C.logger.level = Logger::FATAL
   unless  C.received[:OpenOrder].blank?
-        puts "------------------------------- OpenOrders ----------------------------------"
-    puts C.received[:OpenOrder].to_human.join "\n"
+        puts "---------------------------------------- OpenOrders -------------------------------------------"
+        puts C.clients.map{ |c| c.orders.map &:to_human }.flatten.join("\n")
   end
-  puts  "Connection established on Port  #{port}, client_id #{client_id} used"
+  puts ""
+  puts  Terminal::Table.new title: 'Active Plugins',
+                             rows: C.plugins.delete_if{ |x| x =~ /\// }.sort.each_slice(4),
+                            style: { border: :unicode  }
   puts
   puts  "----> C    points to the connection-instance"
   puts
-  puts  "some basic Messages are subscribed and accordingly displayed"
   puts '-'* 45
 
   IRB.start(__FILE__)

bin/console.yml

@@ -1,3 +1,3 @@
-:gateway:  4002
-:tws: 7496
+:gateway:  "localhost:4002"
+:tws: "tws:7496"
 :client_id: 2000