ig_markets 0.15 → 0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4205e8e7a404222272416344c5f21e912de43256
-  data.tar.gz: 55595208ec8a08d8941d68387c6c61e19c436d5d
+  metadata.gz: 26ec69035134c7762495091e87dd4794c9aaebdf
+  data.tar.gz: 01373bb017a39473a812c60fa599ee0b4f082ec4
 SHA512:
-  metadata.gz: 230f8eb850b639d3a6fa479cd42101ecd89c901382951adaa5a69d064029623a30c042cbe9bc44ee16d11b0e1cf50c034dc99e0aa43f3081063b27cda4a797ec
-  data.tar.gz: 20991fd83b740be9a1bcc36ce2c112a7a63b2070adc9cf736617a130350b9810abe33663214b1b45889b3e53bda3741cc37f633068f1284cab30a09088d36d9b
+  metadata.gz: 6bad0ef7b8a20a769177bfbf8bb59454aa11f31c836efb62a8d9b18ce929a5aff7d59b5a2f51691d5f3862daa40bf00110136bc7a9d331336125c73335c96bd8
+  data.tar.gz: ac90eab61abcfa36d8c022f9d89514eee691e49feafd7aecbf579e710ba1880fea613b0d069a1cb5c2a0bd041a1d0d8a01a31186160ebb7f8c29436a0f446e00

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # IG Markets Changelog
 
+### 0.16 — July 20, 2016
+
+- Switched to YAML for the `.ig_markets` config files and added support for storing multiple authentication profiles in
+  the config files that can then be selected on the command-line using the new `--profile NAME` argument
+- Added `IGMarkets::DealingPlatform#client_account_summary`
+- Report the HTTP code when a request fails
+
 ### 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

data/README.md

@@ -46,21 +46,31 @@ $ ig_markets COMMAND [SUBCOMMAND] --username USERNAME --password PASSWORD --api-
 
 #### 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
+On startup `ig_markets` looks for config files at `./.ig_markets.yml` and `~/.ig_markets.yml`. These are YAML files that
+can hold named sets of predefined authentication profiles in order to avoid having to specify these repeatedly on the
+command-line for every invocation.
+
+The desired authentication profile is specified using the `--profile` command-line argument, and if the `--profile`
+argument is omitted then the `default` profile will be used.
+
+Here is an example of a config file with a `default` profile and a `demo` profile:
+
+```yaml
+profiles:
+  default:
+    username: USERNAME
+    password: PASSWORD
+    api-key: API-KEY
+
+  demo:
+    username: DEMO-USERNAME
+    password: DEMO-PASSWORD
+    api-key: DEMO-API-KEY
+    demo: true
 ```
 
-The following examples assume the presence of a config file that contains valid authentication details.
-
+The following examples assume the presence of a config file that contains a valid default authentication profile.
+    
 #### Commands
 
 Use `ig_markets help` to get details on the options accepted by the commands and subcommands. The list of available

data/lib/ig_markets/activity.rb

@@ -22,14 +22,14 @@ module IGMarkets
       attribute :direction, Symbol, allowed_values: [:buy, :sell]
       attribute :good_till_date
       attribute :guaranteed_stop, Boolean
-      attribute :level, Float, nil_if: 0
+      attribute :level, Float
       attribute :limit_distance, Fixnum
-      attribute :limit_level, Float, nil_if: 0
+      attribute :limit_level, Float
       attribute :market_name
       attribute :size
       attribute :stop_distance, Fixnum
-      attribute :stop_level, Float, nil_if: 0
-      attribute :trailing_step, Float, nil_if: 0
+      attribute :stop_level, Float
+      attribute :trailing_step, Float
       attribute :trailing_stop_distance, Fixnum
     end
 

data/lib/ig_markets/cli/config_file.rb

@@ -1,33 +1,36 @@
 module IGMarkets
   module CLI
-    # Helper class for working with the config files supported by the command-line client.
+    # Helper class for working with the YAML config files supported by the command-line client. A config file has a
+    # `profiles` root key and every subkey of this root key specifies the name of a profile. The values underneath each
+    # subkey are then interpreted as command-line arguments. The profile to use is chosen using the `--profiles`
+    # command-line argument.
+    #
+    # See `README.md` for further details.
     class ConfigFile
-      # Initializes this config file with the passed lines.
+      # Initializes this config file with the passed content.
       #
-      # @param [Array<String>] lines
-      def initialize(lines = [])
-        @lines = lines
-      end
+      # @param [Hash] content
+      def initialize(content = {})
+        @content = content || {}
 
-      # Returns the arguments contained in this config file.
-      #
-      # @return [Array<String>]
-      def arguments
-        @lines.map { |line| line.gsub(/#.*/, '') }
-              .map(&:strip)
-              .join(' ')
-              .split(' ')
+        @profiles = (@content['profiles'] || {}).each_with_object({}) do |(profile_name, profile_arguments), result|
+          result[profile_name] = profile_arguments.map do |argument, value|
+            "--#{argument}=#{value}"
+          end
+        end
       end
 
-      # Inserts the arguments from this config file into the passed arguments array.
+      # Inserts the arguments specified in this config file into the passed arguments array.
       #
       # @param [Array<String>] argv The array of command-line arguments to alter.
-      def prepend_arguments_to_argv(argv)
+      def prepend_profile_arguments_to_argv(argv)
+        profile = selected_profile argv
+
         insert_index = argv.index do |argument|
           argument[0] == '-'
         end || -1
 
-        argv.insert insert_index, *arguments
+        argv.insert insert_index, *@profiles.fetch(profile, [])
       end
 
       # Takes a list of potential config files and returns a {ConfigFile} instance for the first one that exists.
@@ -38,7 +41,21 @@ module IGMarkets
           File.exist? filename
         end
 
-        new(config_file ? File.readlines(config_file) : [])
+        new(config_file && YAML.load_file(config_file))
+      end
+
+      private
+
+      # Searches the passed arguments list for the name of the profile to use (specified by the `--profile` argument).
+      def selected_profile(argv)
+        profile_index = argv.index '--profile'
+
+        if profile_index
+          argv.delete_at profile_index
+          argv.delete_at profile_index
+        else
+          'default'
+        end
       end
     end
   end

data/lib/ig_markets/cli/main.rb

@@ -8,6 +8,7 @@ module IGMarkets
       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 the live platform)'
       class_option :verbose, type: :boolean, desc: 'Whether to print the raw REST API requests and responses'
+      class_option :profile, desc: 'The name of the authentication profile to use (will be read from the config file)'
 
       desc 'orders [SUBCOMAND=list ...]', 'Command for working with orders'
       subcommand 'orders', Orders
@@ -44,7 +45,7 @@ module IGMarkets
         #
         # @param [Array<String>] argv The array of command-line arguments.
         def bootstrap(argv)
-          config_file.prepend_arguments_to_argv argv
+          config_file.prepend_profile_arguments_to_argv argv
 
           if argv.index('--version') || argv.index('-v')
             puts VERSION
@@ -68,7 +69,7 @@ module IGMarkets
 
           yield @dealing_platform
         rescue IGMarkets::RequestFailedError => request_failed_error
-          error "Request error: #{request_failed_error.error}"
+          error "Request error (HTTP #{request_failed_error.http_code}): #{request_failed_error.error}"
         rescue ArgumentError => argument_error
           error "Argument error: #{argument_error}"
         end
@@ -147,7 +148,7 @@ module IGMarkets
         #
         # @return [ConfigFile]
         def config_file
-          ConfigFile.find "#{Dir.pwd}/.ig_markets", "#{Dir.home}/.ig_markets"
+          ConfigFile.find "#{Dir.pwd}/.ig_markets.yml", "#{Dir.home}/.ig_markets.yml"
         end
 
         # Prints out details of the passed deal confirmation.

data/lib/ig_markets/client_account_summary.rb

@@ -1,5 +1,5 @@
 module IGMarkets
-  # Contains details on an IG Markets client account summary. Returned by {DealingPlatform#sign_in}.
+  # Contains details on an IG Markets client account summary. Returned by {DealingPlatform#client_account_summary}.
   class ClientAccountSummary < Model
     # Contains details on a form, used by {#form_details}.
     class FormDetails < Model

data/lib/ig_markets/dealing_platform.rb

@@ -17,6 +17,9 @@ module IGMarkets
     # @return [Session] The session used by this dealing platform.
     attr_reader :session
 
+    # @return [ClientAccountSummary] The summary of the client account that is returned as part of a successful sign in.
+    attr_reader :client_account_summary
+
     # @return [AccountMethods] Methods for working with the logged in account.
     attr_reader :account
 
@@ -57,7 +60,8 @@ module IGMarkets
     # @param [String] api_key The account API key.
     # @param [:live, :demo] platform The platform to use.
     #
-    # @return [ClientAccountSummary] The client account summary returned by the sign in request.
+    # @return [ClientAccountSummary] The client account summary returned by the sign in request. This result can also
+    #                                be accessed through the {#client_account_summary} accessor.
     def sign_in(username, password, api_key, platform)
       session.username = username
       session.password = password
@@ -66,7 +70,7 @@ module IGMarkets
 
       result = session.sign_in
 
-      instantiate_models ClientAccountSummary, result
+      @client_account_summary = instantiate_models ClientAccountSummary, result
     end
 
     # Signs out of the IG Markets Dealing Platform, ending any current session.

data/lib/ig_markets/response_parser.rb

@@ -25,7 +25,7 @@ module IGMarkets
     def parse(response)
       if response.is_a? Hash
         response.each_with_object({}) do |(key, value), new_hash|
-          new_hash[camel_case_to_snake_case(key).downcase.to_sym] = parse(value)
+          new_hash[camel_case_to_snake_case(key).to_sym] = parse(value)
         end
       elsif response.is_a? Array
         response.map { |item| parse item }
@@ -40,7 +40,7 @@ module IGMarkets
     #
     # @return [String]
     def camel_case_to_snake_case(camel_case)
-      camel_case.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').gsub(/([A-Z])([A-Z])([a-z])/, '\1_\2\3')
+      camel_case.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').gsub(/([A-Z])([A-Z])([a-z])/, '\1_\2\3').downcase
     end
   end
 end

data/lib/ig_markets/version.rb

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

data/lib/ig_markets.rb

@@ -7,6 +7,7 @@ require 'rest-client'
 require 'securerandom'
 require 'terminal-table'
 require 'thor'
+require 'yaml'
 
 require 'ig_markets/boolean'
 require 'ig_markets/model'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.15'
+  version: '0.16'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 description: 
 email: richard.viney@gmail.com
 executables:
@@ -310,4 +310,3 @@ specification_version: 4
 summary: Ruby library and command-line client for accessing the IG Markets dealing
   platform.
 test_files: []
-has_rdoc: