ig_markets 0.1 → 0.2

data/lib/ig_markets/cli/sentiment_command.rb

@@ -0,0 +1,35 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets sentiment` command.
+    class Main
+      desc 'sentiment', 'Prints sentiment for the specified market'
+
+      option :market, aliases: '-m', required: true, desc: 'The name of the market to print sentiment for'
+      option :related, aliases: '-r', type: :boolean, desc: 'Whether to print sentiment for related markets as well'
+
+      def sentiment
+        begin_session do
+          result = dealing_platform.client_sentiment[options[:market]]
+
+          print_sentiment result
+
+          if options[:related]
+            result.related_sentiments.each do |model|
+              print_sentiment model
+            end
+          end
+        end
+      end
+
+      private
+
+      def print_sentiment(model)
+        print <<-END
+#{model.market_id}: \
+longs: #{model.long_position_percentage}%, \
+shorts: #{model.short_position_percentage}%
+END
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/sprints_command.rb

@@ -0,0 +1,28 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets sprints` command.
+    class Main
+      desc 'sprints', 'Prints open sprint market positions'
+
+      def sprints
+        begin_session do
+          dealing_platform.sprint_market_positions.all.each do |sprint|
+            print_sprint_market_position sprint
+          end
+        end
+      end
+
+      private
+
+      def print_sprint_market_position(sprint)
+        print <<-END
+#{sprint.deal_id}: \
+#{Format.currency sprint.size, sprint.currency} on #{sprint.epic} \
+to be #{{ buy: 'above', sell: 'below' }.fetch(sprint.direction)} #{sprint.strike_level} \
+in #{Format.seconds sprint.seconds_till_expiry}, \
+payout: #{Format.currency sprint.payout_amount, sprint.currency}
+END
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/transactions_command.rb

@@ -0,0 +1,56 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets transactions` command.
+    class Main
+      desc 'transactions', 'Prints recent transactions'
+
+      option :days, default: 3, type: :numeric, desc: 'The number of days to print recent transactions for'
+
+      def transactions
+        begin_session do
+          transactions = dealing_platform.account.recent_transactions(seconds).sort_by(&:date)
+
+          transactions.each do |transaction|
+            print_transaction transaction
+          end
+
+          print_transaction_totals transactions
+        end
+      end
+
+      private
+
+      def transaction_totals(transactions)
+        transactions.each_with_object({}) do |transaction, hash|
+          profit_loss = transaction.profit_and_loss_amount
+
+          currency = (hash[transaction.currency] ||= Hash.new(0))
+
+          currency[:delta] += profit_loss
+          currency[:interest] += profit_loss if transaction.interest?
+        end
+      end
+
+      def print_transaction(transaction)
+        print <<-END
+#{transaction.reference}: #{transaction.date.strftime '%Y-%m-%d'}, \
+#{transaction.formatted_transaction_type}, \
+#{"#{transaction.size} of " if transaction.size}\
+#{transaction.instrument_name}, \
+profit/loss: #{Format.currency transaction.profit_and_loss_amount, transaction.currency}
+END
+      end
+
+      def print_transaction_totals(transactions)
+        transaction_totals(transactions).each do |currency, value|
+          print <<-END
+
+Totals for currency '#{currency}':
+  Interest: #{Format.currency value[:interest], currency}
+  Profit/loss: #{Format.currency value[:delta], currency}
+END
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/watchlists_command.rb

@@ -0,0 +1,34 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets watchlists` command.
+    class Main
+      desc 'watchlists', 'Prints all watchlists and their markets'
+
+      def watchlists
+        begin_session do
+          dealing_platform.watchlists.all.each do |watchlist|
+            print_watchlist watchlist
+
+            watchlist.markets.each do |market|
+              print '  - '
+              print_market_overview market
+            end
+            print "\n"
+          end
+        end
+      end
+
+      private
+
+      def print_watchlist(watchlist)
+        print <<-END
+#{watchlist.id}: \
+#{watchlist.name}, \
+editable: #{watchlist.editable}, \
+deleteable: #{watchlist.deleteable}, \
+default: #{watchlist.default_system_watchlist}
+END
+      end
+    end
+  end
+end

data/lib/ig_markets/deal_confirmation.rb

@@ -13,10 +13,10 @@ module IGMarkets
     attribute :deal_status, Symbol, allowed_values: [:accepted, :fund_account, :rejected]
     attribute :direction, Symbol, allowed_values: [:buy, :sell]
     attribute :epic
-    attribute :expiry, DateTime, nil_if: '-', format: '%d-%b-%y'
+    attribute :expiry, Date, nil_if: '-', format: '%d-%b-%y'
     attribute :guaranteed_stop, Boolean
     attribute :level, Float
-    attribute :limit_distance, Float
+    attribute :limit_distance, Fixnum
     attribute :limit_level, Float
     attribute :reason, Symbol, allowed_values: [
       :account_not_enabled_to_trading, :attached_order_level_error, :attached_order_trailing_stop_error,
@@ -32,9 +32,9 @@ module IGMarkets
       :reject_spreadbet_order_on_cfd_account, :size_increment, :sprint_market_expiry_after_market_close,
       :stop_or_limit_not_allowed, :stop_required_error, :strike_level_tolerance, :success, :trailing_stop_not_allowed,
       :unknown, :wrong_side_of_market]
-    attribute :size, Fixnum
+    attribute :size, Float
     attribute :status, Symbol, allowed_values: [:amended, :closed, :deleted, :open, :partially_closed]
-    attribute :stop_distance, Float
+    attribute :stop_distance, Fixnum
     attribute :stop_level, Float
     attribute :trailing_stop, Boolean
   end

data/lib/ig_markets/dealing_platform/position_methods.rb

@@ -36,7 +36,7 @@ module IGMarkets
       #                    currencies (see {Instrument#currencies}). Required.
       # @option attributes [:buy, :sell] :direction The position direction. Required.
       # @option attributes [String] :epic The EPIC of the instrument to create a position for. Required.
-      # @option attributes [DateTime] :expiry The expiry date of the instrument, if it has one. Optional.
+      # @option attributes [Time] :expiry The expiry date of the instrument, if it has one. Optional.
       # @option attributes [Boolean] :force_open Whether a force open is required. Defaults to `false`.
       # @option attributes [Boolean] :guaranteed_stop Whether a guaranteed stop is required. Defaults to `false`.
       # @option attributes [Float] :level Required if and only if `:order_type` is `:limit` or `:quote`.
@@ -89,7 +89,7 @@ module IGMarkets
         attribute :currency_code, String, regex: Regex::CURRENCY
         attribute :direction, Symbol, allowed_values: [:buy, :sell]
         attribute :epic, String, regex: Regex::EPIC
-        attribute :expiry, DateTime, format: '%d-%b-%y'
+        attribute :expiry, Time, format: '%d-%b-%y'
         attribute :force_open, Boolean
         attribute :guaranteed_stop, Boolean
         attribute :level, Float
@@ -97,7 +97,7 @@ module IGMarkets
         attribute :limit_level, Float
         attribute :order_type, Symbol, allowed_values: [:limit, :market, :quote]
         attribute :quote_id
-        attribute :size, Fixnum
+        attribute :size, Float
         attribute :stop_distance, Fixnum
         attribute :stop_level, Float
         attribute :time_in_force, Symbol, allowed_values: [:execute_and_eliminate, :fill_or_kill]

data/lib/ig_markets/dealing_platform/sprint_market_position_methods.rb

@@ -39,7 +39,7 @@ module IGMarkets
         attribute :epic, String, regex: Regex::EPIC
         attribute :expiry_period, Symbol, allowed_values: [
           :one_minute, :two_minutes, :five_minutes, :twenty_minutes, :sixty_minutes]
-        attribute :size, Fixnum
+        attribute :size, Float
       end
     end
   end

data/lib/ig_markets/dealing_platform/watchlist_methods.rb

@@ -33,9 +33,7 @@ module IGMarkets
       def create(name, *epics)
         result = @dealing_platform.session.post 'watchlists', { name: name, epics: epics.flatten }, API_V1
 
-        all.detect do |watchlist|
-          watchlist.id == result.fetch(:watchlist_id)
-        end
+        self[result.fetch(:watchlist_id)]
       end
     end
   end

data/lib/ig_markets/dealing_platform/working_order_methods.rb

@@ -40,15 +40,15 @@ module IGMarkets
       #                    currencies (see {Instrument#currencies}). Required.
       # @option attributes [:buy, :sell] :direction Order direction. Required.
       # @option attributes [String] :epic The EPIC of the instrument for the order. Required.
-      # @option attributes [DateTime] :expiry The expiry date of the instrument (if applicable). Optional.
+      # @option attributes [Time] :expiry The expiry date of the instrument (if applicable). Optional.
       # @option attributes [Boolean] :force_open Whether a force open is required. Defaults to `false`.
-      # @option attributes [DateTime] :good_till_date The date that the working order will live till. Must be set if
+      # @option attributes [Time] :good_till_date The date that the working order will live till. Must be set if
       #                    `:time_in_force` is `:good_till_date`.
       # @option attributes [Boolean] :guaranteed_stop Whether a guaranteed stop is required. Defaults to `false`.
       # @option attributes [Float] :level The level at which the order will be triggered.
-      # @option attributes [Float] :limit_distance The distance away in pips to place the limit. Optional.
+      # @option attributes [Fixnum] :limit_distance The distance away in pips to place the limit. Optional.
       # @option attributes [Float] :size The size of the working order. Required.
-      # @option attributes [Float] :stop_distance The distance away in pips to place the stop. Optional.
+      # @option attributes [Fixnum] :stop_distance The distance away in pips to place the stop. Optional.
       # @option attributes [:good_till_cancelled, :good_till_date] :time_in_force The lifespan of the working order.
       #                    `:good_till_cancelled` means the working order will live until it is explicitly cancelled.
       #                    `:good_till_date` means the working order will live until the date specified by
@@ -85,7 +85,7 @@ module IGMarkets
           raise ArgumentError, "#{attribute} attribute must be set" if attributes[attribute].nil?
         end
 
-        if model.time_in_force == :good_till_date && !model.good_till_date.is_a?(DateTime)
+        if model.time_in_force == :good_till_date && !model.good_till_date.is_a?(Time)
           raise ArgumentError, 'good_till_date must be set when time_in_force is :good_till_date'
         end
 
@@ -97,14 +97,14 @@ module IGMarkets
         attribute :currency_code, String, regex: Regex::CURRENCY
         attribute :direction, Symbol, allowed_values: [:buy, :sell]
         attribute :epic, String, regex: Regex::EPIC
-        attribute :expiry, DateTime, format: '%d-%b-%y'
+        attribute :expiry, Time, format: '%d-%b-%y'
         attribute :force_open, Boolean
-        attribute :good_till_date, DateTime, format: '%Y-%m-%d %H:%M:%S'
+        attribute :good_till_date, Time, format: '%F %T'
         attribute :guaranteed_stop, Boolean
         attribute :level, Float
-        attribute :limit_distance, Float
-        attribute :size, Fixnum
-        attribute :stop_distance, Float
+        attribute :limit_distance, Fixnum
+        attribute :size, Float
+        attribute :stop_distance, Fixnum
         attribute :time_in_force, Symbol, allowed_values: [:good_till_cancelled, :good_till_date]
         attribute :type, Symbol, allowed_values: [:limit, :stop]
       end

data/lib/ig_markets/format.rb

@@ -0,0 +1,36 @@
+module IGMarkets
+  # This module contains shared methods for formatting different content types for display.
+  module Format
+    module_function
+
+    # Returns a formatted string for the specified currency amount and currency symbol. Two decimal places are used for
+    # all currencies except the Japanese Yen.
+    #
+    # @param [Float, Fixnum] amount The currency amount to format.
+    # @param [String] symbol The currency symbol.
+    #
+    # @return [String] The formatted currency amount, e.g. `"USD -130.40"`, `"AUD 539.10"`, `"JPY 3560"`.
+    def currency(amount, symbol)
+      if ['JPY', '¥'].include? symbol
+        "#{symbol} #{format '%i', amount.to_i}"
+      else
+        "#{symbol} #{format '%.2f', amount.to_f}"
+      end
+    end
+
+    # Returns a formatted string for the specified number of seconds in the format `[<hours>:]<minutes>:<seconds>`.
+    #
+    # @param [Fixnum] value The number of seconds to format.
+    #
+    # @return [String]
+    def seconds(value)
+      result = if value >= 60 * 60
+                 "#{value / 60 / 60}:#{Kernel.format('%02i', (value / 60) % 60)}"
+               else
+                 (value / 60).to_s
+               end
+
+      result + ':' + Kernel.format('%02i', value % 60)
+    end
+  end
+end

data/lib/ig_markets/historical_price_result.rb

@@ -23,7 +23,7 @@ module IGMarkets
       attribute :last_traded_volume, Float
       attribute :low_price, Price
       attribute :open_price, Price
-      attribute :snapshot_time, DateTime, format: '%Y/%m/%d %H:%M:%S'
+      attribute :snapshot_time, Time, format: '%Y/%m/%d %T', time_zone: '+1000'
     end
 
     attribute :allowance, DataAllowance

data/lib/ig_markets/instrument.rb

@@ -12,7 +12,7 @@ module IGMarkets
 
     # Contains details on the expiry details of an instrument. Returned by {#expiry_details}.
     class ExpiryDetails < Model
-      attribute :last_dealing_date, DateTime, format: '%Y/%m/%d %H:%M:%S'
+      attribute :last_dealing_date, Time, format: '%FT%R', time_zone: '+1000'
       attribute :settlement_info
     end
 
@@ -60,7 +60,7 @@ module IGMarkets
     attribute :country
     attribute :currencies, Currency
     attribute :epic, String, regex: Regex::EPIC
-    attribute :expiry, DateTime, nil_if: '-', format: '%d-%b-%y'
+    attribute :expiry, Date, nil_if: '-', format: '%d-%b-%y'
     attribute :expiry_details, ExpiryDetails
     attribute :force_open_allowed, Boolean
     attribute :lot_size, Float

data/lib/ig_markets/market.rb

@@ -62,17 +62,17 @@ module IGMarkets
     #
     # @param [:minute, :minute_2, :minute_3, :minute_5, :minute_10, :minute_15, :minute_30, :hour, :hour_2, :hour_3,
     #         :hour_4, :day, :week, :month] resolution The resolution of the historical prices to return.
-    # @param [DateTime] start_date_time The start of the desired time period.
-    # @param [DateTime] end_date_time The end of the desired time period.
+    # @param [Time] start_time The start of the desired time period.
+    # @param [Time] end_time The end of the desired time period.
     #
     # @return [HistoricalPriceResult]
-    def prices_in_date_range(resolution, start_date_time, end_date_time)
+    def prices_in_date_range(resolution, start_time, end_time)
       validate_historical_price_resolution resolution
 
-      start_date_time = format_date_time start_date_time
-      end_date_time = format_date_time end_date_time
+      start_time = format_time start_time
+      end_time = format_time end_time
 
-      url = "prices/#{instrument.epic}/#{resolution.to_s.upcase}/#{start_date_time}/#{end_date_time}"
+      url = "prices/#{instrument.epic}/#{resolution.to_s.upcase}/#{start_time}/#{end_time}"
 
       HistoricalPriceResult.from @dealing_platform.session.get(url, API_V2)
     end
@@ -89,11 +89,11 @@ module IGMarkets
       raise ArgumentError, 'resolution is invalid' unless resolutions.include? resolution
     end
 
-    # Takes a `DateTime` and formats it for the historical prices API URLs.
+    # Takes a `Time` and formats it for the historical prices API URLs.
     #
-    # @param [DateTime] date_time The `DateTime` to format.
-    def format_date_time(date_time)
-      date_time.strftime '%Y-%m-%dT%H:%M:%S'
+    # @param [Time] time The `Time` to format.
+    def format_time(time)
+      time.utc.strftime '%FT%T'
     end
   end
 end

data/lib/ig_markets/model.rb

@@ -19,9 +19,8 @@ module IGMarkets
 
       (attributes.keys - defined_attribute_names).map do |attribute|
         value = attributes[attribute]
-        value = value.inspect unless value.is_a? DateTime
 
-        raise ArgumentError, "Unknown attribute: #{self.class.name}##{attribute}, value: #{value}"
+        raise ArgumentError, "Unknown attribute: #{self.class.name}##{attribute}, value: #{inspect_value value}"
       end
     end
 
@@ -39,14 +38,25 @@ module IGMarkets
     # @return [String]
     def inspect
       formatted_attributes = self.class.defined_attribute_names.map do |attribute|
-        value = send attribute
-
-        "#{attribute}: #{value.is_a?(DateTime) ? value : value.inspect}"
+        "#{attribute}: #{inspect_value send(attribute)}"
       end
 
       "#<#{self.class.name} #{formatted_attributes.join ', '}>"
     end
 
+    private
+
+    # Returns the #inspect string for the given value.
+    def inspect_value(value)
+      if value.is_a? Time
+        value.utc.strftime '%F %T %z'
+      elsif value.is_a? Date
+        value.strftime '%F'
+      else
+        value.inspect
+      end
+    end
+
     class << self
       # @return [Hash] A hash containing details of all attributes that have been defined on this model.
       attr_accessor :defined_attributes
@@ -70,15 +80,17 @@ module IGMarkets
       # Defines setter and getter methods for a new attribute on this class.
       #
       # @param [Symbol] name The name of the new attribute.
-      # @param [Boolean, String, DateTime, Fixnum, Float, Symbol, #from] type The attribute's type.
+      # @param [Boolean, String, Date, Time, Fixnum, Float, Symbol, #from] type The attribute's type.
       # @param [Hash] options The configuration options for the new attribute.
       # @option options [Array] :allowed_values The set of values that this attribute is allowed to be set to. An
       #                 attempt to set this attribute to a value not in this list will raise `ArgumentError`. Optional.
       # @option options [Array] :nil_if Values that, when set on the attribute, should be converted to `nil`.
       # @option options [Regexp] :regex When `type` is `String` only values matching this regex will be allowed.
       #                 Optional.
-      # @option options [String] :format When `type` is `DateTime` this specifies the format for parsing String and
-      #                 Fixnum instances assigned to this attribute. See `DateTime#strptime` for details.
+      # @option options [String] :format When `type` is `Date` or `Time` this specifies the format for parsing String
+      #                 and `Fixnum` instances assigned to this attribute.
+      # @option options [String] :time_zone When `type` is `Time` this specifies the time zone to append to
+      #                 `String` values assigned to this attribute prior to parsing them with `:format`. Optional.
       #
       # @macro [attach] attribute
       #   The $1 attribute.
@@ -87,7 +99,8 @@ module IGMarkets
         define_attribute_reader name
         define_attribute_writer name, type, options
 
-        (self.defined_attributes ||= {})[name] = options.merge type: type
+        self.defined_attributes ||= {}
+        self.defined_attributes[name] = options.merge type: type
       end
 
       # Creates a new Model instance from the specified source, which can take a variety of different forms.
@@ -120,7 +133,7 @@ module IGMarkets
         define_method "#{name}=" do |value|
           value = nil if Array(options.fetch(:nil_if, [])).include? value
 
-          value = typecaster.call(value, options)
+          value = typecaster.call value, options
 
           allowed_values = options[:allowed_values]
           if !value.nil? && allowed_values
@@ -130,56 +143,6 @@ module IGMarkets
           (@attributes ||= {})[name] = value
         end
       end
-
-      def typecaster_for(type)
-        if [Boolean, String, Fixnum, Float, Symbol, DateTime].include? type
-          method "typecaster_#{type.to_s.gsub(/\AIGMarkets::/, '').downcase}"
-        elsif type.respond_to? :from
-          -> (value, _options) { type.from value }
-        end
-      end
-
-      def typecaster_boolean(value, _options)
-        return value if [nil, true, false].include? value
-
-        raise ArgumentError, "#{self}: invalid boolean value: #{value}"
-      end
-
-      def typecaster_string(value, options)
-        return nil if value.nil?
-
-        if options.key? :regex
-          raise ArgumentError, "#{self}: invalid string value: #{value}" unless options[:regex].match value.to_s
-        end
-
-        value.to_s
-      end
-
-      def typecaster_fixnum(value, _options)
-        value.nil? ? nil : value.to_s.to_i
-      end
-
-      def typecaster_float(value, _options)
-        value.nil? ? nil : Float(value)
-      end
-
-      def typecaster_symbol(value, _options)
-        value.nil? ? nil : value.to_s.downcase.to_sym
-      end
-
-      def typecaster_datetime(value, options)
-        raise ArgumentError, "#{self}: invalid or missing date time format" unless options[:format].is_a? String
-
-        if value.is_a?(String) || value.is_a?(Fixnum)
-          begin
-            DateTime.strptime(value.to_s, options[:format])
-          rescue ArgumentError
-            raise ArgumentError, "#{self}: failed parsing date '#{value}' with format '#{options[:format]}'"
-          end
-        else
-          value
-        end
-      end
     end
   end
 end