ib-ruby 0.5.10 → 0.5.11

data/HISTORY

@@ -85,3 +85,7 @@
 == 0.5.10 / 2011-12-19
 
 * Bag Contract subclass added
+
+== 0.5.11 / 2011-12-20
+
+* Release Connection.current API

data/VERSION

@@ -1 +1 @@
-0.5.10
+0.5.11

data/bin/list_orders

@@ -15,7 +15,14 @@ require 'ib-ruby'
 ib = IB::Connection.new :client_id => 0
 
 # Subscribe to TWS alerts/errors and order-related messages
-ib.subscribe(:Alert, :OpenOrder, :OrderStatus) { |msg| puts msg.to_human }
+@counter = 0
+
+ib.subscribe(:Alert, :OrderStatus) { |msg| puts msg.to_human }
+
+ib.subscribe(:OpenOrder) do |msg|
+  @counter += 1
+  puts "#{@counter}: #{msg.to_human}"
+end
 
 ib.send_message :RequestAllOpenOrders
 

data/lib/ib-ruby/connection.rb

@@ -27,6 +27,11 @@ module IB
                        :reader => true
     }
 
+    # Singleton to make active Connection universally accessible as IB::Connection.current
+    class << self
+      attr_accessor :current
+    end
+
     attr_reader :server #         Info about IB server and server connection state
     attr_accessor :next_order_id #  Next valid order id
 
@@ -39,6 +44,7 @@ module IB
 
       connect if @options[:connect]
       start_reader if @options[:reader]
+      Connection.current = self
     end
 
     # Message subscribers. Key is the message class to listen for.

data/lib/ib-ruby/models/combo_leg.rb

@@ -5,6 +5,10 @@ module IB
     # is not really a contract, but a combination (combo) of securities. AKA basket
     # or bag of securities.
     class ComboLeg < Model
+      # General Notes:
+      # 1. The exchange for the leg definition must match that of the combination order.
+      # The exception is for a STK leg definition, which must specify the SMART exchange.
+
       # // open/close leg value is same as combo
       # Specifies whether the order is an open or close order. Valid values are:
       SAME = 0 #  Same as the parent security. The only option for retail customers.

data/lib/ib-ruby/models/contract/bag.rb

@@ -3,10 +3,15 @@ require 'ib-ruby/models/contract'
 module IB
   module Models
     class Contract
+
       # "BAG" is not really a contract, but a combination (combo) of securities.
       # AKA basket or bag of securities. Individual securities in combo are represented
       # by ComboLeg objects.
       class Bag < Contract
+        # General Notes:
+        # 1. :exchange for the leg definition must match that of the combination order.
+        # The exception is for a STK legs, which must specify the SMART exchange.
+        # 2. :symbol => "USD" For combo Contract, this is an arbitrary value (like �USD�)
 
         def initialize opts = {}
           super opts
@@ -26,7 +31,9 @@ module IB
         end
 
       end # class Bag
+
       TYPES[IB::SECURITY_TYPES[:bag]] = Bag
+
     end # class Contract
   end # module Models
 end # module IB

data/lib/ib-ruby/models/order.rb

@@ -6,6 +6,15 @@ module IB
   module Models
     class Order < Model
 
+      # General Notes:
+      # 1. Placing Orders by con_id - When you place an order by con_id, you must
+      # provide the con_id AND the exchange. If you provide extra fields when placing
+      # an order by conid, the order may not work.
+
+      # 2. Order IDs - Each order you place must have a unique Order ID. We recommend
+      # that you increment your own Order IDs to avoid conflicts between orders placed
+      # from your API application.
+
       # Constants used in Order objects. Drawn from Order.java
       Origin_Customer = 0
       Origin_Firm = 1
@@ -345,7 +354,7 @@ module IB
 
       def to_human
         "<Order: #{@status} #{@order_type} #{@action} #{@total_quantity} @ #{@limit_price}" +
-        " #{@tif} id/perm: #{@id}/#{@perm_id}>"
+            " #{@tif} id/perm: #{@id}/#{@perm_id}>"
       end
     end # class Order
   end # module Models

metadata

@@ -2,7 +2,7 @@
 name: ib-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors: 
 - Paul Legato
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-19 00:00:00 -08:00
+date: 2011-12-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency