ig_markets 0.12 → 0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e50f2a597b16e6d091f0eff038350ec67847f60
-  data.tar.gz: 769b2056a2a1db136b05947fccbe42127ff54809
+  metadata.gz: d08c5bda8c3b5efc6a42dff92de064a76e42fa24
+  data.tar.gz: defcb9eaeb04b87f3772911e66b849a22ab091e2
 SHA512:
-  metadata.gz: 091827f393098b7b5b19df4686832ce96dd630038aee32ab15af550bfbdae5c4236bb238993198c9caae96273d02b83d8f34dd8d287dc4456b068e974969a3f0
-  data.tar.gz: 4ee120e6a912fdeef9ee98752c15559800ee3b406f168d1bb68524ee213b42a92afb7638dcf1675747bab6e6ed634f2a7030a41cb009b2235ff9ef5f090d17ad
+  metadata.gz: 80efc7ada830d2c5758c0c58dd5f2e666c0c4f315bd196e1de8c25423b8a901be0ac4cac40ddc6f189ca8bedf3d48001caa925b149fa7afb62340f3e32e41a6b
+  data.tar.gz: 4eace6c040b07b374f878c9a621a8e090781758b345da829a841f0b8868c406b3f15b6e27f8166627fae33efebed7a4282e4b0367afce45492477c2e965fd861

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # IG Markets Changelog
 
-### 0.12 - June 21, 2016
+### 0.13 — Unreleased
+
+- Added `ig_markets performance` command that summarizes an account's dealing performance over a specified period
+- Added `ig_markets markets` command which prints the current state of all the passed EPICs
+- Correctly handle instrument periods that are formatted as `DD-MMM-YY`
+- The `:type` option to `IGMarkets::AccountMethods::transactions` is now validated
+- The platform type previously referred to as `production` is now referred to as `live` to better match standard IG
+  terminology, existing calls to `IGMarkets::DealingPlatform#sign_in` and `IGMarkets::Session#sign_in` will need to be
+  updated if they explicitly specified `:production`
+
+### 0.12 — June 21, 2016
 
 - Unrecognized attributes returned by the IG Markets API now trigger a warning rather than causing an error, this makes
   the library able to handle new return values being added to existing APIs
@@ -116,7 +126,7 @@
 - `IGMarkets::Model` now has separate `Date` and `Time` attribute types, and a new `:time_zone` option is used for
   `Time` attributes that have a known time zone. Previous uses of `DateTime` should be replaced with either `Date` or
   `Time`.
-- Changed `size` attribute to always be of type `Float` on all models.
+- Changed `size` attribute to always be of type `Float` on all models
 - Changed `limit_distance` and `stop_distance` attributes to always be of type `Fixnum` on all models
 - Added `IGMarkets::Format` module
 - Added `#expired?` and `#seconds_till_expiry` to `IGMarkets::SprintMarketPosition`

data/README.md

@@ -22,7 +22,7 @@ Includes support for:
 * Watchlists
 * Client sentiment
 
-An IG Markets production or demo trading account is needed in order to use this gem.
+An IG Markets live or demo trading account is needed in order to use this gem.
 
 ## License
 
@@ -71,10 +71,12 @@ commands and their subcommands is:
 - `ig_markets confirmation DEAL-REFERENCE`
 - `ig_markets console`
 - `ig_markets help [COMMAND]`
+- `ig_markets markets EPICS`
 - `ig_markets orders [list]`
 - `ig_markets orders create ...`
 - `ig_markets orders update DEAL-ID ...`
 - `ig_markets orders delete DEAL-ID`
+- `ig_markets performance --days N [...]`
 - `ig_markets positions [list] [...]`
 - `ig_markets positions create ...`
 - `ig_markets positions update DEAL-ID ...`
@@ -104,6 +106,9 @@ ig_markets transactions --days 7 --instrument EUR/USD --no-interest
 # Search for EURUSD currency markets
 ig_markets search EURUSD --type currencies
 
+# Print details for the EURUSD currency pair and the Dow Jones Industrial Average
+ig_markets markets CS.D.EURUSD.CFD.IP IX.D.DOW.IFD.IP
+
 # Print current positions in aggregate
 ig_markets positions --aggregate
 
@@ -130,6 +135,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
 
+# Print account dealing performance from the last 90 days, broken down by the EPICs that were traded
+ig_markets performance --days 90
+
 # Log in and open a Ruby console which can be used to query the IG API, printing all REST requests
 ig_markets console --verbose
 ```
@@ -157,7 +165,7 @@ ig.account.activities from: Date.today - 7
 ig.account.activities from: Date.today - 14, to: Date.today - 7
 ig.account.transactions from: Date.today - 7
 ig.account.transactions from: Date.today - 14, to: Date.today - 7
-ig.account.transactions from: Date.today - 14, to: Date.today - 7, type: :deal
+ig.account.transactions from: Date.today - 14, to: Date.today - 7, type: :withdrawal
 
 # Dealing
 ig.deal_confirmation 'deal_reference'
@@ -187,7 +195,7 @@ ig.working_orders['deal_id'].delete
 # Markets
 ig.markets.hierarchy
 ig.markets.search 'EURUSD'
-ig.markets['CS.D.EURUSD.CFD.IP']
+ig.markets.find 'CS.D.EURUSD.CFD.IP', 'IX.D.DOW.IFD.IP'
 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

data/lib/ig_markets/activity.rb

@@ -39,7 +39,7 @@ module IGMarkets
     attribute :description
     attribute :details, Details
     attribute :epic, String, regex: Regex::EPIC
-    attribute :period, Time, nil_if: %w(- DFB), format: ['%FT%T', '%b-%y']
+    attribute :period, Time, nil_if: %w(- DFB), format: ['%FT%T', '%d-%b-%y', '%b-%y']
     attribute :status, Symbol, allowed_values: [:accepted, :rejected, :unknown]
     attribute :type, Symbol, allowed_values: [:edit_stop_and_limit, :position, :system, :working_order]
   end

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

@@ -0,0 +1,18 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets markets` command.
+    class Main < Thor
+      desc 'markets EPICS', 'Prints the state of the markets with the specified EPICs'
+
+      def markets(*epics)
+        self.class.begin_session(options) do |dealing_platform|
+          markets = dealing_platform.markets.find(*epics)
+
+          table = MarketsTable.new markets
+
+          puts table
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets performance` command.
+    class Main
+      desc 'performance', 'Prints a summary of trading performance over a period'
+
+      option :days, type: :numeric, required: true, desc: 'The number of days to print performance for'
+      option :from, desc: 'The start date to show performance from, format: yyyy-mm-dd'
+
+      def performance
+        self.class.begin_session(options) do |dealing_platform|
+          performances = gather_performances dealing_platform
+          lookup_instrument_names performances, dealing_platform
+
+          table = PerformancesTable.new performances
+
+          puts table
+
+          print_summary performances
+        end
+      end
+
+      private
+
+      def gather_performances(dealing_platform)
+        performances = deal_transactions_by_epic(dealing_platform).map do |epic, transactions|
+          profit_loss = transactions.map(&:profit_and_loss_amount).inject(&:+)
+
+          { epic: epic, transactions: transactions, profit_loss: profit_loss }
+        end
+
+        performances.sort_by { |a| a[:profit_loss] }
+      end
+
+      def deal_transactions_by_epic(dealing_platform)
+        activities = dealing_platform.account.activities history_options
+
+        deal_transactions(dealing_platform).group_by do |transaction|
+          activities.detect do |activity|
+            Regexp.new("^Position(\/s| partially) closed:.*#{transaction.reference}").match activity.description
+          end.epic
+        end
+      end
+
+      def deal_transactions(dealing_platform)
+        dealing_platform.account.transactions(history_options).select do |transaction|
+          transaction.transaction_type == :deal
+        end
+      end
+
+      def lookup_instrument_names(performances, dealing_platform)
+        markets = dealing_platform.markets.find(*performances.map { |a| a[:epic] })
+
+        performances.each do |a|
+          a[:instrument_name] = markets.detect { |market| market.instrument.epic == a[:epic] }.instrument.name
+        end
+      end
+
+      def print_summary(performances)
+        profit_loss = performances.map { |h| h[:profit_loss] }.inject(:+)
+        currency = performances.first[:transactions].first.currency
+
+        puts <<-END
+
+Note: this table only shows the profit/loss made from dealing, it does not include interest payments,
+      dividends, or other adjustments that may have occurred over this period.
+
+Total: #{Format.currency(profit_loss, currency).colorize(profit_loss < 0 ? :red : :green)}
+END
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/main.rb

@@ -6,7 +6,7 @@ module IGMarkets
       class_option :username, required: true, desc: 'The username for the session'
       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 :demo, type: :boolean, desc: 'Use the demo platform (default is the live platform)'
       class_option :verbose, type: :boolean, desc: 'Whether to print the raw REST API requests and responses'
 
       desc 'orders [SUBCOMAND=list ...]', 'Command for working with orders'
@@ -59,7 +59,7 @@ module IGMarkets
         #
         # @param [Thor::CoreExt::HashWithIndifferentAccess] options The Thor options hash.
         def begin_session(options)
-          platform = options[:demo] ? :demo : :production
+          platform = options[:demo] ? :demo : :live
 
           RequestPrinter.enabled = true if options[:verbose]
 

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

@@ -9,7 +9,7 @@ module IGMarkets
       end
 
       def headings
-        ['Type', 'EPIC', 'Instrument', 'Status', 'Expiry', 'Bid', 'Offer', 'High', 'Low', 'Change (net)', 'Change (%)']
+        ['EPIC', 'Type', 'Instrument', 'Status', 'Expiry', 'Bid', 'Offer', 'High', 'Low', 'Change (net)', 'Change (%)']
       end
 
       def right_aligned_columns
@@ -17,8 +17,8 @@ module IGMarkets
       end
 
       def row(market_overview)
-        [market_overview.instrument_type, market_overview.epic, market_overview.instrument_name,
-         market_status(market_overview), market_overview.expiry, levels(market_overview)]
+        [market_overview.epic, market_overview.instrument_type, market_overview.instrument_name,
+         market_overview.market_status, market_overview.expiry, levels(market_overview)]
       end
 
       def cell_color(value, _model, _row_index, column_index)
@@ -36,12 +36,6 @@ module IGMarkets
           Format.level market_overview.send(attribute)
         end
       end
-
-      def market_status(market_overview)
-        { closed: 'Closed', edits_only: 'Edits only', offline: 'Offline', on_auction: 'On auction',
-          on_auction_no_edits: 'On auction no edits', suspended: 'Suspended', tradeable: 'Tradeable' }
-          .fetch market_overview.market_status
-      end
     end
   end
 end

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

@@ -0,0 +1,13 @@
+module IGMarkets
+  module CLI
+    # Helper class that prints out an array of {IGMarkets::Market} instances in a table.
+    class MarketsTable < MarketOverviewsTable
+      private
+
+      def row(market)
+        [market.instrument.epic, market.instrument.type, market.instrument.name, market.snapshot.market_status,
+         market.instrument.expiry, levels(market.snapshot)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module IGMarkets
+  module CLI
+    # Helper class that prints out account performance details in a table.
+    class PerformancesTable < Table
+      private
+
+      def default_title
+        'Dealing performance'
+      end
+
+      def headings
+        ['EPIC', 'Instrument name', '# of closed deals', 'Profit/loss']
+      end
+
+      def right_aligned_columns
+        [2, 3]
+      end
+
+      def row(model)
+        transactions = model.fetch :transactions
+
+        [model.fetch(:epic), model.fetch(:instrument_name), transactions.size,
+         Format.currency(model.fetch(:profit_loss), transactions.first.currency)]
+      end
+
+      def cell_color(value, _transaction, _row_index, column_index)
+        return unless headings[column_index] == 'Profit/loss'
+
+        if value =~ /-/
+          :red
+        else
+          :green
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/dealing_platform/account_methods.rb

@@ -45,6 +45,10 @@ module IGMarkets
       def transactions(options)
         options[:type] ||= :all
 
+        unless [:all, :all_deal, :deposit, :withdrawal].include? options[:type]
+          raise ArgumentError, "Invalid transaction type: #{options[:type]}"
+        end
+
         history_request_complete url: 'history/transactions', url_parameters: history_url_parameters(options),
                                  api_version: API_V2, collection_name: :transactions, model_class: Transaction,
                                  date_attribute: :date_utc

data/lib/ig_markets/dealing_platform.rb

@@ -50,12 +50,12 @@ module IGMarkets
       @working_orders = WorkingOrderMethods.new self
     end
 
-    # Signs in to the IG Markets Dealing Platform, either the production platform or the demo platform.
+    # Signs in to the IG Markets Dealing Platform, either the live platform or the demo platform.
     #
     # @param [String] username The account username.
     # @param [String] password The account password.
     # @param [String] api_key The account API key.
-    # @param [:production, :demo] platform The platform to use.
+    # @param [:live, :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)
@@ -102,10 +102,10 @@ module IGMarkets
     # of each attribute as defined on the models. All model instances returned by this method will have their
     # `@dealing_platform` instance variable set.
     #
-    # @param [Class] model_class The type of model to create from `source`.
+    # @param [Class] model_class The top-level model class to create from `source`.
     # @param [nil, Hash, Array, Model] source The source object to construct the model(s) from. If `nil` then `nil` is
     #                                  returned. If an instance of `model_class` subclass then a deep copy of it is
-    #                                  returned. If a `Hash` then it will be interprted as the attributes for a new
+    #                                  returned. If a `Hash` then it will be interpreted as the attributes for a new
     #                                  instance of `model_class. If an `Array` then each entry will be passed through
     #                                  this method individually.
     #
@@ -113,13 +113,11 @@ module IGMarkets
     def instantiate_models(model_class, source)
       return nil if source.nil?
 
-      source = source.attributes if source.is_a? model_class
+      source = prepare_source model_class, source
 
       if source.is_a? Array
         source.map { |entry| instantiate_models model_class, entry }
       elsif source.is_a? Hash
-        source = model_class.adjusted_api_attributes source if model_class.respond_to? :adjusted_api_attributes
-
         instantiate_model_from_attributes_hash model_class, source
       else
         raise ArgumentError, "#{model_class}: can't instantiate from a source of type #{source.class}"
@@ -128,6 +126,17 @@ module IGMarkets
 
     private
 
+    # This method is a helper for {#instantiate_models} that prepares a source object for instantiation.
+    def prepare_source(model_class, source)
+      source = source.attributes if source.is_a? model_class
+
+      if source.is_a?(Hash) && model_class.respond_to?(:adjusted_api_attributes)
+        source = model_class.adjusted_api_attributes source
+      end
+
+      source
+    end
+
     # This method is a companion to {#instantiate_models} and creates a single instance of `model_class` from the passed
     # attributes hash, setting the `@dealing_platform` instance variable on the new model instance.
     def instantiate_model_from_attributes_hash(model_class, attributes)

