ig_markets 0.20 → 0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0873a06d085af3287d3497f41a7157710216995
-  data.tar.gz: 4606f5cc0084f0092ab1f53361ae3c2ff11f4804
+  metadata.gz: f39c3b7d7b0f7a66c1de890bc6fc9514c97d009f
+  data.tar.gz: 53029d58d12ef0b11863339bd84a5833f3165bee
 SHA512:
-  metadata.gz: db11c11960641e5f468b5765e3e790bce4540c3e2f6e468e29ba0b80fda70e7bd3aab20cdcae5e37f3c86fd2a26a59afc39dde7d22ece0ab8abf9524c254acea
-  data.tar.gz: 6d27114ba6ba7811f767a022643f176bc77ad69d669c8e81b2637c82b321a611cb355bcf4b91bd3e8b0ca30fc4899705b4bb5d8902807b58e4bac96c654b9632
+  metadata.gz: dbf8fc12c117a245f89d44d0731c446f9363403763edae0023ac6416f16bad20bb566a12b593b80f8425a6b9b92c48219c5155aff4aee8c0d9cf34e5f0c834c0
+  data.tar.gz: 89abaf288cc72eb6d96039765c09f3eb34912290c6faa3124ec874117c6285755b343586b3f3f389c632a4864306cd2c290ee8af56fb77cfed8e1917efd061ce

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # IG Markets Changelog
 
+### 0.21 — September 29, 2016
+
+- Replaced `IGMarkets::Streaming::AccountState#data_to_process?` with
+  `IGMarkets::Streaming::AccountState#data_queue_empty?`
+- Fixed circular references in the `IGMarkets::DealingPlatform` subclasses
+- All documented IG Markets API errors now have a matching `IGMarkets::IGMarketsError` subclass, and any unrecognized
+  error codes returned by the API cause a warning to be written to `stderr`
+
 ### 0.20 — August 20, 2016
 
 - Added `IGMarkets::DealingPlatform#streaming` which along with new classes in the `IGMarkets::Streaming` module

data/lib/ig_markets/dealing_platform/account_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
       end
 
       # Returns all accounts associated with the current IG Markets login.

data/lib/ig_markets/dealing_platform/client_sentiment_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
       end
 
       # Returns the client sentiment for a market.

data/lib/ig_markets/dealing_platform/market_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
       end
 
       # Returns details on the market hierarchy directly under the specified node.

data/lib/ig_markets/dealing_platform/position_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
       end
 
       # Returns all positions.

data/lib/ig_markets/dealing_platform/sprint_market_position_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
       end
 
       # Returns all sprint market positions.

data/lib/ig_markets/dealing_platform/streaming_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
         @queue = Queue.new
         @on_error_callbacks = []
       end

data/lib/ig_markets/dealing_platform/watchlist_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
       end
 
       # Returns all watchlists.

data/lib/ig_markets/dealing_platform/working_order_methods.rb

@@ -6,7 +6,7 @@ module IGMarkets
       #
       # @param [DealingPlatform] dealing_platform The dealing platform.
       def initialize(dealing_platform)
-        @dealing_platform = dealing_platform
+        @dealing_platform = WeakRef.new dealing_platform
       end
 
       # Returns all working orders.

data/lib/ig_markets/errors.rb

@@ -89,6 +89,10 @@ module IGMarkets
     class TooManyEPICSError < IGMarketsError
     end
 
+    # This error is raised when an invalid page size is specified.
+    class InvalidPageSizeError < IGMarketsError
+    end
+
     # This error is raised when the account has been denied login privileges.
     class AccountAccessDeniedError < IGMarketsError
     end
@@ -142,6 +146,10 @@ module IGMarkets
     class APIKeyRevokedError < IGMarketsError
     end
 
+    # This error is raised when a timeout occurs during authentication.
+    class AuthenticationTimeoutError < IGMarketsError
+    end
+
     # This error is raised when the client has been suspended from using the platform.
     class ClientSuspendedError < IGMarketsError
     end
@@ -170,6 +178,10 @@ module IGMarkets
     class InvalidWebsiteError < IGMarketsError
     end
 
+    # This error is raised when an invalid OAuth access token is encountered.
+    class OAuthTokenInvalidError < IGMarketsError
+    end
+
     # This error is raised when there have been too many failed login attempts.
     class TooManyFailedLoginAttemptsError < IGMarketsError
     end
@@ -178,6 +190,22 @@ module IGMarkets
     class WatchlistInvalidEPICError < IGMarketsError
     end
 
+    # This error is raised when the expiry period of the sprint market position is invalid.
+    class SprintMarketPositionInvalidExpiryError < IGMarketsError
+    end
+
+    # This error is raised when an unspecified error occurs trying to create a sprint market position.
+    class SprintMarketPositionCreateError < IGMarketsError
+    end
+
+    # This error is raised when the expiry time of a sprint market falls outside market trading hours.
+    class SprintMarketClosedError < IGMarketsError
+    end
+
+    # This error is raised when a sprint market position's order size is invalid.
+    class SprintMarketInvalidOrderSizeError < IGMarketsError
+    end
+
     # This error is raised when trying to set the current account to the current account.
     class AccountAlreadyCurrentError < IGMarketsError
     end
@@ -190,6 +218,10 @@ module IGMarkets
     class InvalidAccountIDError < IGMarketsError
     end
 
+    # This error is raised when a specified instrument is not found.
+    class InstrumentNotFoundError < IGMarketsError
+    end
+
     # This error is raised when an unsupported EPIC was specified.
     class UnsupportedEPICError < IGMarketsError
     end
@@ -246,13 +278,20 @@ module IGMarkets
     #
     # @param [String] error_code The error code.
     #
-    # @return [LightstreamerError]
+    # @return [IGMarketsError]
     #
     # @private
     def self.build(error_code)
       if API_ERROR_CODE_TO_CLASS.key? error_code
         API_ERROR_CODE_TO_CLASS[error_code].new ''
       else
+        @reported_unrecognized_error_codes ||= []
+
+        unless @reported_unrecognized_error_codes.include? error_code
+          @reported_unrecognized_error_codes << error_code
+          warn "ig_markets: unrecognized error code #{error_code}"
+        end
+
         new error_code
       end
     end
@@ -280,6 +319,8 @@ module IGMarkets
       '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.request.invalid.date-range' => Errors::InvalidDateRangeError,
+      'error.request.invalid.page-size' => Errors::InvalidPageSizeError,
       'error.security.account-access-denied' => Errors::AccountAccessDeniedError,
       'error.security.account-migrated' => Errors::AccountMigratedError,
       'error.security.account-not-yet-activated' => Errors::AccountNotYetActivatedError,
@@ -293,6 +334,7 @@ module IGMarkets
       'error.security.api-key-missing' => Errors::APIKeyMissingError,
       'error.security.api-key-restricted' => Errors::APIKeyRestrictedError,
       'error.security.api-key-revoked' => Errors::APIKeyRevokedError,
+      'error.security.authentication.timeout' => Errors::AuthenticationTimeoutError,
       'error.security.client-suspended' => Errors::ClientSuspendedError,
       'error.security.client-token-invalid' => Errors::ClientTokenInvalidError,
       'error.security.client-token-missing' => Errors::ClientTokenMissingError,
@@ -300,11 +342,17 @@ module IGMarkets
       'error.security.invalid-application' => Errors::InvalidApplicationError,
       'error.security.invalid-details' => Errors::InvalidCredentialsError,
       'error.security.invalid-website' => Errors::InvalidWebsiteError,
+      'error.security.oauth-token-invalid' => Errors::OAuthTokenInvalidError,
       'error.security.too-many-failed-attempts' => Errors::TooManyFailedLoginAttemptsError,
       'error.service.watchlists.add-instrument.invalid-epic' => Errors::WatchlistInvalidEPICError,
+      'error.sprintmarket.create-position.expiry.outside-valid-range' => Errors::SprintMarketPositionInvalidExpiryError,
+      'error.sprintmarket.create-position.failure' => Errors::SprintMarketPositionCreateError,
+      'error.sprintmarket.create-position.market-closed' => Errors::SprintMarketPositionInvalidExpiryError,
+      'error.sprintmarket.create-position.order-size.invalid' => Errors::SprintMarketInvalidOrderSizeError,
       'error.switch.accountId-must-be-different' => Errors::AccountAlreadyCurrentError,
       'error.switch.cannot-set-default-account' => Errors::CannotSetDefaultAccountError,
       'error.switch.invalid-accountId' => Errors::InvalidAccountIDError,
+      'error.trading.otc.instrument-not-found' => Errors::InstrumentNotFoundError,
       'error.unsupported.epic' => Errors::UnsupportedEPICError,
       'error.watchlists.management.cannot-delete-watchlist' => Errors::CannotDeleteWatchlistError,
       'error.watchlists.management.duplicate-name' => Errors::DuplicateWatchlistNameError,

data/lib/ig_markets/instrument.rb

@@ -31,12 +31,14 @@ module IGMarkets
       attribute :open_time
 
       # This method is used by {DealingPlatform#instantiate_models} to work around a vagary in the IG API where there
-      # is a seemingly unnecessary hash for the :opening_hours value that contains a single :market_times key which is
+      # is a seemingly unnecessary hash for the :opening_hours value that contains a single `:market_times` key which is
       # what holds the actual opening hours data.
       #
       # @param [Hash] attributes
       #
       # @return [Hash]
+      #
+      # @private
       def self.adjusted_api_attributes(attributes)
         attributes.keys == [:market_times] ? attributes[:market_times] : attributes
       end

data/lib/ig_markets/streaming/account_state.rb

@@ -51,11 +51,12 @@ module IGMarkets
         update_market_subscriptions
       end
 
-      # Returns whether there is any data waiting to be processed by a call to {#process_queued_data}
+      # Returns whether the data queue is empty. If this returns false then there is data waiting to be processed by a
+      # call to {#process_queued_data}.
       #
       # @return [Boolean]
-      def data_to_process?
-        !@data_queue.empty?
+      def data_queue_empty?
+        @data_queue.empty?
       end
 
       # Processes all queued data and updates {#accounts}, {#positions} and {#working_orders} accordingly. If there are

data/lib/ig_markets/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.20'
+  version: '0.21'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-20 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize