ig_markets 0.11 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ffcc67e15b995a577e2a546e9c3167194422eeb
-  data.tar.gz: 6f2bbe2ba36c50719b1cb17de93a5bd3f3dfe037
+  metadata.gz: 7e50f2a597b16e6d091f0eff038350ec67847f60
+  data.tar.gz: 769b2056a2a1db136b05947fccbe42127ff54809
 SHA512:
-  metadata.gz: a11539879eeb53bb9027be01f626e276ceb522cbbaf51f45686155070612914ab218f8adb5d395087095c77af61fcb0e43916252562bda8c0803d2330072732d
-  data.tar.gz: ff1647ed07d0c563fae8956ec4b8a4c0591e7ecc3f45817ca732bb38cf58ca4c3d3df31e36908c14cfaa11ff33a9c8a77907be438d7afd1b575cdf3645870864
+  metadata.gz: 091827f393098b7b5b19df4686832ce96dd630038aee32ab15af550bfbdae5c4236bb238993198c9caae96273d02b83d8f34dd8d287dc4456b068e974969a3f0
+  data.tar.gz: 4ee120e6a912fdeef9ee98752c15559800ee3b406f168d1bb68524ee213b42a92afb7638dcf1675747bab6e6ed634f2a7030a41cb009b2235ff9ef5f090d17ad

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # IG Markets Changelog
 
+### 0.12 - June 21, 2016
+
+- Unrecognized attributes returned by the IG Markets API now trigger a warning rather than causing an error, this makes
+  the library able to handle new return values being added to existing APIs
+- Upgraded to version 3 of the activities API, which significantly changes the structure of `IGMarkets::Activity`
+- Accept "`DFB`" (daily funded bet) on instrument periods, it is silently converted to `nil`
+- Correctly handle instrument periods that are formatted as `MMM-YY`
+- Stops and limits can now be specified as levels rather than distances when creating and updating working orders
+- Report profit/loss information when printing deal confirmations
+- Renamed `--print-requests` option to `--verbose`
+- The `--currency-code` option to `ig_markets positions create` and `ig_markets orders create` no longer defaults to
+  `USD` and must be specified explicitly
+
 ### 0.11 — May 23, 2016
 
 - `IGMarkets::DealingPlatform::AccountMethods#activities` and `IGMarkets::DealingPlatform::AccountMethods#transactions`
@@ -7,7 +20,7 @@
   of results returned by a single request at 500
 - `IGMarkets::DealingPlatform::AccountMethods#activities` and `IGMarkets::DealingPlatform::AccountMethods#transactions`
   no longer take a `:days` option, and their `:to` option defaults to today's date if it is omitted
-- Accept "`DFB`" (Daily Funded Bet) on instrument expiries, it is silently converted to `nil`
+- Accept "`DFB`" (daily funded bet) on instrument expiries, it is silently converted to `nil`
 - Instrument high and low is now shown in the `ig_markets positions list` command
 
 ### 0.10 — May 10, 2016

data/README.md

@@ -108,7 +108,7 @@ ig_markets search EURUSD --type currencies
 ig_markets positions --aggregate
 
 # Create a EURUSD long position of size 2
-ig_markets positions create --direction buy --epic CS.D.EURUSD.CFD.IP --size 2
+ig_markets positions create --direction buy --epic CS.D.EURUSD.CFD.IP --size 2 --currency-code USD
 
 # Change the limit and stop levels for an existing position
 ig_markets positions update DEAL-ID --limit-level 1.15 --stop-level 1.10
@@ -120,16 +120,18 @@ ig_markets positions close DEAL-ID
 ig_markets positions close DEAL-ID --size 1
 
 # Create a EURUSD sprint market short position of size 100 that expires in 20 minutes
-ig_markets sprints create --direction sell --epic FM.D.EURUSD24.EURUSD24.IP --expiry-period 20 --size 100
+ig_markets sprints create --direction sell --epic FM.D.EURUSD24.EURUSD24.IP --expiry-period 20
+                          --size 100
 
 # Create a working order to buy 1 unit of EURUSD at the level 1.1
 ig_markets orders create --direction buy --epic CS.D.EURUSD.CFD.IP --level 1.1 --size 1 --type limit
+                         --currency-code USD
 
 # Print daily prices for EURUSD from the last two weeks
 ig_markets prices --epic CS.D.EURUSD.CFD.IP --resolution day --number 14
 
-# Log in and then open a Ruby console which can be used to query the IG API, all REST requests will be shown
-ig_markets console --print-requests
+# Log in and open a Ruby console which can be used to query the IG API, printing all REST requests
+ig_markets console --verbose
 ```
 
 ## Usage — Library
@@ -176,8 +178,8 @@ ig.sprint_market_positions.create direction: :buy, epic: 'FM.D.EURUSD24.EURUSD24
 
 # Working orders
 ig.working_orders.all
-ig.working_orders.create currency_code: 'USD', direction: :buy, epic: 'CS.D.EURUSD.CFD.IP', level: 0.99,
-                         size: 1, type: :limit
+ig.working_orders.create currency_code: 'USD', direction: :buy, epic: 'CS.D.EURUSD.CFD.IP',
+                         level: 0.99, size: 1, type: :limit
 ig.working_orders['deal_id']
 ig.working_orders['deal_id'].update level: 1.25, limit_distance: 50, stop_distance: 50
 ig.working_orders['deal_id'].delete
@@ -187,7 +189,8 @@ ig.markets.hierarchy
 ig.markets.search 'EURUSD'
 ig.markets['CS.D.EURUSD.CFD.IP']
 ig.markets['CS.D.EURUSD.CFD.IP'].historical_prices resolution: :hour, number: 48
-ig.markets['CS.D.EURUSD.CFD.IP'].historical_prices resolution: :second, from: Time.now - 120, to: Time.now - 60
+ig.markets['CS.D.EURUSD.CFD.IP'].historical_prices resolution: :second, from: Time.now - 120,
+                                                   to: Time.now - 60
 
 # Watchlists
 ig.watchlists.all

data/lib/ig_markets/activity.rb

@@ -2,21 +2,45 @@ module IGMarkets
   # Contains details on a single activity that occurred on an IG Markets account. Returned by
   # {DealingPlatform::AccountMethods#activities}.
   class Activity < Model
-    attribute :action_status, Symbol, allowed_values: [:accept, :reject, :manual, :not_set]
-    attribute :activity
-    attribute :activity_history_id
-    attribute :channel
-    attribute :currency
+    # Contains additional details on an activity. Returned by {#details}.
+    class Details < Model
+      # Contains details on the actions that were performed by an activity. Returned by {#actions}.
+      class Action < Model
+        attribute :action_type, Symbol, allowed_values: [:limit_order_amended, :limit_order_deleted,
+                                                         :limit_order_filled, :limit_order_opened, :limit_order_rolled,
+                                                         :position_closed, :position_deleted, :position_opended,
+                                                         :position_partially_closed, :position_rolled,
+                                                         :stop_limit_amended, :stop_order_amended, :stop_order_deleted,
+                                                         :stop_order_filled, :stop_order_opened, :stop_order_rolled,
+                                                         :unknown, :working_order_deleted]
+        attribute :affected_deal_id
+      end
+
+      attribute :actions, Action
+      attribute :currency
+      attribute :deal_reference
+      attribute :direction, Symbol, allowed_values: [:buy, :sell]
+      attribute :good_till_date
+      attribute :guaranteed_stop, Boolean
+      attribute :level, Float, nil_if: 0
+      attribute :limit_distance, Fixnum
+      attribute :limit_level, Float, nil_if: 0
+      attribute :market_name
+      attribute :size
+      attribute :stop_distance, Fixnum
+      attribute :stop_level, Float, nil_if: 0
+      attribute :trailing_step, Float, nil_if: 0
+      attribute :trailing_stop_distance, Fixnum
+    end
+
+    attribute :channel, Symbol, allowed_values: [:dealer, :mobile, :public_fix_api, :public_web_api, :system, :web]
     attribute :date, Time, format: '%FT%T'
     attribute :deal_id
+    attribute :description
+    attribute :details, Details
     attribute :epic, String, regex: Regex::EPIC
-    attribute :level, Float
-    attribute :limit, Float, nil_if: '-'
-    attribute :market_name
-    attribute :period, String, nil_if: '-'
-    attribute :result
-    attribute :size
-    attribute :stop, String, nil_if: '-'
-    attribute :stop_type, String, nil_if: '-', allowed_values: %w(G N T(50))
+    attribute :period, Time, nil_if: %w(- DFB), format: ['%FT%T', '%b-%y']
+    attribute :status, Symbol, allowed_values: [:accepted, :rejected, :unknown]
+    attribute :type, Symbol, allowed_values: [:edit_stop_and_limit, :position, :system, :working_order]
   end
 end

data/lib/ig_markets/cli/commands/activities_command.rb

@@ -24,7 +24,7 @@ module IGMarkets
       private
 
       def gather_activities(dealing_platform)
-        result = gather_account_history(:activities, dealing_platform).select do |activity|
+        result = dealing_platform.account.activities(history_options).select do |activity|
           activity_filter activity
         end
 
@@ -45,19 +45,6 @@ module IGMarkets
           'type' => :transaction_type
         }.fetch options[:sort_by]
       end
-
-      def gather_account_history(method_name, dealing_platform)
-        history_options = if options[:from]
-                            from = Date.strptime options[:from], '%F'
-                            to = from + options[:days]
-
-                            { from: from, to: to }
-                          else
-                            { from: Date.today - options[:days] }
-                          end
-
-        dealing_platform.account.send method_name, history_options
-      end
     end
   end
 end

data/lib/ig_markets/cli/commands/orders_command.rb

@@ -18,7 +18,7 @@ module IGMarkets
 
       desc 'create', 'Creates a new working order'
 
-      option :currency_code, default: 'USD', desc: 'The 3 character currency code, must be one of the instrument\'s ' \
+      option :currency_code, required: true, desc: 'The 3 character currency code, must be one of the instrument\'s ' \
                                                    'currencies'
       option :direction, enum: %w(buy sell), required: true, desc: 'The trade direction'
       option :epic, required: true, desc: 'The EPIC of the market to trade'
@@ -28,8 +28,10 @@ module IGMarkets
       option :guaranteed_stop, type: :boolean, default: false, desc: 'Whether a guaranteed stop is required'
       option :level, type: :numeric, required: true, desc: 'The level at which the order will be triggered'
       option :limit_distance, type: :numeric, desc: 'The distance away in pips to place the limit'
+      option :limit_level, type: :numeric, desc: 'The level at which to place the limit'
       option :size, type: :numeric, required: true, desc: 'The size of the order'
       option :stop_distance, type: :numeric, desc: 'The distance away in pips to place the stop'
+      option :stop_level, type: :numeric, desc: 'The level at which to place the stop'
       option :type, enum: %w(limit stop), required: true, desc: 'The order type'
 
       def create
@@ -45,7 +47,9 @@ module IGMarkets
       option :good_till_date, desc: 'The date that the order will live till, format: yyyy-mm-ddThh:mm(+|-)zz:zz'
       option :level, type: :numeric, desc: 'The level at which the order will be triggered'
       option :limit_distance, desc: 'The distance away in pips to place the limit'
+      option :limit_level, type: :numeric, desc: 'The level at which to place the limit'
       option :stop_distance, desc: 'The distance away in pips to place the stop'
+      option :stop_level, type: :numeric, desc: 'The level at which to place the stop'
       option :type, enum: %w(limit stop), desc: 'The order type'
 
       def update(deal_id)
@@ -73,7 +77,7 @@ module IGMarkets
       private
 
       ATTRIBUTES = [:currency_code, :direction, :epic, :expiry, :force_open, :good_till_date, :guaranteed_stop, :level,
-                    :limit_distance, :size, :stop_distance, :type].freeze
+                    :limit_distance, :limit_level, :size, :stop_distance, :stop_level, :type].freeze
 
       def working_order_attributes
         attributes = Main.filter_options options, ATTRIBUTES

data/lib/ig_markets/cli/commands/positions_command.rb

@@ -24,7 +24,7 @@ module IGMarkets
 
       desc 'create', 'Creates a new position'
 
-      option :currency_code, default: 'USD', desc: 'The 3 character currency code, must be one of the instrument\'s ' \
+      option :currency_code, required: true, desc: 'The 3 character currency code, must be one of the instrument\'s ' \
                                                    'currencies'
       option :direction, required: true, enum: %w(buy sell), desc: 'The trade direction'
       option :epic, required: true, desc: 'The EPIC of the market to trade'

data/lib/ig_markets/cli/commands/transactions_command.rb

@@ -31,7 +31,7 @@ module IGMarkets
       private
 
       def gather_transactions(dealing_platform)
-        result = gather_account_history(:transactions, dealing_platform).select do |transaction|
+        result = dealing_platform.account.transactions(history_options).select do |transaction|
           transaction_filter transaction
         end
 

data/lib/ig_markets/cli/main.rb

@@ -7,7 +7,7 @@ module IGMarkets
       class_option :password, required: true, desc: 'The password for the session'
       class_option :api_key, required: true, desc: 'The API key for the session'
       class_option :demo, type: :boolean, desc: 'Use the demo platform (default is production)'
-      class_option :print_requests, type: :boolean, desc: 'Whether to print the raw REST API requests and responses'
+      class_option :verbose, type: :boolean, desc: 'Whether to print the raw REST API requests and responses'
 
       desc 'orders [SUBCOMAND=list ...]', 'Command for working with orders'
       subcommand 'orders', Orders
@@ -21,6 +21,23 @@ module IGMarkets
       desc 'watchlists [SUBCOMAND=list ...]', 'Command for working with watchlists'
       subcommand 'watchlists', Watchlists
 
+      private
+
+      # Turns the `:days` and `:from` options into a hash with `:from` and `:to` keys that can be passed to
+      # {AccountMethods#activities} and {AccountMethods#transactions}.
+      #
+      # @return [Hash]
+      def history_options
+        if options[:from]
+          from = Date.strptime options[:from], '%F'
+          to = from + options[:days]
+
+          { from: from, to: to }
+        else
+          { from: Date.today - options[:days] }
+        end
+      end
+
       class << self
         # This is the initial entry point for the execution of the command-line client. It is responsible for reading
         # any config files, implementing the --version/-v options, and then invoking the main application.
@@ -44,7 +61,7 @@ module IGMarkets
         def begin_session(options)
           platform = options[:demo] ? :demo : :production
 
-          RequestPrinter.enabled = true if options[:print_requests]
+          RequestPrinter.enabled = true if options[:verbose]
 
           @dealing_platform ||= DealingPlatform.new
           @dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
@@ -143,8 +160,21 @@ Status: #{Format.symbol deal_confirmation.deal_status}
 Result: #{Format.symbol deal_confirmation.status}
 END
 
+          print_deal_confirmation_profit_loss deal_confirmation
+
           puts "Reason: #{Format.symbol deal_confirmation.reason}" unless deal_confirmation.deal_status == :accepted
         end
+
+        # Prints out the profit/loss for the passed deal confirmation if applicable.
+        #
+        # @param [DealConfirmation] deal_confirmation The deal confirmation to print out the profit/loss for.
+        def print_deal_confirmation_profit_loss(deal_confirmation)
+          return unless deal_confirmation.profit
+
+          profit = Format.currency deal_confirmation.profit, deal_confirmation.profit_currency
+
+          puts "Profit/loss: #{profit.colorize(deal_confirmation.profit < 0 ? :red : :green)}"
+        end
       end
     end
   end

data/lib/ig_markets/cli/tables/activities_table.rb

@@ -17,12 +17,20 @@ module IGMarkets
       end
 
       def row(activity)
-        [activity.date, activity.channel, activity.activity, activity_status(activity), activity.epic,
-         activity.market_name, activity.size, activity.level, activity.limit, activity.stop, activity.result]
+        details = activity.details
+
+        [activity.date, activity.channel, activity.type, activity.status, activity.epic, details.market_name,
+         details.size, details.level, details.limit_level, details.stop_level, action_types(details)]
       end
 
-      def activity_status(activity)
-        { accept: 'Accepted', reject: 'Rejected', manual: 'Manual', not_set: '' }.fetch activity.action_status
+      def action_types(details)
+        types = details.actions.map(&:action_type).uniq
+        types.delete :unknown
+
+        # Fix a typo in one of the values
+        types.map! { |v| v == :position_opended ? :position_opened : v }
+
+        types.map { |v| format_cell_value v }.join ', '
       end
     end
   end

data/lib/ig_markets/cli/tables/market_overviews_table.rb

@@ -39,8 +39,8 @@ module IGMarkets
 
       def market_status(market_overview)
         { closed: 'Closed', edits_only: 'Edits only', offline: 'Offline', on_auction: 'On auction',
-          on_auction_no_edits: 'On auction no edits', suspended: 'Suspended', tradeable: 'Tradeable'
-        }.fetch market_overview.market_status
+          on_auction_no_edits: 'On auction no edits', suspended: 'Suspended', tradeable: 'Tradeable' }
+          .fetch market_overview.market_status
       end
     end
   end

data/lib/ig_markets/cli/tables/positions_table.rb

@@ -84,7 +84,13 @@ module IGMarkets
       end
 
       def combine_position_deal_ids(positions)
-        positions.map(&:deal_id).join ', '
+        lines = []
+
+        positions.map(&:deal_id).each_slice(2) do |deal_ids|
+          lines << deal_ids.join(', ')
+        end
+
+        lines.join "\n"
       end
     end
   end

data/lib/ig_markets/client_account_summary.rb

@@ -20,9 +20,10 @@ module IGMarkets
     attribute :account_info, Account::Balance
     attribute :account_type, Symbol, allowed_values: [:cfd, :physical, :spreadbet]
     attribute :accounts, AccountDetails
-    attribute :authentication_status, Symbol, allowed_values: [
-      :authenticated, :authenticated_missing_credentials, :change_environment, :disabled_preferred_account,
-      :missing_preferred_account, :rejected_invalid_client_version]
+    attribute :authentication_status, Symbol, allowed_values: [:authenticated, :authenticated_missing_credentials,
+                                                               :change_environment, :disabled_preferred_account,
+                                                               :missing_preferred_account,
+                                                               :rejected_invalid_client_version]
     attribute :client_id
     attribute :currency_iso_code, String, regex: Regex::CURRENCY
     attribute :currency_symbol

data/lib/ig_markets/deal_confirmation.rb

@@ -18,20 +18,28 @@ module IGMarkets
     attribute :level, Float
     attribute :limit_distance, Fixnum
     attribute :limit_level, Float
-    attribute :reason, Symbol, allowed_values: [
-      :account_not_enabled_to_trading, :attached_order_level_error, :attached_order_trailing_stop_error,
-      :cannot_change_stop_type, :cannot_remove_stop, :closing_only_trades_accepted_on_this_market, :conflicting_order,
-      :cr_spacing, :duplicate_order_error, :exchange_manual_override, :finance_repeat_dealing,
-      :force_open_on_same_market_different_currency, :general_error, :good_till_date_in_the_past, :instrument_not_found,
-      :insufficient_funds, :level_tolerance_error, :manual_order_timeout, :market_closed, :market_closed_with_edits,
-      :market_closing, :market_not_borrowable, :market_offline, :market_phone_only, :market_rolled,
-      :market_unavailable_to_client, :max_auto_size_exceeded, :minimum_order_size_error, :move_away_only_limit,
-      :move_away_only_stop, :move_away_only_trigger_level, :opposing_direction_orders_not_allowed,
-      :opposing_positions_not_allowed, :order_locked, :order_not_found, :over_normal_market_size,
-      :partially_closed_position_not_deleted, :position_not_available_to_close, :position_not_found,
-      :reject_spreadbet_order_on_cfd_account, :size_increment, :sprint_market_expiry_after_market_close,
-      :stop_or_limit_not_allowed, :stop_required_error, :strike_level_tolerance, :success, :trailing_stop_not_allowed,
-      :unknown, :wrong_side_of_market]
+    attribute :profit, Float
+    attribute :profit_currency, String, regex: Regex::CURRENCY
+    attribute :reason, Symbol, allowed_values: [:account_not_enabled_to_trading, :attached_order_level_error,
+                                                :attached_order_trailing_stop_error, :cannot_change_stop_type,
+                                                :cannot_remove_stop, :closing_only_trades_accepted_on_this_market,
+                                                :conflicting_order, :cr_spacing, :duplicate_order_error,
+                                                :exchange_manual_override, :finance_repeat_dealing,
+                                                :force_open_on_same_market_different_currency, :general_error,
+                                                :good_till_date_in_the_past, :instrument_not_found, :insufficient_funds,
+                                                :level_tolerance_error, :manual_order_timeout, :market_closed,
+                                                :market_closed_with_edits, :market_closing, :market_not_borrowable,
+                                                :market_offline, :market_phone_only, :market_rolled,
+                                                :market_unavailable_to_client, :max_auto_size_exceeded,
+                                                :minimum_order_size_error, :move_away_only_limit, :move_away_only_stop,
+                                                :move_away_only_trigger_level, :opposing_direction_orders_not_allowed,
+                                                :opposing_positions_not_allowed, :order_locked, :order_not_found,
+                                                :over_normal_market_size, :partially_closed_position_not_deleted,
+                                                :position_not_available_to_close, :position_not_found,
+                                                :reject_spreadbet_order_on_cfd_account, :size_increment,
+                                                :sprint_market_expiry_after_market_close, :stop_or_limit_not_allowed,
+                                                :stop_required_error, :strike_level_tolerance, :success,
+                                                :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

data/lib/ig_markets/dealing_platform/account_methods.rb

@@ -26,7 +26,10 @@ module IGMarkets
       #
       # @return [Array<Activity>]
       def activities(options)
-        history_request_complete url: 'history/activity', url_parameters: prepare_history_options(options),
+        url_parameters = history_url_parameters options
+        url_parameters[:detailed] = true
+
+        history_request_complete url: 'history/activity', url_parameters: url_parameters, api_version: API_V3,
                                  collection_name: :activities, model_class: Activity, date_attribute: :date
       end
 
@@ -42,8 +45,9 @@ module IGMarkets
       def transactions(options)
         options[:type] ||= :all
 
-        history_request_complete url: 'history/transactions', url_parameters: prepare_history_options(options),
-                                 collection_name: :transactions, model_class: Transaction, date_attribute: :date_utc
+        history_request_complete url: 'history/transactions', url_parameters: history_url_parameters(options),
+                                 api_version: API_V2, collection_name: :transactions, model_class: Transaction,
+                                 date_attribute: :date_utc
       end
 
       private
@@ -53,11 +57,11 @@ module IGMarkets
 
       # Retrieves historical data for this account (either activities or transactions) in the specified date range. This
       # methods sends a single GET request with the passed URL parameters and returns the response. The maximum number
-      # of items this method can return is capped at 500 {MAXIMUM_PAGE_SIZE}.
+      # of items this method can return is capped at 500 ({MAXIMUM_PAGE_SIZE}).
       def history_request(options)
         url = "#{options[:url]}?#{options[:url_parameters].map { |key, value| "#{key}=#{value.to_s.upcase}" }.join '&'}"
 
-        get_result = @dealing_platform.session.get url, API_V2
+        get_result = @dealing_platform.session.get url, options.fetch(:api_version)
 
         @dealing_platform.instantiate_models options[:model_class], get_result.fetch(options[:collection_name])
       end
@@ -80,12 +84,12 @@ module IGMarkets
         models.uniq
       end
 
-      # Parses and formats the history options shared by {#activities} and {#transactions}.
-      def prepare_history_options(options)
+      # Parses and formats options shared by {#activities} and {#transactions} into a set of URL parameters.
+      def history_url_parameters(options)
         options[:to] ||= Date.today + 1
 
-        options[:from] = options[:from].strftime('%F')
-        options[:to] = options[:to].strftime('%F')
+        options[:from] = options.fetch(:from).strftime('%F')
+        options[:to] = options.fetch(:to).strftime('%F')
 
         options[:pageSize] = MAXIMUM_PAGE_SIZE
 

data/lib/ig_markets/dealing_platform/sprint_market_position_methods.rb

@@ -51,8 +51,8 @@ module IGMarkets
       class SprintMarketPositionCreateAttributes < Model
         attribute :direction, Symbol, allowed_values: [:buy, :sell]
         attribute :epic, String, regex: Regex::EPIC
-        attribute :expiry_period, Symbol, allowed_values: [
-          :one_minute, :two_minutes, :five_minutes, :twenty_minutes, :sixty_minutes]
+        attribute :expiry_period, Symbol, allowed_values: [:one_minute, :two_minutes, :five_minutes, :twenty_minutes,
+                                                           :sixty_minutes]
         attribute :size, Float
       end
 

data/lib/ig_markets/dealing_platform/working_order_methods.rb

@@ -44,9 +44,15 @@ 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. Optional.
+      # @option attributes [Fixnum] :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. Optional.
+      # @option attributes [Fixnum] :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.
       # @option attributes [:limit, :stop] :type `:limit` means the working order is intended to buy at a price lower
       #                    than at present, or to sell at a price higher than at present, i.e. there is an expectation
       #                    of a market reversal at the specified `:level`. `:stop` means the working order is intended
@@ -56,30 +62,14 @@ module IGMarkets
       # @return [String] The resulting deal reference, use {DealingPlatform#deal_confirmation} to check the result of
       #         the working order creation.
       def create(attributes)
-        attributes[:force_open] ||= false
-        attributes[:guaranteed_stop] ||= false
-        attributes[:time_in_force] = attributes[:good_till_date] ? :good_till_date : :good_till_cancelled
-
-        model = build_working_order_model attributes
+        model = WorkingOrderCreateAttributes.new attributes
+        model.validate
 
         payload = PayloadFormatter.format model
 
         payload[:expiry] ||= '-'
 
-        @dealing_platform.session.post('workingorders/otc', payload, API_V2).fetch(:deal_reference)
-      end
-
-      private
-
-      def build_working_order_model(attributes)
-        model = WorkingOrderCreateAttributes.new attributes
-
-        required = [:currency_code, :direction, :epic, :guaranteed_stop, :level, :size, :time_in_force, :type]
-        required.each do |attribute|
-          raise ArgumentError, "#{attribute} attribute must be set" if attributes[attribute].nil?
-        end
-
-        model
+        @dealing_platform.session.post('workingorders/otc', payload, API_V2).fetch :deal_reference
       end
 
       # Internal model used by {#create}.
@@ -93,10 +83,41 @@ module IGMarkets
         attribute :guaranteed_stop, Boolean
         attribute :level, Float
         attribute :limit_distance, Fixnum
+        attribute :limit_level, Float
         attribute :size, Float
         attribute :stop_distance, Fixnum
+        attribute :stop_level, Float
         attribute :time_in_force, Symbol, allowed_values: [:good_till_cancelled, :good_till_date]
         attribute :type, Symbol, allowed_values: [:limit, :stop]
+
+        def initialize(attributes)
+          super
+
+          set_defaults
+        end
+
+        # Runs a series of validations on this model's attributes to check whether it is ready to be sent to the IG
+        # Markets API.
+        def validate
+          required = [:currency_code, :direction, :epic, :guaranteed_stop, :level, :size, :time_in_force, :type]
+          required.each do |attribute|
+            raise ArgumentError, "#{attribute} attribute must be set" if send(attribute).nil?
+          end
+
+          if limit_distance && limit_level
+            raise ArgumentError, 'Do not specify both limit_distance and limit_level options'
+          end
+
+          raise ArgumentError, 'Do not specify both stop_distance and stop_level options' if stop_distance && stop_level
+        end
+
+        private
+
+        def set_defaults
+          self.force_open = false if force_open.nil?
+          self.guaranteed_stop = false if guaranteed_stop.nil?
+          self.time_in_force = good_till_date ? :good_till_date : :good_till_cancelled
+        end
       end
 
       private_constant :WorkingOrderCreateAttributes

data/lib/ig_markets/dealing_platform.rb

@@ -135,6 +135,8 @@ module IGMarkets
         model.instance_variable_set :@dealing_platform, self
 
         attributes.each do |attribute, value|
+          next unless model_class.valid_attribute? attribute
+
           type = model_class.attribute_type attribute
           value = instantiate_models(type, value) if type < Model
 

data/lib/ig_markets/instrument.rb

@@ -79,10 +79,10 @@ module IGMarkets
     attribute :sprint_markets_minimum_expiry_time, Float
     attribute :stops_limits_allowed, Boolean
     attribute :streaming_prices_available, Boolean
-    attribute :type, Symbol, allowed_values: [
-      :binary, :bungee_capped, :bungee_commodities, :bungee_currencies, :bungee_indices, :commodities,
-      :currencies, :indices, :opt_commodities, :opt_currencies, :opt_indices, :opt_rates, :opt_shares,
-      :rates, :sectors, :shares, :sprint_market, :test_market, :unknown]
+    attribute :type, Symbol, allowed_values: [:binary, :bungee_capped, :bungee_commodities, :bungee_currencies,
+                                              :bungee_indices, :commodities, :currencies, :indices, :opt_commodities,
+                                              :opt_currencies, :opt_indices, :opt_rates, :opt_shares, :rates, :sectors,
+                                              :shares, :sprint_market, :test_market, :unknown]
     attribute :unit, Symbol, allowed_values: [:amount, :contracts, :shares]
     attribute :value_of_one_pip
   end

data/lib/ig_markets/market.rb

@@ -11,8 +11,8 @@ module IGMarkets
         attribute :value, Float
       end
 
-      attribute :market_order_preference, Symbol, allowed_values: [
-        :available_default_off, :available_default_on, :not_available]
+      attribute :market_order_preference, Symbol, allowed_values: [:available_default_off, :available_default_on,
+                                                                   :not_available]
       attribute :max_stop_or_limit_distance, RuleDetails
       attribute :min_controlled_risk_stop_distance, RuleDetails
       attribute :min_deal_size, RuleDetails
@@ -30,8 +30,8 @@ module IGMarkets
       attribute :delay_time, Float
       attribute :high, Float
       attribute :low, Float
-      attribute :market_status, Symbol, allowed_values: [
-        :closed, :edits_only, :offline, :on_auction, :on_auction_no_edits, :suspended, :tradeable]
+      attribute :market_status, Symbol, allowed_values: [:closed, :edits_only, :offline, :on_auction,
+                                                         :on_auction_no_edits, :suspended, :tradeable]
       attribute :net_change, Float
       attribute :offer, Float
       attribute :percentage_change, Float

data/lib/ig_markets/model/typecasters.rb

@@ -53,7 +53,7 @@ module IGMarkets
       end
 
       def typecaster_date(value, options, name)
-        raise ArgumentError, "#{self}##{name}: invalid or missing date format" unless options[:format].is_a? String
+        raise ArgumentError, "#{self}##{name}: invalid date format" unless options[:format].is_a? String
 
         if value.is_a? String
           begin
@@ -67,28 +67,36 @@ module IGMarkets
       end
 
       def typecaster_time(value, options, name)
-        raise ArgumentError, "#{self}##{name}: invalid or missing time format" unless options[:format].is_a? String
+        format = options[:format]
+
+        raise ArgumentError, "#{self}##{name}: invalid time format" unless [Array, String].include? format.class
 
         if value.is_a?(String) || value.is_a?(Fixnum)
-          parse_time_from_string value.to_s, options, name
+          parse_formatted_time_value value.to_s, options, name
         else
           value
         end
       end
 
-      def parse_time_from_string(value, options, name)
-        format = options[:format]
+      def parse_formatted_time_value(value, options, name)
+        Array(options[:format]).each do |format|
+          begin
+            return parse_time_using_format value, format
+          rescue ArgumentError
+            next
+          end
+        end
 
+        raise ArgumentError, "#{self}##{name}: failed parsing time: #{value}"
+      end
+
+      def parse_time_using_format(value, format)
         unless format == '%Q'
           format += '%z'
           value += '+0000'
         end
 
-        begin
-          Time.strptime value, format
-        rescue ArgumentError
-          raise ArgumentError, "#{self}##{name}: failed parsing time: #{value}"
-        end
+        Time.strptime value, format
       end
     end
   end

data/lib/ig_markets/model.rb

@@ -68,7 +68,7 @@ module IGMarkets
       # @return [Hash] A hash containing details of all attributes that have been defined on this model.
       attr_accessor :defined_attributes
 
-      # @return [Hash] The names of the deprecated attributes on this model.
+      # @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.
@@ -78,6 +78,23 @@ module IGMarkets
         Hash(defined_attributes).keys
       end
 
+      # Returns whether the passed value is a valid attribute name. If the passed attribute name is not recognized then
+      # an error will be printed to `stderr`. Only one warning will be printed for each unrecognized attribute.
+      #
+      # @param [Symbol] name The candidate attribute name.
+      #
+      # @return [Boolean]
+      def valid_attribute?(name)
+        return true if defined_attribute_names.include?(name) || Array(deprecated_attributes).include?(name)
+
+        unless Array(@reported_invalid_attributes).include? name
+          warn "ig_markets: unrecognized attribute #{self}##{name}"
+          (@reported_invalid_attributes ||= []) << name
+        end
+
+        false
+      end
+
       # Returns the type of the specified attribute.
       #
       # @param [Symbol] attribute_name The name of the attribute to return the type for.
@@ -108,8 +125,8 @@ module IGMarkets
       # @option options [Array] :nil_if Values that, when set on the attribute, should be converted to `nil`.
       # @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 for parsing String
-      #                 and `Fixnum` instances assigned to this attribute.
+      # @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.
       #
       # @macro [attach] attribute
       #   The $1 attribute.

data/lib/ig_markets/payload_formatter.rb

@@ -4,9 +4,9 @@ module IGMarkets
     module_function
 
     # Takes a {Model} and returns its attributes in a hash ready to be passed as a payload to the IG Markets API.
-    # Attribute names will be converted to use camel case rather than snake case, `Symbol` attributes will be converted
-    # to strings and will be uppercased, and both `Date` and `Time` attributes will be converted to strings using their
-    # ':format' option.
+    # Attribute names will be converted from snake case to camel case, `Symbol` attributes will be converted to strings
+    # and will be uppercased, and both `Date` and `Time` attributes will be converted to strings using their first
+    # available `:format` option.
     #
     # @param [Model] model The model instance to convert attributes for.
     #
@@ -32,7 +32,7 @@ module IGMarkets
 
       value = value.utc if options[:type] == Time
 
-      return value.strftime(options.fetch(:format)) if [Date, Time].include? options[:type]
+      return value.strftime(Array(options.fetch(:format)).first) if [Date, Time].include? options[:type]
 
       value
     end

data/lib/ig_markets/position.rb

@@ -107,8 +107,8 @@ module IGMarkets
     #         the result of the position update.
     def update(new_attributes)
       new_attributes = { limit_level: limit_level, stop_level: stop_level, trailing_stop: trailing_stop?,
-                         trailing_stop_distance: trailing_stop_distance, trailing_stop_increment: trailing_step
-                       }.merge new_attributes
+                         trailing_stop_distance: trailing_stop_distance, trailing_stop_increment: trailing_step }
+                       .merge new_attributes
 
       unless new_attributes[:trailing_stop]
         new_attributes[:trailing_stop_distance] = new_attributes[:trailing_stop_increment] = nil

data/lib/ig_markets/transaction.rb

@@ -8,7 +8,7 @@ module IGMarkets
     attribute :date_utc, Time, format: '%FT%T'
     attribute :instrument_name
     attribute :open_level, String, nil_if: %w(- 0)
-    attribute :period, Time, nil_if: '-', format: '%FT%T'
+    attribute :period, Time, nil_if: %w(- DFB), format: ['%FT%T', '%b-%y']
     attribute :profit_and_loss
     attribute :reference
     attribute :size, String, nil_if: '-'

data/lib/ig_markets/version.rb

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

data/lib/ig_markets/working_order.rb

@@ -37,21 +37,23 @@ module IGMarkets
     # @option new_attributes [Time] :good_till_date
     # @option new_attributes [Float] :level
     # @option new_attributes [Fixnum] :limit_distance
+    # @option new_attributes [Float] :limit_level
     # @option new_attributes [Fixnum] :stop_distance
+    # @option new_attributes [Float] :stop_level
     # @option new_attributes [:limit, :stop] :type
     #
     # @return [String] The deal reference of the update operation. Use {DealingPlatform#deal_confirmation} to check
     #         the result of the working order update.
     def update(new_attributes)
-      new_attributes = { good_till_date: good_till_date, level: order_level, limit_distance: limit_distance,
-                         stop_distance: stop_distance, time_in_force: time_in_force, type: order_type
-                       }.merge new_attributes
+      existing_attributes = { good_till_date: good_till_date, level: order_level, limit_distance: limit_distance,
+                              stop_distance: stop_distance, time_in_force: time_in_force, type: order_type }
 
-      new_attributes[:time_in_force] = new_attributes[:good_till_date] ? :good_till_date : :good_till_cancelled
+      model = WorkingOrderUpdateAttributes.new existing_attributes, new_attributes
+      model.validate
 
-      payload = PayloadFormatter.format WorkingOrderUpdateAttributes.new new_attributes
+      payload = PayloadFormatter.format model
 
-      @dealing_platform.session.put("workingorders/otc/#{deal_id}", payload).fetch(:deal_reference)
+      @dealing_platform.session.put("workingorders/otc/#{deal_id}", payload, API_V2).fetch(:deal_reference)
     end
 
     # Internal model used by {#update}.
@@ -59,9 +61,30 @@ module IGMarkets
       attribute :good_till_date, Time, format: '%Y/%m/%d %R:%S'
       attribute :level, Float
       attribute :limit_distance, Fixnum
+      attribute :limit_level, Float
       attribute :stop_distance, Fixnum
+      attribute :stop_level, Float
       attribute :time_in_force, Symbol, allowed_values: [:good_till_cancelled, :good_till_date]
       attribute :type, Symbol, allowed_values: [:limit, :stop]
+
+      def initialize(existing_attributes, new_attributes)
+        existing_attributes.delete :limit_distance if new_attributes.key? :limit_level
+        existing_attributes.delete :stop_distance if new_attributes.key? :stop_level
+
+        super existing_attributes.merge(new_attributes)
+
+        self.time_in_force = good_till_date ? :good_till_date : :good_till_cancelled
+      end
+
+      # Runs a series of validations on this model's attributes to check whether it is ready to be sent to the IG
+      # Markets API.
+      def validate
+        if limit_distance && limit_level
+          raise ArgumentError, 'Do not specify both limit_distance and limit_level options'
+        end
+
+        raise ArgumentError, 'Do not specify both stop_distance and stop_level options' if stop_distance && stop_level
+      end
     end
 
     private_constant :WorkingOrderUpdateAttributes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.12'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: '0.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: '0.40'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement