ig_markets 0.9 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dd48141e03cc58042b6b5c14ae2f7d4a1a0b55c
-  data.tar.gz: 4c3467cc309a493209f646665b27b48eef0daa45
+  metadata.gz: 443589ca4b1af7f2e0de04ba1ca8be7f9b1450ec
+  data.tar.gz: 875b689e9ed88ec0b594b4dac26b43ff669366b4
 SHA512:
-  metadata.gz: 80af908f64fe291975ad4364a4cbc6b713f3f8f37df7dc0f15e2697cc5b4f4f2ee4ebf48c09ec41064f50b687930b45680645b51ec1299f8c3b56213783c8c95
-  data.tar.gz: 46e5518f0bcd7371ef63799da17e1b7d189b81a6a7a477ecd0e580b87e6ce48760a6a19d4d3eedea61517e227c359a413ac105212038dbcdcf5afeaf7d231fd6
+  metadata.gz: 0402b33e23f7fd885d74382b50057242e9cd17fe53322e065180e09784f5a530a046a29bdecb88376e1ef7022eb9e21c26eac2db23752676795ba0783a6d29d4
+  data.tar.gz: f26909d155efbb51262d8fddabc0f6c1a72a2de743da7f6aa6ce09518e8c8834e500f087d285e8357980ab72a7319b69c38fd10609226aa9688eacffb05c0b65

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # IG Markets Changelog
 
+### 0.10 — May 9, 2016
+
+- Added `--epic` option to the `ig_markets activities` command
+- Added `--sort-by` option to the `ig_markets activities` and `ig_markets transactions` commands
+- The `--instrument` option for `ig_markets transactions` is no longer case-sensitive
+- Added `ig_markets positions close-all` to close all open positions at once
+- Added `IGMarkets::DealingPlatform#disable_api_key`
+
 ### 0.9 — May 2, 2016
 
 - `IGMarkets::DealingPlatform#sign_in` now returns an `IGMarkets::ClientAccountSummary` instance

data/README.md

@@ -67,7 +67,7 @@ Use `ig_markets help` to get details on the options accepted by the commands and
 commands and their subcommands is:
 
 - `ig_markets account`
-- `ig_markets activities --days N [--from YYYY-MM-DD]`
+- `ig_markets activities --days N [...]`
 - `ig_markets confirmation DEAL-REFERENCE`
 - `ig_markets console`
 - `ig_markets help [COMMAND]`
@@ -75,20 +75,21 @@ commands and their subcommands is:
 - `ig_markets orders create ...`
 - `ig_markets orders update DEAL-ID ...`
 - `ig_markets orders delete DEAL-ID`
-- `ig_markets positions [list] [--aggregate]`
+- `ig_markets positions [list] [...]`
 - `ig_markets positions create ...`
 - `ig_markets positions update DEAL-ID ...`
 - `ig_markets positions close DEAL-ID [...]`
-- `ig_markets prices --epic EPIC --resolution RESOLUTION [...]`
+- `ig_markets positions close-all [...]`
+- `ig_markets prices --epic EPIC --resolution RESOLUTION ...`
 - `ig_markets search QUERY [--type TYPE]`
 - `ig_markets sentiment MARKET`
 - `ig_markets sprints [list]`
 - `ig_markets sprints create ...`
-- `ig_markets transactions --days N [--from YYYY-MM-DD] [--instrument INSTRUMENT] [--no-interest]`
+- `ig_markets transactions --days N [...]`
 - `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 create NAME [EPIC ...]`
+- `ig_markets watchlists add-markets WATCHLIST-ID [EPIC ...]`
+- `ig_markets watchlists remove-markets WATCHLIST-ID [EPIC ...]`
 - `ig_markets watchlists delete WATCHLIST-ID`
 
 #### Examples
@@ -127,7 +128,7 @@ 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
 
-# Log in and then open a Ruby console which can be used to query the IG API, all REST requests will be printed in full
+# Log in and then open a Ruby console which can be used to query the IG API, all REST requests will be shown
 ig_markets console --print-requests
 ```
 

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

@@ -6,10 +6,12 @@ module IGMarkets
 
       option :days, type: :numeric, required: true, desc: 'The number of days to print account activities for'
       option :from, desc: 'The start date to print account activities from, format: yyyy-mm-dd'
+      option :epic, desc: 'Regex for filtering activities based on their EPIC'
+      option :sort_by, enum: %w(channel date epic type), default: 'date', desc: 'The attribute to sort activities by'
 
       def activities
         self.class.begin_session(options) do |dealing_platform|
-          activities = gather_account_history(:activities, dealing_platform).sort_by(&:date)
+          activities = gather_activities dealing_platform
 
           table = ActivitiesTable.new activities
 
@@ -19,6 +21,31 @@ module IGMarkets
 
       private
 
+      def gather_activities(dealing_platform)
+        @epic_regex = Regexp.new options.fetch('epic', ''), Regexp::IGNORECASE
+
+        result = gather_account_history(:activities, dealing_platform).select do |activity|
+          activity_filter activity
+        end
+
+        result.sort_by do |activity|
+          [activity.send(activity_sort_attribute), activity.date]
+        end
+      end
+
+      def activity_filter(activity)
+        @epic_regex.match activity.epic
+      end
+
+      def activity_sort_attribute
+        {
+          'channel' => :channel,
+          'date' => :date,
+          'epic' => :epic,
+          'type' => :transaction_type
+        }.fetch options[:sort_by]
+      end
+
       def gather_account_history(method_name, dealing_platform)
         history_options = if options[:from]
                             from = Date.strptime options[:from], '%F'

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

@@ -83,6 +83,21 @@ module IGMarkets
         end
       end
 
+      desc 'close-all', 'Closes all open positions'
+
+      option :order_type, enum: %w(limit market quote), default: 'market', desc: 'The order type'
+      option :time_in_force, enum: %w(execute-and-eliminate fill-or-kill), desc: 'The order fill strategy'
+
+      def close_all
+        Main.begin_session(options) do |dealing_platform|
+          dealing_platform.positions.all.each do |position|
+            deal_reference = position.close position_attributes
+
+            Main.report_deal_confirmation deal_reference
+          end
+        end
+      end
+
       private
 
       ATTRIBUTES = [:currency_code, :direction, :epic, :expiry, :force_open, :guaranteed_stop, :level, :limit_distance,

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

@@ -8,6 +8,8 @@ module IGMarkets
       option :from, desc: 'The start date to print account transactions from, format: yyyy-mm-dd'
       option :instrument, desc: 'Regex for filtering transactions based on their instrument'
       option :interest, type: :boolean, default: true, desc: 'Whether to show interest deposits and withdrawals'
+      option :sort_by, enum: %w(date instrument profit-loss type), default: 'date', desc: 'The attribute to sort ' \
+                                                                                          'transactions by'
 
       def transactions
         self.class.begin_session(options) do |dealing_platform|
@@ -27,11 +29,30 @@ module IGMarkets
       private
 
       def gather_transactions(dealing_platform)
-        regex = Regexp.new options.fetch('instrument', '')
+        @instrument_regex = Regexp.new options.fetch('instrument', ''), Regexp::IGNORECASE
 
-        gather_account_history(:transactions, dealing_platform).sort_by(&:date_utc).select do |transaction|
-          regex.match(transaction.instrument_name) && (options[:interest] || !transaction.interest?)
+        result = gather_account_history(:transactions, dealing_platform).select do |transaction|
+          transaction_filter transaction
         end
+
+        result.sort_by do |transaction|
+          [transaction.send(transaction_sort_attribute), transaction.date_utc]
+        end
+      end
+
+      def transaction_filter(transaction)
+        return false if !options[:interest] && transaction.interest?
+
+        @instrument_regex.match transaction.instrument_name
+      end
+
+      def transaction_sort_attribute
+        {
+          'date' => :date_utc,
+          'instrument' => :instrument_name,
+          'profit-loss' => :profit_and_loss_amount,
+          'type' => :transaction_type
+        }.fetch options[:sort_by]
       end
 
       def transaction_totals(transactions)

data/lib/ig_markets/cli/config_file.rb

@@ -22,8 +22,6 @@ module IGMarkets
       # Inserts the arguments from this config file into the passed arguments array.
       #
       # @param [Array<String>] argv The array of command-line arguments to alter.
-      #
-      # @return [void]
       def prepend_arguments_to_argv(argv)
         insert_index = argv.index do |argument|
           argument[0] == '-'

data/lib/ig_markets/cli/main.rb

@@ -26,8 +26,6 @@ module IGMarkets
         # any config files, implementing the --version/-v options, and then invoking the main application.
         #
         # @param [Array<String>] argv The array of command-line arguments.
-        #
-        # @return [void]
         def bootstrap(argv)
           config_file.prepend_arguments_to_argv argv
 
@@ -43,8 +41,6 @@ module IGMarkets
         # occur. This method is used by all of the commands in order to authenticate.
         #
         # @param [Thor::CoreExt::HashWithIndifferentAccess] options The Thor options hash.
-        #
-        # @return [void]
         def begin_session(options)
           platform = options[:demo] ? :demo : :production
 
@@ -65,8 +61,6 @@ module IGMarkets
         # This is done because sometimes there is a delay in the processing of the deal by IG Markets.
         #
         # @param [String] deal_reference The deal reference.
-        #
-        # @return [void]
         def report_deal_confirmation(deal_reference)
           puts "Deal reference: #{deal_reference}"
 
@@ -89,8 +83,6 @@ module IGMarkets
         # @param [String] format The `strptime` format string for the attribute.
         # @param [String] display_format The human-readable version of `format` to put into the raised exception if
         #                 there is a problem parsing the attribute.
-        #
-        # @return [void]
         def parse_date_time(attributes, attribute, klass, format, display_format)
           return unless attributes.key? attribute
 
@@ -141,8 +133,6 @@ module IGMarkets
         # Prints out details of the passed deal confirmation.
         #
         # @param [DealConfirmation] deal_confirmation The deal confirmation to print out.
-        #
-        # @return [void]
         def print_deal_confirmation(deal_confirmation)
           puts <<-END
 Deal ID: #{deal_confirmation.deal_id}

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

@@ -8,7 +8,7 @@ module IGMarkets
       # @param [Hash] options The options hash.
       # @option options [String] :title The title for this table.
       def initialize(models, options = {})
-        @models = models
+        @models = Array(models).flatten
         @title = options[:title] || default_title
       end
 
@@ -43,7 +43,7 @@ module IGMarkets
       end
 
       def rows
-        @models.flatten.each_with_index.map do |model, row_index|
+        @models.each_with_index.map do |model, row_index|
           if model == :separator
             :separator
           else

data/lib/ig_markets/dealing_platform.rb

@@ -88,6 +88,15 @@ module IGMarkets
       instantiate_models Application, session.get('operations/application')
     end
 
+    # Disables the API key currently in use by the logged in session. This means that any further requests to the IG
+    # Markets API with this key will fail with the error `error.security.api-key-disabled`. Disabled API keys can only
+    # be re-enabled through the web platform.
+    #
+    # @return [Application]
+    def disable_api_key
+      instantiate_models Application, session.put('operations/application/disable')
+    end
+
     # This method is used to instantiate the various `Model` subclasses from data returned by the IG Markets API. It
     # recurses through arrays and sub-hashes present in `source`, instantiating the required models based on the types
     # of each attribute as defined on the models. All model instances returned by this method will have their

data/lib/ig_markets/model.rb

@@ -126,8 +126,6 @@ module IGMarkets
       # attributes to be set on the model but not have them be part of the model's structure.
       #
       # @param [Array<Symbol>] names The names of the deprecated attributes.
-      #
-      # @return [void]
       def deprecated_attribute(*names)
         names.each do |name|
           define_method "#{name}=" do |_value|

data/lib/ig_markets/request_printer.rb

@@ -9,8 +9,6 @@ module IGMarkets
       # Prints out an options hash that is ready to be passed to `RestClient::Request.execute`.
       #
       # @param [Hash] options The options hash.
-      #
-      # @return [void]
       def print_options(options)
         return unless enabled
 
@@ -27,8 +25,6 @@ module IGMarkets
       # Formats and prints a JSON response body.
       #
       # @param [String] body The response body.
-      #
-      # @return [void]
       def print_response_body(body)
         return unless enabled
 

data/lib/ig_markets/session.rb

@@ -84,7 +84,7 @@ module IGMarkets
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
-    def put(url, payload, api_version = API_V1)
+    def put(url, payload = nil, api_version = API_V1)
       request(method: :put, url: url, payload: payload, api_version: api_version).fetch :result
     end
 
@@ -99,16 +99,12 @@ module IGMarkets
       request(method: :delete, url: url, payload: payload, api_version: api_version).fetch :result
     end
 
-    # Returns a human-readable string containing this session's details.
-    #
-    # @return [String]
-    def inspect
-      "#<#{self.class.name} #{client_security_token}, #{x_security_token}>"
-    end
-
     private
 
-    HOST_URLS = { demo: 'https://demo-api.ig.com/gateway/deal/', production: 'https://api.ig.com/gateway/deal/' }.freeze
+    HOST_URLS = {
+      demo: 'https://demo-api.ig.com/gateway/deal/',
+      production: 'https://api.ig.com/gateway/deal/'
+    }.freeze
 
     def validate_authentication
       %i(username password api_key).each do |attribute|

data/lib/ig_markets/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize