ig_markets 0.10 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 443589ca4b1af7f2e0de04ba1ca8be7f9b1450ec
-  data.tar.gz: 875b689e9ed88ec0b594b4dac26b43ff669366b4
+  metadata.gz: 3ffcc67e15b995a577e2a546e9c3167194422eeb
+  data.tar.gz: 6f2bbe2ba36c50719b1cb17de93a5bd3f3dfe037
 SHA512:
-  metadata.gz: 0402b33e23f7fd885d74382b50057242e9cd17fe53322e065180e09784f5a530a046a29bdecb88376e1ef7022eb9e21c26eac2db23752676795ba0783a6d29d4
-  data.tar.gz: f26909d155efbb51262d8fddabc0f6c1a72a2de743da7f6aa6ce09518e8c8834e500f087d285e8357980ab72a7319b69c38fd10609226aa9688eacffb05c0b65
+  metadata.gz: a11539879eeb53bb9027be01f626e276ceb522cbbaf51f45686155070612914ab218f8adb5d395087095c77af61fcb0e43916252562bda8c0803d2330072732d
+  data.tar.gz: ff1647ed07d0c563fae8956ec4b8a4c0591e7ecc3f45817ca732bb38cf58ca4c3d3df31e36908c14cfaa11ff33a9c8a77907be438d7afd1b575cdf3645870864

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # IG Markets Changelog
 
-### 0.10 — May 9, 2016
+### 0.11 — May 23, 2016
+
+- `IGMarkets::DealingPlatform::AccountMethods#activities` and `IGMarkets::DealingPlatform::AccountMethods#transactions`
+  now send as many requests as necessary in order to get around the fact that the IG Markets API caps the maximum number
+  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`
+- Instrument high and low is now shown in the `ig_markets positions list` command
+
+### 0.10 — May 10, 2016
 
 - Added `--epic` option to the `ig_markets activities` command
 - Added `--sort-by` option to the `ig_markets activities` and `ig_markets transactions` commands
@@ -94,7 +104,7 @@
   `Time` attributes that have a known time zone. Previous uses of `DateTime` should be replaced with either `Date` or
   `Time`.
 - Changed `size` attribute to always be of type `Float` on all models.
-- Changed `limit_distance` and `stop_distance` attributes to always be of type `Fixnum` on all models.
+- Changed `limit_distance` and `stop_distance` attributes to always be of type `Fixnum` on all models
 - Added `IGMarkets::Format` module
 - Added `#expired?` and `#seconds_till_expiry` to `IGMarkets::SprintMarketPosition`
 - Fixed `IGMarkets::RequestFailedError#message`

data/README.md

@@ -151,10 +151,11 @@ ig.sign_out
 
 # Account
 ig.account.all
-ig.account.activities days: 30
+ig.account.activities from: Date.today - 7
 ig.account.activities from: Date.today - 14, to: Date.today - 7
-ig.account.transactions days: 30
+ig.account.transactions from: Date.today - 7
 ig.account.transactions from: Date.today - 14, to: Date.today - 7
+ig.account.transactions from: Date.today - 14, to: Date.today - 7, type: :deal
 
 # Dealing
 ig.deal_confirmation 'deal_reference'

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

@@ -11,6 +11,8 @@ module IGMarkets
 
       def activities
         self.class.begin_session(options) do |dealing_platform|
+          @epic_regex = Regexp.new options.fetch('epic', ''), Regexp::IGNORECASE
+
           activities = gather_activities dealing_platform
 
           table = ActivitiesTable.new activities
@@ -22,8 +24,6 @@ module IGMarkets
       private
 
       def gather_activities(dealing_platform)
-        @epic_regex = Regexp.new options.fetch('epic', ''), Regexp::IGNORECASE
-
         result = gather_account_history(:activities, dealing_platform).select do |activity|
           activity_filter activity
         end
@@ -53,7 +53,7 @@ module IGMarkets
 
                             { from: from, to: to }
                           else
-                            { days: options[:days] }
+                            { from: Date.today - options[:days] }
                           end
 
         dealing_platform.account.send method_name, history_options

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

@@ -13,6 +13,8 @@ module IGMarkets
 
       def transactions
         self.class.begin_session(options) do |dealing_platform|
+          @instrument_regex = Regexp.new options.fetch('instrument', ''), Regexp::IGNORECASE
+
           transactions = gather_transactions dealing_platform
 
           table = TransactionsTable.new transactions
@@ -29,8 +31,6 @@ module IGMarkets
       private
 
       def gather_transactions(dealing_platform)
-        @instrument_regex = Regexp.new options.fetch('instrument', ''), Regexp::IGNORECASE
-
         result = gather_account_history(:transactions, dealing_platform).select do |transaction|
           transaction_filter transaction
         end

data/lib/ig_markets/cli/main.rb

@@ -50,28 +50,31 @@ module IGMarkets
           @dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
 
           yield @dealing_platform
-        rescue IGMarkets::RequestFailedError => error
-          error "Request error: #{error.error}"
-        rescue ArgumentError => error
-          error "Argument error: #{error}"
+        rescue IGMarkets::RequestFailedError => request_failed_error
+          error "Request error: #{request_failed_error.error}"
+        rescue ArgumentError => argument_error
+          error "Argument error: #{argument_error}"
         end
 
-        # Requests and displays the deal confirmation for the passed deal reference. If the first request for the deal
-        # confirmation returns a 'deal not found' error then the request is attempted again after a five second pause.
-        # This is done because sometimes there is a delay in the processing of the deal by IG Markets.
+        # Requests and displays the deal confirmation for the passed deal reference. If the request for the deal
+        # confirmation returns a 'deal not found' error then the request is attempted again after a two second pause.
+        # This is done because sometimes there is a delay in the processing of the deal by IG Markets. A maximum of
+        # five attempts wil be made before failing outright.
         #
         # @param [String] deal_reference The deal reference.
         def report_deal_confirmation(deal_reference)
           puts "Deal reference: #{deal_reference}"
 
-          print_deal_confirmation @dealing_platform.deal_confirmation(deal_reference)
-        rescue RequestFailedError => request_failed_error
-          raise unless request_failed_error.error == 'error.confirms.deal-not-found'
-
-          puts 'Deal confirmation not found, pausing for five seconds before retrying ...'
+          5.times do |index|
+            begin
+              return print_deal_confirmation @dealing_platform.deal_confirmation(deal_reference)
+            rescue IGMarkets::RequestFailedError => request_failed_error
+              raise if request_failed_error.error != 'error.confirms.deal-not-found' || index == 4
 
-          sleep 5
-          print_deal_confirmation @dealing_platform.deal_confirmation(deal_reference)
+              puts 'Deal not found, retrying ...'
+              sleep 2
+            end
+          end
         end
 
         # Parses and validates a `Date` or `Time` option received as a command-line argument. Raises `ArgumentError` if

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

@@ -16,11 +16,12 @@ module IGMarkets
       end
 
       def headings
-        ['Date', 'EPIC', 'Type', 'Direction', 'Size', 'Level', 'Current', 'Limit', 'Stop', 'Profit/loss', 'Deal IDs']
+        ['Date', 'EPIC', 'Type', 'Direction', 'Size', 'Level', 'Current', 'High', 'Low', 'Limit', 'Stop', 'Profit/loss',
+         'Deal IDs']
       end
 
       def right_aligned_columns
-        [4, 5, 6, 7, 8, 9]
+        [4, 5, 6, 7, 8, 9, 10, 11]
       end
 
       def row(position)
@@ -39,8 +40,15 @@ module IGMarkets
       end
 
       def position_prices(position)
-        [:level, :close_level, :limit_level, :stop_level].map do |attribute|
-          Format.level position.send(attribute)
+        [
+          position.level,
+          position.close_level,
+          position.market.high,
+          position.market.low,
+          position.limit_level,
+          position.stop_level
+        ].map do |value|
+          Format.level value
         end
       end
 

data/lib/ig_markets/deal_confirmation.rb

@@ -13,7 +13,7 @@ module IGMarkets
     attribute :deal_status, Symbol, allowed_values: [:accepted, :fund_account, :rejected]
     attribute :direction, Symbol, allowed_values: [:buy, :sell]
     attribute :epic
-    attribute :expiry, Date, nil_if: '-', format: '%d-%b-%y'
+    attribute :expiry, Date, nil_if: %w(- DFB), format: '%d-%b-%y'
     attribute :guaranteed_stop, Boolean
     attribute :level, Float
     attribute :limit_distance, Fixnum

data/lib/ig_markets/dealing_platform/account_methods.rb

@@ -18,68 +18,78 @@ module IGMarkets
         @dealing_platform.instantiate_models Account, result
       end
 
-      # Returns activities for this account, either the most recent activities by specifying the `:days` option, or
-      # those from a date range by specifying the `:from` and `:to` options.
+      # Returns activities for this account in the specified date range.
       #
       # @param [Hash] options The options hash.
-      # @option options [Float] :days The number of recent days to return activities for. If this is specified then the
-      #                 `:from` and `:to` options must not be specified.
-      # @option options [Date] :from The start of the period to return activities for.
-      # @option options [Date] :to The end of the period to return activities for.
+      # @option options [Date] :from The start of the period to return activities for. Required.
+      # @option options [Date] :to The end of the period to return activities for. Defaults to today.
       #
       # @return [Array<Activity>]
       def activities(options)
-        parse_history_options options
-
-        result = history_request('history/activity', options)
-
-        @dealing_platform.instantiate_models Activity, result.fetch(:activities)
+        history_request_complete url: 'history/activity', url_parameters: prepare_history_options(options),
+                                 collection_name: :activities, model_class: Activity, date_attribute: :date
       end
 
-      # Returns transactions for this account, either the most recent transactions by specifying the `:days` option, or
-      # those from a date range by specifying the `:from` and `:to` options.
+      # Returns transactions for this account in the specified date range.
       #
       # @param [Hash] options The options hash.
       # @option options [:all, :all_deal, :deposit, :withdrawal] :type The type of transactions to return. Defaults to
       #                 `:all`.
-      # @option options [Float] :days The number of recent days to return transactions for. If this is specified then
-      #                 the `:from` and `:to` options must not be specified.
-      # @option options [Date] :from The start of the period to return transactions for.
-      # @option options [Date] :to The end of the period to return transactions for.
+      # @option options [Date] :from The start of the period to return transactions for. Required.
+      # @option options [Date] :to The end of the period to return transactions for. Defaults to today.
       #
-      # @return [Array<Activity>]
+      # @return [Array<Transaction>]
       def transactions(options)
         options[:type] ||= :all
 
-        parse_history_options options
+        history_request_complete url: 'history/transactions', url_parameters: prepare_history_options(options),
+                                 collection_name: :transactions, model_class: Transaction, date_attribute: :date_utc
+      end
 
-        result = history_request('history/transactions', options)
+      private
 
-        @dealing_platform.instantiate_models Transaction, result.fetch(:transactions)
+      # The maximum number of results the IG Markets API will return in one request.
+      MAXIMUM_PAGE_SIZE = 500
+
+      # 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}.
+      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
+
+        @dealing_platform.instantiate_models options[:model_class], get_result.fetch(options[:collection_name])
       end
 
-      private
+      # This method is the same as {#history_request} except it will send as many GET requests as are needed in order
+      # to circumvent the maximum number of results that can be returned per request.
+      def history_request_complete(options)
+        models = []
 
-      # Sends a GET request to the specified URL with the passed options and returns the response.
-      #
-      # @param [String] url The base URL.
-      # @param [Hash] options The options to put with the URL.
-      #
-      # @return [Hash]
-      def history_request(url, options)
-        url = "#{url}?#{options.map { |key, value| "#{key}=#{value.to_s.upcase}" }.join '&'}"
+        loop do
+          request_result = history_request options
+          models += request_result
+
+          break if request_result.size < MAXIMUM_PAGE_SIZE
+
+          # Update the :to parameter so the next GET request returns older results
+          options[:url_parameters][:to] = request_result.last.send(options[:date_attribute]).utc.to_date + 1
+        end
 
-        @dealing_platform.session.get url, API_V2
+        models.uniq
       end
 
       # Parses and formats the history options shared by {#activities} and {#transactions}.
-      #
-      # @param [Hash] options
-      def parse_history_options(options)
-        options[:maxSpanSeconds] = (options.delete(:days).to_f * 24 * 60 * 60).to_i if options.key? :days
-        options[:from] = options[:from].strftime('%F') if options.key? :from
-        options[:to] = options[:to].strftime('%F') if options.key? :to
-        options[:pageSize] = 0
+      def prepare_history_options(options)
+        options[:to] ||= Date.today + 1
+
+        options[:from] = options[:from].strftime('%F')
+        options[:to] = options[:to].strftime('%F')
+
+        options[:pageSize] = MAXIMUM_PAGE_SIZE
+
+        options
       end
     end
   end

data/lib/ig_markets/instrument.rb

@@ -60,7 +60,7 @@ module IGMarkets
     attribute :country
     attribute :currencies, Currency
     attribute :epic, String, regex: Regex::EPIC
-    attribute :expiry, Date, nil_if: '-', format: '%d-%b-%y'
+    attribute :expiry, Date, nil_if: %w(- DFB), format: '%d-%b-%y'
     attribute :expiry_details, ExpiryDetails
     attribute :force_open_allowed, Boolean
     attribute :lot_size, Float

data/lib/ig_markets/market.rb

@@ -63,7 +63,7 @@ module IGMarkets
       options[:from] = options[:from].utc.strftime '%FT%T' if options.key? :from
       options[:to] = options[:to].utc.strftime '%FT%T' if options.key? :to
 
-      @dealing_platform.instantiate_models HistoricalPriceResult, historical_prices_response(options)
+      @dealing_platform.instantiate_models HistoricalPriceResult, historical_prices_request(options)
     end
 
     private
@@ -81,7 +81,7 @@ module IGMarkets
     end
 
     # Returns the API response to a request for historical prices.
-    def historical_prices_response(options)
+    def historical_prices_request(options)
       url = "prices/#{instrument.epic}?#{options.map { |key, value| "#{key}=#{value.to_s.upcase}" }.join '&'}"
 
       @dealing_platform.session.get url, API_V3

data/lib/ig_markets/market_overview.rb

@@ -5,7 +5,7 @@ module IGMarkets
     attribute :delay_time, Float
     attribute :epic, String, regex: Regex::EPIC
     attribute :exchange_id
-    attribute :expiry, String, nil_if: '-'
+    attribute :expiry, String, nil_if: %w(- DFB)
     attribute :high, Float
     attribute :instrument_name
     attribute :instrument_type, Symbol, allowed_values: Instrument.allowed_values(:type)

data/lib/ig_markets/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.10'
+  version: '0.11'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize