ig_markets 0.16 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26ec69035134c7762495091e87dd4794c9aaebdf
-  data.tar.gz: 01373bb017a39473a812c60fa599ee0b4f082ec4
+  metadata.gz: 4c696f25e6b960d65896474cf519c7492f8ad195
+  data.tar.gz: 54dcc2e3caa92373344c3faf7c3a1ea8f916dcf2
 SHA512:
-  metadata.gz: 6bad0ef7b8a20a769177bfbf8bb59454aa11f31c836efb62a8d9b18ce929a5aff7d59b5a2f51691d5f3862daa40bf00110136bc7a9d331336125c73335c96bd8
-  data.tar.gz: ac90eab61abcfa36d8c022f9d89514eee691e49feafd7aecbf579e710ba1880fea613b0d069a1cb5c2a0bd041a1d0d8a01a31186160ebb7f8c29436a0f446e00
+  metadata.gz: 3b0052a80212495c796d6ab5c75188690f259d640fa96982b7c0cb7f7b636014bc43cea9e5102a4bb17e8c07cb0f671d634db469165ab83b002d66d7bdde53b6
+  data.tar.gz: 588dd121edd94b04546afa353802f39ccdde3c972684f17d297d6d2d649baa2cce25968dfc82a6876e06ce7e0e86093236ba4a13720d9db98531a437c057cb17

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # IG Markets Changelog
 
+### 0.17 — July 27, 2016
+
+- Switched to the `excon` HTTP library
+- Replaced `IGMarkets::RequestFailedError` with a new `IGMarkets::IGMarketsError` class which is used as a base class
+  for all errors raised by this gem
+- Added a full set of error subclassses to give more accurate reporting of errors generated by the IG Markets API
+- Documentation improvements
+
 ### 0.16 — July 20, 2016
 
 - Switched to YAML for the `.ig_markets` config files and added support for storing multiple authentication profiles in

data/lib/ig_markets.rb

@@ -1,13 +1,15 @@
 require 'base64'
-require 'colorize'
 require 'date'
 require 'json'
-require 'pry'
-require 'rest-client'
 require 'securerandom'
+require 'time'
+require 'yaml'
+
+require 'colorize'
+require 'excon'
+require 'pry'
 require 'terminal-table'
 require 'thor'
-require 'yaml'
 
 require 'ig_markets/boolean'
 require 'ig_markets/model'
@@ -29,6 +31,7 @@ require 'ig_markets/dealing_platform/position_methods'
 require 'ig_markets/dealing_platform/sprint_market_position_methods'
 require 'ig_markets/dealing_platform/watchlist_methods'
 require 'ig_markets/dealing_platform/working_order_methods'
+require 'ig_markets/errors'
 require 'ig_markets/format'
 require 'ig_markets/instrument'
 require 'ig_markets/historical_price_result'
@@ -38,7 +41,6 @@ require 'ig_markets/market_hierarchy_result'
 require 'ig_markets/password_encryptor'
 require 'ig_markets/payload_formatter'
 require 'ig_markets/position'
-require 'ig_markets/request_failed_error'
 require 'ig_markets/request_printer'
 require 'ig_markets/response_parser'
 require 'ig_markets/session'

data/lib/ig_markets/api_versions.rb

@@ -1,10 +1,16 @@
 module IGMarkets
   # Named constant used to target version 1 of the IG Markets API.
+  #
+  # @private
   API_V1 = 1
 
   # Named constant used to target version 2 of the IG Markets API.
+  #
+  # @private
   API_V2 = 2
 
   # Named constant used to target version 3 of the IG Markets API.
+  #
+  # @private
   API_V3 = 3
 end

data/lib/ig_markets/cli/main.rb

@@ -26,8 +26,6 @@ module IGMarkets
 
       # 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'
@@ -68,10 +66,8 @@ module IGMarkets
           @dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
 
           yield @dealing_platform
-        rescue IGMarkets::RequestFailedError => request_failed_error
-          error "Request error (HTTP #{request_failed_error.http_code}): #{request_failed_error.error}"
-        rescue ArgumentError => argument_error
-          error "Argument error: #{argument_error}"
+        rescue IGMarketsError => error
+          warn_and_exit error
         end
 
         # Requests and displays the deal confirmation for the passed deal reference. If the request for the deal
@@ -86,8 +82,8 @@ module IGMarkets
           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
+            rescue Errors::DealNotFoundError
+              raise if index == 4
 
               puts 'Deal not found, retrying ...'
               sleep 2
@@ -130,30 +126,30 @@ module IGMarkets
           options.each_with_object({}) do |(key, value), new_hash|
             next unless whitelist.include? key.to_sym
 
-            new_hash[key.to_sym] = (value == key) ? nil : value
+            new_hash[key.to_sym] = value == key ? nil : value
           end
         end
 
         private
 
-        # Writes the passed message to `stderr` and then exits the application.
-        #
-        # @param [String] message The error message.
-        def error(message)
-          warn message
+        # Prints the passed error to `stderr` and then exits the application.
+        def warn_and_exit(error)
+          class_name = error.class.name.split('::').last
+
+          message = error.message.to_s
+          message = nil if message.empty? || message == error.class.to_s
+
+          warn ["IG Markets: #{class_name}", message].compact.join(', ')
+
           exit 1
         end
 
         # Returns the config file to use for this invocation.
-        #
-        # @return [ConfigFile]
         def config_file
           ConfigFile.find "#{Dir.pwd}/.ig_markets.yml", "#{Dir.home}/.ig_markets.yml"
         end
 
         # Prints out details of the passed deal confirmation.
-        #
-        # @param [DealConfirmation] deal_confirmation The deal confirmation to print out.
         def print_deal_confirmation(deal_confirmation)
           puts <<-END
 Deal ID: #{deal_confirmation.deal_id}
@@ -167,8 +163,6 @@ END
         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
 

data/lib/ig_markets/dealing_platform.rb

@@ -12,33 +12,51 @@ module IGMarkets
   #
   # See `README.md` for examples.
   #
-  # If any errors occur while executing requests to the IG Markets API then {RequestFailedError} will be raised.
+  # If any errors occur while executing requests to the IG Markets API then an {IGMarketsError} will be raised.
   class DealingPlatform
-    # @return [Session] The session used by this dealing platform.
+    # The session used by this dealing platform.
+    #
+    # @return [Session]
     attr_reader :session
 
-    # @return [ClientAccountSummary] The summary of the client account that is returned as part of a successful sign in.
+    # The summary of the client account that is returned as part of a successful sign in.
+    #
+    # @return [ClientAccountSummary]
     attr_reader :client_account_summary
 
-    # @return [AccountMethods] Methods for working with the logged in account.
+    # Methods for working with the logged in account.
+    #
+    # @return [AccountMethods]
     attr_reader :account
 
-    # @return [ClientSentimentMethods] Methods for working with client sentiment.
+    # Methods for working with client sentiment.
+    #
+    # @return [ClientSentimentMethods]
     attr_reader :client_sentiment
 
-    # @return [MarketMethods] Methods for working with markets.
+    # Methods for working with markets.
+    #
+    # @return [MarketMethods]
     attr_reader :markets
 
-    # @return [PositionMethods] Methods for working with positions.
+    # Methods for working with positions.
+    #
+    # @return [PositionMethods]
     attr_reader :positions
 
-    # @return [SprintMarketPositionMethods] Methods for working with sprint market positions.
+    # Methods for working with sprint market positions.
+    #
+    # @return [SprintMarketPositionMethods]
     attr_reader :sprint_market_positions
 
-    # @return [WatchlistMethods] Methods for working with watchlists.
+    # Methods for working with watchlists.
+    #
+    # @return [WatchlistMethods]
     attr_reader :watchlists
 
-    # @return [WorkingOrderMethods] Methods for working with working orders.
+    # Methods for working with working orders.
+    #
+    # @return [WorkingOrderMethods]
     attr_reader :working_orders
 
     def initialize

data/lib/ig_markets/errors.rb

@@ -0,0 +1,323 @@
+module IGMarkets
+  # Base class for all errors raised by this gem.
+  class IGMarketsError < StandardError
+  end
+
+  # This module contains all the error classes for this gem. They all subclass {IGMarketsError}.
+  module Errors
+    # This error is raised when the specified account is invalid.
+    class InvalidClientAccountError < IGMarketsError
+    end
+
+    # This error is raised when the API key can't be used for this endpoint.
+    class APIKeyRejectedError < IGMarketsError
+    end
+
+    # This error is raised when a specified deal can't be found.
+    class DealNotFoundError < IGMarketsError
+    end
+
+    # This error is raised when an invalid date range is specified.
+    class InvalidDateRangeError < IGMarketsError
+    end
+
+    # This error is raised when an invalid watchlist name is specified.
+    class InvalidWatchlistError < IGMarketsError
+    end
+
+    # This error is raised when a malformed date is specified.
+    class MalformedDateError < IGMarketsError
+    end
+
+    # This error is raised when a specified position can't be found.
+    class PositionNotFoundError < IGMarketsError
+    end
+
+    # This error is raised when a generic position error occurs.
+    class PositionError < IGMarketsError
+    end
+
+    # This error is raised when a specified EPIC can't be found.
+    class EPICNotFoundError < IGMarketsError
+    end
+
+    # This error is raised when the account's traffic allowance is exceeded.
+    class ExceededAccountAllowanceError < IGMarketsError
+    end
+
+    # This error is raised when the account's historical data allowance is exceeded.
+    class ExceededAccountHistoricalDataAllowanceError < IGMarketsError
+    end
+
+    # This error is raised when the account's trading allowance is exceeded.
+    class ExceededAccountTradingAllowanceError < IGMarketsError
+    end
+
+    # This error is raised when the API key's allowance is exceeded.
+    class ExceededAPIKeyAllowanceError < IGMarketsError
+    end
+
+    # This error is raised when trying to login with an unencrypted password to a server that requires encryption.
+    class EncryptionRequiredError < IGMarketsError
+    end
+
+    # This error is raised when required KYC (Know Your Client) authorization for this account is incomplete.
+    class KYCRequiredForAccountError < IGMarketsError
+    end
+
+    # This error is raised when relevant credentials are not supplied.
+    class MissingCredentialsError < IGMarketsError
+    end
+
+    # This error is raised when the account has pending agreements that must be agreed to before using the account.
+    class PendingAgreementsError < IGMarketsError
+    end
+
+    # This error is raised when the preferred account is disabled.
+    class PreferredAccountDisabledError < IGMarketsError
+    end
+
+    # This error is raised when the preferred account is not set.
+    class PreferredAccountNotSetError < IGMarketsError
+    end
+
+    # This error is raised when stockbroking is not supported.
+    class StockbrokingNotSupportedError < IGMarketsError
+    end
+
+    # This error is raised when too many EPICs are specified for a request.
+    class TooManyEPICSError < IGMarketsError
+    end
+
+    # This error is raised when the account has been denied login privileges.
+    class AccountAccessDeniedError < IGMarketsError
+    end
+
+    # This error is raised when the account has been migrated to the client-account model and should be authenticated
+    # with the relevant client credentials.
+    class AccountMigratedError < IGMarketsError
+    end
+
+    # This error is raised when the account has not yet been activated.
+    class AccountNotYetActivatedError < IGMarketsError
+    end
+
+    # This error is raised when the the account has been suspended.
+    class AccountSuspendedError < IGMarketsError
+    end
+
+    # This error is raised when the service requires an account token but the one given was invalid.
+    class AccountTokenInvalidError < IGMarketsError
+    end
+
+    # This error is raised when the service requires an account token but none was specified.
+    class AccountTokenMissingError < IGMarketsError
+    end
+
+    # This error is raised when all accounts are in the 'pending' state.
+    class AllAccountsPendingError < IGMarketsError
+    end
+
+    # This error is raised when all accounts are in the 'suspended' state.
+    class AllAccountsSuspendedError < IGMarketsError
+    end
+
+    # This error is raised when the specified API key is not enabled.
+    class APIKeyDisabledError < IGMarketsError
+    end
+
+    # This error is raised when the specified API key is invalid.
+    class APIKeyInvalidError < IGMarketsError
+    end
+
+    # This error is raised when no API key was specified.
+    class APIKeyMissingError < IGMarketsError
+    end
+
+    # This error is raised when the specified API key is not valid for the requested account.
+    class APIKeyRestrictedError < IGMarketsError
+    end
+
+    # This error is raised when the specified API key has been revoked.
+    class APIKeyRevokedError < IGMarketsError
+    end
+
+    # This error is raised when the client has been suspended from using the platform.
+    class ClientSuspendedError < IGMarketsError
+    end
+
+    # This error is raised when the specified client token is invalid.
+    class ClientTokenInvalidError < IGMarketsError
+    end
+
+    # This error is raised when no client token was specified.
+    class ClientTokenMissingError < IGMarketsError
+    end
+
+    # This error is raised when there is a generic security error.
+    class SecurityError < IGMarketsError
+    end
+
+    # This error is raised when the provided user agent string is not valid.
+    class InvalidApplicationError < IGMarketsError
+    end
+
+    # This error is raised when the specified user credentials are not valid.
+    class InvalidCredentialsError < IGMarketsError
+    end
+
+    # This error is raised when the requested site is not accessible through the API.
+    class InvalidWebsiteError < IGMarketsError
+    end
+
+    # This error is raised when there have been too many failed login attempts.
+    class TooManyFailedLoginAttemptsError < IGMarketsError
+    end
+
+    # This error is raised when an invalid EPIC was used when interacting with a watchlist.
+    class WatchlistInvalidEPICError < IGMarketsError
+    end
+
+    # This error is raised when trying to set the current account to the current account.
+    class AccountAlreadyCurrentError < IGMarketsError
+    end
+
+    # This error is raised when setting the default account is not allowed.
+    class CannotSetDefaultAccountError < IGMarketsError
+    end
+
+    # This error is raised when an invalid account ID was specified.
+    class InvalidAccountIDError < IGMarketsError
+    end
+
+    # This error is raised when an unsupported EPIC was specified.
+    class UnsupportedEPICError < IGMarketsError
+    end
+
+    # This error is raised when trying to delete a watchlist that can't be deleted.
+    class CannotDeleteWatchlistError < IGMarketsError
+    end
+
+    # This error is raised when trying to set two watchlists to have the same name.
+    class DuplicateWatchlistNameError < IGMarketsError
+    end
+
+    # This error is raised when a generic watchlist error occurs.
+    class WatchlistError < IGMarketsError
+    end
+
+    # This error is raised when the specified watchlist could not be found.
+    class WatchlistNotFoundError < IGMarketsError
+    end
+
+    # This error is raised when invalid input was supplied.
+    class InvalidInputError < IGMarketsError
+    end
+
+    # This error is raised when an invalid URL was specified.
+    class InvalidURLError < IGMarketsError
+    end
+
+    # This error is raised when a generic system error occurs.
+    class SystemError < IGMarketsError
+    end
+
+    # This error is raised when trying attempting unauthorised access to an equity.
+    class UnauthorisedAccessToEquityError < IGMarketsError
+    end
+
+    # This error is raised when the specified API key is not valid for the client.
+    class InvalidAPIKeyForClientError < IGMarketsError
+    end
+
+    # This error is raised when invalid JSON is returned by the IG Markets API.
+    class InvalidJSONError < IGMarketsError
+    end
+
+    # This error is raised when an HTTP connection error occurs.
+    class ConnectionError < IGMarketsError
+    end
+  end
+
+  # Base class for all errors raised by this gem.
+  class IGMarketsError
+    # Takes an IG Markets error code and returns an instance of the relevant error class that should be raised in
+    # response to the error.
+    #
+    # @param [String] error_code The error code.
+    #
+    # @return [LightstreamerError]
+    #
+    # @private
+    def self.build(error_code)
+      if API_ERROR_CODE_TO_CLASS.key? error_code
+        API_ERROR_CODE_TO_CLASS[error_code].new ''
+      else
+        new error_code
+      end
+    end
+
+    API_ERROR_CODE_TO_CLASS = {
+      'authentication.failure.not-a-client-account' => Errors::InvalidClientAccountError,
+      'endpoint.unavailable.for.api-key' => Errors::APIKeyRejectedError,
+      'error.confirms.deal-not-found' => Errors::DealNotFoundError,
+      'error.invalid.daterange' => Errors::InvalidDateRangeError,
+      'error.invalid.watchlist' => Errors::InvalidWatchlistError,
+      'error.malformed.date' => Errors::MalformedDateError,
+      'error.position.notfound' => Errors::PositionNotFoundError,
+      'error.positions.generic' => Errors::PositionError,
+      'error.public-api.epic-not-found' => Errors::EPICNotFoundError,
+      'error.public-api.exceeded-account-allowance' => Errors::ExceededAccountAllowanceError,
+      'error.public-api.exceeded-account-historical-data-allowance' =>
+        Errors::ExceededAccountHistoricalDataAllowanceError,
+      'error.public-api.exceeded-account-trading-allowance' => Errors::ExceededAccountTradingAllowanceError,
+      'error.public-api.exceeded-api-key-allowance' => Errors::ExceededAPIKeyAllowanceError,
+      'error.public-api.failure.encryption.required' => Errors::EncryptionRequiredError,
+      'error.public-api.failure.kyc.required' => Errors::KYCRequiredForAccountError,
+      'error.public-api.failure.missing.credentials' => Errors::MissingCredentialsError,
+      'error.public-api.failure.pending.agreements.required' => Errors::PendingAgreementsError,
+      'error.public-api.failure.preferred.account.disabled' => Errors::PreferredAccountDisabledError,
+      'error.public-api.failure.preferred.account.not.set' => Errors::PreferredAccountNotSetError,
+      'error.public-api.failure.stockbroking-not-supported' => Errors::StockbrokingNotSupportedError,
+      'error.public-api.too-many-epics' => Errors::TooManyEPICSError,
+      'error.security.account-access-denied' => Errors::AccountAccessDeniedError,
+      'error.security.account-migrated' => Errors::AccountMigratedError,
+      'error.security.account-not-yet-activated' => Errors::AccountNotYetActivatedError,
+      'error.security.account-suspended' => Errors::AccountSuspendedError,
+      'error.security.account-token-invalid' => Errors::AccountTokenInvalidError,
+      'error.security.account-token-missing' => Errors::AccountTokenMissingError,
+      'error.security.all-accounts-pending' => Errors::AllAccountsPendingError,
+      'error.security.all-accounts-suspended' => Errors::AllAccountsSuspendedError,
+      'error.security.api-key-disabled' => Errors::APIKeyDisabledError,
+      'error.security.api-key-invalid' => Errors::APIKeyInvalidError,
+      'error.security.api-key-missing' => Errors::APIKeyMissingError,
+      'error.security.api-key-restricted' => Errors::APIKeyRestrictedError,
+      'error.security.api-key-revoked' => Errors::APIKeyRevokedError,
+      'error.security.client-suspended' => Errors::ClientSuspendedError,
+      'error.security.client-token-invalid' => Errors::ClientTokenInvalidError,
+      'error.security.client-token-missing' => Errors::ClientTokenMissingError,
+      'error.security.generic' => Errors::SecurityError,
+      'error.security.invalid-application' => Errors::InvalidApplicationError,
+      'error.security.invalid-details' => Errors::InvalidCredentialsError,
+      'error.security.invalid-website' => Errors::InvalidWebsiteError,
+      'error.security.too-many-failed-attempts' => Errors::TooManyFailedLoginAttemptsError,
+      'error.service.watchlists.add-instrument.invalid-epic' => Errors::WatchlistInvalidEPICError,
+      'error.switch.accountId-must-be-different' => Errors::AccountAlreadyCurrentError,
+      'error.switch.cannot-set-default-account' => Errors::CannotSetDefaultAccountError,
+      'error.switch.invalid-accountId' => Errors::InvalidAccountIDError,
+      'error.unsupported.epic' => Errors::UnsupportedEPICError,
+      'error.watchlists.management.cannot-delete-watchlist' => Errors::CannotDeleteWatchlistError,
+      'error.watchlists.management.duplicate-name' => Errors::DuplicateWatchlistNameError,
+      'error.watchlists.management.error' => Errors::WatchlistError,
+      'error.watchlists.management.watchlist-not-found' => Errors::WatchlistNotFoundError,
+      'invalid.input' => Errors::InvalidInputError,
+      'invalid.url' => Errors::InvalidURLError,
+      'system.error' => Errors::SystemError,
+      'unauthorised.access.to.equity.exception' => Errors::UnauthorisedAccessToEquityError,
+      'unauthorised.api-key.revoked' => Errors::APIKeyRevokedError,
+      'unauthorised.clientId.api-key.mismatch' => Errors::InvalidAPIKeyForClientError
+    }.freeze
+
+    private_constant :API_ERROR_CODE_TO_CLASS
+  end
+end

data/lib/ig_markets/format.rb

@@ -1,5 +1,7 @@
 module IGMarkets
   # This module contains shared methods for formatting different content types for display.
+  #
+  # @private
   module Format
     module_function
 

data/lib/ig_markets/model.rb

@@ -3,7 +3,9 @@ module IGMarkets
   # attribute is defined by a call to {attribute}. Attributes have standard getter and setter methods and can also
   # be subject to a variety of constraints and validations, see {attribute} for further details.
   class Model
-    # @return [Hash] The current attribute values set on this model.
+    # The current attribute values set on this model.
+    #
+    # @return [Hash]
     attr_reader :attributes
 
     # Initializes this new model with the given attribute values. Attributes not known to this model will raise
@@ -74,10 +76,14 @@ module IGMarkets
     end
 
     class << self
-      # @return [Hash] A hash containing details of all attributes that have been defined on this model.
+      # A hash containing details of all attributes that have been defined on this model.
+      #
+      # @return [Hash]
       attr_accessor :defined_attributes
 
-      # @return [Array] The names of the deprecated attributes on this model.
+      # The names of the deprecated attributes on this model.
+      #
+      # @return [Array]
       attr_accessor :deprecated_attributes
 
       # Returns the names of all currently defined attributes for this model.

data/lib/ig_markets/password_encryptor.rb

@@ -1,10 +1,16 @@
 module IGMarkets
   # Encrypts account passwords in the manner required for authentication with the IG Markets API.
+  #
+  # @private
   class PasswordEncryptor
-    # @return [OpenSSL::PKey::RSA] The public key used by {#encrypt}, can also be set using {#encoded_public_key=}.
+    # The public key used by {#encrypt}, can also be set using {#encoded_public_key=}.
+    #
+    # @return [OpenSSL::PKey::RSA]
     attr_accessor :public_key
 
-    # @return [String] The time stamp used by {#encrypt}.
+    # The time stamp used by {#encrypt}.
+    #
+    # @return [String]
     attr_accessor :time_stamp
 
     # Initializes this password encryptor with the specified encoded public key and timestamp.

data/lib/ig_markets/payload_formatter.rb

@@ -1,5 +1,7 @@
 module IGMarkets
   # Contains methods for formatting payloads that can be passed to the IG Markets API.
+  #
+  # @private
   module PayloadFormatter
     module_function
 

data/lib/ig_markets/regex.rb

@@ -1,5 +1,7 @@
 module IGMarkets
   # Contains regex's for validating specific types of strings.
+  #
+  # @private
   module Regex
     # Regex used to validate an ISO currency code.
     CURRENCY = /\A[A-Z]{3}\Z/

data/lib/ig_markets/request_printer.rb

@@ -1,9 +1,13 @@
 module IGMarkets
   # This class contains methods for printing a REST request and its JSON response for inspection and debugging.
   # Request printing is enabled by setting {enabled} to `true`.
+  #
+  # @private
   class RequestPrinter
     class << self
-      # @return [Boolean] Whether the request printer is enabled.
+      # Whether the request printer is enabled.
+      #
+      # @return [Boolean]
       attr_accessor :enabled
 
       # Prints out an options hash that is ready to be passed to `RestClient::Request.execute`.

data/lib/ig_markets/response_parser.rb

@@ -1,25 +1,16 @@
 module IGMarkets
   # Contains methods for parsing responses received from the IG Markets API.
+  #
+  # @private
   module ResponseParser
     module_function
 
-    # Parses the passed JSON string and then passes it on to {parse}. If `json` is not valid JSON then `{}` is returned.
-    #
-    # @param [String] json The JSON string.
-    #
-    # @return [Hash]
-    def parse_json(json)
-      parse JSON.parse(json)
-    rescue JSON::ParserError
-      {}
-    end
-
     # Parses the specified value that was returned from a call to the IG Markets API.
     #
-    # @param [Hash, Array, Object] response The response or part of a reponse that should be parsed. If this is of type
+    # @param [Hash, Array, Object] response The response or part of a response that should be parsed. If this is of type
     #        `Hash` then all hash keys will converted from camel case into snake case and their values each to parsed
-    #        individually by a recursive call. If this is of type `Array` then each item will be parsed indidiaully by a
-    #        recursive call. All other types are passed through unchanged.
+    #        individually by a recursive call. If this is of type `Array` then each item will be parsed individually by
+    #        a recursive call. All other types are passed through unchanged.
     #
     # @return [Hash, Array, Object] The parsed object, the type depends on the type of the `response` parameter.
     def parse(response)

data/lib/ig_markets/session.rb

@@ -3,45 +3,55 @@ module IGMarkets
   # In order to sign in, {#username}, {#password}, {#api_key} and {#platform} must be set. {#platform} must be
   # either `:demo` or `:live` depending on which platform is being targeted.
   class Session
-    # @return [String] The username to use to authenticate this session.
+    # The username to use to authenticate this session.
+    #
+    # @return [String]
     attr_accessor :username
 
-    # @return [String] The password to use to authenticate this session.
+    # The password to use to authenticate this session.
+    #
+    # @return [String]
     attr_accessor :password
 
-    # @return [String] The API key to use to authenticate this session.
+    # The API key to use to authenticate this session.
+    #
+    # @return [String]
     attr_accessor :api_key
 
-    # @return [:demo, :live] The platform variant to log into for this session.
+    # The platform variant to log into for this session.
+    #
+    # @return [:demo, :live]
     attr_accessor :platform
 
-    # @return [String] The client session security access token for the currently logged in session, or `nil` if there
-    # is no active session.
+    # The client session security access token for the currently logged in session, or `nil` if there is no active
+    # session.
+    #
+    # @return [String]
     attr_reader :client_security_token
 
-    # @return [String] The account session security access token for the currently logged in session, or `nil` if there
-    # is no active session.
+    # The account session security access token for the currently logged in session, or `nil` if there is no active
+    # session.
+    #
+    # @return [String]
     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.
+    # occurs then an {IGMarketsError} will be raised.
     #
     # @return [Hash] The data returned in the body of the sign in request.
     def sign_in
-      validate_authentication
+      body = { identifier: username, password: password_encryptor.encrypt(password), encryptedPassword: true }
 
-      payload = { identifier: username, password: password_encryptor.encrypt(password), encryptedPassword: true }
-
-      sign_in_result = request method: :post, url: 'session', payload: payload, api_version: API_V2
+      sign_in_result = request method: :post, url: 'session', body: body, api_version: API_V2
 
       headers = sign_in_result.fetch(:response).headers
-      @client_security_token = headers.fetch :cst
-      @x_security_token = headers.fetch :x_security_token
+      @client_security_token = headers.fetch 'CST'
+      @x_security_token = headers.fetch 'X-SECURITY-TOKEN'
 
-      sign_in_result.fetch :result
+      sign_in_result.fetch :body
     end
 
-    # Signs out of IG Markets, ending the current session (if any). If an error occurs then {RequestFailedError} will be
+    # Signs out of IG Markets, ending the current session (if any). If an error occurs then an {IGMarketsError} will be
     # raised.
     def sign_out
       delete 'session' if alive?
@@ -56,61 +66,53 @@ module IGMarkets
       !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.
+    # Sends a POST request to the IG Markets API. If an error occurs then an {IGMarketsError} will be raised.
     #
     # @param [String] url The URL to send the POST request to.
-    # @param [nil, String, Hash] payload The payload to include with the POST request, this will be encoded as JSON.
+    # @param [Hash, nil] body The body to include with the POST request, this will be encoded as JSON.
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
-    def post(url, payload, api_version = API_V1)
-      request(method: :post, url: url, payload: payload, api_version: api_version).fetch :result
+    def post(url, body, api_version = API_V1)
+      request(method: :post, url: url, body: body, api_version: api_version).fetch :body
     end
 
-    # Sends a GET request to the IG Markets API. If an error occurs then {RequestFailedError} will be raised.
+    # Sends a GET request to the IG Markets API. If an error occurs then an {IGMarketsError} will be raised.
     #
     # @param [String] url The URL to send the GET request to.
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
     def get(url, api_version = API_V1)
-      request(method: :get, url: url, api_version: api_version).fetch :result
+      request(method: :get, url: url, api_version: api_version).fetch :body
     end
 
-    # Sends a PUT request to the IG Markets API. If an error occurs then {RequestFailedError} will be raised.
+    # Sends a PUT request to the IG Markets API. If an error occurs then an {IGMarketsError} will be raised.
     #
     # @param [String] url The URL to send the PUT request to.
-    # @param [nil, String, Hash] payload The payload to include with the PUT request, this will be encoded as JSON.
+    # @param [Hash, nil] body The body to include with the PUT request, this will be encoded as JSON.
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
-    def put(url, payload = nil, api_version = API_V1)
-      request(method: :put, url: url, payload: payload, api_version: api_version).fetch :result
+    def put(url, body = nil, api_version = API_V1)
+      request(method: :put, url: url, body: body, api_version: api_version).fetch :body
     end
 
-    # Sends a DELETE request to the IG Markets API. If an error occurs then {RequestFailedError} will be raised.
+    # Sends a DELETE request to the IG Markets API. If an error occurs then an {IGMarketsError} will be raised.
     #
     # @param [String] url The URL to send the DELETE request to.
-    # @param [nil, String, Hash] payload The payload to include with the DELETE request, this will be encoded as JSON.
+    # @param [Hash, nil] body The body to include with the DELETE request, this will be encoded as JSON.
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
-    def delete(url, payload = nil, api_version = API_V1)
-      request(method: :delete, url: url, payload: payload, api_version: api_version).fetch :result
+    def delete(url, body = nil, api_version = API_V1)
+      request(method: :delete, url: url, body: body, api_version: api_version).fetch :body
     end
 
     private
 
     HOST_URLS = { demo: 'https://demo-api.ig.com/gateway/deal/', live: 'https://api.ig.com/gateway/deal/' }.freeze
 
-    def validate_authentication
-      %i(username password api_key).each do |attribute|
-        raise ArgumentError, "#{attribute} is not set" if send(attribute).to_s.empty?
-      end
-
-      raise ArgumentError, 'platform is invalid' unless HOST_URLS.key? platform
-    end
-
     def password_encryptor
       result = get 'session/encryptionKey'
 
@@ -120,76 +122,73 @@ module IGMarkets
     def request(options)
       options[:url] = "#{HOST_URLS.fetch(platform)}#{URI.escape(options[:url])}"
       options[:headers] = request_headers(options)
-      options[:payload] = options[:payload] && options[:payload].to_json
-
-      RequestPrinter.print_options options
-
-      response = execute_request options
 
-      RequestPrinter.print_response_body response.body
+      # The IG Markets API requires that DELETE requests with a body are sent as POST requests with a special header
+      if options[:method] == :delete && options[:body]
+        options[:headers]['_method'] = 'DELETE'
+        options[:method] = :post
+      end
 
-      result = process_response response
+      options[:body] = options[:body] && options[:body].to_json
 
-      { response: response, result: result }
+      execute_request options
     end
 
     def request_headers(options)
       headers = {}
 
-      headers[:content_type] = headers[:accept] = 'application/json; charset=UTF-8'
-      headers[:'X-IG-API-KEY'] = api_key
-      headers[:version] = options.delete :api_version
+      headers['Content-Type'] = headers['Accept'] = 'application/json; charset=UTF-8'
+      headers['X-IG-API-KEY'] = api_key
+      headers['Version'] = options.delete :api_version
 
-      headers[:cst] = client_security_token if client_security_token
-      headers[:x_security_token] = x_security_token if x_security_token
+      headers['CST'] = client_security_token if client_security_token
+      headers['X-SECURITY-TOKEN'] = x_security_token if x_security_token
 
       headers
     end
 
-    def use_post_for_delete_with_payload(options)
-      if options[:method] == :delete && options[:payload]
-        options[:headers]['_method'] = :delete
-        options[:method] = :post
-      end
-    end
-
     def execute_request(options)
-      use_post_for_delete_with_payload options
+      RequestPrinter.print_options options
 
-      RestClient::Request.execute options
-    rescue RestClient::Exception => exception
-      raise RequestFailedError, exception.message unless exception.response
+      response = Excon.send options[:method], options[:url], headers: options[:headers], body: options[:body]
 
-      return exception.response unless should_retry_request? exception.response, options
+      RequestPrinter.print_response_body response.body
 
-      execute_request options.merge(retry: true)
-    rescue SocketError => socket_error
-      raise RequestFailedError, socket_error
+      process_response response, options
+    rescue Excon::Error => error
+      raise Errors::ConnectionError, error.message
     end
 
-    def should_retry_request?(response, options)
-      error_code = ResponseParser.parse_json(response.body)[:error_code]
+    def process_response(response, options)
+      body = parse_body response
 
-      if error_code == 'error.security.client-token-invalid' && !options[:retry]
-        sign_in
-        return true
-      end
+      if body.key? :error_code
+        error = IGMarketsError.build body[:error_code]
 
-      if error_code =~ /^error\.public-api\.exceeded-(api-key|account)-allowance/
-        sleep 5
-        return true
-      end
+        raise error unless should_retry_request? error, options
 
-      false
+        execute_request options.merge(retry: true)
+      else
+        { response: response, body: body }
+      end
     end
 
-    def process_response(response)
-      result = ResponseParser.parse_json response.body
-      http_code = response.code
+    def parse_body(response)
+      return {} if response.body == ''
 
-      raise RequestFailedError.new(result[:error_code], http_code) unless http_code >= 200 && http_code < 300
+      ResponseParser.parse JSON.parse(response.body)
+    rescue JSON::ParserError
+      raise Errors::InvalidJSONError, response.body
+    end
 
-      result
+    def should_retry_request?(error, options)
+      if error.is_a?(Errors::ClientTokenInvalidError) && !options[:retry]
+        sign_in
+        true
+      elsif error.is_a?(Errors::ExceededAPIKeyAllowanceError) || error.is_a?(Errors::ExceededAccountAllowanceError)
+        sleep 5
+        true
+      end
     end
   end
 end

data/lib/ig_markets/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.16'
+  version: '0.17'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '0.51'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '0.51'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0.42'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0.42'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -263,6 +263,7 @@ files:
 - lib/ig_markets/dealing_platform/sprint_market_position_methods.rb
 - lib/ig_markets/dealing_platform/watchlist_methods.rb
 - lib/ig_markets/dealing_platform/working_order_methods.rb
+- lib/ig_markets/errors.rb
 - lib/ig_markets/format.rb
 - lib/ig_markets/historical_price_result.rb
 - lib/ig_markets/instrument.rb
@@ -275,7 +276,6 @@ files:
 - lib/ig_markets/payload_formatter.rb
 - lib/ig_markets/position.rb
 - lib/ig_markets/regex.rb
-- lib/ig_markets/request_failed_error.rb
 - lib/ig_markets/request_printer.rb
 - lib/ig_markets/response_parser.rb
 - lib/ig_markets/session.rb
@@ -307,6 +307,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Ruby library and command-line client for accessing the IG Markets dealing
-  platform.
+summary: Library and command-line client for accessing the IG Markets dealing platform.
 test_files: []

data/lib/ig_markets/request_failed_error.rb

@@ -1,21 +0,0 @@
-module IGMarkets
-  # This error class is raised by {Session} when a request to the IG Markets API fails.
-  class RequestFailedError < StandardError
-    # @return [String] A description of the error that occurred when the request was attempted.
-    attr_reader :error
-
-    # @return [Fixnum] The HTTP code that was returned, or `nil` if unknown.
-    attr_reader :http_code
-
-    # Initializes this request failure error with a message and an HTTP code.
-    #
-    # @param [String] error The error description.
-    # @param [Integer] http_code The HTTP code for the request failure, if known.
-    def initialize(error, http_code = nil)
-      @error = error.to_s
-      @http_code = http_code ? http_code.to_i : nil
-
-      super "#<#{self.class.name} error: #{@error}#{http_code ? ", http_code: #{http_code}" : ''}>"
-    end
-  end
-end