ig_markets 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 724ac2b070ec1f942dc3d1be4417bb82486dd414
-  data.tar.gz: f219d63e7c52e427e5813a6369abcfcea838c9c3
+  metadata.gz: ef481344a1515b0031301c4e70e17ce843f7f111
+  data.tar.gz: f2282b07a67e0dfba0fa8e7a8936d630777663e0
 SHA512:
-  metadata.gz: 037f9fe742a849aa0c74a537bafbe276078e7a34d41fd30f5302e5ff9f025de88ba13842438cef017fddb3ed562f9bb4a317735c72e79b6e2679a9054965b9b5
-  data.tar.gz: 89aa2c236ca20d253a5b5be311cbf9f0819c440fa77b2caa0d0c91380ae200287375b8ff60b52ebeca9b5eaa3e18c41374c9379aa61b26c52e5c2c27c7ccbf9e
+  metadata.gz: d3816a297817a2d1da84402f1a20689e2b2f271ae7bc1c76a623f19b45320674f7ca94ec39b703bbb3553f2eb364b6d08f10f3cdc1db0c615b4887859253dc28
+  data.tar.gz: 27b911f529724f105c3d443b41fc878f78c45815f6b9b1ce94569a6e88c17d85de48e34ed087e38307f638c05af61d90c9101b50a2db9056eb76d9c939ed2aaa

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # IG Markets Changelog
 
+### 0.6 - Unreleased
+
+-
+
+### 0.5 - April 23, 2016
+
+- Ouptut from the command-line client is now formatted using ASCII tables and contains a lot more detail
+- Added `--aggregate` option to `ig_markets positions list` to aggregate together positions with the same EPIC
+- Added `--instrument` option to `ig_markets transactions` to filter by instrument name
+- Added `--no-interest` option to `ig_markets transactions` to exclude interest transactions
+- Added `--print-requests` option to the command-line client to see all the interactions with the IG Markets API
+- Support removal of limits and stops using `ig_markets positions update` and `ig_markets orders update`
+- Removed `--related` option from `ig_markets sentiment`, related sentiments are now always reported and are also
+  color-coded
+- `IGMarkets::DealingPlatform::ClientSentimentMethods#[]` now raises an exception on unknown market IDs
+- Added `IGMarkets::Position#close_level`
+- Removed `IGMarkets::Position#formatted_size` and `IGMarkets::Transaction#formatted_transaction_type`
+
 ### 0.4 - April 18, 2016
 
 - Added `create`, `update` and `delete` subcommands to `ig_markets orders`
@@ -8,10 +26,11 @@
 - Added `create`, `add-markets`, `remove-markets` and `delete` subcommands to `ig_markets watchlists`
 - `ig_markets confirmation`, `ig_markets search` and `ig_markets sentiment` now take their mandatory argument directly
 - Added `--start-date` option to the `ig_markets activities` and `ig_markets transactions` commands
-- Removed the `:time_in_force` option from `IGMarkets::WorkingOrderMethods#create` and `IGMarkets::WorkingOrder#update`,
-  just set `:good_till_date` if it is needed
-- `IGMarkets::AccountMethods#recent_activities` and `IGMarkets::AccountMethods#recent_transactions` now take a number of
-  days rather than a number of seconds
+- Removed the `:time_in_force` option from `IGMarkets::DealingPlatform::WorkingOrderMethods#create` and
+  `IGMarkets::WorkingOrder#update`, just set `:good_till_date` if it is needed
+- `IGMarkets::DealingPlatform::AccountMethods#recent_activities` and
+  `IGMarkets::DealingPlatform::AccountMethods#recent_transactions` now take a number of days rather than a number of
+  seconds
 - Fixed errors working with a working order's `#good_till_date` attribute
 - Automatically reauthenticate if the client security token has expired
 

data/README.md

@@ -28,52 +28,109 @@ An IG Markets production or demo trading account is needed in order to use this
 
 Licensed under the MIT license. You must read and agree to its terms to use this software.
 
-## Usage — Command-Line Client
+## Installation
 
-```sh
-$ gem install ig_markets
+Install the latest version of the `ig_markets` gem with the following command:
 
-Usage: ig_markets COMMAND --username=USERNAME --password=PASSWORD --api-key=API-KEY [--demo]
+```
+$ gem install ig_markets
 ```
 
-On startup `ig_markets` searches for files named `"./.ig_markets"` and then `"~/.ig_markets"`, and if they are present
-interprets their contents as command-line arguments. This can be used to avoid having to specify authentication details
-with every invocation. To do this create a file at `"./.ig_markets"` or `"~/.ig_markets"` with the following contents:
+## Usage — Command-Line Client
+
+The general form for invoking the command-line client is:
 
 ```
+$ ig_markets COMMAND [SUBCOMMAND] --username=USERNAME --password=PASSWORD --api-key=API-KEY [--demo] [...]
+```
+
+#### Config File
+
+On startup `ig_markets` searches for config files named `"./.ig_markets"` and then `"~/.ig_markets"`, and if they are
+present interprets their contents as command-line arguments. This can be used to avoid having to specify authentication
+details with every invocation.
+
+To do this create a config file at `"./.ig_markets"` or `"~/.ig_markets"` with the following contents:
+
+```shell
 --username=USERNAME
 --password=PASSWORD
 --api-key=API-KEY
 --demo              # Include only if this is a demo account
 ```
 
-Run `ig_markets help` to list details on available commands. The full list of commands is:
+The following examples assume the presence of a config file that contains valid authentication details.
+
+#### Commands
+
+Use `ig_markets help` to get details on the options accepted by the commands and subcommands. The list of available
+commands and their subcommands is:
 
 - `ig_markets account`
 - `ig_markets activities --days=N [--start-date=YYYY-MM-DD]`
 - `ig_markets confirmation DEAL-REFERENCE`
+- `ig_markets help [COMMAND]`
 - `ig_markets orders [list]`
 - `ig_markets orders create ...`
 - `ig_markets orders update DEAL-ID ...`
 - `ig_markets orders delete DEAL-ID`
-- `ig_markets positions`
+- `ig_markets positions [list] [--aggregate]`
 - `ig_markets positions create ...`
 - `ig_markets positions update DEAL-ID ...`
-- `ig_markets positions close DEAL-ID ...`
+- `ig_markets positions close DEAL-ID [...]`
 - `ig_markets search QUERY`
-- `ig_markets sentiment MARKET [--related]`
+- `ig_markets sentiment MARKET`
 - `ig_markets sprints [list]`
 - `ig_markets sprints create ...`
-- `ig_markets transactions --days=N [--start-date=YYYY-MM-DD]`
+- `ig_markets transactions --days=N [--start-date=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 ...]`
 - `ig_markets watchlists remove-markets WATCHLIST-ID [EPIC EPIC ...]`
 - `ig_markets watchlists delete WATCHLIST-ID`
 
+#### Examples
+
+```shell
+# Print account details and balances
+ig_markets account
+
+# Print EUR/USD transactions from the last week, excluding interest transactions
+ig_markets transactions --days=7 --instrument EUR/USD --no-interest
+
+# Print current positions in aggregate
+ig_markets positions --aggregate
+
+# Create a EURUSD long position of size 2
+ig_markets positions create --currency-code USD --direction buy --epic CS.D.EURUSD.CFD.IP --size 2
+
+# Change the limit and stop levels for an existing position
+ig_markets positions update DEAL-ID --limit-level 1.15 --stop-level 1.10
+
+# Fully close a position
+ig_markets positions close DEAL-ID
+
+# Partially close a position (assuming its size is greater than 1)
+ig_markets positions close DEAL-ID --size 1
+
+# Create a EURUSD sprint market short position of size 100 that expires in 20 minutes
+ig_markets sprints create --direction sell --epic FM.D.EURUSD24.EURUSD24.IP --expiry-period 20 --size 100
+
+# Create a working order to buy 1 unit of EURUSD at the level 1.1
+ig_markets orders create --currency-code USD --direction buy --epic CS.D.EURUSD.CFD.IP --level 1.1 --size 1 --type limit
+```
+
 ## Usage — Library
 
+#### Documentation
+
+API documentation is available [here](http://www.rubydoc.info/github/rviney/ig_markets/master).
+
+#### Examples
+
 ```ruby
+require 'ig_markets'
+
 ig = IGMarkets::DealingPlatform.new
 
 # Session
@@ -101,7 +158,7 @@ ig.positions['deal_id'].close
 # Sprint market positions
 ig.sprint_market_positions.all
 ig.sprint_market_positions.create direction: :buy, epic: 'FM.D.EURUSD24.EURUSD24.IP',
-                                  expiry_period: :one_minute, size: 100
+                                  expiry_period: :twenty_minutes, size: 100
 
 # Working orders
 ig.working_orders.all
@@ -135,10 +192,6 @@ ig.client_sentiment['EURUSD'].related_sentiments
 ig.applications
 ```
 
-## Documentation
-
-API documentation is available [here](http://www.rubydoc.info/github/rviney/ig_markets/master).
-
 ## Contributors
 
 Gem created by Richard Viney. All contributions welcome.

data/lib/ig_markets.rb

@@ -1,6 +1,8 @@
 require 'base64'
+require 'colorize'
 require 'date'
 require 'rest-client'
+require 'terminal-table'
 require 'thor'
 
 require 'ig_markets/boolean'
@@ -9,23 +11,9 @@ require 'ig_markets/model/typecasters'
 require 'ig_markets/regex'
 
 require 'ig_markets/account'
-require 'ig_markets/account_activity'
-require 'ig_markets/account_transaction'
+require 'ig_markets/activity'
 require 'ig_markets/api_versions'
 require 'ig_markets/application'
-require 'ig_markets/cli/orders_command'
-require 'ig_markets/cli/positions_command'
-require 'ig_markets/cli/sprints_command'
-require 'ig_markets/cli/watchlists_command'
-require 'ig_markets/cli/main'
-require 'ig_markets/cli/account_command'
-require 'ig_markets/cli/activities_command'
-require 'ig_markets/cli/config_file'
-require 'ig_markets/cli/confirmation_command'
-require 'ig_markets/cli/output'
-require 'ig_markets/cli/search_command'
-require 'ig_markets/cli/sentiment_command'
-require 'ig_markets/cli/transactions_command'
 require 'ig_markets/client_sentiment'
 require 'ig_markets/deal_confirmation'
 require 'ig_markets/dealing_platform'
@@ -46,13 +34,37 @@ 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'
 require 'ig_markets/sprint_market_position'
+require 'ig_markets/transaction'
 require 'ig_markets/version'
 require 'ig_markets/watchlist'
 require 'ig_markets/working_order'
 
+require 'ig_markets/cli/commands/orders_command'
+require 'ig_markets/cli/commands/positions_command'
+require 'ig_markets/cli/commands/sprints_command'
+require 'ig_markets/cli/commands/watchlists_command'
+require 'ig_markets/cli/main'
+require 'ig_markets/cli/config_file'
+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/search_command'
+require 'ig_markets/cli/commands/sentiment_command'
+require 'ig_markets/cli/commands/transactions_command'
+require 'ig_markets/cli/tables/table'
+require 'ig_markets/cli/tables/accounts_table'
+require 'ig_markets/cli/tables/activities_table'
+require 'ig_markets/cli/tables/client_sentiments_table'
+require 'ig_markets/cli/tables/market_overviews_table'
+require 'ig_markets/cli/tables/working_orders_table'
+require 'ig_markets/cli/tables/positions_table'
+require 'ig_markets/cli/tables/sprint_market_positions_table'
+require 'ig_markets/cli/tables/transactions_table'
+
 # This module contains all the code for the IG Markets gem. See `README.md` and the {DealingPlatform} class to get
 # started with using this gem.
 module IGMarkets

data/lib/ig_markets/{account_activity.rb → activity.rb}

@@ -2,7 +2,7 @@ module IGMarkets
   # Contains details on a single activity that occurred on an IG Markets account. Returned by
   # {DealingPlatform::AccountMethods#activities_in_date_range} and
   # {DealingPlatform::AccountMethods#recent_activities}.
-  class AccountActivity < Model
+  class Activity < Model
     attribute :action_status, Symbol, allowed_values: [:accept, :reject, :manual, :not_set]
     attribute :activity
     attribute :activity_history_id

data/lib/ig_markets/cli/{account_command.rb → commands/account_command.rb}

@@ -6,10 +6,11 @@ module IGMarkets
 
       def account
         self.class.begin_session(options) do |dealing_platform|
-          dealing_platform.account.all.each do |account|
-            Output.print_account account
-            Output.print_account_balance account
-          end
+          accounts = dealing_platform.account.all
+
+          table = AccountsTable.new accounts
+
+          puts table
         end
       end
     end

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

@@ -0,0 +1,37 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets activities` command.
+    class Main
+      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'
+
+      def activities
+        self.class.begin_session(options) do |_dealing_platform|
+          activities = gather_account_history(:activities).sort_by(&:date)
+
+          table = ActivitiesTable.new activities
+
+          puts table
+        end
+      end
+
+      private
+
+      def gather_account_history(type)
+        days = options[:days]
+        start_date = options[:start_date]
+
+        if start_date
+          start_date = Date.strptime start_date, '%F'
+          end_date = start_date + days.to_i
+
+          Main.dealing_platform.account.send "#{type}_in_date_range", start_date, end_date
+        else
+          Main.dealing_platform.account.send "recent_#{type}", days
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets confirmation` command.
+    class Main < Thor
+      desc 'confirmation DEAL-REFERENCE', 'Prints the deal confirmation for the specified deal reference'
+
+      def confirmation(deal_reference)
+        self.class.begin_session(options) do |_dealing_platform|
+          Main.report_deal_confirmation deal_reference
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/{orders_command.rb → commands/orders_command.rb}

@@ -6,9 +6,11 @@ module IGMarkets
 
       def list
         Main.begin_session(options) do |dealing_platform|
-          dealing_platform.working_orders.all.each do |order|
-            Output.print_working_order order
-          end
+          working_orders = dealing_platform.working_orders.all
+
+          table = WorkingOrdersTable.new working_orders
+
+          puts table
         end
       end
 
@@ -36,32 +38,28 @@ module IGMarkets
         Main.begin_session(options) do |dealing_platform|
           deal_reference = dealing_platform.working_orders.create working_order_attributes
 
-          puts "Deal reference: #{deal_reference}"
-
-          Output.print_deal_confirmation dealing_platform.deal_confirmation(deal_reference)
+          Main.report_deal_confirmation deal_reference
         end
       end
 
-      desc 'update <DEAL-ID>', 'Updates an existing working order'
+      desc 'update DEAL-ID', 'Updates an existing working order'
 
       option :good_till_date, desc: 'The date that the order will live till, if not specified then the order will ' \
                                     'remain until it is deleted, format: yyyy-mm-ddThh:mm(+|-)zz:zz'
       option :level, type: :numeric, desc: 'The level at which the order will be triggered'
-      option :limit_distance, type: :numeric, desc: 'The distance away in pips to place the limit'
-      option :stop_distance, type: :numeric, desc: 'The distance away in pips to place the stop'
+      option :limit_distance, desc: 'The distance away in pips to place the limit'
+      option :stop_distance, desc: 'The distance away in pips to place the stop'
       option :type, desc: 'The order type, either \'limit\' or \'stop\''
 
       def update(deal_id)
         Main.begin_session(options) do |dealing_platform|
           deal_reference = dealing_platform.working_orders[deal_id].update working_order_attributes
 
-          puts "Deal reference: #{deal_reference}"
-
-          Output.print_deal_confirmation dealing_platform.deal_confirmation(deal_reference)
+          Main.report_deal_confirmation deal_reference
         end
       end
 
-      desc 'delete <DEAL-ID>', 'Deletes the working order with the specified deal ID'
+      desc 'delete DEAL-ID', 'Deletes the working order with the specified deal ID'
 
       def delete(deal_id)
         Main.begin_session(options) do |dealing_platform|
@@ -70,21 +68,18 @@ module IGMarkets
           raise 'No working order with the specified deal ID' unless working_order
 
           deal_reference = working_order.delete
-          puts "Deal reference: #{deal_reference}"
 
-          Output.print_deal_confirmation dealing_platform.deal_confirmation(deal_reference)
+          Main.report_deal_confirmation deal_reference
         end
       end
 
       private
 
+      ATTRIBUTES = [:currency_code, :direction, :epic, :expiry, :force_open, :good_till_date, :guaranteed_stop, :level,
+                    :limit_distance, :size, :stop_distance, :type].freeze
+
       def working_order_attributes
-        attributes = options.each_with_object({}) do |(key, value), new_hash|
-          if [:currency_code, :direction, :epic, :expiry, :force_open, :good_till_date, :guaranteed_stop, :level,
-              :limit_distance, :size, :stop_distance, :type].include? key.to_sym
-            new_hash[key.to_sym] = value
-          end
-        end
+        attributes = Main.filter_options options, ATTRIBUTES
 
         Main.parse_date_time attributes, :expiry, Date, '%F', 'yyyy-mm-dd'
         Main.parse_date_time attributes, :good_till_date, Time, '%FT%R%z', 'yyyy-mm-ddThh:mm(+|-)zz:zz'

data/lib/ig_markets/cli/{positions_command.rb → commands/positions_command.rb}

@@ -2,13 +2,21 @@ module IGMarkets
   module CLI
     # Implements the `ig_markets positions` command.
     class Positions < Thor
-      desc 'list', 'Prints open positions'
+      desc 'list', 'Prints open non-binary positions'
+
+      option :aggregate, type: :boolean, desc: 'Whether to aggregate separate positions in the same market'
 
       def list
         Main.begin_session(options) do |dealing_platform|
-          dealing_platform.positions.all.each do |position|
-            Output.print_position position
+          positions = dealing_platform.positions.all.reject do |position|
+            position.market.instrument_type == :binary
           end
+
+          positions_table = PositionsTable.new positions, aggregate: options[:aggregate]
+
+          puts positions_table
+
+          print_position_totals positions
         end
       end
 
@@ -42,16 +50,14 @@ module IGMarkets
         Main.begin_session(options) do |dealing_platform|
           deal_reference = dealing_platform.positions.create position_attributes
 
-          puts "Deal reference: #{deal_reference}"
-
-          Output.print_deal_confirmation dealing_platform.deal_confirmation(deal_reference)
+          Main.report_deal_confirmation deal_reference
         end
       end
 
-      desc 'update <DEAL-ID>', 'Updates attributes of an existing position'
+      desc 'update DEAL-ID', 'Updates attributes of an existing position'
 
-      option :limit_level, type: :numeric, desc: 'The limit level'
-      option :stop_level, type: :numeric, desc: 'The stop level'
+      option :limit_level, desc: 'The limit level'
+      option :stop_level, desc: 'The stop level'
       option :trailing_stop, type: :boolean, desc: 'Whether to use a trailing stop, defaults to false'
       option :trailing_stop_distance, type: :numeric, desc: 'The distance away in pips to place the trailing stop'
       option :trailing_stop_increment, type: :numeric, desc: 'The increment step in pips for the trailing stop'
@@ -62,7 +68,7 @@ module IGMarkets
         end
       end
 
-      desc 'close <DEAL-ID>', 'Closes or partially closes a position'
+      desc 'close DEAL-ID', 'Closes or partially closes a position'
 
       option :level, type: :numeric, desc: 'Required if and only if --order-type is \'limit\' or \'quote\''
       option :order_type, default: 'market', desc: 'The order type, must be \'limit\', \'market\' or \'quote\''
@@ -79,14 +85,12 @@ module IGMarkets
 
       private
 
-      def position_attributes
-        attributes = options.each_with_object({}) do |(key, value), new_hash|
-          next unless [:currency_code, :direction, :epic, :expiry, :force_open, :guaranteed_stop, :level,
-                       :limit_distance, :limit_level, :order_type, :quote_id, :size, :stop_distance, :stop_level,
-                       :time_in_force, :trailing_stop, :trailing_stop_increment].include? key.to_sym
+      ATTRIBUTES = [:currency_code, :direction, :epic, :expiry, :force_open, :guaranteed_stop, :level, :limit_distance,
+                    :limit_level, :order_type, :quote_id, :size, :stop_distance, :stop_level, :time_in_force,
+                    :trailing_stop, :trailing_stop_increment].freeze
 
-          new_hash[key.to_sym] = value
-        end
+      def position_attributes
+        attributes = Main.filter_options options, ATTRIBUTES
 
         Main.parse_date_time attributes, :expiry, Date, '%F', 'yyyy-mm-dd'
 
@@ -101,10 +105,18 @@ module IGMarkets
 
           deal_reference = yield position
 
-          puts "Deal reference: #{deal_reference}"
+          Main.report_deal_confirmation deal_reference
+        end
+      end
+
+      def print_position_totals(positions)
+        currency_totals = positions.group_by(&:currency).map do |currency, subset|
+          total = subset.map(&:profit_loss).reduce(:+)
 
-          Output.print_deal_confirmation dealing_platform.deal_confirmation(deal_reference)
+          Format.currency(total, currency).colorize(total < 0 ? :red : :green)
         end
+
+        puts "\nTotal profit/loss: #{currency_totals.join ', '}"
       end
     end
   end