ig_markets 0.4 → 0.5

data/lib/ig_markets/market_overview.rb

@@ -5,7 +5,7 @@ module IGMarkets
     attribute :delay_time, Float
     attribute :epic, String, regex: Regex::EPIC
     attribute :exchange_id
-    attribute :expiry
+    attribute :expiry, String, nil_if: '-'
     attribute :high, Float
     attribute :instrument_name
     attribute :instrument_type, Symbol, allowed_values: Instrument.allowed_values(:type)

data/lib/ig_markets/model.rb

@@ -24,6 +24,15 @@ module IGMarkets
       end
     end
 
+    # Copy initializer that duplicates the {#attributes} hash in full.
+    #
+    # @param [Model] other The model to copy.
+    def initialize_copy(other)
+      super
+
+      @attributes = other.attributes.dup
+    end
+
     # Compares this model to another, the attributes and class must match for them to be considered equal.
     #
     # @param [#class, #attributes] other The other model to compare to.
@@ -49,7 +58,7 @@ module IGMarkets
     # Returns the #inspect string for the given value.
     def inspect_value(value)
       if value.is_a? Time
-        value.utc.strftime '%F %T %z'
+        value.utc.strftime '%F %T %Z'
       elsif value.is_a? Date
         value.strftime '%F'
       else

data/lib/ig_markets/model/typecasters.rb

@@ -35,7 +35,7 @@ module IGMarkets
       end
 
       def typecaster_float(value, _options)
-        return nil if value.nil?
+        return nil if value.nil? || value == ''
 
         Float(value)
       end

data/lib/ig_markets/position.rb

@@ -23,6 +23,13 @@ module IGMarkets
       !trailing_step.nil? && !trailing_stop_distance.nil?
     end
 
+    # Returns the level at which this position would close at given the current market price as stored in {#market}.
+    #
+    # @return [Float]
+    def close_level
+      { buy: market.bid, sell: market.offer }.fetch direction
+    end
+
     # Returns the favorable difference in the price between {#level} and the current market price as stored in
     # {#market}. If {#direction} is `:buy` and the market has since risen then this method will return a positive value,
     # but if {#direction} is `:sell` and the market has since risen then this method will return a negative value.
@@ -30,9 +37,9 @@ module IGMarkets
     # @return [Float]
     def price_delta
       if direction == :buy
-        market.bid - level
+        close_level - level
       elsif direction == :sell
-        level - market.offer
+        level - close_level
       end
     end
 
@@ -42,19 +49,13 @@ 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}.
+    # state as stored in {#market}. For binary instruments this returns the payout amount.
     #
     # @return [Float]
     def profit_loss
-      price_delta * size * market.lot_size * market.scaling_factor
-    end
+      return size / level if market.instrument_type == :binary
 
-    # 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)}#{format '%g', size}"
+      price_delta * size * contract_size
     end
 
     # Closes this position. If called with no options then this position will be fully closed at current market prices,

data/lib/ig_markets/request_printer.rb

@@ -0,0 +1,56 @@
+module IGMarkets
+  # This class contains methods for printing a REST request and its JSON response for inspection and debugging.
+  # Request printing is enabled by setting {enabled} to `true`.
+  class RequestPrinter
+    class << self
+      # @return [Boolean] Whether the request printer is enabled.
+      attr_accessor :enabled
+
+      # Prints out an options hash that is ready to be passed to `RestClient::Request.execute`.
+      #
+      # @param [Hash] options The options hash.
+      #
+      # @return [void]
+      def print_options(options)
+        return unless enabled
+
+        puts "#{options[:method].to_s.upcase} #{options[:url]}"
+
+        puts '  Headers:'
+        options[:headers].each do |name, value|
+          print_request_header name, value
+        end
+
+        print_request_body options[:payload]
+      end
+
+      # Formats and prints a JSON response body.
+      #
+      # @param [String] body The response body.
+      #
+      # @return [void]
+      def print_response_body(body)
+        return unless enabled
+
+        print '  Response: '
+
+        puts JSON.pretty_generate(JSON.parse(body)).gsub "\n", "\n            "
+      rescue JSON::ParserError
+        puts body
+      end
+
+      private
+
+      def print_request_header(name, value)
+        puts "    #{name.to_s.split('_').map { |h| h[0].upcase + h[1..-1] }.join('-')}: #{value}"
+      end
+
+      def print_request_body(body)
+        return unless body
+
+        print '  Body: '
+        puts JSON.pretty_generate(JSON.parse(body)).gsub("\n", "\n        ")
+      end
+    end
+  end
+end

data/lib/ig_markets/response_parser.rb

@@ -3,6 +3,17 @@ module IGMarkets
   module ResponseParser
     module_function
 
+    # Parses the passed JSON string and then passes it on to {parse}. If `json` is not valid JSON then `{}` is returned.
+    #
+    # @param [String] json The JSON string.
+    #
+    # @return [Hash]
+    def parse_json(json)
+      parse JSON.parse(json)
+    rescue JSON::ParserError
+      {}
+    end
+
     # Parses the specified value that was returned from a call to the IG Markets API.
     #
     # @param [Hash, Array, Object] response The response or part of a reponse that should be parsed. If this is of type

data/lib/ig_markets/session.rb

@@ -125,7 +125,12 @@ module IGMarkets
       options[:headers] = request_headers(options)
       options[:payload] = options[:payload] && options[:payload].to_json
 
+      RequestPrinter.print_options options
+
       response = execute_request options
+
+      RequestPrinter.print_response_body response.body
+
       result = process_response response
 
       { response: response, result: result }
@@ -167,17 +172,11 @@ module IGMarkets
     end
 
     def client_token_invalid?(response)
-      ResponseParser.parse(JSON.parse(response.body))[:error_code] == 'error.security.client-token-invalid'
-    rescue JSON::ParserError
-      false
+      ResponseParser.parse_json(response.body)[:error_code] == 'error.security.client-token-invalid'
     end
 
     def process_response(response)
-      result = begin
-        ResponseParser.parse JSON.parse(response.body)
-      rescue JSON::ParserError
-        {}
-      end
+      result = ResponseParser.parse_json response.body
 
       unless response.code >= 200 && response.code < 300
         raise RequestFailedError.new(result[:error_code], response.code)

data/lib/ig_markets/{account_transaction.rb → transaction.rb}

@@ -2,14 +2,14 @@ module IGMarkets
   # Contains details on a single transaction that occurred on an IG Markets account. Returned by
   # {DealingPlatform::AccountMethods#transactions_in_date_range} and
   # {DealingPlatform::AccountMethods#recent_transactions}.
-  class AccountTransaction < Model
+  class Transaction < Model
     attribute :cash_transaction, Boolean
-    attribute :close_level
+    attribute :close_level, String, nil_if: %w(- 0)
     attribute :currency
     attribute :date, Date, format: '%d/%m/%y'
     attribute :instrument_name
-    attribute :open_level, String, nil_if: '-'
-    attribute :period, String, nil_if: '-'
+    attribute :open_level, String, nil_if: %w(- 0)
+    attribute :period, Time, nil_if: '-', format: '%d/%m/%y %T', time_zone: '+10:00'
     attribute :profit_and_loss
     attribute :reference
     attribute :size, String, nil_if: '-'
@@ -32,18 +32,5 @@ module IGMarkets
 
       profit_and_loss[currency.length..-1].delete(',').to_f
     end
-
-    # Returns this transaction's {#transaction_type} as a human-readable string.
-    #
-    # @return [String]
-    def formatted_transaction_type
-      {
-        deal: 'Deal',
-        depo: 'Deposit',
-        dividend: 'Dividend',
-        exchange: 'Exchange',
-        with: 'Withdrawal'
-      }.fetch transaction_type
-    end
   end
 end

data/lib/ig_markets/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ig_markets
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-17 00:00:00.000000000 Z
+date: 2016-04-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -163,24 +191,31 @@ files:
 - bin/ig_markets
 - lib/ig_markets.rb
 - lib/ig_markets/account.rb
-- lib/ig_markets/account_activity.rb
-- lib/ig_markets/account_transaction.rb
+- lib/ig_markets/activity.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/commands/account_command.rb
+- lib/ig_markets/cli/commands/activities_command.rb
+- lib/ig_markets/cli/commands/confirmation_command.rb
+- lib/ig_markets/cli/commands/orders_command.rb
+- lib/ig_markets/cli/commands/positions_command.rb
+- lib/ig_markets/cli/commands/search_command.rb
+- lib/ig_markets/cli/commands/sentiment_command.rb
+- lib/ig_markets/cli/commands/sprints_command.rb
+- lib/ig_markets/cli/commands/transactions_command.rb
+- lib/ig_markets/cli/commands/watchlists_command.rb
 - lib/ig_markets/cli/config_file.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/output.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/cli/tables/accounts_table.rb
+- lib/ig_markets/cli/tables/activities_table.rb
+- lib/ig_markets/cli/tables/client_sentiments_table.rb
+- lib/ig_markets/cli/tables/market_overviews_table.rb
+- lib/ig_markets/cli/tables/positions_table.rb
+- lib/ig_markets/cli/tables/sprint_market_positions_table.rb
+- lib/ig_markets/cli/tables/table.rb
+- lib/ig_markets/cli/tables/transactions_table.rb
+- lib/ig_markets/cli/tables/working_orders_table.rb
 - lib/ig_markets/client_sentiment.rb
 - lib/ig_markets/deal_confirmation.rb
 - lib/ig_markets/dealing_platform.rb
@@ -204,9 +239,11 @@ files:
 - lib/ig_markets/position.rb
 - lib/ig_markets/regex.rb
 - lib/ig_markets/request_failed_error.rb
+- lib/ig_markets/request_printer.rb
 - lib/ig_markets/response_parser.rb
 - lib/ig_markets/session.rb
 - lib/ig_markets/sprint_market_position.rb
+- lib/ig_markets/transaction.rb
 - lib/ig_markets/version.rb
 - lib/ig_markets/watchlist.rb
 - lib/ig_markets/working_order.rb
@@ -233,6 +270,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Ruby client for the IG Markets dealing platform.
+summary: Ruby library and command-line client for accessing the IG Markets dealing
+  platform.
 test_files: []
 has_rdoc: 

data/lib/ig_markets/cli/activities_command.rb

@@ -1,31 +0,0 @@
-module IGMarkets
-  module CLI
-    # Implements the `ig_markets activities` command.
-    class Main
-      desc 'activities', 'Prints account activities'
-
-      option :days, type: :numeric, required: true, desc: 'The number of days to print account activities for'
-      option :start_date, desc: 'The start date to print account activities from, format: yyyy-mm-dd'
-
-      def activities
-        self.class.begin_session(options) do |dealing_platform|
-          gather_activities(dealing_platform, options[:days], options[:start_date]).sort_by(&:date).each do |activity|
-            Output.print_activity activity
-          end
-        end
-      end
-
-      private
-
-      def gather_activities(dealing_platform, days, start_date = nil)
-        if start_date
-          start_date = Date.strptime options[:start_date], '%F'
-
-          dealing_platform.account.activities_in_date_range start_date, start_date + days.to_i
-        else
-          dealing_platform.account.recent_activities days
-        end
-      end
-    end
-  end
-end

data/lib/ig_markets/cli/confirmation_command.rb

@@ -1,16 +0,0 @@
-module IGMarkets
-  module CLI
-    # Implements the `ig_markets confirmation` command.
-    class Main < Thor
-      desc 'confirmation <DEAL-REFERENCE>', 'Prints the deal confirmation for the specified deal reference'
-
-      def confirmation(deal_reference)
-        self.class.begin_session(options) do |dealing_platform|
-          deal_confirmation = dealing_platform.deal_confirmation deal_reference
-
-          Output.print_deal_confirmation deal_confirmation
-        end
-      end
-    end
-  end
-end

data/lib/ig_markets/cli/output.rb

@@ -1,115 +0,0 @@
-module IGMarkets
-  module CLI
-    # Contains methods used by the CLI to print models to stdout.
-    module Output
-      module_function
-
-      def print_account(account)
-        puts <<-END
-Account '#{account.account_name}':
-  ID:           #{account.account_id}
-  Type:         #{account.account_type.to_s.upcase}
-  Currency:     #{account.currency}
-  Status:       #{account.status.to_s.upcase}
-END
-      end
-
-      def print_account_balance(account)
-        {
-          available:   'Available:  ',
-          balance:     'Balance:    ',
-          deposit:     'Margin:     ',
-          profit_loss: 'Profit/loss:'
-        }.each do |attribute, title|
-          puts "  #{title}  #{Format.currency account.balance.send(attribute), account.currency}"
-        end
-      end
-
-      def print_activity(activity)
-        puts <<-END
-#{activity.date.strftime '%F'} #{activity.deal_id}: \
-#{activity.size} of #{activity.epic}, \
-level: #{activity.level}, \
-result: #{activity.result}
-END
-      end
-
-      def print_client_sentiment(client_sentiment)
-        puts <<-END
-#{client_sentiment.market_id}: \
-longs: #{client_sentiment.long_position_percentage}%, \
-shorts: #{client_sentiment.short_position_percentage}%
-END
-      end
-
-      def print_deal_confirmation(deal_confirmation)
-        print "Deal confirmation: #{deal_confirmation.deal_id}, #{deal_confirmation.deal_status}, "
-
-        if deal_confirmation.deal_status == :accepted
-          print "affected deals: #{deal_confirmation.affected_deals.map(&:deal_id).join(',')}, "
-        else
-          print "reason: #{deal_confirmation.reason}, "
-        end
-
-        puts "epic: #{deal_confirmation.epic}"
-      end
-
-      def print_market_overview(market)
-        puts <<-END
-#{market.epic}: \
-#{market.instrument_name}, \
-type: #{market.instrument_type}, \
-bid: #{market.bid} \
-offer: #{market.offer}
-END
-      end
-
-      def print_position(position)
-        puts <<-END
-#{position.deal_id}: \
-#{position.formatted_size} of #{position.market.epic} at #{position.level}, \
-profit/loss: #{Format.currency position.profit_loss, position.currency}
-END
-      end
-
-      def print_sprint_market_position(sprint)
-        puts <<-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
-
-      def print_transaction(transaction)
-        puts <<-END
-#{transaction.date.strftime '%F'} #{transaction.reference}: \
-#{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_watchlist(watchlist)
-        puts <<-END
-#{watchlist.id}: #{watchlist.name}, \
-editable: #{watchlist.editable}, \
-deleteable: #{watchlist.deleteable}, \
-default: #{watchlist.default_system_watchlist}
-END
-      end
-
-      def print_working_order(order)
-        puts <<-END
-#{order.deal_id}: \
-#{order.direction} #{format '%g', order.order_size} of #{order.epic} at #{order.order_level}\
-, limit distance: #{order.limit_distance || '-'}\
-, stop distance: #{order.stop_distance || '-'}\
-#{", good till #{order.good_till_date.utc.strftime '%F %R %z'}" if order.time_in_force == :good_till_date}
-END
-      end
-    end
-  end
-end