ig_markets 0.22 → 0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fda25b08bcbcfd1c57b25ba76965c792d3966af
-  data.tar.gz: 63e99c58c1d6ae1fca403f063d88a0279b35aec3
+  metadata.gz: 207f951a5be987c96debc33292afecc695435241
+  data.tar.gz: ebd1837c2f2f99c7c65b9a3199d7a247cbe768d5
 SHA512:
-  metadata.gz: d251e98be9191b08e0a684956ea73ae6c48815595b2e734ce9042210cb717686ae8d032ddbe4cce2a0d676ad6541f25ac901aeac9d5d7acd09d207e14d3d3045
-  data.tar.gz: f160337bc572f79dc1f16d00a925d4af95507abeb1f38bce7084280c72d8f2723f59ad56a8295d6fd1c26ff68517e0f7d75c34e0bf474b7ae8d1cd33740d60dd
+  metadata.gz: 775d3e912b35c17cc57deed6dd6827beb52491e5ac204c4ae68c0e4a8602db9e1175e701936285951200c9edf4beb180f2823f646f1e3364d2f1d151561bfab1
+  data.tar.gz: 1e82cb866071f438b19fb75a60557eaefedf2eb35c64a3a72fc35c18251adc9e8ebc348f97712146a24bcf19f6399f7f14c46a30720b90e233a4cf6c01b81654

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # IG Markets Changelog
 
+### 0.23 — October 19, 2016
+
+- Use `Integer` instead of `Fixnum` in preparation for Ruby 2.4
+- Fixed documentation warnings found by Inch CI
+
 ### 0.22 — October 3, 2016
 
 - The `curses` gem is no longer a dependency because it can be difficult to install on Windows, it now has to be

data/lib/ig_markets/activity.rb

@@ -23,14 +23,14 @@ module IGMarkets
       attribute :good_till_date
       attribute :guaranteed_stop, Boolean
       attribute :level, Float
-      attribute :limit_distance, Fixnum
+      attribute :limit_distance, Integer
       attribute :limit_level, Float
       attribute :market_name
       attribute :size
-      attribute :stop_distance, Fixnum
+      attribute :stop_distance, Integer
       attribute :stop_level, Float
       attribute :trailing_step, Float
-      attribute :trailing_stop_distance, Fixnum
+      attribute :trailing_stop_distance, Integer
     end
 
     attribute :channel, Symbol, allowed_values: [:dealer, :mobile, :public_fix_api, :public_web_api, :system, :web]

data/lib/ig_markets/application.rb

@@ -3,13 +3,13 @@ module IGMarkets
   class Application < Model
     attribute :allow_equities, Boolean
     attribute :allow_quote_orders, Boolean
-    attribute :allowance_account_historical_data, Fixnum
-    attribute :allowance_account_overall, Fixnum
-    attribute :allowance_account_trading, Fixnum
-    attribute :allowance_application_overall, Fixnum
+    attribute :allowance_account_historical_data, Integer
+    attribute :allowance_account_overall, Integer
+    attribute :allowance_account_trading, Integer
+    attribute :allowance_application_overall, Integer
     attribute :api_key
     attribute :client_id
-    attribute :concurrent_subscriptions_limit, Fixnum
+    attribute :concurrent_subscriptions_limit, Integer
     attribute :created_date, Time, format: '%Q'
     attribute :fast_markets_settlement_price_enabled, Boolean
     attribute :id

data/lib/ig_markets/deal_confirmation.rb

@@ -18,7 +18,7 @@ module IGMarkets
     attribute :expiry, Date, nil_if: %w(- DFB), format: ['%d-%b-%y', '%b-%y']
     attribute :guaranteed_stop, Boolean
     attribute :level, Float
-    attribute :limit_distance, Fixnum
+    attribute :limit_distance, Integer
     attribute :limit_level, Float
     attribute :profit, Float
     attribute :profit_currency, String, regex: Regex::CURRENCY
@@ -44,7 +44,7 @@ module IGMarkets
                                                 :trailing_stop_not_allowed, :unknown, :wrong_side_of_market]
     attribute :size, Float
     attribute :status, Symbol, allowed_values: [:amended, :closed, :deleted, :open, :partially_closed]
-    attribute :stop_distance, Fixnum
+    attribute :stop_distance, Integer
     attribute :stop_level, Float
     attribute :trailing_stop, Boolean
   end

data/lib/ig_markets/dealing_platform/position_methods.rb

@@ -40,7 +40,7 @@ module IGMarkets
       # @option attributes [Boolean] :force_open Whether a force open is required. Defaults to `false`.
       # @option attributes [Boolean] :guaranteed_stop Whether a guaranteed stop is required. Defaults to `false`.
       # @option attributes [Float] :level Required if and only if `:order_type` is `:limit` or `:quote`.
-      # @option attributes [Fixnum] :limit_distance The distance away in pips to place the limit. If this is set then
+      # @option attributes [Integer] :limit_distance The distance away in pips to place the limit. If this is set then
       #                    `:limit_level` must be `nil`. Optional.
       # @option attributes [Float] :limit_level The limit level. If this is set then `:limit_distance` must be `nil`.
       #                    Optional.
@@ -50,7 +50,7 @@ module IGMarkets
       #                    Defaults to `:market`.
       # @option attributes [String] :quote_id The Lightstreamer quote ID. Required when `:order_type` is `:quote`.
       # @option attributes [Float] :size The size of the position to create. Required.
-      # @option attributes [Fixnum] :stop_distance The distance away in pips to place the stop. If this is set then
+      # @option attributes [Integer] :stop_distance The distance away in pips to place the stop. If this is set then
       #                    `:stop_level` must be `nil`. Optional.
       # @option attributes [Float] :stop_level The stop level. If this is set then `:stop_distance` must be `nil`.
       #                    Optional.
@@ -62,7 +62,7 @@ module IGMarkets
       #                    `:market` (the default) then `:time_in_force` will be automatically set to
       #                    `:execute_and_eliminate`.
       # @option attributes [Boolean] :trailing_stop Whether to use a trailing stop. Defaults to false. Optional.
-      # @option attributes [Fixnum] :trailing_stop_increment The increment step in pips for the trailing stop. Required
+      # @option attributes [Integer] :trailing_stop_increment The increment step in pips for the trailing stop. Required
       #                    when `:trailing_stop` is `true`.
       #
       # @return [String] The resulting deal reference, use {DealingPlatform#deal_confirmation} to check the result of
@@ -86,16 +86,16 @@ module IGMarkets
         attribute :force_open, Boolean
         attribute :guaranteed_stop, Boolean
         attribute :level, Float
-        attribute :limit_distance, Fixnum
+        attribute :limit_distance, Integer
         attribute :limit_level, Float
         attribute :order_type, Symbol, allowed_values: [:limit, :market, :quote]
         attribute :quote_id
         attribute :size, Float
-        attribute :stop_distance, Fixnum
+        attribute :stop_distance, Integer
         attribute :stop_level, Float
         attribute :time_in_force, Symbol, allowed_values: [:execute_and_eliminate, :fill_or_kill]
         attribute :trailing_stop, Boolean
-        attribute :trailing_stop_increment, Fixnum
+        attribute :trailing_stop_increment, Integer
 
         def initialize(attributes = {})
           super
@@ -137,10 +137,9 @@ module IGMarkets
           if trailing_stop
             raise ArgumentError, 'do not set stop_level when trailing_stop is true' if stop_level
             raise ArgumentError, 'set stop_distance when trailing_stop is true' unless stop_distance
-          end
-
-          if trailing_stop == trailing_stop_increment.nil?
-            raise ArgumentError, 'set trailing_stop_increment if and only if trailing_stop is true'
+            raise ArgumentError, 'set trailing_stop_increment when trailing_stop is true' unless trailing_stop_increment
+          elsif trailing_stop_increment
+            raise ArgumentError, 'do not set trailing_stop_increment when trailing_stop is false'
           end
         end
 
@@ -152,9 +151,9 @@ module IGMarkets
 
         # Checks that attributes associated with the guaranteed stop are valid.
         def validate_guaranteed_stop_constraints
-          if guaranteed_stop && !(stop_level.nil? ^ stop_distance.nil?)
-            raise ArgumentError, 'set exactly one of stop_level or stop_distance when guaranteed_stop is true'
-          end
+          return if !guaranteed_stop || (stop_level.nil? ^ stop_distance.nil?)
+
+          raise ArgumentError, 'set exactly one of stop_level or stop_distance when guaranteed_stop is true'
         end
       end
 

data/lib/ig_markets/dealing_platform/working_order_methods.rb

@@ -44,12 +44,12 @@ module IGMarkets
       #                    the working order will remain until it is cancelled.
       # @option attributes [Boolean] :guaranteed_stop Whether a guaranteed stop is required. Defaults to `false`.
       # @option attributes [Float] :level The level at which the order will be triggered. Required.
-      # @option attributes [Fixnum] :limit_distance The distance away in pips to place the limit. If this is set then
+      # @option attributes [Integer] :limit_distance The distance away in pips to place the limit. If this is set then
       #                    the `:limit_level` option must be omitted. Optional.
       # @option attributes [Float] :limit_level The level at which to place the limit. If this is set then the
       #                    `:limit_distance` option must be omitted. Optional.
       # @option attributes [Float] :size The size of the working order. Required.
-      # @option attributes [Fixnum] :stop_distance The distance away in pips to place the stop. If this is set then the
+      # @option attributes [Integer] :stop_distance The distance away in pips to place the stop. If this is set then the
       #                    `:stop_level` option must be omitted. Optional.
       # @option attributes [Float] :stop_level The level at which to place the stop. If this is set then the
       #                    `:stop_distance` option must be omitted. Optional.
@@ -79,10 +79,10 @@ module IGMarkets
         attribute :good_till_date, Time, format: '%Y/%m/%d %R:%S'
         attribute :guaranteed_stop, Boolean
         attribute :level, Float
-        attribute :limit_distance, Fixnum
+        attribute :limit_distance, Integer
         attribute :limit_level, Float
         attribute :size, Float
-        attribute :stop_distance, Fixnum
+        attribute :stop_distance, Integer
         attribute :stop_level, Float
         attribute :time_in_force, Symbol, allowed_values: [:good_till_cancelled, :good_till_date]
         attribute :type, Symbol, allowed_values: [:limit, :stop]

data/lib/ig_markets/format.rb

@@ -19,7 +19,7 @@ module IGMarkets
     # Returns a formatted string for the specified currency amount and currency. Two decimal places are used for all
     # currencies except the Japanese Yen.
     #
-    # @param [Float, Fixnum] amount The currency amount to format.
+    # @param [Float, Integer] amount The currency amount to format.
     # @param [String] currency The currency.
     #
     # @return [String] The formatted currency amount, e.g. `"USD -130.40"`, `"AUD 539.10"`, `"JPY 3560"`.
@@ -35,7 +35,7 @@ module IGMarkets
 
     # Returns a formatted string for the specified number of seconds in the format `[<hours>:]<minutes>:<seconds>`.
     #
-    # @param [Fixnum] value The number of seconds to format.
+    # @param [Integer] value The number of seconds to format.
     #
     # @return [String]
     def seconds(value)

data/lib/ig_markets/historical_price_result.rb

@@ -5,21 +5,21 @@ module IGMarkets
     class Metadata < Model
       # Contains details on the remaining allowance for looking up historical prices. Used by {#allowance}.
       class Allowance < Model
-        attribute :allowance_expiry, Fixnum
-        attribute :remaining_allowance, Fixnum
-        attribute :total_allowance, Fixnum
+        attribute :allowance_expiry, Integer
+        attribute :remaining_allowance, Integer
+        attribute :total_allowance, Integer
       end
 
       # Contains details on paging status for a historical price lookup. Used by {#page_data}.
       class PageData < Model
-        attribute :page_number, Fixnum
-        attribute :page_size, Fixnum
-        attribute :total_pages, Fixnum
+        attribute :page_number, Integer
+        attribute :page_size, Integer
+        attribute :total_pages, Integer
       end
 
       attribute :allowance, Allowance
       attribute :page_data, PageData
-      attribute :size, Fixnum
+      attribute :size, Integer
     end
 
     # Contains details on a single historical price snapshot. Used by {#prices}.

data/lib/ig_markets/market.rb

@@ -55,7 +55,7 @@ module IGMarkets
     # @option options [:minute, :minute_2, :minute_3, :minute_5, :minute_10, :minute_15, :minute_30, :hour, :hour_2,
     #                  :hour_3, :hour_4, :day, :week, :month] :resolution The resolution of the prices to return.
     #                 Required.
-    # @option options [Fixnum] :number The number of historical prices to return. If this is specified then the `:from`
+    # @option options [Integer] :number The number of historical prices to return. If this is specified then the `:from`
     #                 and `:to` options must not be specified.
     # @option options [Time] :from The start of the period to return prices for.
     # @option options [Time] :to The end of the period to return prices for.
@@ -80,9 +80,9 @@ module IGMarkets
 
       raise ArgumentError, 'resolution is invalid' unless resolutions.include? options[:resolution]
 
-      if options.keys != [:resolution, :from, :to] && options.keys != [:resolution, :number]
-        raise ArgumentError, 'options must specify either :number or :from and :to'
-      end
+      return if options.keys == [:resolution, :from, :to] || options.keys == [:resolution, :number]
+
+      raise ArgumentError, 'options must specify either :number or :from and :to'
     end
 
     # Returns the API response to a request for historical prices.

data/lib/ig_markets/model.rb

@@ -76,14 +76,10 @@ module IGMarkets
     end
 
     class << self
-      # A hash containing details of all attributes that have been defined on this model.
-      #
-      # @return [Hash]
+      # @return [Hash] a hash containing details of all attributes that have been defined on this model.
       attr_accessor :defined_attributes
 
-      # The names of the deprecated attributes on this model.
-      #
-      # @return [Array]
+      # @return [Array] the names of the deprecated attributes on this model.
       attr_accessor :deprecated_attributes
 
       # Returns the names of all currently defined attributes for this model.
@@ -145,7 +141,7 @@ module IGMarkets
       # Defines setter and getter instance methods and a sanitizer class method for a new attribute on this class.
       #
       # @param [Symbol] name The name of the new attribute.
-      # @param [Boolean, String, Date, Time, Fixnum, Float, Symbol, Model] type The attribute's type.
+      # @param [Boolean, String, Date, Time, Integer, Float, Symbol, Model] type The attribute's type.
       # @param [Hash] options The configuration options for the new attribute.
       # @option options [Array] :allowed_values The set of values that this attribute is allowed to be set to. An
       #                 attempt to set this attribute to a value not in this list will raise `ArgumentError`. Optional.
@@ -153,7 +149,7 @@ module IGMarkets
       # @option options [Regexp] :regex When `type` is `String` only values matching this regex will be allowed.
       #                 Optional.
       # @option options [String] :format When `type` is `Date` or `Time` this specifies the format or formats for
-      #                 parsing String and `Fixnum` instances assigned to this attribute.
+      #                 parsing String and `Integer` instances assigned to this attribute.
       #
       # @macro [attach] attribute
       #   The $1 attribute.

data/lib/ig_markets/model/typecasters.rb

@@ -5,7 +5,7 @@ module IGMarkets
       private
 
       def typecaster_for(type)
-        if [Boolean, String, Fixnum, Float, Symbol, Date, Time].include? type
+        if [Boolean, String, Integer, Float, Symbol, Date, Time].include? type
           method "typecaster_#{type.to_s.gsub(/\AIGMarkets::/, '').downcase}"
         elsif type
           lambda do |value, _options, name|
@@ -35,7 +35,7 @@ module IGMarkets
         value.to_s
       end
 
-      def typecaster_fixnum(value, _options, _name)
+      def typecaster_integer(value, _options, _name)
         return nil if value.nil?
 
         value.to_s.to_i
@@ -74,7 +74,7 @@ module IGMarkets
       end
 
       def typecaster_time(value, options, name)
-        if value.is_a?(String) || value.is_a?(Fixnum)
+        if value.is_a?(String) || value.is_a?(Integer)
           parse_formatted_time_value value.to_s, options, name
         else
           value

data/lib/ig_markets/position.rb

@@ -14,7 +14,7 @@ module IGMarkets
     attribute :size, Float
     attribute :stop_level, Float
     attribute :trailing_step, Float
-    attribute :trailing_stop_distance, Fixnum
+    attribute :trailing_stop_distance, Integer
 
     attribute :market, MarketOverview
 
@@ -106,8 +106,8 @@ module IGMarkets
     # @option new_attributes [Float] :limit_level The new limit level for this position.
     # @option new_attributes [Float] :stop_level The new stop level for this position.
     # @option new_attributes [Boolean] :trailing_stop Whether to use a trailing stop for this position.
-    # @option new_attributes [Fixnum] :trailing_stop_distance The distance away in pips to place the trailing stop.
-    # @option new_attributes [Fixnum] :trailing_stop_increment The step increment to use for the trailing stop.
+    # @option new_attributes [Integer] :trailing_stop_distance The distance away in pips to place the trailing stop.
+    # @option new_attributes [Integer] :trailing_stop_increment The step increment to use for the trailing stop.
     #
     # @return [String] The deal reference of the update operation. Use {DealingPlatform#deal_confirmation} to check
     #         the result of the position update.
@@ -133,9 +133,9 @@ module IGMarkets
         raise ArgumentError, 'set quote_id if and only if order_type is :quote'
       end
 
-      if [:limit, :quote].include?(attributes[:order_type]) == attributes[:level].nil?
-        raise ArgumentError, 'set level if and only if order_type is :limit or :quote'
-      end
+      return unless [:limit, :quote].include?(attributes[:order_type]) == attributes[:level].nil?
+
+      raise ArgumentError, 'set level if and only if order_type is :limit or :quote'
     end
 
     # Internal model used by {#close}.
@@ -176,8 +176,8 @@ module IGMarkets
       attribute :limit_level, Float
       attribute :stop_level, Float
       attribute :trailing_stop, Boolean
-      attribute :trailing_stop_distance, Fixnum
-      attribute :trailing_stop_increment, Fixnum
+      attribute :trailing_stop_distance, Integer
+      attribute :trailing_stop_increment, Integer
     end
 
     private_constant :PositionCloseAttributes, :PositionUpdateAttributes

data/lib/ig_markets/session.rb

@@ -3,36 +3,24 @@ module IGMarkets
   # In order to sign in, {#username}, {#password}, {#api_key} and {#platform} must be set. {#platform} must be
   # either `:demo` or `:live` depending on which platform is being targeted.
   class Session
-    # The username to use to authenticate this session.
-    #
-    # @return [String]
+    # @return [String] the username to use to authenticate this session.
     attr_accessor :username
 
-    # The password to use to authenticate this session.
-    #
-    # @return [String]
+    # @return [String] the password to use to authenticate this session.
     attr_accessor :password
 
-    # The API key to use to authenticate this session.
-    #
-    # @return [String]
+    # @return [String] the API key to use to authenticate this session.
     attr_accessor :api_key
 
-    # The platform variant to log into for this session.
-    #
-    # @return [:demo, :live]
+    # @return [:demo, :live] The platform variant to log into for this session.
     attr_accessor :platform
 
-    # The client session security access token for the currently logged in session, or `nil` if there is no active
-    # session.
-    #
-    # @return [String]
+    # @return [String] the client session security access token for the currently logged in session, or `nil` if there
+    #         is no active session.
     attr_reader :client_security_token
 
-    # The account session security access token for the currently logged in session, or `nil` if there is no active
-    # session.
-    #
-    # @return [String]
+    # @return [String] the account session security access token for the currently logged in session, or `nil` if there
+    #         is no active session.
     attr_reader :x_security_token
 
     # Signs in to IG Markets using the values of {#username}, {#password}, {#api_key} and {#platform}. If an error
@@ -72,7 +60,7 @@ module IGMarkets
     #
     # @param [String] url The URL to send the POST request to.
     # @param [Hash, nil] body The body to include with the POST request, this will be encoded as JSON.
-    # @param [Fixnum] api_version The API version to target.
+    # @param [Integer] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
     def post(url, body, api_version = API_V1)
@@ -82,7 +70,7 @@ module IGMarkets
     # Sends a GET request to the IG Markets API. If an error occurs then an {IGMarketsError} will be raised.
     #
     # @param [String] url The URL to send the GET request to.
-    # @param [Fixnum] api_version The API version to target.
+    # @param [Integer] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
     def get(url, api_version = API_V1)
@@ -93,7 +81,7 @@ module IGMarkets
     #
     # @param [String] url The URL to send the PUT request to.
     # @param [Hash, nil] body The body to include with the PUT request, this will be encoded as JSON.
-    # @param [Fixnum] api_version The API version to target.
+    # @param [Integer] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
     def put(url, body = nil, api_version = API_V1)
@@ -104,7 +92,7 @@ module IGMarkets
     #
     # @param [String] url The URL to send the DELETE request to.
     # @param [Hash, nil] body The body to include with the DELETE request, this will be encoded as JSON.
-    # @param [Fixnum] api_version The API version to target.
+    # @param [Integer] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
     def delete(url, body = nil, api_version = API_V1)

data/lib/ig_markets/sprint_market_position.rb

@@ -17,7 +17,7 @@ module IGMarkets
     # Returns the number of seconds till when this sprint market position expires. This will be a negative number if
     # this sprint market position has expired.
     #
-    # @return [Fixnum]
+    # @return [Integer]
     def seconds_till_expiry
       (expiry_time - Time.now).to_i
     end

data/lib/ig_markets/streaming/account_state.rb

@@ -5,21 +5,16 @@ module IGMarkets
     # making repeated calls to the REST API to get current account, position or working order details, and also avoids
     # running into API traffic allowance limits.
     class AccountState
-      # The current state of the accounts. The balances will be updated automatically as new streaming data arrives.
-      #
-      # @return [Array<Account>]
+      # @return [Array<Account>] the current state of the accounts. The balances will be updated automatically as new
+      #         streaming data arrives.
       attr_accessor :accounts
 
-      # The current positions for this account. This set of positions will be updated automatically as new streaming
-      # data arrives.
-      #
-      # @return [Array<Position>]
+      # @return [Array<Position>] the current positions for this account. This set of positions will be updated
+      #         automatically as new streaming data arrives.
       attr_accessor :positions
 
-      # The current working orders for this account. This set of working orders will be updated automatically as new
-      # streaming data arrives.
-      #
-      # @return [Array<WorkingOrder>]
+      # @return [Array<WorkingOrder>] the current working orders for this account. This set of working orders will be
+      #         updated automatically as new streaming data arrives.
       attr_accessor :working_orders
 
       # Initializes this account state with the specified dealing platform.

data/lib/ig_markets/streaming/consolidated_chart_data_update.rb

@@ -8,7 +8,7 @@ module IGMarkets
       attribute :bid_low, Float
       attribute :bid_open, Float
       attribute :cons_end, Boolean
-      attribute :cons_tick_count, Fixnum
+      attribute :cons_tick_count, Integer
       attribute :day_high, Float
       attribute :day_low, Float
       attribute :day_net_chg_mid, Float

data/lib/ig_markets/streaming/subscription.rb

@@ -51,16 +51,18 @@ module IGMarkets
       CONSOLIDATED_CHART_DATA_REGEX = /^CHART:(.*):(SECOND|1MINUTE|5MINUTE|HOUR)$/
 
       def on_raw_data(subscription, item_name, item_data, new_data)
-        on_account_data subscription, item_name, item_data, new_data if item_name =~ ACCOUNT_DATA_REGEX
-        on_market_data subscription, item_name, item_data, new_data if item_name =~ MARKET_DATA_REGEX
-        on_trade_data subscription, item_name, item_data, new_data if item_name =~ TRADE_DATA_REGEX
-        on_chart_tick_data subscription, item_name, item_data, new_data if item_name =~ CHART_TICK_DATA_REGEX
-
-        if item_name =~ CONSOLIDATED_CHART_DATA_REGEX
-          on_consolidated_chart_data subscription, item_name, item_data, new_data
+        {
+          ACCOUNT_DATA_REGEX => :on_account_data,
+          MARKET_DATA_REGEX => :on_market_data,
+          TRADE_DATA_REGEX => :on_trade_data,
+          CHART_TICK_DATA_REGEX => :on_chart_tick_data,
+          CONSOLIDATED_CHART_DATA_REGEX => :on_consolidated_chart_data
+        }.each do |regex, handler|
+          send handler, subscription, item_name, item_data, new_data if item_name =~ regex
         end
       end
 
+      # Handles streaming account data.
       def on_account_data(_subscription, item_name, item_data, new_data)
         item_data = @dealing_platform.instantiate_models AccountUpdate, item_data
         new_data = @dealing_platform.instantiate_models AccountUpdate, new_data
@@ -71,6 +73,7 @@ module IGMarkets
         run_callbacks new_data, item_data
       end
 
+      # Handles streaming market data.
       def on_market_data(_subscription, item_name, item_data, new_data)
         item_data = @dealing_platform.instantiate_models MarketUpdate, item_data
         new_data = @dealing_platform.instantiate_models MarketUpdate, new_data
@@ -81,6 +84,7 @@ module IGMarkets
         run_callbacks new_data, item_data
       end
 
+      # Handles streaming trade data.
       def on_trade_data(_subscription, item_name, _item_data, new_data)
         account_id = item_name.match(TRADE_DATA_REGEX).captures.first
 
@@ -94,6 +98,7 @@ module IGMarkets
         end
       end
 
+      # Handles streaming chart tick data.
       def on_chart_tick_data(_subscription, item_name, _item_data, new_data)
         new_data = @dealing_platform.instantiate_models ChartTickUpdate, new_data
 
@@ -102,6 +107,7 @@ module IGMarkets
         run_callbacks new_data
       end
 
+      # Handles streaming consolidated chart data.
       def on_consolidated_chart_data(_subscription, item_name, item_data, new_data)
         item_data = @dealing_platform.instantiate_models ConsolidatedChartDataUpdate, item_data
         new_data = @dealing_platform.instantiate_models ConsolidatedChartDataUpdate, new_data

data/lib/ig_markets/streaming/working_order_update.rb

@@ -13,10 +13,10 @@ module IGMarkets
       attribute :expiry, Date, nil_if: %w(- DFB), format: ['%d-%b-%y', '%b-%y']
       attribute :guaranteed_stop, Boolean
       attribute :level, Float
-      attribute :limit_distance, Fixnum
+      attribute :limit_distance, Integer
       attribute :size, Float
       attribute :status, Symbol, allowed_values: [:deleted, :open, :updated]
-      attribute :stop_distance, Fixnum
+      attribute :stop_distance, Integer
       attribute :timestamp, Time, format: '%FT%T.%L'
     end
   end

data/lib/ig_markets/version.rb

@@ -1,4 +1,4 @@
 module IGMarkets
   # The version of this gem.
-  VERSION = '0.22'.freeze
+  VERSION = '0.23'.freeze
 end

data/lib/ig_markets/working_order.rb

@@ -10,11 +10,11 @@ module IGMarkets
     attribute :epic, String, regex: Regex::EPIC
     attribute :good_till_date, Time, format: '%Y/%m/%d %R'
     attribute :guaranteed_stop, Boolean
-    attribute :limit_distance, Fixnum
+    attribute :limit_distance, Integer
     attribute :order_level, Float
     attribute :order_size, Float
     attribute :order_type, Symbol, allowed_values: [:limit, :stop]
-    attribute :stop_distance, Fixnum
+    attribute :stop_distance, Integer
     attribute :time_in_force, Symbol, allowed_values: [:good_till_cancelled, :good_till_date]
 
     attribute :market, MarketOverview
@@ -41,9 +41,9 @@ module IGMarkets
     #        {DealingPlatform::WorkingOrderMethods#create} for a description of the attributes.
     # @option new_attributes [Time] :good_till_date
     # @option new_attributes [Float] :level
-    # @option new_attributes [Fixnum] :limit_distance
+    # @option new_attributes [Integer] :limit_distance
     # @option new_attributes [Float] :limit_level
-    # @option new_attributes [Fixnum] :stop_distance
+    # @option new_attributes [Integer] :stop_distance
     # @option new_attributes [Float] :stop_level
     # @option new_attributes [:limit, :stop] :type
     #
@@ -65,9 +65,9 @@ module IGMarkets
     class WorkingOrderUpdateAttributes < Model
       attribute :good_till_date, Time, format: '%Y/%m/%d %R:%S'
       attribute :level, Float
-      attribute :limit_distance, Fixnum
+      attribute :limit_distance, Integer
       attribute :limit_level, Float
-      attribute :stop_distance, Fixnum
+      attribute :stop_distance, Integer
       attribute :stop_level, Float
       attribute :time_in_force, Symbol, allowed_values: [:good_till_cancelled, :good_till_date]
       attribute :type, Symbol, allowed_values: [:limit, :stop]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.22'
+  version: '0.23'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -42,14 +42,14 @@ dependencies:
   name: lightstreamer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
 - !ruby/object:Gem::Dependency
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '0.44'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '0.44'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement