ig_markets 0.26 → 0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 593ec96300d193a18f730b26cf9dedb9aec19f54
-  data.tar.gz: fa29e0da14e82bfb9f53c266275d7a176286a124
+  metadata.gz: 38e42f2852c1b0b82d37dcd2268baeea8fe96285
+  data.tar.gz: 785316d7a75af12c80128175e93a8130e38a0182
 SHA512:
-  metadata.gz: 11a54058f41f9a7e897be4040590eb35f4d1e18117c1ed2a021dc4040f0f937f930f57dcf6565de534e911c47c84139020519a03b0672ba5a28f34bddf66f97f
-  data.tar.gz: 04def1bdd5817c224bac244e0caf332ae1aed58d951de207b220d061902d38f934b917ea9193a3945ae539d877fce8cc5a1abf2c51bdf7411a5401f950a1c2da
+  metadata.gz: 3513fd82d3776331f049479a649206b47803047645ec2a51695dde2492ebdfeaed15678da1ce32f9fca8ecdb5bfa91644f1a6619dbd7b1919a2555791a7382af
+  data.tar.gz: b0408775065f32ac25fe8e0e867ca011eb07e85a91be8508ac41a000a792bffed42fbcf2e38835a667b1f59e76186cd6014e22cb885fffac38c8382c7917512b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # IG Markets Changelog
 
+### 0.27 — January 18, 2017
+
+- Added `IGMarkets::Format.colored_currency`
+- Fixed `ig_markets help` command not working when using a config file
+
 ### 0.26 — January 12, 2017
 
 - Fully support Ruby 2.4

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

@@ -2,7 +2,7 @@ module IGMarkets
   module CLI
     # Implements the `ig_markets console` command.
     class Main < Thor
-      desc 'console', 'Logs in and opens a live Ruby console, the IGMarkets::DealingPlatform instance is named \'ig\''
+      desc 'console', "Logs in and opens a live Ruby console, the IGMarkets::DealingPlatform instance is named 'ig'"
 
       def console
         self.class.begin_session(options) do |dealing_platform|

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

@@ -18,7 +18,7 @@ module IGMarkets
 
       desc 'create', 'Creates a new working order'
 
-      option :currency_code, required: true, desc: 'The 3 character currency code, must be one of the instrument\'s ' \
+      option :currency_code, required: true, desc: "The 3 character currency code, must be one of the instrument's " \
                                                    'currencies'
       option :direction, enum: %w(buy sell), required: true, desc: 'The trade direction'
       option :epic, required: true, desc: 'The EPIC of the market to trade'

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

@@ -65,7 +65,7 @@ module IGMarkets
 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)}
+Total: #{Format.colored_currency profit_loss, currency}
 END
       end
     end

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

@@ -24,14 +24,14 @@ module IGMarkets
 
       desc 'create', 'Creates a new position'
 
-      option :currency_code, required: true, desc: 'The 3 character currency code, must be one of the instrument\'s ' \
+      option :currency_code, required: true, desc: "The 3 character currency code, must be one of the instrument's " \
                                                    'currencies'
       option :direction, required: true, enum: %w(buy sell), desc: 'The trade direction'
       option :epic, required: true, desc: 'The EPIC of the market to trade'
       option :expiry, desc: 'The expiry date of the instrument (if applicable), format: yyyy-mm-dd'
       option :force_open, type: :boolean, default: false, desc: 'Whether a force open is required'
       option :guaranteed_stop, type: :boolean, default: false, desc: 'Whether a guaranteed stop is required'
-      option :level, type: :numeric, desc: 'Required if and only if --order-type is \'limit\' or \'quote\''
+      option :level, type: :numeric, desc: "Required if and only if --order-type is 'limit' or 'quote'"
       option :limit_distance, type: :numeric, desc: 'The distance away in pips to place the limit, if set then ' \
                                                     '--limit-level must not be used'
       option :limit_level, type: :numeric, desc: 'The limit level, if set then --limit-distance must not be used'
@@ -70,7 +70,7 @@ module IGMarkets
 
       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 :level, type: :numeric, desc: "Required if and only if --order-type is 'limit' or 'quote'"
       option :order_type, enum: %w(limit market quote), default: 'market', desc: 'The order type'
       option :quote_id, desc: 'The Lightstreamer quote ID, required when using --order-type=quote'
       option :size, type: :numeric, desc: 'The size of the position to close, if not specified then the entire ' \
@@ -130,7 +130,7 @@ module IGMarkets
         currency_totals = positions.group_by(&:currency).map do |currency, subset|
           total = subset.map(&:profit_loss).reduce :+
 
-          Format.currency(total, currency).colorize(total < 0 ? :red : :green)
+          Format.colored_currency total, currency
         end
 
         puts "\nTotal profit/loss: #{currency_totals.join ', '}"

data/lib/ig_markets/cli/main.rb

@@ -46,7 +46,7 @@ module IGMarkets
         #
         # @param [Array<String>] argv The array of command-line arguments.
         def bootstrap(argv)
-          config_file.prepend_profile_arguments_to_argv argv
+          config_file.prepend_profile_arguments_to_argv argv unless argv.first == 'help'
 
           if argv.index('--version') || argv.index('-v')
             puts VERSION
@@ -110,7 +110,7 @@ module IGMarkets
             begin
               attributes[attribute] = klass.strptime attributes[attribute], format
             rescue ArgumentError
-              raise ArgumentError, "invalid #{attribute}, use format \"#{display_format}\""
+              raise ArgumentError, %(invalid #{attribute}, use format "#{display_format}")
             end
           else
             attributes[attribute] = nil
@@ -170,9 +170,7 @@ END
         def print_deal_confirmation_profit_loss(deal_confirmation)
           return unless deal_confirmation.profit
 
-          profit = Format.currency deal_confirmation.profit, deal_confirmation.profit_currency
-
-          puts "Profit/loss: #{profit.colorize(deal_confirmation.profit < 0 ? :red : :green)}"
+          puts "Profit/loss: #{Format.colored_currency deal_confirmation.profit, deal_confirmation.profit_currency}"
         end
       end
     end

data/lib/ig_markets/dealing_platform.rb

@@ -1,6 +1,6 @@
 module IGMarkets
   # This is the primary class for interacting with the IG Markets API. After signing in using {#sign_in} most
-  # functionality is accessed via the following top-level methods:
+  # functionality can be accessed using the following methods:
   #
   # - {#account}
   # - {#client_sentiment}
@@ -11,9 +11,9 @@ module IGMarkets
   # - {#working_orders}
   # - {#streaming}
   #
-  # See `README.md` for examples.
+  # See `README.md` for code examples.
   #
-  # If any errors occur while executing requests to the IG Markets API then an {IGMarketsError} will be raised.
+  # If any errors occur while executing requests to the IG Markets API then an {IGMarketsError} subclass will be raised.
   class DealingPlatform
     # The session used by this dealing platform.
     #
@@ -25,7 +25,7 @@ module IGMarkets
     # @return [ClientAccountSummary]
     attr_reader :client_account_summary
 
-    # Methods for working with the logged in account.
+    # Methods for working with the balances and history of the logged in account.
     #
     # @return [AccountMethods]
     attr_reader :account
@@ -80,13 +80,13 @@ module IGMarkets
 
     # 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 [String] username The IG Markets username.
+    # @param [String] password The IG Markets password.
+    # @param [String] api_key The IG Markets API key.
     # @param [:live, :demo] platform The platform to use.
     #
     # @return [ClientAccountSummary] The client account summary returned by the sign in request. This result can also
-    #                                be accessed through the {#client_account_summary} accessor.
+    #                                be accessed later using {#client_account_summary}.
     def sign_in(username, password, api_key, platform)
       session.username = username
       session.password = password
@@ -118,9 +118,9 @@ 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.
+    # Disables the API key currently being used by the logged in session. This means that any further requests to the IG
+    # Markets API with this key will raise {Errors::APIKeyDisabledError}. Disabled API keys can only be re-enabled
+    # through the web platform.
     #
     # @return [Application]
     def disable_api_key

data/lib/ig_markets/format.rb

@@ -20,19 +20,34 @@ module IGMarkets
     # currencies except the Japanese Yen.
     #
     # @param [Float, Integer] amount The currency amount to format.
-    # @param [String] currency The currency.
+    # @param [String] currency_name The name or symbol of the currency.
     #
     # @return [String] The formatted currency amount, e.g. `"USD -130.40"`, `"AUD 539.10"`, `"JPY 3560"`.
-    def currency(amount, currency)
+    def currency(amount, currency_name)
       return '' unless amount
 
-      if ['JPY', '¥'].include? currency
-        "#{currency} #{format '%i', amount.to_i}"
+      if ['JPY', '¥'].include? currency_name
+        "#{currency_name} #{format '%i', amount.to_i}"
       else
-        "#{currency} #{format '%.2f', amount.to_f}"
+        "#{currency_name} #{format '%.2f', amount.to_f}"
       end
     end
 
+    # Returns a formatted string for the specified currency amount and currency, and colors it red for negative values
+    # and green for positive values. Two decimal places are used for all currencies except the Japanese Yen.
+    #
+    # @param [Float, Integer] amount The currency amount to format.
+    # @param [String] currency_name The currency.
+    #
+    # @return [String] The formatted and colored currency amount, e.g. `"USD -130.40"`, `"AUD 539.10"`, `"JPY 3560"`.
+    def colored_currency(amount, currency_name)
+      return '' unless amount
+
+      color = amount < 0 ? :red : :green
+
+      currency(amount, currency_name).send color
+    end
+
     # Returns a formatted string for the specified number of seconds in the format `[<hours>:]<minutes>:<seconds>`.
     #
     # @param [Integer] value The number of seconds to format.

data/lib/ig_markets/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.26'
+  version: '0.27'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: '0.47'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: '0.47'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement