ig_markets 0.5 → 0.6

data/lib/ig_markets/dealing_platform/watchlist_methods.rb

@@ -13,7 +13,9 @@ module IGMarkets
       #
       # @return [Array<Watchlist>]
       def all
-        @dealing_platform.gather 'watchlists', :watchlists, Watchlist
+        result = @dealing_platform.session.get('watchlists').fetch :watchlists
+
+        @dealing_platform.instantiate_models Watchlist, result
       end
 
       # Returns the watchlist that has the specified ID, or `nil` if there is no watchlist with that ID.
@@ -31,7 +33,7 @@ module IGMarkets
       #
       # @return [Watchlist] The new watchlist.
       def create(name, *epics)
-        result = @dealing_platform.session.post 'watchlists', { name: name, epics: epics.flatten }, API_V1
+        result = @dealing_platform.session.post 'watchlists', name: name, epics: epics.flatten
 
         self[result.fetch(:watchlist_id)]
       end

data/lib/ig_markets/dealing_platform/working_order_methods.rb

@@ -14,11 +14,9 @@ module IGMarkets
       # @return [Array<WorkingOrder>]
       def all
         @dealing_platform.session.get('workingorders', API_V2).fetch(:working_orders).map do |attributes|
-          attributes = attributes.fetch(:working_order_data).merge(market: attributes.fetch(:market_data))
+          attributes = attributes.fetch(:working_order_data).merge market: attributes.fetch(:market_data)
 
-          WorkingOrder.new(attributes).tap do |working_order|
-            working_order.instance_variable_set :@dealing_platform, @dealing_platform
-          end
+          @dealing_platform.instantiate_models WorkingOrder, attributes
         end
       end
 

data/lib/ig_markets/format.rb

@@ -45,5 +45,15 @@ module IGMarkets
 
       result + ':' + Kernel.format('%02i', value % 60)
     end
+
+    # Formats the passed symbol into a human-readable string, replacing underscores with spaces and capitalizing the
+    # first letter.
+    #
+    # @param [Symbol] value The symbol to format.
+    #
+    # @return [String]
+    def symbol(value)
+      value.to_s.capitalize.tr '_', ' '
+    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, Time, format: '%Y/%m/%d %T', time_zone: '+1000'
+      attribute :snapshot_time, Time, format: '%Y/%m/%d %T', time_zone: -> { @dealing_platform.account_time_zone }
     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, Time, format: '%FT%R', time_zone: '+1000'
+      attribute :last_dealing_date, Time, format: '%FT%R', time_zone: -> { @dealing_platform.account_time_zone }
       attribute :settlement_info
     end
 
@@ -30,15 +30,15 @@ module IGMarkets
       attribute :close_time
       attribute :open_time
 
-      # (See {Model.from}).
-      def self.from(value)
-        # This check works around a vagary in the IG API where there is a seemingly unnecessary hash for the
-        # :opening_hours value that only has a single :market_times key which is what holds the actual data.
-        if value.is_a?(Hash) && value.keys == [:market_times]
-          super value[:market_times]
-        else
-          super
-        end
+      # This method is used by {DealingPlatform#instantiate_models} to work around a vagary in the IG API where there
+      # is a seemingly unnecessary hash for the :opening_hours value that contains a single :market_times key which is
+      # what holds the actual opening hours data.
+      #
+      # @param [Hash] attributes
+      #
+      # @return [Hash]
+      def self.adjusted_api_attributes(attributes)
+        attributes.keys == [:market_times] ? attributes[:market_times] : attributes
       end
     end
 

data/lib/ig_markets/market.rb

@@ -55,7 +55,7 @@ module IGMarkets
 
       url = "prices/#{instrument.epic}/#{resolution.to_s.upcase}/#{num_points.to_i}"
 
-      HistoricalPriceResult.from @dealing_platform.session.get(url, API_V2)
+      @dealing_platform.instantiate_models HistoricalPriceResult, @dealing_platform.session.get(url, API_V2)
     end
 
     # Returns historical prices for this market at a specified resolution over a specified time period.
@@ -74,7 +74,7 @@ module IGMarkets
 
       url = "prices/#{instrument.epic}/#{resolution.to_s.upcase}/#{start_time}/#{end_time}"
 
-      HistoricalPriceResult.from @dealing_platform.session.get(url, API_V2)
+      @dealing_platform.instantiate_models HistoricalPriceResult, @dealing_platform.session.get(url, API_V2)
     end
 
     private
@@ -93,7 +93,7 @@ module IGMarkets
     #
     # @param [Time] time The `Time` to format.
     def format_time(time)
-      time.utc.strftime '%FT%T'
+      time.utc.strftime '%F %T'
     end
   end
 end

data/lib/ig_markets/model.rb

@@ -20,7 +20,7 @@ module IGMarkets
       (attributes.keys - defined_attribute_names).map do |attribute|
         value = attributes[attribute]
 
-        raise ArgumentError, "Unknown attribute: #{self.class.name}##{attribute}, value: #{inspect_value value}"
+        raise ArgumentError, "unknown attribute: #{self.class.name}##{attribute}, value: #{inspect_value value}"
       end
     end
 
@@ -55,7 +55,7 @@ module IGMarkets
 
     private
 
-    # Returns the #inspect string for the given value.
+    # Returns the {#inspect} string for the given value.
     def inspect_value(value)
       if value.is_a? Time
         value.utc.strftime '%F %T %Z'
@@ -77,19 +77,28 @@ module IGMarkets
         (defined_attributes || {}).keys
       end
 
+      # Returns the type of the specified attribute.
+      #
+      # @param [Symbol] attribute_name The name of the attribute to return the type for.
+      #
+      # @return The type of the specified attribute.
+      def attribute_type(attribute_name)
+        defined_attributes.fetch(attribute_name).fetch :type
+      end
+
       # Returns the array of allowed values for the specified attribute that was passed to {attribute}.
       #
       # @param [Symbol] attribute_name The name of the attribute to return the allowed values for.
       #
       # @return [Array]
       def allowed_values(attribute_name)
-        defined_attributes.fetch(attribute_name).fetch(:allowed_values)
+        defined_attributes.fetch(attribute_name).fetch :allowed_values
       end
 
       # Defines setter and getter methods for a new attribute on this class.
       #
       # @param [Symbol] name The name of the new attribute.
-      # @param [Boolean, String, Date, Time, Fixnum, Float, Symbol, #from] type The attribute's type.
+      # @param [Boolean, String, Date, Time, Fixnum, Float, Symbol, Model] 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.
@@ -98,9 +107,10 @@ module IGMarkets
       #                 Optional.
       # @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
+      # @option options [String, Proc] :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`. Defaults to
-      #                 `+0000` (UTC) unless `:format` is `%Q`.
+      #                 `+0000` (UTC) unless `:format` is `%Q`. Can be a `Proc` that returns the time zone string to
+      #                 use.
       #
       # @macro [attach] attribute
       #   The $1 attribute.
@@ -113,24 +123,6 @@ module IGMarkets
         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.
-      #
-      # @param [nil, Hash, Model, Array] source The source object to create a new `Model` instance from. If `source` is
-      #        `nil` then `nil` is returned. If `source` is a hash then a new `Model` instance is returned and the
-      #        hash is passed to `Model#initialize`. If `source` is an instance of this class then `dup` is called on it
-      #        and the duplicate returned. If source is an array then it is mapped into a new array with each item
-      #        having been recursively passed through this method.
-      #
-      # @return [nil, Array, Model]
-      def from(source)
-        return nil if source.nil?
-        return new source if source.is_a? Hash
-        return source.dup if source.is_a? self
-        return source.map { |item| from item } if source.is_a? Array
-
-        raise ArgumentError, "Unable to make a #{self} from instance of #{source.class}"
-      end
-
       private
 
       def define_attribute_reader(name)
@@ -143,7 +135,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, self, name
 
           allowed_values = options[:allowed_values]
           if !value.nil? && allowed_values

data/lib/ig_markets/model/typecasters.rb

@@ -7,18 +7,24 @@ module IGMarkets
       def typecaster_for(type)
         if [Boolean, String, Fixnum, Float, Symbol, Date, Time].include? type
           method "typecaster_#{type.to_s.gsub(/\AIGMarkets::/, '').downcase}"
-        elsif type.respond_to? :from
-          -> (value, _options) { type.from value }
+        elsif type
+          lambda do |value, _options, model, name|
+            if Array(value).any? { |entry| !entry.is_a? type }
+              raise ArgumentError, "incorrect type set on #{model.class}##{name}: #{value.inspect}"
+            end
+
+            value
+          end
         end
       end
 
-      def typecaster_boolean(value, _options)
+      def typecaster_boolean(value, _options, _model, _name)
         return value if [nil, true, false].include? value
 
         raise ArgumentError, "#{self}: invalid boolean value: #{value}"
       end
 
-      def typecaster_string(value, options)
+      def typecaster_string(value, options, _model, _name)
         return nil if value.nil?
 
         if options.key? :regex
@@ -28,25 +34,25 @@ module IGMarkets
         value.to_s
       end
 
-      def typecaster_fixnum(value, _options)
+      def typecaster_fixnum(value, _options, _model, _name)
         return nil if value.nil?
 
         value.to_s.to_i
       end
 
-      def typecaster_float(value, _options)
+      def typecaster_float(value, _options, _model, _name)
         return nil if value.nil? || value == ''
 
         Float(value)
       end
 
-      def typecaster_symbol(value, _options)
+      def typecaster_symbol(value, _options, _model, _name)
         return nil if value.nil?
 
         value.to_s.downcase.to_sym
       end
 
-      def typecaster_date(value, options)
+      def typecaster_date(value, options, _model, _name)
         raise ArgumentError, "#{self}: invalid or missing date format" unless options[:format].is_a? String
 
         if value.is_a? String
@@ -60,26 +66,27 @@ module IGMarkets
         end
       end
 
-      def typecaster_time(value, options)
+      def typecaster_time(value, options, model, name)
         raise ArgumentError, "#{self}: invalid or missing time format" unless options[:format].is_a? String
 
         if value.is_a?(String) || value.is_a?(Fixnum)
-          parse_time_from_string value.to_s, options
+          parse_time_from_string value.to_s, options, model, name
         else
           value
         end
       end
 
-      def parse_time_from_string(value, options)
+      def parse_time_from_string(value, options, model, name)
         format = options[:format]
-        time_zone = options[:time_zone]
 
+        time_zone = options[:time_zone]
         time_zone ||= '+0000' unless format == '%Q'
+        time_zone = model.instance_exec(&time_zone) if time_zone.is_a? Proc
 
         begin
           Time.strptime "#{value}#{time_zone}", "#{format}#{'%z' if time_zone}"
         rescue ArgumentError
-          raise ArgumentError, "#{self}: failed parsing time '#{value}' with format '#{format}'"
+          raise ArgumentError, "#{self}##{name}: failed parsing time '#{value}' with format '#{format}'"
         end
       end
     end

data/lib/ig_markets/payload_formatter.rb

@@ -45,7 +45,7 @@ module IGMarkets
     def snake_case_to_camel_case(value)
       pieces = value.to_s.split '_'
 
-      (pieces[0] + pieces[1..-1].map(&:capitalize).join).to_sym
+      (pieces.first + pieces[1..-1].map(&:capitalize).join).to_sym
     end
   end
 end

data/lib/ig_markets/position.rb

@@ -89,7 +89,7 @@ module IGMarkets
 
       payload = PayloadFormatter.format model
 
-      @dealing_platform.session.delete('positions/otc', payload, API_V1).fetch(:deal_reference)
+      @dealing_platform.session.delete('positions/otc', payload).fetch :deal_reference
     end
 
     # Updates this position. No attributes are mandatory, and any attributes not specified will be kept at their

data/lib/ig_markets/session.rb

@@ -15,10 +15,10 @@ module IGMarkets
     # @return [:demo, :production] The platform variant to log into for this session.
     attr_accessor :platform
 
-    # @return [String] The CST for the currently logged in session, or nil if there is no active session.
+    # @return [String] The CST for the currently logged in session, or `nil` if there is no active session.
     attr_reader :cst
 
-    # @return [String] The security token for the currently logged in session, or nil if there is no active session.
+    # @return [String] The security token for the currently logged in session, or `nil` if there is no active session.
     attr_reader :x_security_token
 
     # Signs in to IG Markets using the values of {#username}, {#password}, {#api_key} and {#platform}. If an error
@@ -40,7 +40,7 @@ module IGMarkets
     # Signs out of IG Markets, ending the current session (if any). If an error occurs then {RequestFailedError} will be
     # raised.
     def sign_out
-      delete 'session', nil, API_V1 if alive?
+      delete 'session' if alive?
 
       @cst = @x_security_token = nil
     end
@@ -59,7 +59,7 @@ module IGMarkets
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
-    def post(url, payload, api_version)
+    def post(url, payload, api_version = API_V1)
       request(method: :post, url: url, payload: payload, api_version: api_version).fetch :result
     end
 
@@ -69,7 +69,7 @@ module IGMarkets
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
-    def get(url, api_version)
+    def get(url, api_version = API_V1)
       request(method: :get, url: url, api_version: api_version).fetch :result
     end
 
@@ -80,7 +80,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)
+    def put(url, payload, api_version = API_V1)
       request(method: :put, url: url, payload: payload, api_version: api_version).fetch :result
     end
 
@@ -91,7 +91,7 @@ module IGMarkets
     # @param [Fixnum] api_version The API version to target.
     #
     # @return [Hash] The response from the IG Markets API.
-    def delete(url, payload, api_version)
+    def delete(url, payload = nil, api_version = API_V1)
       request(method: :delete, url: url, payload: payload, api_version: api_version).fetch :result
     end
 
@@ -115,7 +115,7 @@ module IGMarkets
     end
 
     def password_encryptor
-      result = get 'session/encryptionKey', API_V1
+      result = get 'session/encryptionKey'
 
       PasswordEncryptor.new result.fetch(:encryption_key), result.fetch(:time_stamp)
     end

data/lib/ig_markets/sprint_market_position.rb

@@ -1,13 +1,13 @@
 module IGMarkets
   # Contains details on a sprint market position. Returned by {DealingPlatform::SprintMarketPositionMethods#all}.
   class SprintMarketPosition < Model
-    attribute :created_date, Time, format: '%Y/%m/%d %T:%L', time_zone: '+1000'
+    attribute :created_date, Time, format: '%Y/%m/%d %T:%L', time_zone: -> { @dealing_platform.account_time_zone }
     attribute :currency, String, regex: Regex::CURRENCY
     attribute :deal_id
     attribute :description
     attribute :direction, Symbol, allowed_values: [:buy, :sell]
     attribute :epic, String, regex: Regex::EPIC
-    attribute :expiry_time, Time, format: '%Y/%m/%d %T:%L', time_zone: '+1000'
+    attribute :expiry_time, Time, format: '%Y/%m/%d %T:%L', time_zone: -> { @dealing_platform.account_time_zone }
     attribute :instrument_name
     attribute :market_status, Symbol, allowed_values: Market::Snapshot.allowed_values(:market_status)
     attribute :payout_amount, Float

data/lib/ig_markets/transaction.rb

@@ -9,7 +9,7 @@ module IGMarkets
     attribute :date, Date, format: '%d/%m/%y'
     attribute :instrument_name
     attribute :open_level, String, nil_if: %w(- 0)
-    attribute :period, Time, nil_if: '-', format: '%d/%m/%y %T', time_zone: '+10:00'
+    attribute :period, Time, nil_if: '-', format: '%d/%m/%y %T', time_zone: -> { @dealing_platform.account_time_zone }
     attribute :profit_and_loss
     attribute :reference
     attribute :size, String, nil_if: '-'

data/lib/ig_markets/version.rb

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

data/lib/ig_markets/watchlist.rb

@@ -12,26 +12,28 @@ module IGMarkets
     #
     # @return [Array<Market>]
     def markets
-      @dealing_platform.gather "watchlists/#{id}", :markets, MarketOverview
+      result = @dealing_platform.session.get("watchlists/#{id}").fetch :markets
+
+      @dealing_platform.instantiate_models MarketOverview, result
     end
 
     # Deletes this watchlist.
     def delete
-      @dealing_platform.session.delete "watchlists/#{id}", nil, API_V1
+      @dealing_platform.session.delete "watchlists/#{id}"
     end
 
     # Adds a market to this watchlist.
     #
     # @param [String] epic The EPIC of the market to add to this watchlist.
     def add_market(epic)
-      @dealing_platform.session.put "watchlists/#{id}", { epic: epic }, API_V1
+      @dealing_platform.session.put "watchlists/#{id}", epic: epic
     end
 
     # Removes a market from this watchlist.
     #
     # @param [String] epic The EPIC of the market to remove from this watchlist.
     def remove_market(epic)
-      @dealing_platform.session.delete "watchlists/#{id}/#{epic}", nil, API_V1
+      @dealing_platform.session.delete "watchlists/#{id}/#{epic}"
     end
   end
 end