ib-ruby 0.7.11 → 0.7.12

data/spec/ib-ruby/models/option_spec.rb

@@ -1,66 +1,59 @@
 require 'model_helper'
 
-describe IB::Models::Option do # AKA IB::Option
-
-  let(:props) do
-    {:symbol => 'AAPL',
-     :expiry => '201301',
-     :strike => 600.5,
-     :right => :put,
-    }
-  end
+describe IB::Models::Option,
+         :human => "<Option: AAPL 201301 put 600.5 SMART >",
 
-  let(:human) do
-    "<Option: AAPL 201301 put 600.5 SMART >"
-  end
+         :errors => {:right => ["should be put or call"],
+                     :strike => ["must be greater than 0"],
+         },
 
-  let(:errors) do
-    {:right => ["should be put or call"],
-     :strike => ["must be greater than 0"],
-    }
-  end
+         :props => {:symbol => 'AAPL',
+                    :expiry => '201301',
+                    :strike => 600.5,
+                    :right => :put,
+         },
 
-  let(:assigns) do
-    {:expiry =>
-         {[200609, '200609'] => '200609',
-          [20060913, '20060913'] => '20060913',
-          [:foo, 2006, 42, 'bar'] => /should be YYYYMM or YYYYMMDD/},
+         :assigns => {
+             :local_symbol =>
+                 {['AAPL  130119C00500000',
+                   :'AAPL  130119C00500000'] => 'AAPL  130119C00500000',
+                  'BAR'=> /invalid OSI code/},
 
-     :sec_type =>
-         {['OPT', :option] => :option,
-          IB::CODES[:sec_type].reject { |k, _| k == :option }.to_a =>
-              /should be an option/},
+             :expiry =>
+                 {[200609, '200609'] => '200609',
+                  [20060913, '20060913'] => '20060913',
+                  [:foo, 2006, 42, 'bar'] => /should be YYYYMM or YYYYMMDD/},
 
-     :right =>
-         {["PUT", "put", "P", "p", :put] => :put,
-          ["CALL", "call", "C", "c", :call] => :call,
-          ['', '0', '?', :none, :foo, 'BAR', 42] => /should be put or call/},
+             :sec_type =>
+                 {['OPT', :option] => :option,
+                  IB::CODES[:sec_type].reject { |k, _| k == :option }.to_a =>
+                      /should be an option/},
 
-     :exchange => string_upcase_assigns.merge(
-         [:smart, 'SMART', 'smArt'] => 'SMART'),
+             :right =>
+                 {["PUT", "put", "P", "p", :put] => :put,
+                  ["CALL", "call", "C", "c", :call] => :call,
+                  ['', '0', '?', :none, :foo, 'BAR', 42] => /should be put or call/},
 
-     :primary_exchange =>string_upcase_assigns.merge(
-         [:SMART, 'SMART'] => /should not be SMART/),
+             :exchange => string_upcase_assigns.merge(
+                 [:smart, 'SMART', 'smArt'] => 'SMART'),
 
-     :multiplier => to_i_assigns,
+             :primary_exchange =>string_upcase_assigns.merge(
+                 [:SMART, 'SMART'] => /should not be SMART/),
 
-     :symbol => string_assigns,
+             :multiplier => to_i_assigns,
 
-     :local_symbol =>
-         {['AAPL  130119C00500000', :'AAPL  130119C00500000'] => 'AAPL  130119C00500000',
-          'BAR'=> /invalid OSI code/},
-
-     :strike => {[0, -30.0] => /must be greater than 0/},
-    }
-  end
+             :symbol => string_assigns,
 
-  context 'using shortest class name without properties' do
-    subject { IB::Option.new }
-    it_behaves_like 'Model instantiated empty'
-  end
+             :strike => {[0, -30.0] => /must be greater than 0/},
+         } do # AKA IB::Option
 
-  it_behaves_like 'Model'
   it_behaves_like 'Self-equal Model'
+  it_behaves_like 'Model with invalid defaults'
+
+  it 'has class name shortcut' do
+    IB::Option.should == IB::Models::Option
+    IB::Option.new.should == IB::Models::Option.new
+  end
 
   context 'properly initiated' do
     subject { IB::Option.new props }
@@ -86,6 +79,13 @@ describe IB::Models::Option do # AKA IB::Option
     end
   end
 
+  it 'correctly validates OSI symbol' do
+    o = IB::Option.new props
+    o.should be_valid
+    o.local_symbol = "AAPL  130119C00500000"
+    o.should be_valid
+  end
+
   context '.from_osi class builder' do
     subject { IB::Option.from_osi 'AAPL130119C00500000' }
 

data/spec/ib-ruby/models/order_spec.rb

@@ -1,98 +1,96 @@
 require 'model_helper'
 
-describe IB::Models::Order do
-
-  let(:props) do
-    {:local_id => 23,
-     :order_ref => 'Test',
-     :client_id => 1111,
-     :perm_id => 173276893,
-     :parent_id => 0,
-     :side => :buy,
-     :order_type => :market_if_touched,
-     :limit_price => 0.1,
-     :quantity => 100,
-     :tif => :good_till_cancelled,
-     :open_close => :close,
-     :oca_group => '',
-     :oca_type => :reduce_no_block,
-     :origin => :firm,
-     :designated_location => "WHATEVER",
-     :exempt_code => 123,
-     :delta_neutral_order_type => :market,
-     :transmit => false,
-     :outside_rth => true,
-     :what_if => true,
-     :not_held => true}
-  end
-
-  # TODO: :presents => { Object => "Formatted"}
-  let(:human) do
-    "<Order: Test MIT GTC buy 100 New 0.1 #23/173276893 from 1111>"
-  end
-
-  let(:errors) do
-    {:side =>["should be buy/sell/short"]}
-  end
-
-  let(:assigns) do
-    {[:order_type, :delta_neutral_order_type] => codes_and_values_for(:order_type),
-
-     :open_close =>
-         {[42, nil, 'Foo', :bar] => /should be same.open.close.unknown/,
-          ['SAME', 'same', 'S', 's', :same, 0, '0'] => :same,
-          ['OPEN', 'open', 'O', 'o', :open, 1, '1'] => :open,
-          ['CLOSE', 'close', 'C', 'c', :close, 2, '2'] => :close,
-          ['UNKNOWN', 'unknown', 'U', 'u', :unknown, 3, '3'] => :unknown,
-         },
+describe IB::Models::Order,
+         :props =>
+             {:local_id => 23,
+              :order_ref => 'Test',
+              :client_id => 1111,
+              :perm_id => 173276893,
+              :parent_id => 0,
+              :side => :buy,
+              :order_type => :market_if_touched,
+              :limit_price => 0.1,
+              :quantity => 100,
+              :tif => :good_till_cancelled,
+              :open_close => :close,
+              :oca_group => '',
+              :oca_type => :reduce_no_block,
+              :origin => :firm,
+              :designated_location => "WHATEVER",
+              :exempt_code => 123,
+              :delta_neutral_order_type => :market,
+              :transmit => false,
+              :outside_rth => true,
+              :what_if => true,
+              :not_held => true},
+
+         # TODO: :presents => { Object => "Formatted"}
+         :human => "<Order: Test MIT GTC buy 100 New 0.1 #23/173276893 from 1111>",
+
+         :errors => {:side =>["should be buy/sell/short"]},
+
+         :assigns =>
+             {[:order_type, :delta_neutral_order_type] => codes_and_values_for(:order_type),
+
+              :open_close =>
+                  {[42, nil, 'Foo', :bar] => /should be same.open.close.unknown/,
+                   ['SAME', 'same', 'S', 's', :same, 0, '0'] => :same,
+                   ['OPEN', 'open', 'O', 'o', :open, 1, '1'] => :open,
+                   ['CLOSE', 'close', 'C', 'c', :close, 2, '2'] => :close,
+                   ['UNKNOWN', 'unknown', 'U', 'u', :unknown, 3, '3'] => :unknown,
+                  },
+
+              [:what_if, :not_held, :outside_rth, :hidden, :transmit, :block_order,
+               :sweep_to_fill, :override_percentage_constraints, :all_or_none,
+               :etrade_only, :firm_quote_only, :opt_out_smart_routing, :scale_auto_reset,
+               :scale_random_percent] => boolean_assigns,
+
+              [:local_id, :perm_id, :parent_id] => numeric_or_nil_assigns,
+             },
+
+         :aliases =>
+             {[:side, :action] => buy_sell_short_assigns,
+              [:quantity, :total_quantity] => numeric_or_nil_assigns,
+             },
+
+         :collections =>
+             {:order_states =>[{:status => :Foo},
+                               {:status => 'Bar'},],
+
+              :executions =>
+                  [{:local_id => 23,
+                    :client_id => 1111,
+                    :perm_id => 173276893,
+                    :exchange => "IDEALPRO",
+                    :exec_id => "0001f4e8.4f5d48f1.01.01",
+                    :price => 0.1,
+                    :average_price => 0.1,
+                    :shares => 40,
+                    :cumulative_quantity => 40,
+                    :side => :buy,
+                    :time => "20120312  15:41:09"},
+
+                   {:local_id => 23,
+                    :client_id => 1111,
+                    :perm_id => 173276893,
+                    :exchange => "IDEALPRO",
+                    :exec_id => "0001f4e8.4f5d48f1.01.02",
+                    :price => 0.1,
+                    :average_price => 0.1,
+                    :shares => 60,
+                    :cumulative_quantity => 100,
+                    :side => :buy,
+                    :time => "20120312  15:41:10"}]
+             } do
 
-     [:what_if, :not_held, :outside_rth, :hidden, :transmit, :block_order,
-      :sweep_to_fill, :override_percentage_constraints, :all_or_none,
-      :etrade_only, :firm_quote_only, :opt_out_smart_routing, :scale_auto_reset,
-      :scale_random_percent] => boolean_assigns,
-
-     [:local_id, :perm_id, :parent_id] => numeric_or_nil_assigns,
-    }
-  end
-
-  let(:aliases) do
-    {[:side, :action] => buy_sell_short_assigns,
-     [:quantity, :total_quantity] => numeric_or_nil_assigns,
-    }
-  end
+  it_behaves_like 'Self-equal Model'
+  it_behaves_like 'Model with invalid defaults'
 
-  let(:collections) do
-    {:order_states => [IB::OrderState.new(:status => :Foo),
-                       IB::OrderState.new(:status => 'Bar'),],
-
-     :executions => [IB::Execution.new(:local_id => 23,
-                                       :client_id => 1111,
-                                       :perm_id => 173276893,
-                                       :exchange => "IDEALPRO",
-                                       :exec_id => "0001f4e8.4f5d48f1.01.01",
-                                       :price => 0.1,
-                                       :average_price => 0.1,
-                                       :shares => 40,
-                                       :cumulative_quantity => 40,
-                                       :side => :buy,
-                                       :time => "20120312  15:41:09"),
-                     IB::Execution.new(:local_id => 23,
-                                       :client_id => 1111,
-                                       :perm_id => 173276893,
-                                       :exchange => "IDEALPRO",
-                                       :exec_id => "0001f4e8.4f5d48f1.01.02",
-                                       :price => 0.1,
-                                       :average_price => 0.1,
-                                       :shares => 60,
-                                       :cumulative_quantity => 100,
-                                       :side => :buy,
-                                       :time => "20120312  15:41:10")]
-    }
+  it 'has class name shortcut' do
+    IB::Order.should == IB::Models::Order
+    IB::Order.new.should == IB::Models::Order.new
   end
 
