ig_markets 0.4 → 0.5

data/lib/ig_markets/cli/commands/search_command.rb

@@ -0,0 +1,18 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets search` command.
+    class Main < Thor
+      desc 'search QUERY', 'Searches markets based on the specified query string'
+
+      def search(query)
+        self.class.begin_session(options) do |dealing_platform|
+          market_overviews = dealing_platform.markets.search query
+
+          table = MarketOverviewsTable.new market_overviews
+
+          puts table
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/commands/sentiment_command.rb

@@ -0,0 +1,19 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets sentiment` command.
+    class Main
+      desc 'sentiment MARKET', 'Prints sentiment and related sentiments for the specified market'
+
+      def sentiment(market)
+        self.class.begin_session(options) do |dealing_platform|
+          client_sentiment = dealing_platform.client_sentiment[market]
+          client_sentiments = [client_sentiment, :separator, client_sentiment.related_sentiments]
+
+          table = ClientSentimentsTable.new client_sentiments, title: "Client sentiment for '#{market}'"
+
+          puts table
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/{sprints_command.rb → commands/sprints_command.rb}

@@ -6,9 +6,13 @@ module IGMarkets
 
       def list
         Main.begin_session(options) do |dealing_platform|
-          dealing_platform.sprint_market_positions.all.each do |sprint_market_position|
-            Output.print_sprint_market_position sprint_market_position
-          end
+          sprints = dealing_platform.sprint_market_positions.all
+
+          markets = dealing_platform.markets.find sprints.map(&:epic).uniq
+
+          table = SprintMarketPositionsTable.new sprints, markets: markets
+
+          puts table
         end
       end
 
@@ -23,17 +27,15 @@ module IGMarkets
 
       def create
         Main.begin_session(options) do |dealing_platform|
-          deal_reference = dealing_platform.sprint_market_positions.create new_sprint_market_position_attributes
-
-          puts "Deal reference: #{deal_reference}"
+          deal_reference = dealing_platform.sprint_market_positions.create sprint_market_position_attributes
 
-          Output.print_deal_confirmation dealing_platform.deal_confirmation deal_reference
+          Main.report_deal_confirmation deal_reference
         end
       end
 
       private
 
-      def new_sprint_market_position_attributes
+      def sprint_market_position_attributes
         {
           direction: options[:direction],
           epic: options[:epic],

data/lib/ig_markets/cli/commands/transactions_command.rb

@@ -0,0 +1,61 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets transactions` command.
+    class Main
+      desc 'transactions', 'Prints account transactions'
+
+      option :days, type: :numeric, required: true, desc: 'The number of days to print account transactions for'
+      option :start_date, desc: 'The start date to print account transactions from, format: yyyy-mm-dd'
+      option :instrument, desc: 'Regex for filtering transactions based on their instrument'
+      option :interest, type: :boolean, default: true, desc: 'Whether to show interest deposits and withdrawals'
+
+      def transactions
+        self.class.begin_session(options) do |_dealing_platform|
+          transactions = gather_transactions
+
+          table = TransactionsTable.new transactions
+
+          puts table
+
+          if transactions.any?
+            puts ''
+            print_transaction_totals transactions
+          end
+        end
+      end
+
+      private
+
+      def gather_transactions
+        regex = Regexp.new options.fetch('instrument', '')
+
+        gather_account_history(:transactions).sort_by(&:date).select do |transaction|
+          regex.match(transaction.instrument_name) && (options[:interest] || !transaction.interest?)
+        end
+      end
+
+      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_totals(transactions)
+        totals = transaction_totals transactions
+
+        return if totals.empty?
+
+        if options[:interest]
+          puts "Interest: #{totals.map { |currency, value| Format.currency value[:interest], currency }.join ', '}"
+        end
+
+        puts "Profit/loss: #{totals.map { |currency, value| Format.currency value[:delta], currency }.join ', '}"
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/{watchlists_command.rb → commands/watchlists_command.rb}

@@ -6,22 +6,18 @@ module IGMarkets
 
       def list
         Main.begin_session(options) do |dealing_platform|
-          dealing_platform.watchlists.all.each do |watchlist|
-            Output.print_watchlist watchlist
+          dealing_platform.watchlists.all.each_with_index do |watchlist, index|
+            table = MarketOverviewsTable.new watchlist.markets, title: table_title(watchlist)
 
-            watchlist.markets.each do |market_overview|
-              print '  - '
-              Output.print_market_overview market_overview
-            end
-
-            puts ''
+            puts '' if index > 0
+            puts table
           end
         end
       end
 
       default_task :list
 
-      desc 'create <NAME> [<EPIC> <EPIC> ...]', 'Creates a new watchlist with the specified name and EPICs'
+      desc 'create NAME [EPIC EPIC ...]', 'Creates a new watchlist with the specified name and EPICs'
 
       def create(name, *epics)
         Main.begin_session(options) do |dealing_platform|
@@ -31,7 +27,7 @@ module IGMarkets
         end
       end
 
-      desc 'add-markets <WATCHLIST-ID> <EPIC> [<EPIC> ...]', 'Adds the specified markets to a watchlist'
+      desc 'add-markets WATCHLIST-ID EPIC [EPIC ...]', 'Adds the specified markets to a watchlist'
 
       def add_markets(watchlist_id, *epics)
         with_watchlist(watchlist_id) do |watchlist|
@@ -41,7 +37,7 @@ module IGMarkets
         end
       end
 
-      desc 'remove-markets <WATCHLIST-ID> <EPIC> [<EPIC> ...]', 'Removes the specified markets from a watchlist'
+      desc 'remove-markets WATCHLIST-ID EPIC [EPIC ...]', 'Removes the specified markets from a watchlist'
 
       def remove_markets(watchlist_id, *epics)
         with_watchlist(watchlist_id) do |watchlist|
@@ -51,7 +47,7 @@ module IGMarkets
         end
       end
 
-      desc 'delete <WATCHLIST-ID>', 'Deletes the watchlist with the specified ID'
+      desc 'delete WATCHLIST-ID', 'Deletes the watchlist with the specified ID'
 
       def delete(watchlist_id)
         with_watchlist(watchlist_id, &:delete)
@@ -68,6 +64,14 @@ module IGMarkets
           yield watchlist
         end
       end
+
+      def table_title(watchlist)
+        title = "#{watchlist.name} (id: #{watchlist.id}"
+        title << ', editable' if watchlist.editable
+        title << ', deleteable' if watchlist.deleteable
+        title << ', default' if watchlist.default_system_watchlist
+        title << ')'
+      end
     end
   end
 end

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 :print_requests, type: :boolean, desc: 'Whether to print the raw REST API requests and responses'
 
       desc 'orders [SUBCOMAND=list ...]', 'Command for working with orders'
       subcommand 'orders', Orders
@@ -21,8 +22,8 @@ module IGMarkets
       subcommand 'watchlists', Watchlists
 
       class << self
-        # Signs in to IG Markets and yields back an {DealingPlatform} instance, with common error handling if exceptions
-        # occur. This method is used by all of the CLI commands to authenticate.
+        # Signs in to IG Markets and yields back a {DealingPlatform} instance, with common error handling if exceptions
+        # occur. This method is used by all of the commands in order to authenticate.
         #
         # @param [Thor::CoreExt::HashWithIndifferentAccess] options The Thor options hash.
         #
@@ -30,14 +31,16 @@ module IGMarkets
         def begin_session(options)
           platform = options[:demo] ? :demo : :production
 
+          RequestPrinter.enabled = true if options[:print_requests]
+
           dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
 
           yield dealing_platform
         rescue IGMarkets::RequestFailedError => error
-          warn "Request failed: #{error.error}"
+          warn "Request error: #{error.error}"
           exit 1
-        rescue StandardError => error
-          warn "Error: #{error}"
+        rescue ArgumentError => error
+          warn "Argument error: #{error}"
           exit 1
         end
 
@@ -46,13 +49,32 @@ module IGMarkets
           @dealing_platform ||= DealingPlatform.new
         end
 
-        # Parses and validates a Date or Time option received on the command line. Raises `ArgumentError` if the
-        # attribute has been specified in an invalid format.
+        # Takes a deal reference and prints out its full deal confirmation.
+        #
+        # @param [String] deal_reference The deal reference.
+        #
+        # @return [void]
+        def report_deal_confirmation(deal_reference)
+          puts "Deal reference: #{deal_reference}"
+
+          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 "epic: #{deal_confirmation.epic}"
+        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.
         #
         # @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 to parse the attribute 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.
         #
@@ -64,13 +86,29 @@ module IGMarkets
             begin
               attributes[attribute] = klass.strptime attributes[attribute], format
             rescue ArgumentError
-              raise "invalid #{attribute}, use format \"#{display_format}\""
+              raise ArgumentError, "invalid #{attribute}, use format \"#{display_format}\""
             end
           else
             attributes[attribute] = nil
           end
         end
 
+        # 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.
+        #
+        # @param [Thor::CoreExt::HashWithIndifferentAccess] options The Thor options.
+        # @param [Array<Symbol>] whitelist The list of options allowed in the returned `Hash`.
+        #
+        # @return [Hash]
+        def filter_options(options, whitelist)
+          options.each_with_object({}) do |(key, value), new_hash|
+            next unless whitelist.include? key.to_sym
+
+            new_hash[key.to_sym] = (value == key) ? nil : value
+          end
+        end
+
         # This is the initial entry point for the execution of the command-line client. It is responsible for reading
         # any config files, implementing the --version/-v options, and then invoking the main application.
         #
@@ -78,19 +116,31 @@ module IGMarkets
         #
         # @return [void]
         def bootstrap(argv)
+          prepend_config_file_arguments argv
+
           if argv.index('--version') || argv.index('-v')
             puts VERSION
             exit
           end
 
-          # Use arguments from a config file if one exists
+          start argv
+        end
+
+        # Searches for a config file and if found inserts its arguments into the passed arguments array.
+        #
+        # @param [Array<String>] argv The array of command-line arguments.
+        #
+        # @return [void]
+        def prepend_config_file_arguments(argv)
           config_file = ConfigFile.find
-          if config_file
-            insert_index = argv.index { |argument| argument[0] == '-' } || -1
-            argv.insert insert_index, *config_file.arguments
-          end
 
-          start argv
+          return unless config_file
+
+          insert_index = argv.index do |argument|
+            argument[0] == '-'
+          end || -1
+
+          argv.insert insert_index, *config_file.arguments
         end
       end
     end

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

@@ -0,0 +1,30 @@
+module IGMarkets
+  module CLI
+    # Helper class that prints out an array of {IGMarkets::Account} instances in a table.
+    class AccountsTable < Table
+      private
+
+      def default_title
+        'Accounts'
+      end
+
+      def headings
+        ['Name', 'ID', 'Type', 'Currency', 'Status', 'Preferred', 'Available', 'Balance', 'Margin', 'Profit/loss']
+      end
+
+      def right_aligned_columns
+        [6, 7, 8, 9]
+      end
+
+      def row(account)
+        type = { cfd: 'CFD', physical: 'Physical', spreadbet: 'Spreadbet' }.fetch account.account_type
+        status = { disabled: 'Disabled', enabled: 'Enabled', suspended_from_dealing: 'Suspended' }.fetch account.status
+
+        [account.account_name, account.account_id, type, account.currency, status, account.preferred] +
+          [:available, :balance, :deposit, :profit_loss].map do |attribute|
+            Format.currency account.balance.send(attribute), account.currency
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module IGMarkets
+  module CLI
+    # Helper class that prints out an array of {IGMarkets::Activity} instances in a table.
+    class ActivitiesTable < Table
+      private
+
+      def default_title
+        'Activities'
+      end
+
+      def headings
+        %w(Date Time Channel Type Status EPIC Market Size Level Limit Stop Result)
+      end
+
+      def right_aligned_columns
+        [7, 8, 9, 10]
+      end
+
+      def row(activity)
+        [activity.date, activity.time, activity.channel, activity.activity, activity_status(activity), activity.epic,
+         activity.market_name, activity.size, activity.level, activity.limit, activity.stop, activity.result]
+      end
+
+      def activity_status(activity)
+        { accept: 'Accepted', reject: 'Rejected', manual: 'Manual', not_set: '' }.fetch activity.action_status
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module IGMarkets
+  module CLI
+    # Helper class that prints out an array of {IGMarkets::ClientSentiment} instances in a table.
+    class ClientSentimentsTable < Table
+      private
+
+      def headings
+        ['Market', 'Long %', 'Short %']
+      end
+
+      def right_aligned_columns
+        [1, 2]
+      end
+
+      def row(client_sentiment)
+        [client_sentiment.market_id, client_sentiment.long_position_percentage,
+         client_sentiment.short_position_percentage]
+      end
+
+      def cell_color(_value, client_sentiment, _row_index, _column_index)
+        distance_from_center = (client_sentiment.long_position_percentage - 50.0).abs
+
+        if distance_from_center > 35
+          :red
+        elsif distance_from_center > 20
+          :yellow
+        end
+      end
+    end
+  end
+end