data/lib/ig_markets/session.rb

@@ -1,7 +1,7 @@
 module IGMarkets
   # Manages a session with the IG Markets REST API, including signing in, signing out, and the sending of requests.
   # In order to sign in, {#username}, {#password}, {#api_key} and {#platform} must be set. {#platform} must be
-  # either `:demo` or `:production` depending on which platform is being targeted.
+  # either `:demo` or `:live` depending on which platform is being targeted.
   class Session
     # @return [String] The username to use to authenticate this session.
     attr_accessor :username
@@ -12,7 +12,7 @@ module IGMarkets
     # @return [String] The API key to use to authenticate this session.
     attr_accessor :api_key
 
-    # @return [:demo, :production] The platform variant to log into for this session.
+    # @return [:demo, :live] The platform variant to log into for this session.
     attr_accessor :platform
 
     # @return [String] The client session security access token for the currently logged in session, or `nil` if there
@@ -103,7 +103,7 @@ module IGMarkets
 
     HOST_URLS = {
       demo: 'https://demo-api.ig.com/gateway/deal/',
-      production: 'https://api.ig.com/gateway/deal/'
+      live: 'https://api.ig.com/gateway/deal/'
     }.freeze
 
     def validate_authentication

data/lib/ig_markets/transaction.rb

@@ -8,7 +8,7 @@ module IGMarkets
     attribute :date_utc, Time, format: '%FT%T'
     attribute :instrument_name
     attribute :open_level, String, nil_if: %w(- 0)
-    attribute :period, Time, nil_if: %w(- DFB), format: ['%FT%T', '%b-%y']
+    attribute :period, Time, nil_if: %w(- DFB), format: ['%FT%T', '%d-%b-%y', '%b-%y']
     attribute :profit_and_loss
     attribute :reference
     attribute :size, String, nil_if: '-'

data/lib/ig_markets/version.rb

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

data/lib/ig_markets.rb

@@ -55,6 +55,8 @@ 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/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/sentiment_command'
@@ -65,6 +67,8 @@ require 'ig_markets/cli/tables/activities_table'
 require 'ig_markets/cli/tables/client_sentiments_table'
 require 'ig_markets/cli/tables/historical_price_result_snapshots_table'
 require 'ig_markets/cli/tables/market_overviews_table'
+require 'ig_markets/cli/tables/markets_table'
+require 'ig_markets/cli/tables/performances_table'
 require 'ig_markets/cli/tables/positions_table'
 require 'ig_markets/cli/tables/sprint_market_positions_table'
 require 'ig_markets/cli/tables/transactions_table'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.12'
+  version: '0.13'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -213,7 +213,9 @@ files:
 - 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/markets_command.rb
 - lib/ig_markets/cli/commands/orders_command.rb
+- lib/ig_markets/cli/commands/performance_command.rb
 - lib/ig_markets/cli/commands/positions_command.rb
 - lib/ig_markets/cli/commands/prices_command.rb
 - lib/ig_markets/cli/commands/search_command.rb
@@ -228,6 +230,8 @@ files:
 - lib/ig_markets/cli/tables/client_sentiments_table.rb
 - lib/ig_markets/cli/tables/historical_price_result_snapshots_table.rb
 - lib/ig_markets/cli/tables/market_overviews_table.rb
+- lib/ig_markets/cli/tables/markets_table.rb
+- lib/ig_markets/cli/tables/performances_table.rb
 - lib/ig_markets/cli/tables/positions_table.rb
 - lib/ig_markets/cli/tables/sprint_market_positions_table.rb
 - lib/ig_markets/cli/tables/table.rb