ig_markets 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4523bb2bdfdecccd336489d894f6ea218e78624
-  data.tar.gz: c8b898a21868963278e30fc66cc680c167b4e2f7
+  metadata.gz: 30bad1af818d34d53ba4b795a9eabd4ceff42bc1
+  data.tar.gz: 10131179ae36ddafba7f61b8db89b162699dd5cb
 SHA512:
-  metadata.gz: 369d69e66d370dcbd5ce69727ecd78d8b44e106de52bca60c68dedf30e0ef266d3a6d37021cae85553c2c4089a740743d07f50da7273ea211078d877e134efab
-  data.tar.gz: ce58fbf4ac2a67fbe02235a0d41484cca37280bf2a0082711cf70e07bf72872a80442096c6402e8e4da73fe6bfa86228030d8bb4dbbcd4d03971873a745aca78
+  metadata.gz: 47e56e3def7e7da1e53bb3e990dcaa94eb27fa8eecffe8b6038a1806357bf79e7c08a0692c067fcf3f6c9a68251132c4242c8162fd5e535801c9f6bb59988194
+  data.tar.gz: 555d47c8e5b70d92b40e6e942f4bb0a395c7f0eb34c5873cc4864e56d35d8843691795c83dfd8cd74ac5f27124d9198929cf40719f52c55f686b9de2a42bbb47

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# IG Markets Changelog
+
+### 0.2 - April 14, 2016
+
+- Added `ig_markets` command-line client
+- `IGMarkets::Model` now has separate `Date` and `Time` attribute types, and a new `:time_zone` option is used for
+  `Time` attributes that have a known time zone. Previous uses of `DateTime` should be replaced with either `Date` or
+  `Time`.
+- Changed `size` attribute to always be of type `Float` on all models.
+- Changed `limit_distance` and `stop_distance` attributes to always be of type `Fixnum` on all models.
+- Added `IGMarkets::Format` module
+- Added `#expired?` and `#seconds_till_expiry` to `IGMarkets::SprintMarketPosition`
+- Fixed `IGMarkets::RequestFailedError#message`
+
+### 0.1 - April 8, 2016
+
+- Initial release

data/README.md

@@ -8,8 +8,8 @@
 [![Documentation][documentation-badge]][documentation-link]
 [![License][license-badge]][license-link]
 
-Easily access the IG Markets Dealing Platform from Ruby with this gem. Written against the
-[official REST API](http://labs.ig.com/rest-trading-api-reference).
+Easily access the IG Markets Dealing Platform from Ruby with this gem, either directly through code or by using the
+provided command-line client. Written against the [official REST API](http://labs.ig.com/rest-trading-api-reference).
 
 Includes support for:
 
@@ -28,25 +28,41 @@ An IG Markets production or demo trading account is needed in order to use this
 
 Licensed under the MIT license. You must read and agree to its terms to use this software.
 
-## Requirements
+## Usage — Command-Line Client
 
-Ruby 2.0 or later.
+```sh
+$ gem install ig_markets
 
-## Installation
+Usage: ig_markets <command> --username=<username> --password=<password> --api-key=<api-key> [--demo]
+```
 
-Add the following to your `Gemfile`
+On startup `ig_markets` searches for files named `"./.ig_markets"` and then `"~/.ig_markets"`, and if they are present
+interprets their contents as command-line arguments. This can be used to avoid having to specify authentication details
+with every invocation. To do this create a file at `./".ig_markets"` or `~/".ig_markets"` with the following contents:
 
-```ruby
-gem 'ig_markets', git: 'https://github.com/rviney/ig_markets.git'
+```
+--username=<username>
+--password=<password>
+--api-key=<api-key>
+# (include if this is a demo account) --demo
 ```
 
-Then run
+Run `ig_markets help` to list details on available commands. The full list of commands is:
 
-```ruby
-bundle install
-```
+- `ig_markets account`
+- `ig_markets activities [--days=3]`
+- `ig_markets confirmation --deal-reference=<...>`
+- `ig_markets orders`
+- `ig_markets positions`
+- `ig_markets search --query=<...>`
+- `ig_markets sentiment --market=<...> [--related]`
+- `ig_markets sprints`
+- `ig_markets transactions [--days=3]`
+- `ig_markets watchlists`
+
+Note: at present there is no support in the command-line client for creating/updating/deleting positions, orders, etc...
 
-## Usage
+## Usage — Library
 
 ```ruby
 ig = IGMarkets::DealingPlatform.new
@@ -59,8 +75,8 @@ ig.sign_out
 ig.account.all
 ig.account.recent_activities 24 * 60 * 60
 ig.account.recent_transactions 24 * 60 * 60
-ig.account.activities_in_date_range Date.today.prev_month(2), Date.today.prev_month(1)
-ig.account.transactions_in_date_range Date.today.prev_month(2), Date.today.prev_month(1)
+ig.account.activities_in_date_range Date.today - 14, Date.today - 7
+ig.account.transactions_in_date_range Date.today - 14, Date.today - 7
 
 # Dealing
 ig.deal_confirmation 'deal_reference'
@@ -91,7 +107,7 @@ ig.markets.hierarchy
 ig.markets.search 'EURUSD'
 ig.markets['CS.D.EURUSD.CFD.IP']
 ig.markets['CS.D.EURUSD.CFD.IP'].recent_prices :day, 10
-ig.markets['CS.D.EURUSD.CFD.IP'].prices_in_date_range :day, Date.today.prev_month(2), Date.today.prev_month(1)
+ig.markets['CS.D.EURUSD.CFD.IP'].prices_in_date_range :day, Date.today - 14, Date.today - 7
 
 # Watchlists
 ig.watchlists.all

data/bin/ig_markets

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(File.realpath(__FILE__)) + '/../lib'
+
+require 'ig_markets'
+
+# Read arguments from any '.ig_markets' config file
+def config_file_arguments
+  config_file = ['.ig_markets', "#{Dir.home}/.ig_markets"].detect { |file| File.exist? file }
+
+  return [] unless config_file
+
+  File.readlines(config_file)
+      .map { |line| line.gsub(/#.*/, '') }
+      .map(&:strip)
+      .join(' ')
+      .split(' ')
+end
+
+# Put arguments from the config file into a modified ARGV array
+def modified_argv
+  insert_index = ARGV.index do |argument|
+    argument[0] == '-'
+  end || ARGV.size
+
+  ARGV.dup.insert insert_index, *config_file_arguments
+end
+
+IGMarkets::CLI::Main.start modified_argv

data/lib/ig_markets.rb

@@ -1,8 +1,11 @@
 require 'base64'
+require 'date'
 require 'rest-client'
+require 'thor'
 
 require 'ig_markets/boolean'
 require 'ig_markets/model'
+require 'ig_markets/model/typecasters'
 require 'ig_markets/regex'
 
 require 'ig_markets/account'
@@ -10,6 +13,17 @@ require 'ig_markets/account_activity'
 require 'ig_markets/account_transaction'
 require 'ig_markets/api_versions'
 require 'ig_markets/application'
+require 'ig_markets/cli/main'
+require 'ig_markets/cli/account_command'
+require 'ig_markets/cli/activities_command'
+require 'ig_markets/cli/confirmation_command'
+require 'ig_markets/cli/orders_command'
+require 'ig_markets/cli/positions_command'
+require 'ig_markets/cli/search_command'
+require 'ig_markets/cli/sentiment_command'
+require 'ig_markets/cli/sprints_command'
+require 'ig_markets/cli/transactions_command'
+require 'ig_markets/cli/watchlists_command'
 require 'ig_markets/client_sentiment'
 require 'ig_markets/deal_confirmation'
 require 'ig_markets/dealing_platform'
@@ -20,6 +34,7 @@ require 'ig_markets/dealing_platform/position_methods'
 require 'ig_markets/dealing_platform/sprint_market_position_methods'
 require 'ig_markets/dealing_platform/watchlist_methods'
 require 'ig_markets/dealing_platform/working_order_methods'
+require 'ig_markets/format'
 require 'ig_markets/instrument'
 require 'ig_markets/historical_price_result'
 require 'ig_markets/market'

data/lib/ig_markets/account_activity.rb

@@ -8,7 +8,7 @@ module IGMarkets
     attribute :activity_history_id
     attribute :channel
     attribute :currency
-    attribute :date, DateTime, format: '%d/%m/%y'
+    attribute :date, Date, format: '%d/%m/%y'
     attribute :deal_id
     attribute :epic, String, regex: Regex::EPIC
     attribute :level, Float

data/lib/ig_markets/account_transaction.rb

@@ -6,7 +6,7 @@ module IGMarkets
     attribute :cash_transaction, Boolean
     attribute :close_level
     attribute :currency
-    attribute :date, DateTime, format: '%d/%m/%y'
+    attribute :date, Date, format: '%d/%m/%y'
     attribute :instrument_name
     attribute :open_level, String, nil_if: '-'
     attribute :period, String, nil_if: '-'

data/lib/ig_markets/application.rb

@@ -10,13 +10,13 @@ module IGMarkets
     attribute :api_key
     attribute :client_id
     attribute :concurrent_subscriptions_limit, Fixnum
-    attribute :created_date, DateTime, format: '%Q'
+    attribute :created_date, Time, format: '%Q'
     attribute :fast_markets_settlement_price_enabled, Boolean
     attribute :id
     attribute :name
     attribute :restricted_to_self, Boolean
     attribute :status, Symbol, allowed_values: [:disabled, :enabled, :revoked]
-    attribute :terms_accepted_date, DateTime, format: '%Q'
+    attribute :terms_accepted_date, Time, format: '%Q'
     attribute :tier
   end
 end

data/lib/ig_markets/cli/account_command.rb

@@ -0,0 +1,40 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets account` command.
+    class Main
+      desc 'account', 'Prints account overview and balances'
+
+      def account
+        begin_session do
+          dealing_platform.account.all.each do |account|
+            print_account account
+            print_account_balance account
+          end
+        end
+      end
+
+      private
+
+      def print_account(account)
+        print <<-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, display_name|
+          print "  #{display_name}  #{Format.currency account.balance.send(attribute), account.currency}\n"
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/activities_command.rb

@@ -0,0 +1,33 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets activities` command.
+    class Main
+      desc 'activities', 'Prints recent activities'
+
+      option :days, default: 3, type: :numeric, desc: 'The number of days to print recent activities for'
+
+      def activities
+        begin_session do
+          dealing_platform.account.recent_activities(seconds).each do |activity|
+            print_activity activity
+          end
+        end
+      end
+
+      private
+
+      def seconds
+        (options[:days].to_f * 60 * 60 * 24).to_i
+      end
+
+      def print_activity(activity)
+        print <<-END
+#{activity.deal_id}: \
+#{activity.size} of #{activity.epic}, \
+level: #{activity.level}, \
+result: #{activity.result}
+END
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/confirmation_command.rb

@@ -0,0 +1,32 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets confirmation` command.
+    class Main < Thor
+      desc 'confirmation', 'Prints the deal confirmation for the specified deal reference.'
+
+      option :deal_reference, aliases: '-r', required: true, desc: 'The deal reference to print the confirmation for.'
+
+      def confirmation
+        begin_session do
+          deal_confirmation = dealing_platform.deal_confirmation options[:deal_reference]
+
+          print_deal_confirmation deal_confirmation
+        end
+      end
+
+      private
+
+      def print_deal_confirmation(deal_confirmation)
+        print "#{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
+
+        print "epic: #{deal_confirmation.epic}\n"
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/main.rb

@@ -0,0 +1,39 @@
+module IGMarkets
+  # This module contains the code for the CLI frontend. See `README.md` for usage details.
+  module CLI
+    # Implements the `ig_markets` command-line client.
+    class Main < Thor
+      class_option :username, aliases: '-u', required: true, desc: 'The username for the session'
+      class_option :password, aliases: '-p', required: true, desc: 'The password for the session'
+      class_option :api_key, aliases: '-k', required: true, desc: 'The API key for the session'
+      class_option :demo, aliases: '-d', type: :boolean, desc: 'Use the demo platform (default is production)'
+
+      no_commands do
+        # Intercepts calls to `print` in the CLI commands, used by the test suite.
+        def print(string)
+          Kernel.print string
+        end
+
+        # Intercepts calls to `exit` in the CLI commands, used by the test suite.
+        def exit(code)
+          Kernel.exit code
+        end
+
+        def dealing_platform
+          @dealing_platform ||= DealingPlatform.new
+        end
+
+        def begin_session
+          platform = options[:demo] ? :demo : :production
+
+          dealing_platform.sign_in options[:username], options[:password], options[:api_key], platform
+
+          yield
+        rescue IGMarkets::RequestFailedError => error
+          print "ERROR: #{error.error}\n"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/orders_command.rb

@@ -0,0 +1,28 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets orders` command.
+    class Main
+      desc 'orders', 'Prints working orders'
+
+      def orders
+        begin_session do
+          dealing_platform.working_orders.all.each do |order|
+            print_working_order order
+          end
+        end
+      end
+
+      private
+
+      def print_working_order(order)
+        print <<-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 %T %z'}" if order.time_in_force == :good_till_date}
+END
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/positions_command.rb

@@ -0,0 +1,20 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets positions` command.
+    class Main
+      desc 'positions', 'Prints open positions'
+
+      def positions
+        begin_session do
+          dealing_platform.positions.all.each do |position|
+            print <<-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
+        end
+      end
+    end
+  end
+end

data/lib/ig_markets/cli/search_command.rb

@@ -0,0 +1,30 @@
+module IGMarkets
+  module CLI
+    # Implements the `ig_markets search` command.
+    class Main < Thor
+      desc 'search', 'Searches markets based on a query string'
+
+      option :query, aliases: '-q', required: true, desc: 'The search query'
+
+      def search
+        begin_session do
+          dealing_platform.markets.search(options[:query]).each do |market|
+            print_market_overview market
+          end
+        end
+      end
+
+      private
+
+      def print_market_overview(market)
+        print <<-END
+#{market.epic}: \
+#{market.instrument_name}, \
+type: #{market.instrument_type}, \
+bid: #{market.bid} \
+offer: #{market.offer}
+END
+      end
+    end
+  end
+end