-  it_behaves_like 'Model'
-  it_behaves_like 'Self-equal Model'
-
   context 'Order associations' do
     after(:all) { DatabaseCleaner.clean }
 
@@ -129,12 +127,12 @@ describe IB::Models::Order do
       subject.maint_margin.should be_nil
       subject.equity_with_loan.should be_nil
       # Properties arriving via OrderStatus message
-      subject.filled.should  == 0
-      subject.remaining.should  == 0
-      subject.price.should  == 0
-      subject.last_fill_price.should  == 0
-      subject.average_price.should  == 0
-      subject.average_fill_price.should  == 0
+      subject.filled.should == 0
+      subject.remaining.should == 0
+      subject.price.should == 0
+      subject.last_fill_price.should == 0
+      subject.average_price.should == 0
+      subject.average_fill_price.should == 0
       subject.why_held.should be_nil
       # Testing Order state
       subject.should be_new

data/spec/ib-ruby/models/order_state_spec.rb

@@ -1,77 +1,64 @@
 require 'model_helper'
 
-describe IB::Models::OrderState do
+describe IB::Models::OrderState,
+         :props =>
+             {:local_id => 23,
+              :perm_id => 173276893,
+              :client_id => 1111,
+              :parent_id => 0,
+              :filled => 3,
+              :remaining => 2,
+              :last_fill_price => 0.5,
+              :average_fill_price => 0.55,
+              :why_held => 'child',
+
+              :init_margin => 500.0,
+              :maint_margin => 500.0,
+              :equity_with_loan => 750.0,
+              :commission_currency => 'USD',
+              :commission => 1.2,
+              :min_commission => 1,
+              :max_commission => 1.5,
+              :status => 'PreSubmitted',
+              :warning_text => 'Oh noes!',
+             },
+         :human =>
+             "<OrderState: PreSubmitted #23/173276893 from 1111 filled 3/2 at 0.5/0.55 margin 500.0/500.0 equity 750.0 fee 1.2 why_held child warning Oh noes!>",
+         :errors =>
+             {:status => ["must not be empty"],
+             },
+         :assigns =>
+             {[:status] =>
+                  {[nil, ''] => /must not be empty/,
+                   ['Zorro', :Zorro] => 'Zorro'},
+
+              :local_id => numeric_or_nil_assigns,
+             },
+         :aliases =>
+             {[:price, :last_fill_price] => float_or_nil_assigns,
+              [:average_price, :average_fill_price] => float_or_nil_assigns,
+             } do
 
-  let(:props) do
-    {:local_id => 23,
-     :perm_id => 173276893,
-     :client_id => 1111,
-     :parent_id => 0,
-     :filled => 3,
-     :remaining => 2,
-     :last_fill_price => 0.5,
-     :average_fill_price => 0.55,
-     :why_held => 'child',
-
-     :init_margin => 500.0,
-     :maint_margin => 500.0,
-     :equity_with_loan => 750.0,
-     :commission_currency => 'USD',
-     :commission => 1.2,
-     :min_commission => 1,
-     :max_commission => 1.5,
-     :status => 'PreSubmitted',
-     :warning_text => 'Oh noes!',
-    }
-  end
-
-  # TODO: :presents => { Object => "Formatted"}
-  let(:human) do
-    "<OrderState: PreSubmitted #23/173276893 from 1111 filled 3/2 at 0.5/0.55 margin 500.0/500.0 equity 750.0 fee 1.2 why_held child warning Oh noes!>"
-  end
-
-  let(:errors) do
-    {:status => ["must not be empty"],
-    }
-  end
-
-  let(:assigns) do
-    {[:status] =>
-         {[nil, ''] => /must not be empty/,
-          ['Zorro', :Zorro] => 'Zorro'},
-
-     :local_id => numeric_or_nil_assigns,
-    }
-  end
+  it_behaves_like 'Self-equal Model'
+  it_behaves_like 'Model with invalid defaults'
 
-  let(:aliases) do
-    {[:price, :last_fill_price] => float_or_nil_assigns,
-     [:average_price, :average_fill_price] => float_or_nil_assigns,
-    }
+  it 'has class name shortcut' do
+    IB::OrderState.should == IB::Models::OrderState
+    IB::OrderState.new.should == IB::Models::OrderState.new
   end
 
-  it_behaves_like 'Model'
-  it_behaves_like 'Self-equal Model'
-
   context '#update_missing' do
     let(:nil_state) { IB::OrderState.new(:filled => nil, :remaining => nil,
                                          :price => nil, :average_price => nil) }
     context 'updating with Hash' do
-
       subject { nil_state.update_missing(props) }
-
       it_behaves_like 'Model instantiated with properties'
-
     end
 
     context 'updating with Model' do
-
       subject { nil_state.update_missing(IB::OrderState.new(props)) }
-
       it_behaves_like 'Model instantiated with properties'
-
     end
-
   end
 
   it 'has extra test methods' do

data/spec/ib-ruby/models/underlying_spec.rb

@@ -1,36 +1,29 @@
 require 'model_helper'
 
-describe IB::Models::Underlying do # AKA IB::Underlying
+describe IB::Models::Underlying,
+         :props =>
+             {:con_id => 234567,
+              :delta => 0.55,
+              :price => 20.5,
+             },
 
-  let(:props) do
-    {:con_id => 234567,
-     :delta => 0.55,
-     :price => 20.5,
-    }
-  end
+         :human => /<Underlying: con_id: 234567 .*delta: 0.55 price: 20.5.*>/,
 
-  let(:human) do
-    /<Underlying: con_id: 234567 .*delta: 0.55 price: 20.5.*>/
-  end
+         :errors =>
+             {:delta => ['is not a number'],
+              :price => ['is not a number'],
+             },
 
-  let(:errors) do
-    {:delta => ['is not a number'],
-     :price => ['is not a number'],
-    }
-  end
+         :assigns =>
+             {[:con_id, :delta, :price] => numeric_assigns,
 
-  let(:assigns) do
-    {[:con_id, :delta, :price] => numeric_assigns,
-    }
-  end
+             } do # AKA IB::Underlying
 
-  it_behaves_like 'Model'
   it_behaves_like 'Self-equal Model'
+  it_behaves_like 'Model with invalid defaults'
 
-  context 'using shortest class name without properties' do
-    subject { IB::Underlying.new }
-    it_behaves_like 'Model instantiated empty'
-    it_behaves_like 'Self-equal Model'
+  it 'has class name shortcut' do
+    IB::Underlying.should == IB::Models::Underlying
+    IB::Underlying.new.should == IB::Models::Underlying.new
   end
-
 end # describe IB::Contract

data/spec/integration/contract_info_spec.rb

@@ -29,6 +29,7 @@ describe "Request Contract Info", :connected => true, :integration => true do
       msg = @ib.received[:ContractData].first
       msg.request_id.should == 111
       msg.contract.should == @contract
+      msg.contract.should be_valid
     end
 
     it 'receives Contract Data with extended fields' do
@@ -79,6 +80,7 @@ describe "Request Contract Info", :connected => true, :integration => true do
     it 'receives Contract Data for requested contract' do
       subject.request_id.should == 123
       subject.contract.should == @contract
+      subject.contract.should be_valid
     end
 
     it 'receives Contract Data with extended fields' do
@@ -127,6 +129,7 @@ describe "Request Contract Info", :connected => true, :integration => true do
     it 'receives Contract Data for requested contract' do
       subject.request_id.should == 135
       subject.contract.should == @contract
+      subject.contract.should be_valid
     end
 
     it 'receives Contract Data with extended fields' do
@@ -172,6 +175,7 @@ describe "Request Contract Info", :connected => true, :integration => true do
     it 'receives Contract Data for requested contract' do
       subject.request_id.should == 147
       subject.contract.should == @contract
+      subject.contract.should be_valid
     end
 
     it 'receives Contract Data with extended fields' do