ig_markets 0.5 → 0.6

data/lib/ig_markets/cli/config_file.rb

@@ -17,7 +17,7 @@ module IGMarkets
               .split(' ')
       end
 
-      # Returns the config file to use, or nil if there is no config file.
+      # Returns the config file to use, or `nil` if there is no config file.
       #
       # @return [CLI::ConfigFile]
       def self.find

data/lib/ig_markets/cli/main.rb

@@ -7,6 +7,7 @@ module IGMarkets
       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 :account_time_zone, default: '+0000', desc: 'The time zone of the account'
       class_option :print_requests, type: :boolean, desc: 'Whether to print the raw REST API requests and responses'
 
       desc 'orders [SUBCOMAND=list ...]', 'Command for working with orders'
@@ -33,23 +34,31 @@ module IGMarkets
 
           RequestPrinter.enabled = true if options[:print_requests]
 
+          dealing_platform.account_time_zone = options[:account_time_zone]
+
           dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
 
           yield dealing_platform
         rescue IGMarkets::RequestFailedError => error
-          warn "Request error: #{error.error}"
-          exit 1
+          error "Request error: #{error.error}"
         rescue ArgumentError => error
-          warn "Argument error: #{error}"
+          error "Argument error: #{error}"
+        end
+
+        # Writes the passed message to `stderr` and then exits the application.
+        #
+        # @param [String] message The error message.
+        def error(message)
+          warn message
           exit 1
         end
 
-        # The dealing platform instance used by {begin_session}.
+        # The {DealingPlatform} instance used by {begin_session}.
         def dealing_platform
           @dealing_platform ||= DealingPlatform.new
         end
 
-        # Takes a deal reference and prints out its full deal confirmation.
+        # Requests and displays the deal confirmation for the passed deal reference.
         #
         # @param [String] deal_reference The deal reference.
         #
@@ -59,24 +68,24 @@ module IGMarkets
 
           deal_confirmation = dealing_platform.deal_confirmation deal_reference
 
-          print "Deal confirmation: #{deal_confirmation.deal_id}, #{deal_confirmation.deal_status}, "
-
-          unless deal_confirmation.deal_status == :accepted
-            print "reason: #{deal_confirmation.reason}, "
-          end
+          puts <<-END
+Deal ID: #{deal_confirmation.deal_id}
+Status: #{Format.symbol deal_confirmation.deal_status}
+Result: #{Format.symbol deal_confirmation.status}
+END
 
-          puts "epic: #{deal_confirmation.epic}"
+          puts "Reason: #{Format.symbol deal_confirmation.reason}" unless deal_confirmation.deal_status == :accepted
         end
 
-        # Parses and validates a Date or Time option received as a command-line argument. Raises `ArgumentError` if it
-        # is been specified in an invalid format.
+        # Parses and validates a `Date` or `Time` option received as a command-line argument. Raises `ArgumentError` if
+        # it is been specified in an invalid format.
         #
         # @param [Hash] attributes The attributes hash.
         # @param [Symbol] attribute The name of the date or time attribute to parse and validate.
         # @param [Date, Time] klass The class to validate with.
         # @param [String] format The `strptime` format string for the attribute.
-        # @param [String] display_format The human-readable version of `format` to put into an exception if there is
-        #                 a problem parsing 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)
@@ -95,7 +104,7 @@ module IGMarkets
 
         # Takes a Thor options hash and filters out its keys in the specified whitelist. Thor has an unusual behavior
         # when an option is specified without a value: its value is set to the option's name. This method resets any
-        # such occurrences to nil.
+        # such occurrences to `nil`.
         #
         # @param [Thor::CoreExt::HashWithIndifferentAccess] options The Thor options.
         # @param [Array<Symbol>] whitelist The list of options allowed in the returned `Hash`.

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

@@ -25,6 +25,16 @@ module IGMarkets
             Format.currency account.balance.send(attribute), account.currency
           end
       end
+
+      def cell_color(value, _model, _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/cli/tables/historical_price_result_snapshots_table.rb

@@ -0,0 +1,25 @@
+module IGMarkets
+  module CLI
+    # Helper class that prints out an array of {IGMarkets::HistoricalPriceResult::Snapshot} instances in a table.
+    class HistoricalPriceResultSnapshotsTable < Table
+      private
+
+      def headings
+        %w(Date Open Close Low High)
+      end
+
+      def right_aligned_columns
+        [1, 2, 3, 4]
+      end
+
+      def row(snapshot)
+        [snapshot.snapshot_time, format_price(snapshot.open_price), format_price(snapshot.close_price),
+         format_price(snapshot.low_price), format_price(snapshot.high_price)]
+      end
+
+      def format_price(price)
+        (price.ask + price.bid) / 2.0
+      end
+    end
+  end
+end

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

@@ -80,7 +80,7 @@ module IGMarkets
       end
 
       def format_time(value)
-        value.utc.strftime '%F %T %Z'
+        value.localtime.strftime '%F %T %Z'
       end
 
       def format_date(value)
@@ -89,7 +89,7 @@ module IGMarkets
 
       def format_string(value)
         value = if value.is_a? Symbol
-                  value.to_s.tr '_', ' '
+                  Format.symbol value
                 else
                   value.to_s
                 end

data/lib/ig_markets/client_sentiment.rb

@@ -10,7 +10,9 @@ module IGMarkets
     #
     # @return [Array<ClientSentiment>]
     def related_sentiments
-      @dealing_platform.gather "clientsentiment/related/#{market_id}", :client_sentiments, ClientSentiment
+      result = @dealing_platform.session.get("clientsentiment/related/#{market_id}").fetch :client_sentiments
+
+      @dealing_platform.instantiate_models ClientSentiment, result
     end
   end
 end

data/lib/ig_markets/dealing_platform.rb

@@ -38,6 +38,11 @@ module IGMarkets
     # @return [WorkingOrderMethods] Methods for working with working orders.
     attr_reader :working_orders
 
+    # @return [String] The time zone of the account, e.g. `'+1000'` or `'-0800'`. This is required in order for certain
+    # dates and times reported by this library to be correct, due to the fact that the IG Markets API does not reliably
+    # report time zone details in all attributes. Defaults to `'+0000'`.
+    attr_accessor :account_time_zone
+
     def initialize
       @session = Session.new
 
@@ -48,6 +53,8 @@ module IGMarkets
       @sprint_market_positions = SprintMarketPositionMethods.new self
       @watchlists = WatchlistMethods.new self
       @working_orders = WorkingOrderMethods.new self
+
+      @account_time_zone = '+0000'
     end
 
     # Signs in to the IG Markets Dealing Platform, either the production platform or the demo platform.
@@ -74,30 +81,58 @@ module IGMarkets
     #
     # @return [DealConfirmation]
     def deal_confirmation(deal_reference)
-      DealConfirmation.from session.get "confirms/#{deal_reference}", API_V1
+      instantiate_models DealConfirmation, session.get("confirms/#{deal_reference}")
     end
 
     # Returns details on the IG Markets applications for the accounts associated with this login.
     #
     # @return [Array<Application>]
     def applications
-      Application.from session.get 'operations/application', API_V1
+      instantiate_models Application, session.get('operations/application')
     end
 
-    # Sends a GET request to a URL then takes a single key from the returned hash and converts its contents to an array
-    # of type `klass`.
+    # 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
+    # `@dealing_platform` instance variable set.
     #
-    # @param [String] url The URL to send a GET request to.
-    # @param [Symbol] collection The name of the top level symbol that contains the array of data to return.
-    # @param [Class] klass The type to return.
-    # @param [API_V1, API_V2, API_V3] api_version The API version to target for the request.
+    # @param [Class] model_class The type of model 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
+    #                                  instance of `model_class. If an `Array` then each entry will be passed through
+    #                                  this method individually.
     #
-    # @return [Array]
-    def gather(url, collection, klass, api_version = API_V1)
-      klass.from(session.get(url, api_version).fetch(collection)).tap do |result|
-        # Set @dealing_platform on all the results
-        result.each do |item|
-          item.instance_variable_set :@dealing_platform, self
+    # @return [nil, `model_class`, Array<`model_class`>] The resulting instantiated model(s).
+    def instantiate_models(model_class, source)
+      return nil if source.nil?
+
+      source = source.attributes if source.is_a? model_class
+
+      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}"
+      end
+    end
+
+    private
+
+    # 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)
+      model_class.new.tap do |model|
+        model.instance_variable_set :@dealing_platform, self
+
+        attributes.each do |attribute, value|
+          type = model_class.attribute_type attribute
+          value = instantiate_models(type, value) if type < Model
+
+          model.send "#{attribute}=", value
         end
       end
     end

data/lib/ig_markets/dealing_platform/account_methods.rb

@@ -13,7 +13,9 @@ module IGMarkets
       #
       # @return [Array<Account>]
       def all
-        @dealing_platform.gather 'accounts', :accounts, Account
+        result = @dealing_platform.session.get('accounts').fetch :accounts
+
+        @dealing_platform.instantiate_models Account, result
       end
 
       # Returns all account activities that occurred in the specified date range.
@@ -26,7 +28,9 @@ module IGMarkets
         from_date = format_date from_date
         to_date = format_date to_date
 
-        @dealing_platform.gather "history/activity/#{from_date}/#{to_date}", :activities, Activity
+        result = @dealing_platform.session.get("history/activity/#{from_date}/#{to_date}").fetch :activities
+
+        @dealing_platform.instantiate_models Activity, result
       end
 
       # Returns all account activities that occurred in the most recent specified number of days.
@@ -35,7 +39,9 @@ module IGMarkets
       #
       # @return [Array<Activity>]
       def recent_activities(days)
-        @dealing_platform.gather "history/activity/#{milliseconds(days)}", :activities, Activity
+        result = @dealing_platform.session.get("history/activity/#{milliseconds(days)}").fetch :activities
+
+        @dealing_platform.instantiate_models Activity, result
       end
 
       # Returns all transactions that occurred in the specified date range.
@@ -52,8 +58,9 @@ module IGMarkets
         to_date = format_date to_date
 
         url = "history/transactions/#{transaction_type.to_s.upcase}/#{from_date}/#{to_date}"
+        result = @dealing_platform.session.get(url).fetch :transactions
 
-        @dealing_platform.gather url, :transactions, Transaction
+        @dealing_platform.instantiate_models Transaction, result
       end
 
       # Returns all transactions that occurred in the last specified number of days.
@@ -66,8 +73,9 @@ module IGMarkets
         validate_transaction_type transaction_type
 
         url = "history/transactions/#{transaction_type.to_s.upcase}/#{milliseconds(days)}"
+        result = @dealing_platform.session.get(url).fetch :transactions
 
-        @dealing_platform.gather url, :transactions, Transaction
+        @dealing_platform.instantiate_models Transaction, result
       end
 
       private

data/lib/ig_markets/dealing_platform/client_sentiment_methods.rb

@@ -15,14 +15,12 @@ module IGMarkets
       #
       # @return [ClientSentiment]
       def [](market_id)
-        result = @dealing_platform.session.get "clientsentiment/#{market_id}", API_V1
+        result = @dealing_platform.session.get "clientsentiment/#{market_id}"
 
-        ClientSentiment.from(result).tap do |client_sentiment|
+        @dealing_platform.instantiate_models(ClientSentiment, result).tap do |client_sentiment|
           if client_sentiment.long_position_percentage == 0.0 && client_sentiment.short_position_percentage == 0.0
             raise ArgumentError, "unknown market '#{market_id}'"
           end
-
-          client_sentiment.instance_variable_set :@dealing_platform, @dealing_platform
         end
       end
     end

data/lib/ig_markets/dealing_platform/market_methods.rb

@@ -18,7 +18,9 @@ module IGMarkets
       def hierarchy(node_id = nil)
         url = ['marketnavigation', node_id].compact.join '/'
 
-        MarketHierarchyResult.from @dealing_platform.session.get(url, API_V1)
+        result = @dealing_platform.session.get url
+
+        @dealing_platform.instantiate_models MarketHierarchyResult, result
       end
 
       # Returns details for the markets with the passed EPICs.
@@ -27,13 +29,17 @@ module IGMarkets
       #
       # @return [Array<Market>]
       def find(*epics)
-        raise ArgumentError, 'at least one EPIC must be specified' if epics.empty?
+        epics = epics.flatten
+
+        return [] if epics.empty?
 
-        epics.flatten.each do |epic|
+        epics.each do |epic|
           raise ArgumentError, "invalid EPIC: #{epic}" unless epic.to_s =~ Regex::EPIC
         end
 
-        @dealing_platform.gather "markets?epics=#{epics.join(',')}", :market_details, Market, API_V2
+        result = @dealing_platform.session.get("markets?epics=#{epics.join(',')}", API_V2).fetch :market_details
+
+        @dealing_platform.instantiate_models Market, result
       end
 
       # Searches markets using a search term and returns an array of results.
@@ -42,7 +48,9 @@ module IGMarkets
       #
       # @return [Array<MarketOverview>]
       def search(search_term)
-        @dealing_platform.gather "markets?searchTerm=#{search_term}", :markets, MarketOverview
+        result = @dealing_platform.session.get("markets?searchTerm=#{search_term}").fetch :markets
+
+        @dealing_platform.instantiate_models MarketOverview, result
       end
 
       # Returns market details for the market with the specified EPIC, or `nil` if there is no market with that EPIC.
@@ -52,7 +60,7 @@ module IGMarkets
       #
       # @return [Market]
       def [](epic)
-        find(epic)[0]
+        find(epic).first
       end
     end
   end

data/lib/ig_markets/dealing_platform/position_methods.rb

@@ -20,13 +20,13 @@ module IGMarkets
 
       # Returns the position with the specified deal ID, or `nil` if there is no position with that ID.
       #
-      # @param [String] deal_id The deal ID of the working order to return.
+      # @param [String] deal_id The deal ID of the position to return.
       #
       # @return [Position]
       def [](deal_id)
-        attributes = @dealing_platform.session.get "positions/#{deal_id}", API_V2
-
-        position_from_attributes attributes
+        all.detect do |position|
+          position.deal_id == deal_id
+        end
       end
 
       # Creates a new position.
@@ -161,9 +161,9 @@ module IGMarkets
       end
 
       def position_from_attributes(attributes)
-        Position.new(attributes.fetch(:position).merge(market: attributes.fetch(:market))).tap do |position|
-          position.instance_variable_set :@dealing_platform, @dealing_platform
-        end
+        attributes = attributes.fetch(:position).merge market: attributes.fetch(:market)
+
+        @dealing_platform.instantiate_models Position, attributes
       end
 
       private_constant :PositionCreateAttributes

data/lib/ig_markets/dealing_platform/sprint_market_position_methods.rb

@@ -13,7 +13,21 @@ module IGMarkets
       #
       # @return [Array<SprintMarketPosition>]
       def all
-        @dealing_platform.gather 'positions/sprintmarkets', :sprint_market_positions, SprintMarketPosition
+        result = @dealing_platform.session.get('positions/sprintmarkets').fetch :sprint_market_positions
+
+        @dealing_platform.instantiate_models SprintMarketPosition, result
+      end
+
+      # Returns the sprint market position with the specified deal ID, or `nil` if there is no sprint market position
+      # with that ID.
+      #
+      # @param [String] deal_id The deal ID of the sprint market position to return.
+      #
+      # @return [SprintMarketPosition]
+      def [](deal_id)
+        all.detect do |sprint_market_position|
+          sprint_market_position.deal_id == deal_id
+        end
       end
 
       # Creates a new sprint market position.
@@ -30,7 +44,7 @@ module IGMarkets
       def create(attributes)
         payload = PayloadFormatter.format SprintMarketPositionCreateAttributes.new attributes
 
-        @dealing_platform.session.post('positions/sprintmarkets', payload, API_V1).fetch(:deal_reference)
+        @dealing_platform.session.post('positions/sprintmarkets', payload).fetch :deal_reference
       end
 
       # Internal model used by {#create}