ig_markets 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 589e81bb5e11e735c8dacf82cac67d784d5d705f
-  data.tar.gz: 2a84abcae5a0844574fdbc25cbeff2fd831624e3
+  metadata.gz: fe408c4f3b1493d7da7574265ceab99d931d8685
+  data.tar.gz: b21bbe2f50cb5a5bedbd92b718fea4afc02462b5
 SHA512:
-  metadata.gz: f2706333bf110e2b169df6769d602bda5dae0d7e14cb98b92bb73785d81f169b35286855b72367f7182b5d41994514053768d95e1991028ee39c4a7733b3f4fb
-  data.tar.gz: d7c015c2573702b1ac5c1be4ec83f9c5d7e4212ded0be95d80fbe15f6542d580fed02e7fa1e5cfa5fb921227e4cd6ab74b3aaa47da6a3a093776f1949b8f0d6e
+  metadata.gz: 8ff8f42c43576533bd8c44de769f5bb43f725857294c9edce1ab8a45716704c2551eeddb0eb8307345cbfa292a0b1aacb53e45129a3b7ce4c317534ab81dd14c
+  data.tar.gz: d7a8011e786e30d2cd5a75de50edf5b129ab73ddc4d037fb6f22e18ec00a783adbd7276035326752f7a42fe2f7dad93a78dd0f77c11dcd5b6f772bd146d6ece2

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # IG Markets Changelog
 
+### 0.7 — 1 May, 2016
+
+- Added `ig_markets console` command which logs in then opens a live Ruby console
+- Merged `IGMarkets::DealingPlatform::AccountMethods#activities_in_date_range` and
+  `IGMarkets::DealingPlatform::AccountMethods#recent_activities` into
+  `IGMarkets::DealingPlatform::AccountMethods#activities`
+- Merged `IGMarkets::DealingPlatform::AccountMethods#transactions_in_date_range` and
+  `IGMarkets::DealingPlatform::AccountMethods#recent_transactions` into
+  `IGMarkets::DealingPlatform::AccountMethods#transactions`
+- Merged `IGMarkets::Market#recent_prices` and `IGMarkets::Market#prices_in_date_range` into
+  `IGMarkets::Market#historical_prices`
+- Removed the `--account-time-zone` option and `IGMarkets::DealingPlatform#account_time_zone`
+- Improved error reporting on assignment of invalid values to model attributes
+- `IGMarkets::Model#inspect` now reports `Time` attributes in the local time zone
+- Model attributes that are deprecated in the IG Markets API are now no longer included as part of the model classes
+
 ### 0.6 — April 27, 2016
 
 - Added `ig_markets prices` command to print historical market prices

data/README.md

@@ -69,6 +69,7 @@ commands and their subcommands is:
 - `ig_markets account`
 - `ig_markets activities --days N [--start-date YYYY-MM-DD]`
 - `ig_markets confirmation DEAL-REFERENCE`
+- `ig_markets console`
 - `ig_markets help [COMMAND]`
 - `ig_markets orders [list]`
 - `ig_markets orders create ...`
@@ -125,24 +126,9 @@ ig_markets orders create --direction buy --epic CS.D.EURUSD.CFD.IP --level 1.1 -
 
 # Print daily prices for EURUSD from the last two weeks
 ig_markets prices --epic CS.D.EURUSD.CFD.IP --resolution day --number 14
-```
-
-#### Account Time Zone
-
-Some timestamps returned by the IG Markets API are in an unspecified time zone, which can result in some times
-displayed by the command-line client being incorrect. By default the unknown time zone is assumed to be UTC, but if this
-is incorrect then use the `--account-time-zone` argument to specify the actual time zone these times are in.
-
-For example, an IG Markets Australia account requires `--account-time-zone +1000`.
-
-The `--account-time-zone` argument should be put into an `.ig_markets` config file to avoid specifying it on every
-invocation.
-
-To check that the account time zone is correct run the following command and verify that the date and time reported for
-the price is the current date/time in your local time zone.
 
-```
-ig_markets prices --epic CS.D.EURUSD.CFD.IP --resolution minute --number 1
+# Log in and then open a live Ruby console which can be used to query the IG API
+ig_markets console
 ```
 
 ## Usage — Library
@@ -162,16 +148,12 @@ ig = IGMarkets::DealingPlatform.new
 ig.sign_in 'username', 'password', 'api_key', :demo
 ig.sign_out
 
-# Set the time zone for the account, this is applied to time attributes returned from the IG Markets API that are not
-# in a known time zone such as UTC
-ig.account_time_zone = '+0000'
-
 # Account
 ig.account.all
-ig.account.recent_activities 365
-ig.account.recent_transactions 365
-ig.account.activities_in_date_range Date.today - 14, Date.today - 7
-ig.account.transactions_in_date_range Date.today - 14, Date.today - 7
+ig.account.activities days: 365
+ig.account.activities from: Date.today - 14, to: Date.today - 7
+ig.account.transactions days: 365
+ig.account.transactions from: Date.today - 14, to: Date.today - 7
 
 # Dealing
 ig.deal_confirmation 'deal_reference'
@@ -195,15 +177,15 @@ 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['deal_id']
-ig.working_orders['deal_id'].update level: 1.25, limit_distance: 50, stop_distance: 0.02
+ig.working_orders['deal_id'].update level: 1.25, limit_distance: 50, stop_distance: 50
 ig.working_orders['deal_id'].delete
 
 # Markets
 ig.markets.hierarchy
 ig.markets.search 'EURUSD'
 ig.markets['CS.D.EURUSD.CFD.IP']
-ig.markets['CS.D.EURUSD.CFD.IP'].recent_prices :day, 10
-ig.markets['CS.D.EURUSD.CFD.IP'].prices_in_date_range :day, Date.today - 14, Date.today - 7
+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
 
 # Watchlists
 ig.watchlists.all

data/lib/ig_markets.rb

@@ -1,6 +1,7 @@
 require 'base64'
 require 'colorize'
 require 'date'
+require 'pry'
 require 'rest-client'
 require 'terminal-table'
 require 'thor'
@@ -52,6 +53,7 @@ require 'ig_markets/cli/config_file'
 require 'ig_markets/cli/commands/account_command'
 require 'ig_markets/cli/commands/activities_command'
 require 'ig_markets/cli/commands/confirmation_command'
+require 'ig_markets/cli/commands/console_command'
 require 'ig_markets/cli/commands/prices_command'
 require 'ig_markets/cli/commands/search_command'
 require 'ig_markets/cli/commands/sentiment_command'

data/lib/ig_markets/activity.rb

@@ -1,14 +1,13 @@
 module IGMarkets
   # Contains details on a single activity that occurred on an IG Markets account. Returned by
-  # {DealingPlatform::AccountMethods#activities_in_date_range} and
-  # {DealingPlatform::AccountMethods#recent_activities}.
+  # {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
-    attribute :date, Date, format: '%d/%m/%y'
+    attribute :date, Time, format: '%FT%T'
     attribute :deal_id
     attribute :epic, String, regex: Regex::EPIC
     attribute :level, Float
@@ -19,6 +18,5 @@ module IGMarkets
     attribute :size
     attribute :stop, String, nil_if: '-'
     attribute :stop_type, String, nil_if: '-', allowed_values: %w(G N T(50))
-    attribute :time
   end
 end

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

@@ -19,20 +19,17 @@ module IGMarkets
 
       private
 
-      def gather_account_history(type)
-        days = options[:days]
-        start_date = options[:start_date]
+      def gather_account_history(method_name)
+        history_options = if options[:start_date]
+                            from = Date.strptime options[:start_date], '%F'
+                            to = from + options[:days].to_i
 
-        send_args = if start_date
-                      start_date = Date.strptime start_date, '%F'
-                      end_date = start_date + days.to_i
+                            { from: from, to: to }
+                          else
+                            { days: options[:days] }
+                          end
 
-                      ["#{type}_in_date_range", start_date, end_date]
-                    else
-                      ["recent_#{type}", days]
-                    end
-
-        Main.dealing_platform.account.send(*send_args)
+        Main.dealing_platform.account.send method_name, history_options
       end
     end
   end

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

@@ -0,0 +1,16 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets console` command.
+    class Main < Thor
+      desc 'console', 'Logs in and opens a live Ruby console, the IGMarkets::DealingPlatform instance is named \'ig\''
+
+      def console
+        self.class.begin_session(options) do |dealing_platform|
+          ig = dealing_platform
+
+          pry binding
+        end
+      end
+    end
+  end
+end

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

@@ -17,14 +17,15 @@ module IGMarkets
       def prices
         self.class.begin_session(options) do |dealing_platform|
           result = historical_price_result dealing_platform
+          allowance = result.metadata.allowance
 
           table = HistoricalPriceResultSnapshotsTable.new result.prices, title: "Prices for #{options[:epic]}"
 
           puts <<-END
 #{table}
 
-Allowance: #{result.allowance.total_allowance}
-Remaining: #{result.allowance.remaining_allowance}
+Allowance: #{allowance.total_allowance}
+Remaining: #{allowance.remaining_allowance}
 END
         end
       end
@@ -50,7 +51,7 @@ END
       end
 
       def historical_price_result_from_number(market)
-        market.recent_prices resolution, options[:number]
+        market.historical_prices resolution: resolution, max: options[:number]
       end
 
       def historical_price_result_from_date_range(market)
@@ -59,7 +60,7 @@ END
         self.class.parse_date_time filtered, :start_date, Time, '%FT%R%z', 'yyyy-mm-ddThh:mm(+|-)zz:zz'
         self.class.parse_date_time filtered, :end_date, Time, '%FT%R%z', 'yyyy-mm-ddThh:mm(+|-)zz:zz'
 
-        market.prices_in_date_range resolution, filtered[:start_date], filtered[:end_date]
+        market.historical_prices resolution: resolution, from: filtered[:start_date], to: filtered[:end_date]
       end
     end
   end

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

@@ -29,7 +29,7 @@ module IGMarkets
       def gather_transactions
         regex = Regexp.new options.fetch('instrument', '')
 
-        gather_account_history(:transactions).sort_by(&:date).select do |transaction|
+        gather_account_history(:transactions).sort_by(&:date_utc).select do |transaction|
           regex.match(transaction.instrument_name) && (options[:interest] || !transaction.interest?)
         end
       end

data/lib/ig_markets/cli/config_file.rb

@@ -2,12 +2,14 @@ module IGMarkets
   module CLI
     # Helper class for working with the config files supported by the command-line client.
     class ConfigFile
-      # Initializes this config file with the contents of the specified config file.
-      def initialize(config_file)
-        @lines = File.readlines config_file
+      # Initializes this config file with the passed lines.
+      #
+      # @param [Array<String>] lines
+      def initialize(lines = [])
+        @lines = lines
       end
 
-      # Returns the arguments in this config file as an array.
+      # Returns the arguments contained in this config file.
       #
       # @return [Array<String>]
       def arguments
@@ -17,20 +19,28 @@ module IGMarkets
               .split(' ')
       end
 
-      # Returns the config file to use, or `nil` if there is no config file.
+      # Inserts the arguments from this config file into the passed arguments array.
+      #
+      # @param [Array<String>] argv The array of command-line arguments to alter.
       #
-      # @return [CLI::ConfigFile]
-      def self.find
-        config_file_locations = [
-          "#{Dir.pwd}/.ig_markets",
-          "#{Dir.home}/.ig_markets"
-        ]
+      # @return [void]
+      def prepend_arguments_to_argv(argv)
+        insert_index = argv.index do |argument|
+          argument[0] == '-'
+        end || -1
 
-        config_file = config_file_locations.detect do |filename|
+        argv.insert insert_index, *arguments
+      end
+
+      # Takes a list of potential config files and returns a {ConfigFile} instance for the first one that exists.
+      #
+      # @return [ConfigFile]
+      def self.find(*config_files)
+        config_file = config_files.detect do |filename|
           File.exist? filename
         end
 
-        config_file ? new(config_file) : nil
+        new(config_file ? File.readlines(config_file) : [])
       end
     end
   end

data/lib/ig_markets/cli/main.rb

@@ -7,7 +7,6 @@ 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 :account_time_zone, default: '+0000', desc: 'The time zone of the account'
       class_option :print_requests, type: :boolean, desc: 'Whether to print the raw REST API requests and responses'
 
       desc 'orders [SUBCOMAND=list ...]', 'Command for working with orders'
@@ -34,8 +33,6 @@ module IGMarkets
 
           RequestPrinter.enabled = true if options[:print_requests]
 
-          dealing_platform.account_time_zone = options[:account_time_zone]
-
           dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
 
           yield dealing_platform
@@ -125,7 +122,7 @@ END
         #
         # @return [void]
         def bootstrap(argv)
-          prepend_config_file_arguments argv
+          config_file.prepend_arguments_to_argv argv
 
           if argv.index('--version') || argv.index('-v')
             puts VERSION
@@ -135,21 +132,11 @@ END
           start argv
         end
 
-        # Searches for a config file and if found inserts its arguments into the passed arguments array.
-        #
-        # @param [Array<String>] argv The array of command-line arguments.
+        # Returns the config file to use for this invocation.
         #
-        # @return [void]
-        def prepend_config_file_arguments(argv)
-          config_file = ConfigFile.find
-
-          return unless config_file
-
-          insert_index = argv.index do |argument|
-            argument[0] == '-'
-          end || -1
-
-          argv.insert insert_index, *config_file.arguments
+        # @return [ConfigFile]
+        def config_file
+          ConfigFile.find "#{Dir.pwd}/.ig_markets", "#{Dir.home}/.ig_markets"
         end
       end
     end

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

@@ -9,15 +9,15 @@ module IGMarkets
       end
 
       def headings
-        %w(Date Time Channel Type Status EPIC Market Size Level Limit Stop Result)
+        %w(Date Channel Type Status EPIC Market Size Level Limit Stop Result)
       end
 
       def right_aligned_columns
-        [7, 8, 9, 10]
+        [6, 7, 8, 9]
       end
 
       def row(activity)
-        [activity.date, activity.time, activity.channel, activity.activity, activity_status(activity), activity.epic,
+        [activity.date, activity.channel, activity.activity, activity_status(activity), activity.epic,
          activity.market_name, activity.size, activity.level, activity.limit, activity.stop, activity.result]
       end
 

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

@@ -13,7 +13,7 @@ module IGMarkets
       end
 
       def row(snapshot)
-        [snapshot.snapshot_time, format_price(snapshot.open_price), format_price(snapshot.close_price),
+        [snapshot.snapshot_time_utc, format_price(snapshot.open_price), format_price(snapshot.close_price),
          format_price(snapshot.low_price), format_price(snapshot.high_price)]
       end
 

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

@@ -66,7 +66,7 @@ module IGMarkets
         return format_boolean(value) if value.is_a?(TrueClass) || value.is_a?(FalseClass)
         return format_float(value) if value.is_a? Float
         return format_time(value) if value.is_a? Time
-        return format_date(value) if value.is_a? Date
+        return format_symbol(value) if value.is_a? Symbol
 
         format_string value
       end
@@ -83,16 +83,12 @@ module IGMarkets
         value.localtime.strftime '%F %T %Z'
       end
 
-      def format_date(value)
-        value.strftime '%F'
+      def format_symbol(value)
+        Format.symbol value
       end
 
       def format_string(value)
-        value = if value.is_a? Symbol
-                  Format.symbol value
-                else
-                  value.to_s
-                end
+        value = value.to_s
 
         return '' if value.empty?
 

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

@@ -17,7 +17,7 @@ module IGMarkets
       end
 
       def row(transaction)
-        [transaction.date, transaction.reference, formatted_type(transaction.transaction_type),
+        [transaction.date_utc, transaction.reference, formatted_type(transaction.transaction_type),
          transaction.instrument_name, transaction.size, Format.level(transaction.open_level),
          Format.level(transaction.close_level),
          Format.currency(transaction.profit_and_loss_amount, transaction.currency)]

data/lib/ig_markets/dealing_platform.rb

@@ -38,11 +38,6 @@ module IGMarkets
     # @return [WorkingOrderMethods] Methods for working with working orders.
     attr_reader :working_orders
 
-    # @return [String] The time zone of the account, e.g. `'+1000'` or `'-0800'`. This is required in order for certain
-    # dates and times reported by this library to be correct, due to the fact that the IG Markets API does not reliably
-    # report time zone details in all attributes. Defaults to `'+0000'`.
-    attr_accessor :account_time_zone
-
     def initialize
       @session = Session.new
 
@@ -53,8 +48,6 @@ module IGMarkets
       @sprint_market_positions = SprintMarketPositionMethods.new self
       @watchlists = WatchlistMethods.new self
       @working_orders = WorkingOrderMethods.new self
-
-      @account_time_zone = '+0000'
     end
 
     # Signs in to the IG Markets Dealing Platform, either the production platform or the demo platform.

data/lib/ig_markets/dealing_platform/account_methods.rb

@@ -18,91 +18,67 @@ module IGMarkets
         @dealing_platform.instantiate_models Account, result
       end
 
-      # Returns all account activities that occurred in the specified date range.
+      # 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.
       #
-      # @param [Date] from_date The start date of the desired date range.
-      # @param [Date] to_date The end date of the desired 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.
       #
       # @return [Array<Activity>]
-      def activities_in_date_range(from_date, to_date)
-        from_date = format_date from_date
-        to_date = format_date to_date
+      def activities(options)
+        parse_history_options options
 
-        result = @dealing_platform.session.get("history/activity/#{from_date}/#{to_date}").fetch :activities
+        result = history_request('history/activity', options)
 
-        @dealing_platform.instantiate_models Activity, result
+        @dealing_platform.instantiate_models Activity, result.fetch(:activities)
       end
 
-      # Returns all account activities that occurred in the most recent specified number of days.
+      # 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.
       #
-      # @param [Fixnum, Float] days The number of days to return recent activities for.
+      # @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.
       #
       # @return [Array<Activity>]
-      def recent_activities(days)
-        result = @dealing_platform.session.get("history/activity/#{milliseconds(days)}").fetch :activities
+      def transactions(options)
+        options[:type] ||= :all
 
-        @dealing_platform.instantiate_models Activity, result
-      end
-
-      # Returns all transactions that occurred in the specified date range.
-      #
-      # @param [Date] from_date The start date of the desired date range.
-      # @param [Date] to_date The end date of the desired date range.
-      # @param [:all, :all_deal, :deposit, :withdrawal] transaction_type The type of transactions to return.
-      #
-      # @return [Array<Transaction>]
-      def transactions_in_date_range(from_date, to_date, transaction_type = :all)
-        validate_transaction_type transaction_type
-
-        from_date = format_date from_date
-        to_date = format_date to_date
-
-        url = "history/transactions/#{transaction_type.to_s.upcase}/#{from_date}/#{to_date}"
-        result = @dealing_platform.session.get(url).fetch :transactions
-
-        @dealing_platform.instantiate_models Transaction, result
-      end
+        parse_history_options options
 
-      # Returns all transactions that occurred in the last specified number of days.
-      #
-      # @param [Fixnum, Float] days The number of days to return recent transactions for.
-      # @param [:all, :all_deal, :deposit, :withdrawal] transaction_type The type of transactions to return.
-      #
-      # @return [Array<Transaction>]
-      def recent_transactions(days, transaction_type = :all)
-        validate_transaction_type transaction_type
+        result = history_request('history/transactions', options)
 
-        url = "history/transactions/#{transaction_type.to_s.upcase}/#{milliseconds(days)}"
-        result = @dealing_platform.session.get(url).fetch :transactions
-
-        @dealing_platform.instantiate_models Transaction, result
+        @dealing_platform.instantiate_models Transaction, result.fetch(:transactions)
       end
 
       private
 
-      # Validates whether the passed argument is a valid transaction type.
-      #
-      # @param [Symbol] type The candidate transaction type to validate.
-      def validate_transaction_type(type)
-        raise ArgumentError, 'transaction type is invalid' unless [:all, :all_deal, :deposit, :withdrawal].include? type
-      end
-
-      # Formats the passed `Date` as a string in the manner needed for building IG Markets URLs.
+      # Sends a GET request to the specified URL with the passed options and returns the response.
       #
-      # @param [Date] date The date to format.
+      # @param [String] url The base URL.
+      # @param [Hash] options The options to put with the URL.
       #
-      # @return [String]
-      def format_date(date)
-        date.strftime '%d-%m-%Y'
+      # @return [Hash]
+      def history_request(url, options)
+        url = "#{url}?#{options.map { |key, value| "#{key}=#{value.to_s.upcase}" }.join '&'}"
+
+        @dealing_platform.session.get url, API_V2
       end
 
-      # Converts a number of days into a number of milliseconds.
-      #
-      # @param [Fixnum, Float] days The number of days.
+      # Parses and formats the history options shared by {#activities} and {#transactions}.
       #
-      # @return [Fixnum]
-      def milliseconds(days)
-        (days.to_f * 24 * 60 * 60 * 1000).to_i
+      # @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
       end
     end
   end

data/lib/ig_markets/dealing_platform/sprint_market_position_methods.rb

@@ -13,7 +13,7 @@ module IGMarkets
       #
       # @return [Array<SprintMarketPosition>]
       def all
-        result = @dealing_platform.session.get('positions/sprintmarkets').fetch :sprint_market_positions
+        result = @dealing_platform.session.get('positions/sprintmarkets', API_V2).fetch :sprint_market_positions
 
         @dealing_platform.instantiate_models SprintMarketPosition, result
       end

data/lib/ig_markets/historical_price_result.rb

@@ -1,33 +1,48 @@
 module IGMarkets
-  # Contains details on a historical price query result. Returned by {Market#recent_prices} and
-  # {Market#prices_in_date_range}.
+  # Contains details on a historical price query result. Returned by {Market#historical_prices}.
   class HistoricalPriceResult < Model
-    # Contains details on the remaining allowance for looking up historical prices. Used by {#allowance}.
-    class DataAllowance < Model
-      attribute :allowance_expiry, Fixnum
-      attribute :remaining_allowance, Fixnum
-      attribute :total_allowance, Fixnum
-    end
+    # Contains metadata associated with an historical price lookup. Used by {#metadata}.
+    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
+      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
+      end
 
-    # Contains details on a single historical price. Used by {Snapshot}.
-    class Price < Model
-      attribute :ask, Float
-      attribute :bid, Float
-      attribute :last_traded, Float
+      attribute :allowance, Allowance
+      attribute :page_data, PageData
+      attribute :size, Fixnum
     end
 
     # Contains details on a single historical price snapshot. Used by {#prices}.
     class Snapshot < Model
+      # Contains details on a single historical price.
+      class Price < Model
+        attribute :ask, Float
+        attribute :bid, Float
+        attribute :last_traded, Float
+      end
+
       attribute :close_price, Price
       attribute :high_price, Price
       attribute :last_traded_volume, Float
       attribute :low_price, Price
       attribute :open_price, Price
-      attribute :snapshot_time, Time, format: '%Y/%m/%d %T', time_zone: -> { @dealing_platform.account_time_zone }
+      attribute :snapshot_time_utc, Time, format: '%FT%T'
+
+      deprecated_attribute :snapshot_time
     end
 
-    attribute :allowance, DataAllowance
     attribute :instrument_type, Symbol, allowed_values: Instrument.allowed_values(:type)
+    attribute :metadata, Metadata
     attribute :prices, Snapshot
   end
 end

data/lib/ig_markets/instrument.rb

@@ -12,7 +12,7 @@ module IGMarkets
 
     # Contains details on the expiry details of an instrument. Returned by {#expiry_details}.
     class ExpiryDetails < Model
-      attribute :last_dealing_date, Time, format: '%FT%R', time_zone: -> { @dealing_platform.account_time_zone }
+      attribute :last_dealing_date, Time, format: '%FT%R'
       attribute :settlement_info
     end
 

data/lib/ig_markets/market.rb

@@ -43,57 +43,48 @@ module IGMarkets
     attribute :instrument, Instrument
     attribute :snapshot, Snapshot
 
-    # Returns recent historical prices for this market at a specified resolution.
+    # Returns historical prices for this market at a given resolution, either the most recent prices by specifying the
+    # `:number` option, or those from a date range by specifying the `:from` and `:to` options.
     #
-    # @param [: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 historical prices to return.
-    # @param [Fixnum] num_points The number of historical prices to return.
+    # @param [Hash] options The options hash.
+    # @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`
+    #                 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.
     #
     # @return [HistoricalPriceResult]
-    def recent_prices(resolution, num_points)
-      validate_historical_price_resolution resolution
+    def historical_prices(options)
+      validate_historical_prices_options options
 
-      url = "prices/#{instrument.epic}/#{resolution.to_s.upcase}/#{num_points.to_i}"
+      options[:max] = options.delete(:number) if options.key? :number
+      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, @dealing_platform.session.get(url, API_V2)
+      @dealing_platform.instantiate_models HistoricalPriceResult, historical_prices_response(options)
     end
 
-    # Returns historical prices for this market at a specified resolution over a specified time period.
-    #
-    # @param [: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 historical prices to return.
-    # @param [Time] start_time The start of the desired time period.
-    # @param [Time] end_time The end of the desired time period.
-    #
-    # @return [HistoricalPriceResult]
-    def prices_in_date_range(resolution, start_time, end_time)
-      validate_historical_price_resolution resolution
+    private
 
-      start_time = format_time start_time
-      end_time = format_time end_time
+    # Validates the options passed to {#historical_prices}.
+    def validate_historical_prices_options(options)
+      resolutions = [:second, :minute, :minute_2, :minute_3, :minute_5, :minute_10, :minute_15, :minute_30, :hour,
+                     :hour_2, :hour_3, :hour_4, :day, :week, :month]
 
-      url = "prices/#{instrument.epic}/#{resolution.to_s.upcase}/#{start_time}/#{end_time}"
+      raise ArgumentError, 'resolution is invalid' unless resolutions.include? options[:resolution]
 
-      @dealing_platform.instantiate_models HistoricalPriceResult, @dealing_platform.session.get(url, API_V2)
+      if options.keys != [:resolution, :from, :to] && options.keys != [:resolution, :number]
+        raise ArgumentError, 'options must specify either :number or :from and :to'
+      end
     end
 
-    private
+    # Returns the API response to a request for historical prices.
+    def historical_prices_response(options)
+      url = "prices/#{instrument.epic}?#{options.map { |key, value| "#{key}=#{value.to_s.upcase}" }.join '&'}"
 
-    # Validates whether the passed argument is a valid historical price resolution.
-    #
-    # @param [Symbol] resolution The candidate historical price resolution to validate.
-    def validate_historical_price_resolution(resolution)
-      resolutions = [:minute, :minute_2, :minute_3, :minute_5, :minute_10, :minute_15, :minute_30, :hour, :hour_2,
-                     :hour_3, :hour_4, :day, :week, :month]
-
-      raise ArgumentError, 'resolution is invalid' unless resolutions.include? resolution
-    end
-
-    # Takes a `Time` and formats it for the historical prices API URLs.
-    #
-    # @param [Time] time The `Time` to format.
-    def format_time(time)
-      time.utc.strftime '%F %T'
+      @dealing_platform.session.get url, API_V3
     end
   end
 end

data/lib/ig_markets/market_overview.rb

@@ -18,7 +18,8 @@ module IGMarkets
     attribute :percentage_change, Float
     attribute :scaling_factor, Float
     attribute :streaming_prices_available, Boolean
-    attribute :update_time
     attribute :update_time_utc
+
+    deprecated_attribute :update_time
   end
 end

data/lib/ig_markets/model.rb

@@ -11,16 +11,14 @@ module IGMarkets
     #
     # @param [Hash] attributes The attribute values to set on this new model.
     def initialize(attributes = {})
-      defined_attribute_names = self.class.defined_attribute_names
-
-      defined_attribute_names.each do |name|
+      self.class.defined_attribute_names.each do |name|
         send "#{name}=", attributes[name]
       end
 
-      (attributes.keys - defined_attribute_names).map do |attribute|
-        value = attributes[attribute]
+      attributes.each do |name, value|
+        next if respond_to? "#{name}="
 
-        raise ArgumentError, "unknown attribute: #{self.class.name}##{attribute}, value: #{inspect_value value}"
+        raise ArgumentError, "unknown attribute: #{self.class.name}##{name}, value: #{inspect_value value}"
       end
     end
 
@@ -58,7 +56,7 @@ module IGMarkets
     # Returns the {#inspect} string for the given value.
     def inspect_value(value)
       if value.is_a? Time
-        value.utc.strftime '%F %T %Z'
+        value.localtime.strftime '%F %T %Z'
       elsif value.is_a? Date
         value.strftime '%F'
       else
@@ -107,10 +105,6 @@ module IGMarkets
       #                 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, Proc] :time_zone When `type` is `Time` this specifies the time zone to append to
-      #                 `String` values assigned to this attribute prior to parsing them with `:format`. Defaults to
-      #                 `+0000` (UTC) unless `:format` is `%Q`. Can be a `Proc` that returns the time zone string to
-      #                 use.
       #
       # @macro [attach] attribute
       #   The $1 attribute.
@@ -123,6 +117,15 @@ module IGMarkets
         self.defined_attributes[name] = options.merge type: type
       end
 
+      # Defines a no-op setter method for each of the passed attribute names. This is used to silently allow deprecated
+      # attributes to be set on the model but not have them be otherwise part of the model's structure.
+      def deprecated_attribute(*names)
+        names.each do |name|
+          define_method "#{name}=" do |_value|
+          end
+        end
+      end
+
       private
 
       def define_attribute_reader(name)
@@ -135,7 +138,7 @@ module IGMarkets
         define_method "#{name}=" do |value|
           value = nil if Array(options.fetch(:nil_if, [])).include? value
 
-          value = typecaster.call value, options, self, name
+          value = typecaster.call value, options, name
 
           allowed_values = options[:allowed_values]
           if !value.nil? && allowed_values

data/lib/ig_markets/model/typecasters.rb

@@ -8,9 +8,9 @@ module IGMarkets
         if [Boolean, String, Fixnum, Float, Symbol, Date, Time].include? type
           method "typecaster_#{type.to_s.gsub(/\AIGMarkets::/, '').downcase}"
         elsif type
-          lambda do |value, _options, model, name|
+          lambda do |value, _options, name|
             if Array(value).any? { |entry| !entry.is_a? type }
-              raise ArgumentError, "incorrect type set on #{model.class}##{name}: #{value.inspect}"
+              raise ArgumentError, "incorrect type set on #{self}##{name}: #{value.inspect}"
             end
 
             value
@@ -18,75 +18,76 @@ module IGMarkets
         end
       end
 
-      def typecaster_boolean(value, _options, _model, _name)
+      def typecaster_boolean(value, _options, _name)
         return value if [nil, true, false].include? value
 
-        raise ArgumentError, "#{self}: invalid boolean value: #{value}"
+        raise ArgumentError, "#{self}##{name}: invalid boolean value: #{value}"
       end
 
-      def typecaster_string(value, options, _model, _name)
+      def typecaster_string(value, options, _name)
         return nil if value.nil?
 
-        if options.key? :regex
-          raise ArgumentError, "#{self}: invalid string value: #{value}" unless options[:regex].match value.to_s
+        if options.key?(:regex) && !options[:regex].match(value.to_s)
+          raise ArgumentError, "#{self}##{name}: invalid string value: #{value}"
         end
 
         value.to_s
       end
 
-      def typecaster_fixnum(value, _options, _model, _name)
+      def typecaster_fixnum(value, _options, _name)
         return nil if value.nil?
 
         value.to_s.to_i
       end
 
-      def typecaster_float(value, _options, _model, _name)
+      def typecaster_float(value, _options, _name)
         return nil if value.nil? || value == ''
 
         Float(value)
       end
 
-      def typecaster_symbol(value, _options, _model, _name)
+      def typecaster_symbol(value, _options, _name)
         return nil if value.nil?
 
         value.to_s.downcase.to_sym
       end
 
-      def typecaster_date(value, options, _model, _name)
-        raise ArgumentError, "#{self}: invalid or missing date format" unless options[:format].is_a? String
+      def typecaster_date(value, options, name)
+        raise ArgumentError, "#{self}##{name}: invalid or missing date format" unless options[:format].is_a? String
 
         if value.is_a? String
           begin
             Date.strptime value, options[:format]
           rescue ArgumentError
-            raise ArgumentError, "#{self}: failed parsing date '#{value}' with format '#{options[:format]}'"
+            raise ArgumentError, "#{self}##{name}: failed parsing date: #{value}"
           end
         else
           value
         end
       end
 
-      def typecaster_time(value, options, model, name)
-        raise ArgumentError, "#{self}: invalid or missing time format" unless options[:format].is_a? String
+      def typecaster_time(value, options, name)
+        raise ArgumentError, "#{self}##{name}: invalid or missing time format" unless options[:format].is_a? String
 
         if value.is_a?(String) || value.is_a?(Fixnum)
-          parse_time_from_string value.to_s, options, model, name
+          parse_time_from_string value.to_s, options, name
         else
           value
         end
       end
 
-      def parse_time_from_string(value, options, model, name)
+      def parse_time_from_string(value, options, name)
         format = options[:format]
 
-        time_zone = options[:time_zone]
-        time_zone ||= '+0000' unless format == '%Q'
-        time_zone = model.instance_exec(&time_zone) if time_zone.is_a? Proc
+        unless format == '%Q'
+          format += '%z'
+          value += '+0000'
+        end
 
         begin
-          Time.strptime "#{value}#{time_zone}", "#{format}#{'%z' if time_zone}"
+          Time.strptime value, format
         rescue ArgumentError
-          raise ArgumentError, "#{self}##{name}: failed parsing time '#{value}' with format '#{format}'"
+          raise ArgumentError, "#{self}##{name}: failed parsing time: #{value}"
         end
       end
     end

data/lib/ig_markets/position.rb

@@ -4,7 +4,6 @@ module IGMarkets
   class Position < Model
     attribute :contract_size, Float
     attribute :controlled_risk, Boolean
-    attribute :created_date, Time, format: '%Y/%m/%d %T:%L'
     attribute :created_date_utc, Time, format: '%FT%T'
     attribute :currency, String, regex: Regex::CURRENCY
     attribute :deal_id
@@ -18,6 +17,8 @@ module IGMarkets
 
     attribute :market, MarketOverview
 
+    deprecated_attribute :created_date
+
     # Returns whether this position has a trailing stop.
     def trailing_stop?
       !trailing_step.nil? && !trailing_stop_distance.nil?

data/lib/ig_markets/sprint_market_position.rb

@@ -1,13 +1,13 @@
 module IGMarkets
   # Contains details on a sprint market position. Returned by {DealingPlatform::SprintMarketPositionMethods#all}.
   class SprintMarketPosition < Model
-    attribute :created_date, Time, format: '%Y/%m/%d %T:%L', time_zone: -> { @dealing_platform.account_time_zone }
+    attribute :created_date, Time, format: '%FT%T'
     attribute :currency, String, regex: Regex::CURRENCY
     attribute :deal_id
     attribute :description
     attribute :direction, Symbol, allowed_values: [:buy, :sell]
     attribute :epic, String, regex: Regex::EPIC
-    attribute :expiry_time, Time, format: '%Y/%m/%d %T:%L', time_zone: -> { @dealing_platform.account_time_zone }
+    attribute :expiry_time, Time, format: '%FT%T'
     attribute :instrument_name
     attribute :market_status, Symbol, allowed_values: Market::Snapshot.allowed_values(:market_status)
     attribute :payout_amount, Float

data/lib/ig_markets/transaction.rb

@@ -1,20 +1,21 @@
 module IGMarkets
   # Contains details on a single transaction that occurred on an IG Markets account. Returned by
-  # {DealingPlatform::AccountMethods#transactions_in_date_range} and
-  # {DealingPlatform::AccountMethods#recent_transactions}.
+  # {DealingPlatform::AccountMethods#transactions}.
   class Transaction < Model
     attribute :cash_transaction, Boolean
     attribute :close_level, String, nil_if: %w(- 0)
     attribute :currency
-    attribute :date, Date, format: '%d/%m/%y'
+    attribute :date_utc, Time, format: '%FT%T'
     attribute :instrument_name
     attribute :open_level, String, nil_if: %w(- 0)
-    attribute :period, Time, nil_if: '-', format: '%d/%m/%y %T', time_zone: -> { @dealing_platform.account_time_zone }
+    attribute :period, Time, nil_if: '-', format: '%FT%T'
     attribute :profit_and_loss
     attribute :reference
     attribute :size, String, nil_if: '-'
     attribute :transaction_type, Symbol, allowed_values: [:deal, :depo, :dividend, :exchange, :with]
 
+    deprecated_attribute :date
+
     # Returns whether or not this transaction was an interest payment. Interest payments can be either deposits or
     # withdrawals depending on the underlying instrument and currencies involved. Interest payments are identified by
     # the presence of the word `interest` in {#instrument_name}.

data/lib/ig_markets/version.rb

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

data/lib/ig_markets/working_order.rb

@@ -2,7 +2,6 @@ module IGMarkets
   # Contains details on a working order. Returned by {DealingPlatform::WorkingOrderMethods#all} and
   # {DealingPlatform::WorkingOrderMethods#[]}.
   class WorkingOrder < Model
-    attribute :created_date, Time, format: '%Y/%m/%d %T:%L'
     attribute :created_date_utc, Time, format: '%FT%T'
     attribute :currency_code, String, regex: Regex::CURRENCY
     attribute :deal_id
@@ -10,7 +9,6 @@ module IGMarkets
     attribute :dma, Boolean
     attribute :epic, String, regex: Regex::EPIC
     attribute :good_till_date, Time, format: '%Y/%m/%d %R'
-    attribute :good_till_date_iso, Time, format: '%FT%R'
     attribute :guaranteed_stop, Boolean
     attribute :limit_distance, Fixnum
     attribute :order_level, Float
@@ -21,6 +19,8 @@ module IGMarkets
 
     attribute :market, MarketOverview
 
+    deprecated_attribute :created_date, :good_till_date_iso
+
     # Deletes this working order.
     #
     # @return [String] The deal reference of the deletion operation. Use {DealingPlatform#deal_confirmation} to check

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +212,7 @@ files:
 - lib/ig_markets/cli/commands/account_command.rb
 - lib/ig_markets/cli/commands/activities_command.rb
 - lib/ig_markets/cli/commands/confirmation_command.rb
+- lib/ig_markets/cli/commands/console_command.rb
 - lib/ig_markets/cli/commands/orders_command.rb
 - lib/ig_markets/cli/commands/positions_command.rb
 - lib/ig_markets/cli/commands/prices_command.rb