ig_markets 0.1 → 0.2

data/lib/ig_markets/model/typecasters.rb

@@ -0,0 +1,78 @@
+module IGMarkets
+  # Implement typecaster methods for Model.
+  class Model
+    class << self
+      private
+
+      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 }
+        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)
+        return nil if value.nil?
+
+        value.to_s.to_i
+      end
+
+      def typecaster_float(value, _options)
+        return nil if value.nil?
+
+        Float(value)
+      end
+
+      def typecaster_symbol(value, _options)
+        return nil if value.nil?
+
+        value.to_s.downcase.to_sym
+      end
+
+      def typecaster_date(value, options)
+        raise ArgumentError, "#{self}: invalid or missing date format" unless options[:format].is_a? String
+
+        if value.is_a? String
+          begin
+            Date.strptime value, options[:format]
+          rescue ArgumentError
+            raise ArgumentError, "#{self}: failed parsing date '#{value}' with format '#{options[:format]}'"
+          end
+        else
+          value
+        end
+      end
+
+      def typecaster_time(value, options)
+        raise ArgumentError, "#{self}: invalid or missing time format" unless options[:format].is_a? String
+
+        if value.is_a?(String) || value.is_a?(Fixnum)
+          begin
+            Time.strptime "#{value}#{options[:time_zone]}", "#{options[:format]}#{'%z' if options[:time_zone]}"
+          rescue ArgumentError
+            raise ArgumentError, "#{self}: failed parsing time '#{value}' with format '#{options[:format]}'"
+          end
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/payload_formatter.rb

@@ -5,8 +5,8 @@ module IGMarkets
 
     # Takes a {Model} and returns its attributes in a hash ready to be passed as a payload to the IG Markets API.
     # Attribute names will be converted to use camel case rather than snake case, `Symbol` attributes will be converted
-    # to strings and will be uppercased, and `DateTime` attributes will be converted to strings using their ':format'
-    # option.
+    # to strings and will be uppercased, and both `Date` and `Time` attributes will be converted to strings using their
+    # ':format' option.
     #
     # @param [Model] model The model instance to convert attributes for.
     #
@@ -17,13 +17,26 @@ module IGMarkets
 
         next if value.nil?
 
-        value = value.to_s.upcase if options[:type] == Symbol
-        value = value.strftime(options.fetch(:format)) if options[:type] == DateTime
-
-        formatted[snake_case_to_camel_case(name)] = value
+        formatted[snake_case_to_camel_case(name)] = format_value value, options
       end
     end
 
+    # Formats an individual value, see {#format} for details.
+    #
+    # @param value The attribute value to format.
+    # @param options The options hash for the attribute.
+    #
+    # @return [String]
+    def format_value(value, options)
+      return value.to_s.upcase if options[:type] == Symbol
+
+      value = value.utc if options[:type] == Time
+
+      return value.strftime(options.fetch(:format)) if [Date, Time].include? options[:type]
+
+      value
+    end
+
     # Takes a string or symbol that uses snake case and converts it to a camel case symbol.
     #
     # @param [String, Symbol] value The string or symbol to convert to camel case.

data/lib/ig_markets/position.rb

@@ -4,14 +4,14 @@ module IGMarkets
   class Position < Model
     attribute :contract_size, Float
     attribute :controlled_risk, Boolean
-    attribute :created_date, DateTime, format: '%Y/%m/%d %H:%M:%S:%L'
-    attribute :created_date_utc, DateTime, format: '%Y-%m-%dT%H:%M:%S'
+    attribute :created_date, Time, format: '%Y/%m/%d %T:%L', time_zone: '+0000'
+    attribute :created_date_utc, Time, format: '%FT%T', time_zone: '+0000'
     attribute :currency, String, regex: Regex::CURRENCY
     attribute :deal_id
     attribute :direction, Symbol, allowed_values: [:buy, :sell]
     attribute :level, Float
     attribute :limit_level, Float
-    attribute :size, Fixnum
+    attribute :size, Float
     attribute :stop_level, Float
     attribute :trailing_step, Float
     attribute :trailing_stop_distance, Fixnum
@@ -42,37 +42,23 @@ module IGMarkets
     end
 
     # Returns this position's current profit or loss, denominated in its {#currency}, and based on the current market
-    # state as stored in {#market}. {#formatted_profit_loss} can be used to get a human-readable representation of this
-    # value.
+    # state as stored in {#market}.
     #
     # @return [Float]
     def profit_loss
       price_delta * size * market.lot_size * market.scaling_factor
     end
 
-    # Returns a human-readable string describing this position's current profit or loss, denominated in its {#currency},
-    # and based on the current market state as stored in {#market}. Some examples of the format of the return value:
-    #
-    # - `"USD -130.40"`
-    # - `"AUD 539.10"`
-    # - `"JPY 3560"`
-    #
-    # @return [String]
-    def formatted_profit_loss
-      format_string = (currency == 'JPY' ? '%.0f' : '%.2f')
-      "#{currency} #{format format_string, profit_loss}"
-    end
-
     # Returns this position's {#size} as a string prefixed with a `+` if {#direction} is `:buy`, or a `-` if
     # {#direction} is `:sell`.
     #
     # @return [String]
     def formatted_size
-      "#{{ buy: '+', sell: '-' }.fetch(direction)}#{size}"
+      "#{{ buy: '+', sell: '-' }.fetch(direction)}#{format '%g', size}"
     end
 
     # Closes this position. If called with no options then this position will be fully closed at current market prices,
-    # partial closes and greater control over the close conditions can be achieved with the relevant options.
+    # partial closes and greater control over the close conditions can be achieved by using the relevant options.
     #
     # @param [Hash] options The options for the position close.
     # @option options [Float] :level Required if and only if `:order_type` is `:limit` or `:quote`.
@@ -151,7 +137,7 @@ module IGMarkets
       attribute :level, Float
       attribute :order_type, Symbol, allowed_values: [:limit, :market, :quote]
       attribute :quote_id
-      attribute :size, Fixnum
+      attribute :size, Float
       attribute :time_in_force, Symbol, allowed_values: [:execute_and_eliminate, :fill_or_kill]
 
       # Runs a series of validations on this model's attributes to check whether it is ready to be sent to the IG

data/lib/ig_markets/request_failed_error.rb

@@ -15,7 +15,7 @@ module IGMarkets
       @error = error.to_s
       @http_code = http_code ? http_code.to_i : nil
 
-      super "#<#{self.class.name} error: @error#{http_code ? ", http_code: #{http_code}" : ''}"
+      super "#<#{self.class.name} error: #{@error}#{http_code ? ", http_code: #{http_code}" : ''}>"
     end
   end
 end

data/lib/ig_markets/sprint_market_position.rb

@@ -1,17 +1,32 @@
 module IGMarkets
   # Contains details on a sprint market position. Returned by {DealingPlatform::SprintMarketPositionMethods#all}.
   class SprintMarketPosition < Model
-    attribute :created_date, DateTime, format: '%Y/%m/%d %H:%M:%S:%L'
+    attribute :created_date, Time, format: '%Y/%m/%d %T:%L', time_zone: '+1000'
     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, DateTime, format: '%Y/%m/%d %H:%M:%S:%L'
+    attribute :expiry_time, Time, format: '%Y/%m/%d %T:%L', time_zone: '+1000'
     attribute :instrument_name
     attribute :market_status, Symbol, allowed_values: Market::Snapshot.allowed_values(:market_status)
     attribute :payout_amount, Float
-    attribute :size, Fixnum
+    attribute :size, Float
     attribute :strike_level, Float
+
+    # Returns the number of seconds till when this sprint market position expires. This will be a negative number if
+    # this sprint market position has expired.
+    #
+    # @return [Fixnum]
+    def seconds_till_expiry
+      (expiry_time - Time.now).to_i
+    end
+
+    # Returns whether this sprint market position has expired.
+    #
+    # @return [Boolean]
+    def expired?
+      expiry_time < Time.now
+    end
   end
 end

data/lib/ig_markets/version.rb

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

data/lib/ig_markets/working_order.rb

@@ -2,15 +2,15 @@ module IGMarkets
   # Contains details on a working order. Returned by {DealingPlatform::WorkingOrderMethods#all} and
   # {DealingPlatform::WorkingOrderMethods#[]}.
   class WorkingOrder < Model
-    attribute :created_date, DateTime, format: '%Y/%m/%d %H:%M:%S:%L'
-    attribute :created_date_utc, DateTime, format: '%Y-%m-%dT%H:%M:%S'
+    attribute :created_date, Time, format: '%Y/%m/%d %T:%L'
+    attribute :created_date_utc, Time, format: '%FT%T', time_zone: '+0000'
     attribute :currency_code, String, regex: Regex::CURRENCY
     attribute :deal_id
     attribute :direction, Symbol, allowed_values: [:buy, :sell]
     attribute :dma, Boolean
     attribute :epic, String, regex: Regex::EPIC
-    attribute :good_till_date, DateTime, format: '%Y/%m/%d %H:%M'
-    attribute :good_till_date_iso, DateTime, format: '%Y-%m-%dT%H:%M'
+    attribute :good_till_date, Time, format: '%Y/%m/%d %R', time_zone: '+0000'
+    attribute :good_till_date_iso, Time, format: '%FT%R', time_zone: '+0000'
     attribute :guaranteed_stop, Boolean
     attribute :limit_distance, Fixnum
     attribute :order_level, Float
@@ -34,10 +34,10 @@ module IGMarkets
     #
     # @param [Hash] new_attributes The attributes of this working order to update. See
     #        {DealingPlatform::WorkingOrderMethods#create} for a description of the attributes.
-    # @option new_attributes [DateTime] :good_till_date
+    # @option new_attributes [Time] :good_till_date
     # @option new_attributes [Float] :level
-    # @option new_attributes [Float] :limit_distance
-    # @option new_attributes [Float] :stop_distance
+    # @option new_attributes [Fixnum] :limit_distance
+    # @option new_attributes [Fixnum] :stop_distance
     # @option new_attributes [:good_till_cancelled, :good_till_date] :time_in_force
     # @option new_attributes [:limit, :stop] :type
     #
@@ -55,12 +55,12 @@ module IGMarkets
 
     # Internal model used by {#update}.
     class WorkingOrderUpdateAttributes < Model
-      attribute :good_till_date, DateTime, format: '%Y/%m/%d %H:%M'
-      attribute :limit_distance, Float
+      attribute :good_till_date, Time, format: '%Y/%m/%d %R'
       attribute :level, Float
-      attribute :type, Symbol, allowed_values: [:limit, :stop]
-      attribute :stop_distance, Float
+      attribute :limit_distance, Fixnum
+      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
 
     private_constant :WorkingOrderUpdateAttributes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -136,32 +150,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: Ruby client for the IG Markets dealing platform.
+description: 
 email: richard.viney@gmail.com
-executables: []
+executables:
+- ig_markets
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
-- Gemfile
-- LICENSE.md
-- README.md
-- ig_markets.gemspec
-- lib/ig_markets.rb
+- bin/ig_markets
 - lib/ig_markets/account.rb
 - lib/ig_markets/account_activity.rb
 - lib/ig_markets/account_transaction.rb
 - lib/ig_markets/api_versions.rb
 - lib/ig_markets/application.rb
 - lib/ig_markets/boolean.rb
+- lib/ig_markets/cli/account_command.rb
+- lib/ig_markets/cli/activities_command.rb
+- lib/ig_markets/cli/confirmation_command.rb
+- lib/ig_markets/cli/main.rb
+- lib/ig_markets/cli/orders_command.rb
+- lib/ig_markets/cli/positions_command.rb
+- lib/ig_markets/cli/search_command.rb
+- lib/ig_markets/cli/sentiment_command.rb
+- lib/ig_markets/cli/sprints_command.rb
+- lib/ig_markets/cli/transactions_command.rb
+- lib/ig_markets/cli/watchlists_command.rb
 - lib/ig_markets/client_sentiment.rb
 - lib/ig_markets/deal_confirmation.rb
-- lib/ig_markets/dealing_platform.rb
 - lib/ig_markets/dealing_platform/account_methods.rb
 - lib/ig_markets/dealing_platform/client_sentiment_methods.rb
 - lib/ig_markets/dealing_platform/market_methods.rb
@@ -169,11 +184,14 @@ files:
 - lib/ig_markets/dealing_platform/sprint_market_position_methods.rb
 - lib/ig_markets/dealing_platform/watchlist_methods.rb
 - lib/ig_markets/dealing_platform/working_order_methods.rb
+- lib/ig_markets/dealing_platform.rb
+- lib/ig_markets/format.rb
 - lib/ig_markets/historical_price_result.rb
 - lib/ig_markets/instrument.rb
 - lib/ig_markets/market.rb
 - lib/ig_markets/market_hierarchy_result.rb
 - lib/ig_markets/market_overview.rb
+- lib/ig_markets/model/typecasters.rb
 - lib/ig_markets/model.rb
 - lib/ig_markets/password_encryptor.rb
 - lib/ig_markets/payload_formatter.rb
@@ -186,53 +204,10 @@ files:
 - lib/ig_markets/version.rb
 - lib/ig_markets/watchlist.rb
 - lib/ig_markets/working_order.rb
-- spec/factories/ig_markets/account.rb
-- spec/factories/ig_markets/account_activity.rb
-- spec/factories/ig_markets/account_balance.rb
-- spec/factories/ig_markets/account_transaction.rb
-- spec/factories/ig_markets/application.rb
-- spec/factories/ig_markets/client_sentiment.rb
-- spec/factories/ig_markets/deal_confirmation.rb
-- spec/factories/ig_markets/historical_price_result.rb
-- spec/factories/ig_markets/historical_price_result_data_allowance.rb
-- spec/factories/ig_markets/historical_price_result_price.rb
-- spec/factories/ig_markets/historical_price_result_snapshot.rb
-- spec/factories/ig_markets/instrument.rb
-- spec/factories/ig_markets/instrument_currency.rb
-- spec/factories/ig_markets/instrument_expiry_details.rb
-- spec/factories/ig_markets/instrument_margin_deposit_band.rb
-- spec/factories/ig_markets/instrument_opening_hours.rb
-- spec/factories/ig_markets/instrument_rollover_details.rb
-- spec/factories/ig_markets/instrument_slippage_factor.rb
-- spec/factories/ig_markets/market.rb
-- spec/factories/ig_markets/market_dealing_rules.rb
-- spec/factories/ig_markets/market_dealing_rules_rule_details.rb
-- spec/factories/ig_markets/market_hierarchy_result.rb
-- spec/factories/ig_markets/market_hierarchy_result_hierarchy_node.rb
-- spec/factories/ig_markets/market_overview.rb
-- spec/factories/ig_markets/market_snapshot.rb
-- spec/factories/ig_markets/position.rb
-- spec/factories/ig_markets/sprint_market_position.rb
-- spec/factories/ig_markets/watchlist.rb
-- spec/factories/ig_markets/working_order.rb
-- spec/ig_markets/account_transaction_spec.rb
-- spec/ig_markets/dealing_platform/account_methods_spec.rb
-- spec/ig_markets/dealing_platform/client_sentiment_methods_spec.rb
-- spec/ig_markets/dealing_platform/market_methods_spec.rb
-- spec/ig_markets/dealing_platform/position_methods_spec.rb
-- spec/ig_markets/dealing_platform/sprint_market_position_methods_spec.rb
-- spec/ig_markets/dealing_platform/watchlist_methods_spec.rb
-- spec/ig_markets/dealing_platform/working_order_methods_spec.rb
-- spec/ig_markets/dealing_platform_spec.rb
-- spec/ig_markets/model_spec.rb
-- spec/ig_markets/password_encryptor_spec.rb
-- spec/ig_markets/payload_formatter_spec.rb
-- spec/ig_markets/position_spec.rb
-- spec/ig_markets/response_parser_spec.rb
-- spec/ig_markets/session_spec.rb
-- spec/spec_helper.rb
-- spec/support/factory_girl.rb
-- spec/support/random_test_order.rb
+- lib/ig_markets.rb
+- CHANGELOG.md
+- LICENSE.md
+- README.md
 homepage: https://github.com/rviney/ig_markets
 licenses:
 - MIT
@@ -253,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Ruby client for the IG Markets dealing platform.