ig_markets 0.8 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 905ebb175a410a5b6a86f1b92c215745e642e04b
-  data.tar.gz: 6bb5b7d2360c936c46c2380002a15f632b853b63
+  metadata.gz: 8dd48141e03cc58042b6b5c14ae2f7d4a1a0b55c
+  data.tar.gz: 4c3467cc309a493209f646665b27b48eef0daa45
 SHA512:
-  metadata.gz: 0abc1a40d8fb0c4ef98835c40cf525c129ea5623dc23cff94792034431d2109ce164dbbea6d1097fef176b599c3ae823d88d9aa1bb78f330a7a10ce919239aa9
-  data.tar.gz: e0a4e9984d8eb1286ef8e92547512ec1cafb94fbdfc14bb152ffba9f9ff41072d8475b54805da3e1db7191bbf7b41ee958dc1f37e0e73ced7642e6a1f945cbb8
+  metadata.gz: 80af908f64fe291975ad4364a4cbc6b713f3f8f37df7dc0f15e2697cc5b4f4f2ee4ebf48c09ec41064f50b687930b45680645b51ec1299f8c3b56213783c8c95
+  data.tar.gz: 46e5518f0bcd7371ef63799da17e1b7d189b81a6a7a477ecd0e580b87e6ce48760a6a19d4d3eedea61517e227c359a413ac105212038dbcdcf5afeaf7d231fd6

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # IG Markets Changelog
 
+### 0.9 — May 2, 2016
+
+- `IGMarkets::DealingPlatform#sign_in` now returns an `IGMarkets::ClientAccountSummary` instance
+- `IGMarkets::DealingPlatform::MarketMethods#find` can now handle being passed more than 50 EPICs at once
+- Renamed `--start-date` option for `ig_markets activities` and `ig_markets transactions` commands to `--from`
+- Deal confirmations reported by the command-line client are now retried after a five second pause if the initial
+  request returns a 'deal not found' error
+
 ### 0.8 — April 30, 2016
 
-- The `ig_markets` prices command now takes `--from` and `--to` arguments accurate to one second
+- The `ig_markets prices` command now takes `--from` and `--to` arguments accurate to one second
 - Fixed incomplete data being returned by `IGMarkets::DealingPlatform::AccountMethods#activities` and
   `IGMarkets::DealingPlatform::AccountMethods#transactions`
 - Fixed errors calling `IGMarkets::DealingPlatform#instantiate_models` for models that have deprecated attributes

data/README.md

@@ -67,7 +67,7 @@ Use `ig_markets help` to get details on the options accepted by the commands and
 commands and their subcommands is:
 
 - `ig_markets account`
-- `ig_markets activities --days N [--start-date YYYY-MM-DD]`
+- `ig_markets activities --days N [--from YYYY-MM-DD]`
 - `ig_markets confirmation DEAL-REFERENCE`
 - `ig_markets console`
 - `ig_markets help [COMMAND]`
@@ -84,7 +84,7 @@ commands and their subcommands is:
 - `ig_markets sentiment MARKET`
 - `ig_markets sprints [list]`
 - `ig_markets sprints create ...`
-- `ig_markets transactions --days N [--start-date YYYY-MM-DD] [--instrument INSTRUMENT] [--no-interest]`
+- `ig_markets transactions --days N [--from YYYY-MM-DD] [--instrument INSTRUMENT] [--no-interest]`
 - `ig_markets watchlists [list]`
 - `ig_markets watchlists create NAME [EPIC EPIC ...]`
 - `ig_markets watchlists add-markets WATCHLIST-ID [EPIC EPIC ...]`
@@ -127,8 +127,8 @@ 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
 
-# Log in and then open a live Ruby console which can be used to query the IG API
-ig_markets console
+# Log in and then open a Ruby console which can be used to query the IG API, all REST requests will be printed in full
+ig_markets console --print-requests
 ```
 
 ## Usage — Library
@@ -150,9 +150,9 @@ ig.sign_out
 
 # Account
 ig.account.all
-ig.account.activities days: 365
+ig.account.activities days: 30
 ig.account.activities from: Date.today - 14, to: Date.today - 7
-ig.account.transactions days: 365
+ig.account.transactions days: 30
 ig.account.transactions from: Date.today - 14, to: Date.today - 7
 
 # Dealing

data/lib/ig_markets.rb

@@ -15,6 +15,7 @@ require 'ig_markets/account'
 require 'ig_markets/activity'
 require 'ig_markets/api_versions'
 require 'ig_markets/application'
+require 'ig_markets/client_account_summary'
 require 'ig_markets/client_sentiment'
 require 'ig_markets/deal_confirmation'
 require 'ig_markets/dealing_platform'

data/lib/ig_markets/account.rb

@@ -1,7 +1,7 @@
 module IGMarkets
   # Contains details on an IG Markets account. Returned by {DealingPlatform::AccountMethods#all}.
   class Account < Model
-    # Contains details on the balance of an {Account}, used by {Account#balance}.
+    # Contains details on the balance of an {Account}, used by {#balance}.
     class Balance < Model
       attribute :available, Float
       attribute :balance, Float

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

@@ -5,11 +5,11 @@ module IGMarkets
       desc 'activities', 'Prints account activities'
 
       option :days, type: :numeric, required: true, desc: 'The number of days to print account activities for'
-      option :start_date, desc: 'The start date to print account activities from, format: yyyy-mm-dd'
+      option :from, desc: 'The start date to print account activities from, format: yyyy-mm-dd'
 
       def activities
-        self.class.begin_session(options) do |_dealing_platform|
-          activities = gather_account_history(:activities).sort_by(&:date)
+        self.class.begin_session(options) do |dealing_platform|
+          activities = gather_account_history(:activities, dealing_platform).sort_by(&:date)
 
           table = ActivitiesTable.new activities
 
@@ -19,17 +19,17 @@ module IGMarkets
 
       private
 
-      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
+      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
                             { days: options[:days] }
                           end
 
-        Main.dealing_platform.account.send method_name, history_options
+        dealing_platform.account.send method_name, history_options
       end
     end
   end

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

@@ -5,13 +5,13 @@ module IGMarkets
       desc 'transactions', 'Prints account transactions'
 
       option :days, type: :numeric, required: true, desc: 'The number of days to print account transactions for'
-      option :start_date, desc: 'The start date to print account transactions from, format: yyyy-mm-dd'
+      option :from, desc: 'The start date to print account transactions from, format: yyyy-mm-dd'
       option :instrument, desc: 'Regex for filtering transactions based on their instrument'
       option :interest, type: :boolean, default: true, desc: 'Whether to show interest deposits and withdrawals'
 
       def transactions
-        self.class.begin_session(options) do |_dealing_platform|
-          transactions = gather_transactions
+        self.class.begin_session(options) do |dealing_platform|
+          transactions = gather_transactions dealing_platform
 
           table = TransactionsTable.new transactions
 
@@ -26,10 +26,10 @@ module IGMarkets
 
       private
 
-      def gather_transactions
+      def gather_transactions(dealing_platform)
         regex = Regexp.new options.fetch('instrument', '')
 
-        gather_account_history(:transactions).sort_by(&:date_utc).select do |transaction|
+        gather_account_history(:transactions, dealing_platform).sort_by(&:date_utc).select do |transaction|
           regex.match(transaction.instrument_name) && (options[:interest] || !transaction.interest?)
         end
       end

data/lib/ig_markets/cli/main.rb

@@ -22,6 +22,23 @@ module IGMarkets
       subcommand 'watchlists', Watchlists
 
       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.
+        #
+        # @param [Array<String>] argv The array of command-line arguments.
+        #
+        # @return [void]
+        def bootstrap(argv)
+          config_file.prepend_arguments_to_argv argv
+
+          if argv.index('--version') || argv.index('-v')
+            puts VERSION
+            exit
+          end
+
+          start argv
+        end
+
         # Signs in to IG Markets and yields back a {DealingPlatform} instance, with common error handling if exceptions
         # occur. This method is used by all of the commands in order to authenticate.
         #
@@ -33,29 +50,19 @@ module IGMarkets
 
           RequestPrinter.enabled = true if options[:print_requests]
 
-          dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
+          @dealing_platform ||= DealingPlatform.new
+          @dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
 
-          yield dealing_platform
+          yield @dealing_platform
         rescue IGMarkets::RequestFailedError => error
           error "Request error: #{error.error}"
         rescue ArgumentError => error
           error "Argument error: #{error}"
         end
 
-        # Writes the passed message to `stderr` and then exits the application.
-        #
-        # @param [String] message The error message.
-        def error(message)
-          warn message
-          exit 1
-        end
-
-        # The {DealingPlatform} instance used by {begin_session}.
-        def dealing_platform
-          @dealing_platform ||= DealingPlatform.new
-        end
-
-        # Requests and displays the deal confirmation for the passed deal reference.
+        # 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.
         #
         # @param [String] deal_reference The deal reference.
         #
@@ -63,15 +70,14 @@ module IGMarkets
         def report_deal_confirmation(deal_reference)
           puts "Deal reference: #{deal_reference}"
 
-          deal_confirmation = dealing_platform.deal_confirmation 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 <<-END
-Deal ID: #{deal_confirmation.deal_id}
-Status: #{Format.symbol deal_confirmation.deal_status}
-Result: #{Format.symbol deal_confirmation.status}
-END
+          puts 'Deal confirmation not found, pausing for five seconds before retrying ...'
 
-          puts "Reason: #{Format.symbol deal_confirmation.reason}" unless deal_confirmation.deal_status == :accepted
+          sleep 5
+          print_deal_confirmation @dealing_platform.deal_confirmation(deal_reference)
         end
 
         # Parses and validates a `Date` or `Time` option received as a command-line argument. Raises `ArgumentError` if
@@ -115,21 +121,14 @@ END
           end
         end
 
-        # 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.
-        #
-        # @param [Array<String>] argv The array of command-line arguments.
-        #
-        # @return [void]
-        def bootstrap(argv)
-          config_file.prepend_arguments_to_argv argv
+        private
 
-          if argv.index('--version') || argv.index('-v')
-            puts VERSION
-            exit
-          end
-
-          start argv
+        # Writes the passed message to `stderr` and then exits the application.
+        #
+        # @param [String] message The error message.
+        def error(message)
+          warn message
+          exit 1
         end
 
         # Returns the config file to use for this invocation.
@@ -138,6 +137,21 @@ END
         def config_file
           ConfigFile.find "#{Dir.pwd}/.ig_markets", "#{Dir.home}/.ig_markets"
         end
+
+        # Prints out details of the passed deal confirmation.
+        #
+        # @param [DealConfirmation] deal_confirmation The deal confirmation to print out.
+        #
+        # @return [void]
+        def print_deal_confirmation(deal_confirmation)
+          puts <<-END
+Deal ID: #{deal_confirmation.deal_id}
+Status: #{Format.symbol deal_confirmation.deal_status}
+Result: #{Format.symbol deal_confirmation.status}
+END
+
+          puts "Reason: #{Format.symbol deal_confirmation.reason}" unless deal_confirmation.deal_status == :accepted
+        end
       end
     end
   end

data/lib/ig_markets/client_account_summary.rb

@@ -0,0 +1,41 @@
+module IGMarkets
+  # Contains details on an IG Markets client account summary. Returned by {DealingPlatform#sign_in}.
+  class ClientAccountSummary < Model
+    # Contains details on a form, used by {#form_details}.
+    class FormDetails < Model
+      attribute :form_dismissable, Boolean
+      attribute :form_title
+      attribute :form_type, Symbol, allowed_values: [:bca, :kyc]
+      attribute :form_url
+    end
+
+    # Contains details on an account, used by {#accounts}.
+    class AccountDetails < Model
+      attribute :account_id
+      attribute :account_name
+      attribute :account_type, Symbol, allowed_values: [:cfd, :physical, :spreadbet]
+      attribute :preferred, Boolean
+    end
+
+    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 :client_id
+    attribute :currency_iso_code, String, regex: Regex::CURRENCY
+    attribute :currency_symbol
+    attribute :current_account_id
+    attribute :dealing_enabled, Boolean
+    attribute :encrypted
+    attribute :form_details, FormDetails
+    attribute :has_active_demo_accounts, Boolean
+    attribute :has_active_live_accounts, Boolean
+    attribute :ig_company
+    attribute :lightstreamer_endpoint
+    attribute :rerouting_environment, Symbol, allowed_values: [:demo, :live, :test, :uat]
+    attribute :timezone_offset, Float
+    attribute :trailing_stops_enabled, Boolean
+  end
+end

data/lib/ig_markets/dealing_platform.rb

@@ -56,13 +56,17 @@ module IGMarkets
     # @param [String] password The account password.
     # @param [String] api_key The account API key.
     # @param [:production, :demo] platform The platform to use.
+    #
+    # @return [ClientAccountSummary] The client account summary returned by the sign in request.
     def sign_in(username, password, api_key, platform)
       session.username = username
       session.password = password
       session.api_key = api_key
       session.platform = platform
 
-      session.sign_in
+      result = session.sign_in
+
+      instantiate_models ClientAccountSummary, result
     end
 
     # Signs out of the IG Markets Dealing Platform, ending any current session.

data/lib/ig_markets/dealing_platform/market_methods.rb

@@ -37,9 +37,12 @@ module IGMarkets
           raise ArgumentError, "invalid EPIC: #{epic}" unless epic.to_s =~ Regex::EPIC
         end
 
-        result = @dealing_platform.session.get("markets?epics=#{epics.join(',')}", API_V2).fetch :market_details
+        # The API imposes a maximum of 50 EPICs per request
+        markets = epics.each_slice(50).map do |epics_slice|
+          @dealing_platform.session.get("markets?epics=#{epics_slice.join(',')}", API_V2).fetch :market_details
+        end
 
-        @dealing_platform.instantiate_models Market, result
+        @dealing_platform.instantiate_models Market, markets.flatten
       end
 
       # Searches markets using a search term and returns an array of results.

data/lib/ig_markets/dealing_platform/sprint_market_position_methods.rb

@@ -55,6 +55,8 @@ module IGMarkets
           :one_minute, :two_minutes, :five_minutes, :twenty_minutes, :sixty_minutes]
         attribute :size, Float
       end
+
+      private_constant :SprintMarketPositionCreateAttributes
     end
   end
 end

data/lib/ig_markets/session.rb

@@ -15,26 +15,30 @@ module IGMarkets
     # @return [:demo, :production] The platform variant to log into for this session.
     attr_accessor :platform
 
-    # @return [String] The CST for the currently logged in session, or `nil` if there is no active session.
-    attr_reader :cst
+    # @return [String] The client session security access token for the currently logged in session, or `nil` if there
+    # is no active session.
+    attr_reader :client_security_token
 
-    # @return [String] The security token for the currently logged in session, or `nil` if there is no active session.
+    # @return [String] The account session security access token for the currently logged in session, or `nil` if there
+    # is no active session.
     attr_reader :x_security_token
 
     # Signs in to IG Markets using the values of {#username}, {#password}, {#api_key} and {#platform}. If an error
     # occurs then {RequestFailedError} will be raised.
+    #
+    # @return [Hash] The data returned in the body of the sign in request.
     def sign_in
       validate_authentication
 
       payload = { identifier: username, password: password_encryptor.encrypt(password), encryptedPassword: true }
 
-      sign_in_result = request method: :post, url: 'session', payload: payload, api_version: API_V1
+      sign_in_result = request method: :post, url: 'session', payload: payload, api_version: API_V2
 
       headers = sign_in_result.fetch(:response).headers
-      @cst = headers.fetch :cst
+      @client_security_token = headers.fetch :cst
       @x_security_token = headers.fetch :x_security_token
 
-      nil
+      sign_in_result.fetch :result
     end
 
     # Signs out of IG Markets, ending the current session (if any). If an error occurs then {RequestFailedError} will be
@@ -42,14 +46,14 @@ module IGMarkets
     def sign_out
       delete 'session' if alive?
 
-      @cst = @x_security_token = nil
+      @client_security_token = @x_security_token = nil
     end
 
     # Returns whether this session is currently alive and successfully signed in.
     #
     # @return [Boolean]
     def alive?
-      !cst.nil? && !x_security_token.nil?
+      !client_security_token.nil? && !x_security_token.nil?
     end
 
     # Sends a POST request to the IG Markets API. If an error occurs then {RequestFailedError} will be raised.
@@ -99,7 +103,7 @@ module IGMarkets
     #
     # @return [String]
     def inspect
-      "#<#{self.class.name} #{cst}, #{x_security_token}>"
+      "#<#{self.class.name} #{client_security_token}, #{x_security_token}>"
     end
 
     private
@@ -143,7 +147,7 @@ module IGMarkets
       headers[:'X-IG-API-KEY'] = api_key
       headers[:version] = options.delete :api_version
 
-      headers[:cst] = cst if cst
+      headers[:cst] = client_security_token if client_security_token
       headers[:x_security_token] = x_security_token if x_security_token
 
       headers

data/lib/ig_markets/version.rb

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

data/lib/ig_markets/working_order.rb

@@ -26,11 +26,11 @@ module IGMarkets
     # @return [String] The deal reference of the deletion operation. Use {DealingPlatform#deal_confirmation} to check
     #         the result of the working order deletion.
     def delete
-      @dealing_platform.session.delete("workingorders/otc/#{deal_id}", {}).fetch(:deal_reference)
+      @dealing_platform.session.delete("workingorders/otc/#{deal_id}", nil, API_V2).fetch(:deal_reference)
     end
 
-    # Updates this working order. No attributes are mandatory, and any attributes not specified will be kept at the
-    # current value.
+    # Updates this working order. No attributes are mandatory, and any attributes not specified will be kept at their
+    # current values.
     #
     # @param [Hash] new_attributes The attributes of this working order to update. See
     #        {DealingPlatform::WorkingOrderMethods#create} for a description of the attributes.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-30 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -233,6 +233,7 @@ files:
 - lib/ig_markets/cli/tables/table.rb
 - lib/ig_markets/cli/tables/transactions_table.rb
 - lib/ig_markets/cli/tables/working_orders_table.rb
+- lib/ig_markets/client_account_summary.rb
 - lib/ig_markets/client_sentiment.rb
 - lib/ig_markets/deal_confirmation.rb
 - lib/ig_markets/dealing_platform.rb