ib-api 972.0 → 972.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 542bca5318150ae448c4b7578abd64beec70e5b35760eea8abfd22c28f5da1fd
-  data.tar.gz: cb68b0afa4812eb224936f5269be2f6d6c825ea5f9bd21b25c1c9dfe21b70777
+  metadata.gz: d9119cbc06f3b5e5e32b73fbe0d706b06d94c55ff2ce2ca4357e4f349f49f43f
+  data.tar.gz: b977e09dee0df176e673679839b738425871dbf25ca8cad4e8f497323647ecc6
 SHA512:
-  metadata.gz: 96bac41a8432c7175dcba4fa38548db4af966d370fc8e12570c4cfd28f89284afb3188ad50d1131859861cc40d414515772cece8bed147093de04aaaf3e6b2c5
-  data.tar.gz: 57c186381a3da9eb7e2169d588ca99440c24993a41905ca9828c4490471a229d1e078739b34f58e666fffb7d4031bba0dfcae4a48e987667ce6d0d65246a66be
+  metadata.gz: '02538d6ab965ee0024cef798aebbcdff42859025a848108c5ca7af1e305cae019b1db3f9489300497fde388f5b0e659064d305ec316695d4154d20abc05277f1'
+  data.tar.gz: 3245c0fda19a98f6ab5b29827b246b91d31c91a5daac10bcd8bbe114d699edc117922bae11503b3219f7bd18d8b654b6be6e19365c346bad3f4201829ce6f97b

data/Gemfile.lock

@@ -7,21 +7,21 @@ GIT
 PATH
   remote: .
   specs:
-    ib-api (972.0)
+    ib-api (972.1)
       activemodel
       activesupport (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activesupport (6.0.3.4)
+    activemodel (6.1.0)
+      activesupport (= 6.1.0)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
@@ -80,11 +80,10 @@ GEM
     rspec-support (3.9.3)
     shellany (0.0.1)
     thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     value_semantics (3.6.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -3,6 +3,7 @@ Ruby interface to Interactive Brokers' TWS API
 
 Reimplementation of the basic functions of ib-ruby
 
+__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.
@@ -11,12 +12,18 @@ Reimplementation of the basic functions of ib-ruby
 
 ----
 
-In its plain vanilla usage, it just exchanges messages with the TWS. The user is responsible for any further data processing.
+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`.
 
 Even then, it needs just a few lines of code to place an order
 
 ```ruby
+require 'ib-api'
 # connect with default parameters 
 ib =  IB::Connection.new 
 
@@ -38,10 +45,48 @@ puts ib.recieved[:OrderStatus].to_human
 
 # => ["<OrderState: Submitted #17/1528367295 from 2000 filled 0.0/100.0 at 0.0/0.0 why_held >"]
 
+```
+
+##### User-specific Actions
+Besides storing any TWS-response in an array, callbacks are implemented.
+
+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
+
+```
+
+or occationally
+
+```ruby
+        # first define actions
+	a = ib.subscribe(:Alert, :ContractData ) do |msg| 
+		case msg
+		when Messages::Incoming::Alert
+			if msg.code == 200   # No security found 
+				# do someting
+			end
+		when Messages::Incoming::ContractData  # security returned
+			# do something
+	
+		end  # case
+	end
+        # perform request
+        ib.send_message :RequestContractData, :contract => #{some contract}
+         
+        # wait until the :ContractDataEnd message returned
+        ib.wait_for :ContractDataEnd
+         
+        ib.unsubscribe a    # release subscriptions
+         
 ```
 ## Minimal TWS-Version
 
-`ib-api` is tested via the _stable ib-Gateway_ (Version 9.72) 
+`ib-api` is tested via the _stable IB-Gateway_ (Version 9.72) and should work with any current tws-installation. 
 
 ## Tests
 
@@ -58,7 +103,7 @@ You have to edit `spec/spec.yml` and replace the `:account`-Setting with your ow
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ib-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 

data/VERSION

@@ -1 +1 @@
-972.0
+972.1

data/changelog.md

@@ -5,3 +5,14 @@ Changelog
 |=++++   |=++++++++++++ |
 | 30.8.2020 | migrating lib-files from ib-ruby-project |
 
+| 28.11.2020| separating lib/model and lib/models to enable extension with
+              ActiveRecord/Rails and OrientDB/ActiveOrient. |
+|           | Introducing a Database-Switch in /lib/requires to omit 
+              loading of model- and messages files. This has to be done 
+							manually after assigning the database-model framework. |
+
+| 1.12.2020 | moving model/ib/spread.rb from `ib-extensions` to `ib-api`.|
+| 1.12.2020 | creating a dummy Contract#verify to guaranty safe operation of spreads |
+
+|           | Preparation of a Gem-Release  |
+

data/lib/ib/base_properties.rb

@@ -19,11 +19,10 @@ module IB
 
     # Comparison support
     def content_attributes
-      #HashWithIndifferentAccess[attributes.reject do |(attr, _)|
 			#NoMethodError if a Hash is assigned to an attribute
       Hash[attributes.reject do |(attr, _)|
                                   attr.to_s =~ /(_count)\z/ ||
-                                    [:created_at, :updated_at, :type,
+                                    [:created_at, :type, # :updated_at, 
                                      :id, :order_id, :contract_id].include?(attr.to_sym)
       end]
     end
@@ -151,9 +150,9 @@ Remove all Time-Stamps from the list of Attributes
       end
 
       # Timestamps in lightweight models
-      unless defined?(ActiveRecord::Base) && ancestors.include?(ActiveRecord::Base)
+ #     unless defined?(ActiveRecord::Base) && ancestors.include?(ActiveRecord::Base)
         prop :created_at #, :updated_at
-      end
+ #     end
 
     end # included
   end # module BaseProperties

data/lib/ib/messages/incoming.rb

@@ -139,7 +139,7 @@ module IB
       TickRequestParameters = def_message [81, 0], [ :ticker_id, :int ],
 					      [ :min_tick, :decimal],
 					      [ :exchange, :string ],
-					      [ :snapshot_prermissions, :int ]
+					      [ :snapshot_permissions, :int ]
 #      class TickRequestParameters 
 #	def load
 #	  simple_load

data/lib/ib/messages/incoming/contract_data.rb

@@ -56,8 +56,6 @@ module IB
           @contract_detail = IB::ContractDetail.new @data[:contract_detail]
         end
 
-        alias contract_details contract_detail
-
 				def to_human
 					"<Contract #{contract.to_human}   #{contract_detail.to_human}>"
 				end

data/lib/ib/messages/incoming/ticks.rb

@@ -13,7 +13,7 @@ module IB
           "<#{self.message_type} #{type}:" +
               @data.map do |key, value|
                 " #{key} #{value}" unless [:version, :ticker_id, :tick_type].include?(key)
-              end.compact.join(',') + " >"
+              end.compact.join('",') + " >"
         end
 
 				def the_data
@@ -129,71 +129,32 @@ module IB
                       [:theta, :decimal_limit_2],					#      -2   -"-
                       [:under_price, :decimal_limit_1]) do
 
-            "<TickOption #{type} for #{ticker_id}: underlying @ #{under_price}, "+
-                "option @ #{option_price}, IV #{implied_volatility}%, delta #{delta}, " +
-                "gamma #{gamma}, vega #{vega}, theta #{theta}, pv_dividend #{pv_dividend}>"
+            "<TickOption #{type}   " + 
+                "option @ #{"%8.3f" % (option_price || -1)}, IV: #{"%4.3f" % (implied_volatility || -1)}, " +
+						    "delta: #{"%5.3f" % (delta || -1)}, " +
+                "gamma: #{"%6.4f" % (gamma || -1)}, vega: #{ "%6.5f" % (vega || -1)}, " + 
+								"theta: #{"%7.6f" % (theta || -1)}, pv_dividend: #{"%5.3f" % (pv_dividend || -1)}, " +
+							  "underlying @ #{"% 8.3f" % (under_price || -1)} >"
           end
 
-      TickSnapshotEnd = def_message 57, [:ticker_id, :int]
-=begin
-    def processTickByTickMsg(self, fields):
-        next(fields)
-        reqId = decode(int, fields)
-        tickType = decode(int, fields)
-        time = decode(int, fields)
-
-        if tickType == 0:
-            # None
-            pass
-        elif tickType == 1 or tickType == 2:
-            # Last or AllLast
-            price = decode(float, fields)
-            size = decode(int, fields)
-            mask = decode(int, fields)
-class TickAttribLast(Object):
-    def __init__(self):
-        self.pastLimit = False
-        self.unreported = False
-
-    def __str__(self):
-        return "PastLimit: %d, Unreported: %d" % (self.pastLimit, self.unreported)
-
-            tickAttribLast = TickAttribLast()
-            tickAttribLast.pastLimit = mask & 1 != 0
-            tickAttribLast.unreported = mask & 2 != 0
-            exchange = decode(str, fields)
-            specialConditions = decode(str, fields)
+			 class TickOption		
+				 def greeks
+					 { delta: delta, gamma: gamma, vega: vega, theta: theta }
+				 end
 
-            self.wrapper.tickByTickAllLast(reqId, tickType, time, price, size, tickAttribLast,
-                                           exchange, specialConditions)
-        elif tickType == 3:
-            # BidAsk
-            bidPrice = decode(float, fields)
-            askPrice = decode(float, fields)
-            bidSize = decode(int, fields)
-            askSize = decode(int, fields)
-            mask = decode(int, fields)
-	class TickAttribBidAsk(Object):
-    def __init__(self):
-        self.bidPastLow = False
-        self.askPastHigh = False
+				 def iv
+					 implied_volatility
+				 end
+			
+				 
+				 def greeks? 
+					 greeks.values.any? &:present?
+				 end
 
-    def __str__(self):
-        return "BidPastLow: %d, AskPastHigh: %d" % (self.bidPastLow, self.askPastHigh)
+			 end
 
+      TickSnapshotEnd = def_message 57, [:ticker_id, :int]
 
-            tickAttribBidAsk = TickAttribBidAsk()
-            tickAttribBidAsk.bidPastLow = mask & 1 != 0
-            tickAttribBidAsk.askPastHigh = mask & 2 != 0
-
-            self.wrapper.tickByTickBidAsk(reqId, time, bidPrice, askPrice, bidSize,
-                                          askSize, tickAttribBidAsk)
-        elif tickType == 4:
-            # MidPoint
-            midPoint = decode(float, fields)
-
-            self.wrapper.tickByTickMidPoint(reqId, time, midPoint)
-=end
 			TickByTick =  def_message [99, 0], [:ticker_id, :int ],
 			[ :tick_type, :int],
 			[ :time, :int_date ]

data/lib/ib/messages/outgoing.rb

@@ -249,10 +249,12 @@ module IB
 			CancelHistogramData =
 					def_message [89,0 ] # , :(request_)id  required
 
+			## Attention: If not reasonable data are used, simply nothing is returned.
+			## There is no error message either.
       RequestCalculateImpliedVolatility = CalculateImpliedVolatility =
           RequestImpliedVolatility =
               def_message([ 54,3 ],:request_id,  # autogenerated
-                      [:contract, :serialize_short, :primary_exchange],
+                      [:contract, :serialize_short],
                           :option_price,
                           :under_price,
 													[:implied_volatility_options_count, 0],
@@ -262,7 +264,7 @@ module IB
       #          :volatility => double, :under_price => double }
       RequestCalculateOptionPrice = CalculateOptionPrice = RequestOptionPrice =
           def_message([ 55, 3], :request_id, #autogenerated if not specified
-                      [:contract, :serialize_short, :primary_exchange],
+                      [:contract, :serialize_short],
                       :volatility,
                       :under_price,
 													[:implied_volatility_options_count, 0],

data/lib/ib/messages/outgoing/request_marketdata.rb

@@ -4,7 +4,8 @@ module IB
     module Outgoing
       extend Messages # def_message macros
 
-
+			#  ==> details:  https://interactivebrokers.github.io/tws-api/tick_types.html
+			#
       # @data={:id => int: ticker_id - Must be a unique value. When the market data
       #                                returns, it will be identified by this tag,
 			#                                if omitted, id-autogeneration process is performed
@@ -32,7 +33,7 @@ module IB
       #        292 - (Wide News)                          
       #        293 - (TradeCount)                          
       #        295 - (VolumeRate)                          
-      #        318 - (iLastRTHT-Trade)                          
+      #        318 - (LastRTHT-Trade)                          
       #        370 - (Participation Monitor)
       #        375 - RTTrdVolumne
       #        377 - CttTickTag
@@ -46,7 +47,11 @@ module IB
       #        411 - Realtime Historical Volatility - 58
       #        428 - Monetary Close
       #        439 - MonitorTicTag
-      #        456/59 - IB Dividends
+      #        456/59 - IB Dividends, 4 comma separated values: 12 Month dividend, 
+			#                                                         projected 12 Month dividend,
+			#                                                         next dividend date,
+			#                                                         next dividend value
+			#                                                         (use primary exchange instead of smart)
       #        459 - RTCLOSE
       #        460 - Bond Factor Multiplier
       #        499 - Fee and Rebate Ratge
@@ -79,7 +84,7 @@ module IB
       #                   :tick_list values if you use snapshot. 
       #
       #      :regulatory_snapshot => bool - With the US Value Snapshot Bundle for stocks,
-      #                   regulatory snapshots are available for 0.01 USD each.
+      #                   regulatory snapshots are available for 0.01 USD each. (applies on demo accounts as well)
       #      :mktDataOptions => (TagValueList)  For internal use only.
       #                    Use default value XYZ. 
       #
@@ -88,9 +93,7 @@ module IB
                       [:contract, :serialize_short, :primary_exchange],  # include primary exchange in request
                       [:contract, :serialize_legs, []],
                       [:contract, :serialize_under_comp, []],
-                      [:tick_list, lambda do |tick_list|
-                        tick_list.is_a?(Array) ? tick_list.join(',') : (tick_list || '')
-                      end, []],
+                      [:tick_list, ->(tick_list){ tick_list.is_a?(Array) ? tick_list.join(',') : (tick_list || '')}, []],
                       [:snapshot, false],
 		      [:regulatory_snapshot, false],
 		      [:mkt_data_options, "XYZ"]

data/lib/ib/models.rb

@@ -1,4 +1,3 @@
-  require 'ib/model'
 
   require 'models/ib/account'
   require 'models/ib/account_value'
@@ -11,4 +10,5 @@
   require 'models/ib/combo_leg'
   require 'models/ib/execution'
   require 'models/ib/bar'
+  require 'models/ib/spread'
 	require 'models/ib/condition'

data/lib/models/ib/account.rb

@@ -1,7 +1,6 @@
 module IB
 	class Account < IB::Model
 		include BaseProperties
-#		include Redis::Objects
 		#  attr_accessible :alias, :account, :connected
 
 		prop :account,  # String 
@@ -10,10 +9,6 @@ module IB
 			:last_updated,
 			:connected => :bool
 
-#		redis_id_field :account
-#		value :my_alias
-#		value :the_account
-#		value :active
 
 
 		validates_format_of :account, :with =>  /\A[D]?[UF]{1}\d{5,8}\z/ , :message => 'should be (X)X00000'
@@ -37,14 +32,6 @@ module IB
 			Connection.logger
 		end
 
-		# Setze Account connect/disconnect und undate!
-		def connect!
-			update_attribute :connected , true
-		end 
-		def disconnect!
-			update_attribute :connected , false
-		end 
-
 		def print_type #nodoc#
 			(test_environment? ? "demo_"  : "") + ( user? ? "user" : "advisor" )
 		end

data/lib/models/ib/bag.rb

@@ -1,4 +1,4 @@
-require 'models/ib/contract'
+#require 'models/ib/contract'
 
 module IB
 

data/lib/models/ib/contract.rb

@@ -4,7 +4,13 @@ require 'models/ib/underlying'
 
 
 module IB
-  class Contract < IB::Model
+
+  if defined?(Contract) 
+		puts "Contract already a #{defined?(Contract)}"
+#		puts Contract.ancestors
+#		IB.send(:remove_const, 'Contract')
+	end
+  class Contract <  IB::Model
     include BaseProperties
 
     # Fields are Strings unless noted otherwise
@@ -211,17 +217,24 @@ module IB
 		# the link to contract-details is __not__ maintained.
 		def  essential
 
-			self_attributes = [ :right, :sec_type]
-			the_attributes = [ :symbol , :con_id,   :exchange, 
+			self_attributes = [ :sec_type]
+			the_attributes = [ :symbol , :con_id,   :exchange, :right, 
 									  :currency, :expiry,  :strike,   :local_symbol, :last_trading_day,
 								:multiplier,  :primary_exchange, :trading_class ]
-			the_hash= the_attributes.map{|x| y= attributes[x];  [x,y] if y.present?  }.compact.to_h
-			the_hash[:description] = @description if @description.present?
-			self.class.new   the_hash.merge( self_attributes.map{|x| y = self.send(x);  [x,y] unless y == :none}.compact.to_h )
+			the_hash= the_attributes.map{|x| y= self.send(x);  [x,y] if y.present? }.compact.to_h
+			the_hash[:description] = 
+				 if @description.present? 
+					  @description 
+				 elsif contract_detail.present?
+					 contract_detail.long_name
+				 else 
+					 ""
+				 end
+			self.class.new   the_hash.merge( self_attributes.map{|x| y = self.send(x);  [x,y] unless y == :none }.compact.to_h )
 		end
 
 
-		# creates a new Contract substituting attributes by the provied key-value pairs.
+		# creates a new Contract substituting attributes by the provided key-value pairs.
 		#
 		# con_id is resetted
 		def merge **new_attributes
@@ -327,6 +340,10 @@ module IB
       self[:sec_type] == 'IND'
     end
 
+
+		def verify  # :nodoc:
+			error "verify must be overloaded. Please require at least `ib/verify` from the `ib-extenstions` gem "
+		end
 =begin
 From the release notes of TWS 9.50
 
@@ -365,7 +382,7 @@ In places where these terms are used to indicate a concept, we have left them as
 
   ### Now let's deal with Contract subclasses
 
-  require 'models/ib/option'
+  require_relative 'option'
   require 'models/ib/bag'
   require 'models/ib/forex'
   require 'models/ib/future'
@@ -378,6 +395,7 @@ In places where these terms are used to indicate a concept, we have left them as
     Subclasses = Hash.new(Contract)
     Subclasses[:bag] = IB::Bag
     Subclasses[:option] = IB::Option
+    Subclasses[:future_option] = IB::FutureOption
     Subclasses[:future] = IB::Future
     Subclasses[:stock] = IB::Stock
     Subclasses[:forex] =  IB::Forex

data/lib/models/ib/contract_detail.rb

@@ -95,13 +95,19 @@ module IB
     end
 
 		def to_human
-			ret = "<ContractDetails  #{long_name}, market-name:#{market_name}, "
-			ret << "category:#{category}, industry:#{industry} / #{subcategory}, " if category.present?
-			ret << "underlying: con_id:#{under_con_id} , sec_type:#{under_sec_type}, symbol:#{under_symbol} " unless under_con_id.zero?
-      ret << "ev_multiplier:#{ev_multiplier}, convertible:#{convertible}, cupon:#{coupon}, "
-			ret << "md_size_multiplier:#{md_size_multiplier}, min_tick:#{min_tick}, next_option_partial:#{next_option_partial} "
-			ret <<"price_magnifier:#{price_magnifier}, puttable:#{puttable}, sec_id-list:#{sec_id_list}, "
-			ret <<"valid exchanges: #{ valid_exchanges}, order types: #{order_types} >"
+			ret = "<ContractDetails  #{long_name}, "
+			ret << "--> #{market_name}, " if market_name.present?
+			ret << "/C/ #{category}, /I/ #{industry} /SC/ #{subcategory}, " if category.present?
+			ret << "Underlying:#{under_symbol}[#{under_sec_type}](#{under_con_id}), " unless under_con_id.zero?
+      ret << "ev_multiplier:#{ev_multiplier}, " if ev_multiplier.present?
+			ret << "convertible:#{convertible}, " if convertible
+			ret << "coupon:#{coupon}, " if coupon.present?  && coupon > 0 
+			ret << "md_size_multiplier:#{md_size_multiplier}, min_tick:#{min_tick}, "
+			ret << "next_option_partial:#{next_option_partial}, " if next_option_partial.present?
+			ret << "price_magnifier:#{price_magnifier}, " 
+			ret << "puttable:#{puttable}, " if puttable.present? 
+			ret << "sec_id-list:#{sec_id_list}, " unless sec_id_list.empty?
+			ret <<"valid exchanges: #{ valid_exchanges}; order types: #{order_types} >"
 		end
 
   end # class ContractDetail

data/lib/models/ib/index.rb

@@ -7,7 +7,7 @@ module IB
       super.merge :sec_type => :ind
     end
     def to_human
-      "<Index: " + [symbol, currency].join(" ") + ">"
+      "<Index: " + [symbol, currency].join(" ") + " (#{description}) >"
     end
 
   end

data/lib/models/ib/option.rb

@@ -1,5 +1,5 @@
-require 'models/ib/contract'
-require 'models/ib/option_detail'
+#require_relative 'contract'
+require_relative 'option_detail'
 
 module IB
   class Option < Contract
@@ -75,4 +75,8 @@ module IB
     end
 
   end # class Option
+
+	class FutureOption   < Option 
+
+	end
 end # module IB

data/lib/models/ib/option_detail.rb

@@ -17,7 +17,8 @@ module IB
 	 :next_strike,
 	 :prev_expiry,
 	 :next_expiry,
-	 :option_price
+	 :option_price,
+	 :updated_at
     belongs_to :option
 
     # returns true if all datafields are filled with reasonal data
@@ -32,19 +33,34 @@ module IB
 
     def greeks?
      fields= [ :delta,  :gamma, :vega, :theta,
-         :implied_volatility, :pv_dividend]
+         :implied_volatility]
 
       !fields.detect{|y| self.send(y).nil?}
 
     end
 
+		def prices?
+			fields = [:implied_volatility, :under_price, :option_price]
+      !fields.detect{|y| self.send(y).nil?}
+		end
+
+		def iv
+			implied_volatility
+		end
+
+		def spread
+			bid_price - ask_price
+		end 
+
     def to_human
       outstr= ->( item ) { if item.nil? then "--" else  sprintf("%g" , item)  end  }
       att = " optionPrice: #{ outstr[ option_price ]}, UnderlyingPrice: #{ outstr[ under_price] } impl.Vola: #{ outstr[ implied_volatility ]} ; dividend: #{ outstr[ pv_dividend ]}; "
       greeks = "Greeks::  delta:  #{ outstr[ delta ] }; gamma: #{ outstr[ gamma ]}, vega: #{ outstr[ vega ] }; theta: #{ outstr[ theta ]}" 
       prices= " close: #{ outstr[ close_price ]}; bid: #{ outstr[ bid_price ]}; ask: #{ outstr[ ask_price ]} "
       if	complete?
-	"< "+ prices + "\n" + att + "\n" + greeks + " >"
+				"< "+ prices + "\n" + att + "\n" + greeks + " >"
+			elsif prices?
+				"< " + att + greeks + " >"
       else
 	"< " + greeks + " >"
       end

data/lib/models/ib/spread.rb

@@ -0,0 +1,159 @@
+#require 'ib/verify'
+module IB
+	class Spread  < Bag
+		has_many :legs
+
+		using IBSupport
+
+=begin
+Parameters:   front: YYYMM(DD)
+							back: {n}w, {n}d or YYYYMM(DD)
+
+Adds (or substracts) relative (back) measures to the front month, just passes absolute YYYYMM(DD) value
+	
+	front: 201809   back:  2m (-1m) --> 201811 (201808)
+	front: 20180908 back:  1w (-1w) --> 20180918 (20180902)
+=end
+
+		def transform_distance front, back
+			# Check Format of back: 201809 --> > 200.000
+			#	                      20180989 ---> 20.000.000
+			start_date = front.to_i < 20000000 ?  Date.strptime(front.to_s,"%Y%m") :  Date.strptime(front.to_s,"%Y%m%d") 
+			nb = if back.to_i > 200000 
+						 back.to_i
+					 elsif back[-1] == "w" && front.to_i > 20000000
+						 start_date + (back.to_i * 7)
+					 elsif back[-1] == "m" && front.to_i > 200000
+						 start_date >> back.to_i
+					 else
+						 error "Wrong date #{back} required format YYYMM, YYYYMMDD ord {n}w or {n}m"
+					 end
+			if nb.is_a?(Date)	
+				if back[-1]=='w'
+					nb.strftime("%Y%m%d")
+				else
+					nb.strftime("%Y%m")
+				end
+			else
+				nb
+			end 
+		end # def 
+	
+		def to_human
+			self.description
+		end
+
+		def calculate_spread_value( array_of_portfolio_values )
+			array_of_portfolio_values.map{|x| x.send yield }.sum if block_given?
+		end
+	
+		def fake_portfolio_position(  array_of_portfolio_values )
+				calculate_spread_value= ->( a_o_p_v, attribute ) do
+							a_o_p_v.map{|x| x.send attribute }.sum 
+				end
+				ar=array_of_portfolio_values
+				IB::PortfolioValue.new  contract: self, 
+					average_cost: 	calculate_spread_value[ar, :average_cost],
+					market_price: 	calculate_spread_value[ar, :market_price],
+					market_value: 	calculate_spread_value[ar, :market_value],
+					unrealized_pnl: 	calculate_spread_value[ar, :unrealized_pnl],
+					realized_pnl: 	calculate_spread_value[ar, :realized_pnl],
+					position: 0
+
+		end
+
+
+
+		def serialize_rabbit
+			{ "Spread" => serialize( :option, :trading_class ),
+				'legs' => legs.map{ |y| y.serialize :option, :trading_class }, 'combo_legs' => combo_legs.map(&:serialize),
+				'misc' => [description]
+			}	
+		end
+
+		# adds a leg to any spread
+		#
+		# Parameter: 
+		#		contract:  Will be verified. Contract.essential is added to legs-array
+		#		action: :buy or :sell
+		#		weight:
+		#		ratio:
+		#		
+		#	Default:  action: :buy, 	weight: 1
+
+		def add_leg contract,  **leg_params
+			evaluated_contracts =  []
+			nc =	contract.verify.first.essential
+			#			weigth = 1 --> sets Combo.side to buy and overwrites the action statement
+#			leg_params[:weight] = 1 unless leg_params.key?(:weight) || leg_params.key?(:ratio)
+			if nc.is_a?( IB::Contract) && nc.con_id.present?
+					the_leg= ComboLeg.new( nc.attributes.slice( :con_id, :exchange )
+																					.merge( leg_params ))
+					self.combo_legs << the_leg 
+					self.description = description + " added #{nc.to_human}" rescue "Spread: #{nc.to_human}"
+					self.legs << nc
+			end
+			self  # return value to enable chaining
+
+
+		end
+
+		# removes the contract from the spread definition
+		#
+		def remove_leg contract
+			contract.verify do |c|
+				legs.delete_if { |x| x.con_id == c.con_id }
+				combo_legs.delete_if { |x| x.con_id == c.con_id }
+				self.description = description + " removed #{c.to_human}"
+			end
+			self
+		end
+
+
+		def essential
+				legs.each{ |x| x.essential }
+				self
+		end
+		def  multiplier
+			(legs.map(&:multiplier).sum/legs.size).to_i
+		end
+		
+		# provide a negative con_id 
+		def con_id
+			-legs.map(&:con_id).sum
+		end
+
+
+		def non_guaranteed= x
+      super.merge		combo_params: [ ['NonGuaranteed', x] ]
+		end
+
+
+		def non_guaranteed
+     	combo_params['NonGuaranteed']
+		end
+#  optional: specify default order prarmeters for all spreads
+#		def order_requirements
+#		 super.merge		symbol: symbol
+#		end
+
+
+		def self.build_from_json container
+			read_leg = ->(a) do 
+				  IB::ComboLeg.new :con_id => a.read_int,
+                           :ratio => a.read_int,
+                           :action => a.read_string,
+                           :exchange => a.read_string
+
+			end
+			object= self.new  container['Spread'].read_contract
+			object.legs = container['legs'].map{|x| IB::Contract.build x.read_contract}
+			object.combo_legs = container['combo_legs'].map{ |x| read_leg[ x ] } 
+			object.description = container['misc'].read_string
+			object
+
+		end
+	end
+
+
+end

data/lib/models/ib/stock.rb

@@ -1,14 +1,20 @@
-require_relative 'contract'
+#require_relative 'contract'
 module IB
 	class Stock < IB::Contract
 		validates_format_of :sec_type, :with => /\Astock\z/,
 			:message => "should be a Stock"
+		validates_format_of :symbol, with: /\A.*\z/,
+			message: 'should not be blank'
 		def default_attributes
 			super.merge :sec_type => :stock, currency:'USD', exchange:'SMART'
 		end
 
-		def to_human
-			att =  [ symbol, currency, ( exchange == 'SMART' ? nil: exchange ), (primary_exchange.present? && !primary_exchange.empty? ? primary_exchange : nil)].compact
+		def to_human 
+			att =  [ symbol, 
+						  currency, ( exchange == 'SMART' ? nil: exchange ), 
+							(primary_exchange.present? && !primary_exchange.empty? ? primary_exchange : nil),
+							@description.present? ? " (#{@description}) " : nil,
+			       ].compact
 						"<Stock: " + att.join(" ") + ">"
 		end
 

data/lib/models/ib/underlying.rb

@@ -1,4 +1,7 @@
 module IB
+  if defined?(Underlying) 
+		puts "Underlying already a #{defined?(Underlying)}"
+	else
 
   # Calculated characteristics of underlying Contract (volatile)
   class Underlying < IB::Model
@@ -30,5 +33,5 @@ module IB
 
   end # class Underlying
   UnderComp = Underlying
-
+	end
 end # module IB

data/lib/requires.rb

@@ -7,6 +7,13 @@ require 'ib/errors'
 require 'ib/constants'
 require 'ib/connection'
 
-require 'ib/models'
-require 'ib/messages'
-
+# An external model- or database-driver provides the base class for models 
+# if the constant DB is defined
+# 
+# basically 	IB::Model  has to be assigned to the substitute base class
+# the database-driver requires models and messages at the appropoate time
+unless defined?(DB)
+	require 'ib/model' 
+	require 'ib/models'
+	require 'ib/messages'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ib-api
 version: !ruby/object:Gem::Version
-  version: '972.0'
+  version: '972.1'
 platform: ruby
 authors:
 - Hartmut Bischoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,7 @@ files:
 - lib/models/ib/order.rb
 - lib/models/ib/order_state.rb
 - lib/models/ib/portfolio_value.rb
+- lib/models/ib/spread.rb
 - lib/models/ib/stock.rb
 - lib/models/ib/underlying.rb
 - lib/models/ib/vertical.rb