ig_markets 0.14 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a9c0f861710bf880c830d2826c3e4ece9c2ef35
-  data.tar.gz: 4c2f4dbd5d336489e2a343ac0015ff34c0910e2b
+  metadata.gz: 4205e8e7a404222272416344c5f21e912de43256
+  data.tar.gz: 55595208ec8a08d8941d68387c6c61e19c436d5d
 SHA512:
-  metadata.gz: fa7dc0e4c01816d95e5b6dfec934c3a52e66b9b82ed27f5b777c19a89fa7bda5915b8f9bdba02ae6a3b8b42c251622ffa91c2c1a41e6c032ca4ae7300b611ca8
-  data.tar.gz: 9ca3b4fe730001d4ed3d8900ec5483e3a10e386e9b772f4057e0696b9c3f8019889318faf6abda047735046dade967bcaf537a1a157b95e90e5eb751928feb23
+  metadata.gz: 230f8eb850b639d3a6fa479cd42101ecd89c901382951adaa5a69d064029623a30c042cbe9bc44ee16d11b0e1cf50c034dc99e0aa43f3081063b27cda4a797ec
+  data.tar.gz: 20991fd83b740be9a1bcc36ce2c112a7a63b2070adc9cf736617a130350b9810abe33663214b1b45889b3e53bda3741cc37f633068f1284cab30a09088d36d9b

data/CHANGELOG.md

@@ -1,10 +1,21 @@
 # IG Markets Changelog
 
+### 0.15 — July 11, 2016
+
+- Added `ig_markets self-test` command that can be run under a demo account in order to test the library against the
+  live IG Markets API
+- If the API key or account's traffic allowance is exceeded then `IGMarkets::Session` now automatically retries the
+  request after a five second pause
+- Added `IGMarkets::MarketHierarchyResult::HierarchyNode#markets` and
+  `IGMarkets::MarketHierarchyResult::HierarchyNode#nodes` methods
+
 ### 0.14 — July 2, 2016
 
 - Added `delete-all` subcommand to `ig_markets orders`
 - Added a `#reload` method that reloads a model's attributes in-place to `IGMarkets::Account`,
   `IGMarkets::ClientSentiment`, `IGMarkets::Market`, `IGMarkets::Position` and `IGMarkets::WorkingOrder`
+- Support mass assignment of attributes on models
+- Fixed a compatibility issue with recent IG API changes
 
 ### 0.13 — June 22, 2016
 

data/README.md

@@ -85,6 +85,7 @@ commands and their subcommands is:
 - `ig_markets positions close-all [...]`
 - `ig_markets prices --epic EPIC --resolution RESOLUTION ...`
 - `ig_markets search QUERY [--type TYPE]`
+- `ig_markets self-test`
 - `ig_markets sentiment MARKET`
 - `ig_markets sprints [list]`
 - `ig_markets sprints create ...`

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

@@ -0,0 +1,142 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets self-test` command.
+    class Main < Thor
+      desc 'self-test', 'Runs a self-test of this application against the live IG Markets API (demo accounts only)'
+
+      def self_test
+        self.class.begin_session(options) do |dealing_platform|
+          raise 'Error: self-tests must be run on a demo account' unless dealing_platform.session.platform == :demo
+
+          run_self_test dealing_platform
+
+          dealing_platform.sign_out
+        end
+      end
+
+      private
+
+      def run_self_test(dealing_platform)
+        test_markets dealing_platform
+        test_positions dealing_platform
+        test_sprint_market_positions dealing_platform
+        test_working_orders dealing_platform
+        test_watchlists dealing_platform
+        test_client_sentiment dealing_platform
+        test_account_methods dealing_platform
+        test_applications dealing_platform
+      end
+
+      def test_markets(dealing_platform)
+        dealing_platform.markets.hierarchy '264134' # ID of the main 'Forex' node
+        dealing_platform.markets.search 'EURUSD'
+        @eur_usd = dealing_platform.markets['CS.D.EURUSD.CFD.IP']
+        @eur_usd_sprint = dealing_platform.markets['FM.D.EURUSD24.EURUSD24.IP']
+        @eur_usd.historical_prices resolution: :hour, number: 1
+      end
+
+      def test_positions(dealing_platform)
+        test_position_create dealing_platform
+        test_position_update
+        test_position_close dealing_platform
+      end
+
+      def test_position_create(dealing_platform)
+        deal_reference = dealing_platform.positions.create currency_code: 'USD', direction: :buy,
+                                                           epic: 'CS.D.EURUSD.CFD.IP', size: 2
+
+        @position = dealing_platform.positions[dealing_platform.deal_confirmation(deal_reference).deal_id]
+
+        raise 'Error: failed creating position' unless @position
+      end
+
+      def test_position_update
+        stop_level = @position.level - 0.01
+
+        @position.update stop_level: stop_level
+        @position.reload
+
+        update_worked = (@position.stop_level - stop_level).abs < 0.001
+
+        raise 'Error: failed updating position' unless update_worked
+      end
+
+      def test_position_close(dealing_platform)
+        @position.close
+
+        raise 'Error: failed closing position' if dealing_platform.positions[@position.deal_id]
+      end
+
+      def test_sprint_market_positions(dealing_platform)
+        deal_reference = dealing_platform.sprint_market_positions.create direction: :buy,
+                                                                         epic: 'FM.D.EURUSD24.EURUSD24.IP',
+                                                                         expiry_period: :twenty_minutes, size: 100
+
+        deal_confirmation = dealing_platform.deal_confirmation deal_reference
+
+        sprint_market_position = dealing_platform.sprint_market_positions[deal_confirmation.deal_id]
+
+        raise 'Error: failed creating sprint market position' unless sprint_market_position
+      end
+
+      def test_working_orders(dealing_platform)
+        test_working_order_create dealing_platform
+        test_working_order_update dealing_platform
+        test_working_order_delete dealing_platform
+      end
+
+      def test_working_order_create(dealing_platform)
+        deal_reference = dealing_platform.working_orders.create currency_code: 'USD', direction: :buy,
+                                                                epic: 'CS.D.EURUSD.CFD.IP', type: :limit,
+                                                                level: @eur_usd.snapshot.bid - 0.1, size: 1
+
+        @working_order = dealing_platform.working_orders[dealing_platform.deal_confirmation(deal_reference).deal_id]
+
+        raise 'Error: failed creating working order' unless @working_order
+      end
+
+      def test_working_order_update(dealing_platform)
+        new_level = @eur_usd.snapshot.bid - 1
+
+        @working_order.update level: new_level
+        @working_order.reload
+
+        update_worked = (new_level - dealing_platform.working_orders[@working_order.deal_id].order_level).abs < 0.01
+
+        raise 'Error: failed updating working order' unless update_worked
+      end
+
+      def test_working_order_delete(dealing_platform)
+        @working_order.delete
+
+        raise 'Error: failed deleting working order' if dealing_platform.working_orders[@working_order.deal_id]
+      end
+
+      def test_watchlists(dealing_platform)
+        watchlist = dealing_platform.watchlists.create SecureRandom.hex, 'UA.D.AAPL.CASH.IP'
+        watchlist = dealing_platform.watchlists[watchlist.id]
+        watchlist.markets
+        watchlist.add_market 'CS.D.EURUSD.CFD.IP'
+        watchlist.remove_market 'CS.D.EURUSD.CFD.IP'
+        watchlist.delete
+
+        raise 'Error: failed deleting watchlist' if dealing_platform.watchlists[watchlist.id]
+      end
+
+      def test_account_methods(dealing_platform)
+        dealing_platform.account.all
+        dealing_platform.account.activities from: Date.today - 14
+        dealing_platform.account.transactions from: Date.today - 14
+      end
+
+      def test_client_sentiment(dealing_platform)
+        client_sentiment = dealing_platform.client_sentiment['EURUSD']
+        client_sentiment.related_sentiments
+      end
+
+      def test_applications(dealing_platform)
+        dealing_platform.applications
+      end
+    end
+  end
+end

data/lib/ig_markets/market_hierarchy_result.rb

@@ -5,6 +5,20 @@ module IGMarkets
     class HierarchyNode < Model
       attribute :id
       attribute :name
+
+      # Returns an array of the markets under this node in the market hierarchy.
+      #
+      # @return [Array<MarketOverview>]
+      def markets
+        @dealing_platform.markets.hierarchy(id).markets
+      end
+
+      # Returns an array of the child nodes under this node in the market hierarchy.
+      #
+      # @return [Array<HierarchyNode>]
+      def nodes
+        @nodes ||= @dealing_platform.markets.hierarchy(id).nodes
+      end
     end
 
     attribute :markets, MarketOverview

data/lib/ig_markets/session.rb

@@ -101,10 +101,7 @@ module IGMarkets
 
     private
 
-    HOST_URLS = {
-      demo: 'https://demo-api.ig.com/gateway/deal/',
-      live: 'https://api.ig.com/gateway/deal/'
-    }.freeze
+    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|
@@ -163,24 +160,34 @@ module IGMarkets
     rescue RestClient::Exception => exception
       raise RequestFailedError, exception.message unless exception.response
 
-      return exception.response unless !options[:retry] && client_token_invalid?(exception.response)
+      return exception.response unless should_retry_request? exception.response, options
 
-      sign_in
       execute_request options.merge(retry: true)
     rescue SocketError => socket_error
       raise RequestFailedError, socket_error
     end
 
-    def client_token_invalid?(response)
-      ResponseParser.parse_json(response.body)[:error_code] == 'error.security.client-token-invalid'
+    def should_retry_request?(response, options)
+      error_code = ResponseParser.parse_json(response.body)[:error_code]
+
+      if error_code == 'error.security.client-token-invalid' && !options[:retry]
+        sign_in
+        return true
+      end
+
+      if error_code =~ /^error\.public-api\.exceeded-(api-key|account)-allowance/
+        sleep 5
+        return true
+      end
+
+      false
     end
 
     def process_response(response)
       result = ResponseParser.parse_json response.body
+      http_code = response.code
 
-      unless response.code >= 200 && response.code < 300
-        raise RequestFailedError.new(result[:error_code], response.code)
-      end
+      raise RequestFailedError.new(result[:error_code], http_code) unless http_code >= 200 && http_code < 300
 
       result
     end

data/lib/ig_markets/version.rb

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

data/lib/ig_markets.rb

@@ -4,6 +4,7 @@ require 'date'
 require 'json'
 require 'pry'
 require 'rest-client'
+require 'securerandom'
 require 'terminal-table'
 require 'thor'
 
@@ -60,6 +61,7 @@ require 'ig_markets/cli/commands/markets_command'
 require 'ig_markets/cli/commands/performance_command'
 require 'ig_markets/cli/commands/prices_command'
 require 'ig_markets/cli/commands/search_command'
+require 'ig_markets/cli/commands/self_test_command'
 require 'ig_markets/cli/commands/sentiment_command'
 require 'ig_markets/cli/commands/transactions_command'
 require 'ig_markets/cli/tables/table'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.14'
+  version: '0.15'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -233,6 +233,7 @@ files:
 - lib/ig_markets/cli/commands/positions_command.rb
 - lib/ig_markets/cli/commands/prices_command.rb
 - lib/ig_markets/cli/commands/search_command.rb
+- lib/ig_markets/cli/commands/self_test_command.rb
 - lib/ig_markets/cli/commands/sentiment_command.rb
 - lib/ig_markets/cli/commands/sprints_command.rb
 - lib/ig_markets/cli/commands/transactions_command.rb