ig_markets 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4523bb2bdfdecccd336489d894f6ea218e78624
+  data.tar.gz: c8b898a21868963278e30fc66cc680c167b4e2f7
+SHA512:
+  metadata.gz: 369d69e66d370dcbd5ce69727ecd78d8b44e106de52bca60c68dedf30e0ef266d3a6d37021cae85553c2c4089a740743d07f50da7273ea211078d877e134efab
+  data.tar.gz: ce58fbf4ac2a67fbe02235a0d41484cca37280bf2a0082711cf70e07bf72872a80442096c6402e8e4da73fe6bfa86228030d8bb4dbbcd4d03971873a745aca78

data/.codeclimate.yml

@@ -0,0 +1,15 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -0,0 +1,9 @@
+/*.gem
+*.rbc
+/.bundle
+/.yardoc
+/coverage
+/doc
+/Gemfile.lock
+/tmp
+/vendor

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+script: bundle exec rspec
+addons:
+  code_climate:
+    repo_token: 9c6f0528b1bec40e8d0426f750c9402dab6e763f7a12b7fcae343f57ccb20a33

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+--markup-provider redcarpet
+--no-private
+--title "IG Markets Gem"

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © 2015-2016 Richard Viney
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,134 @@
+# Ruby IG Markets Dealing Platform Gem
+
+[![Gem][gem-badge]][gem-link]
+[![Build Status][travis-ci-badge]][travis-ci-link]
+[![Test Coverage][test-coverage-badge]][test-coverage-link]
+[![Code Climate][code-climate-badge]][code-climate-link]
+[![Dependencies][dependencies-badge]][dependencies-link]
+[![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).
+
+Includes support for:
+
+* Activity and transaction history
+* Positions
+* Sprint market positions
+* Working orders
+* Market navigation, searches and snapshots
+* Historical prices
+* Watchlists
+* Client sentiment
+
+An IG Markets production or demo trading account is needed in order to use this gem.
+
+## License
+
+Licensed under the MIT license. You must read and agree to its terms to use this software.
+
+## Requirements
+
+Ruby 2.0 or later.
+
+## Installation
+
+Add the following to your `Gemfile`
+
+```ruby
+gem 'ig_markets', git: 'https://github.com/rviney/ig_markets.git'
+```
+
+Then run
+
+```ruby
+bundle install
+```
+
+## Usage
+
+```ruby
+ig = IGMarkets::DealingPlatform.new
+
+# Session
+ig.sign_in 'username', 'password', 'api_key', :demo
+ig.sign_out
+
+# Account
+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)
+
+# Dealing
+ig.deal_confirmation 'deal_reference'
+
+# Positions
+ig.positions.all
+ig.positions.create currency_code: 'USD', direction: :buy, epic: 'CS.D.EURUSD.CFD.IP', size: 2
+ig.positions['deal_id']
+ig.positions['deal_id'].profit_loss
+ig.positions['deal_id'].update limit_level: 1.2, stop_level: 1.1
+ig.positions['deal_id'].close
+
+# Sprint market positions
+ig.sprint_market_positions.all
+ig.sprint_market_positions.create direction: :buy, epic: 'FM.D.EURUSD24.EURUSD24.IP',
+                                  expiry_period: :one_minute, size: 100
+
+# Working orders
+ig.working_orders.all
+ig.working_orders.create currency_code: 'USD', direction: :buy, epic: 'CS.D.EURUSD.CFD.IP', level: 0.99,
+                         size: 1, time_in_force: :good_till_cancelled, type: :limit
+ig.working_orders['deal_id']
+ig.working_orders['deal_id'].update level: 1.25, limit_distance: 50, stop_distance: 0.02
+ig.working_orders['deal_id'].delete
+
+# Markets
+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)
+
+# Watchlists
+ig.watchlists.all
+ig.watchlists.create 'New Watchlist', 'CS.D.EURUSD.CFD.IP', 'UA.D.AAPL.CASH.IP'
+ig.watchlists['watchlist_id']
+ig.watchlists['watchlist_id'].markets
+ig.watchlists['watchlist_id'].add_market 'CS.D.EURUSD.CFD.IP'
+ig.watchlists['watchlist_id'].remove_market 'CS.D.EURUSD.CFD.IP'
+ig.watchlists['watchlist_id'].delete
+
+# Client sentiment
+ig.client_sentiment['EURUSD']
+ig.client_sentiment['EURUSD'].related_sentiments
+
+# Miscellaneous
+ig.applications
+```
+
+## Documentation
+
+API documentation is available [here](http://www.rubydoc.info/github/rviney/ig_markets/master).
+
+## Contributors
+
+Gem created by Richard Viney. All contributions welcome.
+
+[gem-link]: https://rubygems.org/gems/ig_markets
+[gem-badge]: https://badge.fury.io/rb/ig_markets.svg
+[travis-ci-link]: http://travis-ci.org/rviney/ig_markets
+[travis-ci-badge]: https://travis-ci.org/rviney/ig_markets.svg?branch=master
+[test-coverage-link]: https://codeclimate.com/github/rviney/ig_markets/coverage
+[test-coverage-badge]: https://codeclimate.com/github/rviney/ig_markets/badges/coverage.svg
+[code-climate-link]: https://codeclimate.com/github/rviney/ig_markets
+[code-climate-badge]: https://codeclimate.com/github/rviney/ig_markets/badges/gpa.svg
+[dependencies-link]: https://gemnasium.com/rviney/ig_markets
+[dependencies-badge]: https://gemnasium.com/rviney/ig_markets.svg
+[documentation-link]: https://inch-ci.org/github/rviney/ig_markets
+[documentation-badge]: https://inch-ci.org/github/rviney/ig_markets.svg?branch=master
+[license-link]: https://github.com/rviney/ig_markets/blob/master/LICENSE.md
+[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg

data/ig_markets.gemspec

@@ -0,0 +1,28 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'ig_markets/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ig_markets'
+  s.version     = IGMarkets::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = 'MIT'
+  s.summary     = 'Ruby client for the IG Markets dealing platform.'
+  s.description = 'Ruby client for the IG Markets dealing platform.'
+  s.homepage    = 'https://github.com/rviney/ig_markets'
+  s.author      = 'Richard Viney'
+  s.email       = 'richard.viney@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_runtime_dependency 'rest-client', '~> 1.8'
+
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+  s.add_development_dependency 'factory_girl', '~> 4.7'
+  s.add_development_dependency 'github-markup', '~> 1.4'
+  s.add_development_dependency 'redcarpet', '~> 3.3'
+  s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'rspec-mocks', '~> 3.4'
+  s.add_development_dependency 'rubocop', '~> 0.39'
+  s.add_development_dependency 'yard', '~> 0.8'
+end

data/lib/ig_markets.rb

@@ -0,0 +1,42 @@
+require 'base64'
+require 'rest-client'
+
+require 'ig_markets/boolean'
+require 'ig_markets/model'
+require 'ig_markets/regex'
+
+require 'ig_markets/account'
+require 'ig_markets/account_activity'
+require 'ig_markets/account_transaction'
+require 'ig_markets/api_versions'
+require 'ig_markets/application'
+require 'ig_markets/client_sentiment'
+require 'ig_markets/deal_confirmation'
+require 'ig_markets/dealing_platform'
+require 'ig_markets/dealing_platform/account_methods'
+require 'ig_markets/dealing_platform/client_sentiment_methods'
+require 'ig_markets/dealing_platform/market_methods'
+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/instrument'
+require 'ig_markets/historical_price_result'
+require 'ig_markets/market'
+require 'ig_markets/market_overview'
+require 'ig_markets/market_hierarchy_result'
+require 'ig_markets/password_encryptor'
+require 'ig_markets/payload_formatter'
+require 'ig_markets/position'
+require 'ig_markets/request_failed_error'
+require 'ig_markets/response_parser'
+require 'ig_markets/session'
+require 'ig_markets/sprint_market_position'
+require 'ig_markets/version'
+require 'ig_markets/watchlist'
+require 'ig_markets/working_order'
+
+# This module contains all the code for the IG Markets gem. See `README.md` and the {DealingPlatform} class to get
+# started with using this gem.
+module IGMarkets
+end

data/lib/ig_markets/account.rb

@@ -0,0 +1,23 @@
+module IGMarkets
+  # Contains details on an IG Markets account. Returned by {DealingPlatform::AccountMethods#all}.
+  class Account < Model
+    # Contains details on the balance of an {Account}, used by {Account#balance}.
+    class Balance < Model
+      attribute :available, Float
+      attribute :balance, Float
+      attribute :deposit, Float
+      attribute :profit_loss, Float
+    end
+
+    attribute :account_alias
+    attribute :account_id
+    attribute :account_name
+    attribute :account_type, Symbol, allowed_values: [:cfd, :physical, :spreadbet]
+    attribute :balance, Balance
+    attribute :can_transfer_from, Boolean
+    attribute :can_transfer_to, Boolean
+    attribute :currency, String, regex: Regex::CURRENCY
+    attribute :preferred, Boolean
+    attribute :status, Symbol, allowed_values: [:disabled, :enabled, :suspended_from_dealing]
+  end
+end

data/lib/ig_markets/account_activity.rb

@@ -0,0 +1,24 @@
+module IGMarkets
+  # Contains details on a single activity that occurred on an IG Markets account. Returned by
+  # {DealingPlatform::AccountMethods#activities_in_date_range} and
+  # {DealingPlatform::AccountMethods#recent_activities}.
+  class AccountActivity < Model
+    attribute :action_status, Symbol, allowed_values: [:accept, :reject, :manual, :not_set]
+    attribute :activity
+    attribute :activity_history_id
+    attribute :channel
+    attribute :currency
+    attribute :date, DateTime, format: '%d/%m/%y'
+    attribute :deal_id
+    attribute :epic, String, regex: Regex::EPIC
+    attribute :level, Float
+    attribute :limit, Float, nil_if: '-'
+    attribute :market_name
+    attribute :period, String, nil_if: '-'
+    attribute :result
+    attribute :size
+    attribute :stop, String, nil_if: '-'
+    attribute :stop_type, String, nil_if: '-', allowed_values: %w(G N T(50))
+    attribute :time
+  end
+end

data/lib/ig_markets/account_transaction.rb

@@ -0,0 +1,49 @@
+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
+    attribute :cash_transaction, Boolean
+    attribute :close_level
+    attribute :currency
+    attribute :date, DateTime, format: '%d/%m/%y'
+    attribute :instrument_name
+    attribute :open_level, String, nil_if: '-'
+    attribute :period, String, nil_if: '-'
+    attribute :profit_and_loss
+    attribute :reference
+    attribute :size, String, nil_if: '-'
+    attribute :transaction_type, Symbol, allowed_values: [:deal, :depo, :dividend, :exchange, :with]
+
+    # Returns whether or not this transaction was an interest payment. Interest payments can be either deposits or
+    # withdrawals depending on the underlying instrument and currencies involved. Interest payments are identified by
+    # the presence of the word `interest` in {#instrument_name}.
+    #
+    # @return [Boolean]
+    def interest?
+      [:depo, :with].include?(transaction_type) && !(instrument_name.downcase =~ /(^|[^a-z])interest([^a-z]|$)/).nil?
+    end
+
+    # Returns this transaction's {#profit_and_loss} as a `Float`, denominated in this transaction's {#currency}.
+    #
+    # @return [Float]
+    def profit_and_loss_amount
+      raise 'profit_and_loss does not start with the expected currency' unless profit_and_loss.start_with? currency
+
+      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/api_versions.rb

@@ -0,0 +1,10 @@
+module IGMarkets
+  # Named constant used to target version 1 of the IG Markets API.
+  API_V1 = 1
+
+  # Named constant used to target version 2 of the IG Markets API.
+  API_V2 = 2
+
+  # Named constant used to target version 3 of the IG Markets API.
+  API_V3 = 3
+end

data/lib/ig_markets/application.rb

@@ -0,0 +1,22 @@
+module IGMarkets
+  # Contains details on an IG Markets application configuration. Returned by {DealingPlatform#applications}.
+  class Application < Model
+    attribute :allow_equities, Boolean
+    attribute :allow_quote_orders, Boolean
+    attribute :allowance_account_historical_data, Fixnum
+    attribute :allowance_account_overall, Fixnum
+    attribute :allowance_account_trading, Fixnum
+    attribute :allowance_application_overall, Fixnum
+    attribute :api_key
+    attribute :client_id
+    attribute :concurrent_subscriptions_limit, Fixnum
+    attribute :created_date, DateTime, 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 :tier
+  end
+end

data/lib/ig_markets/boolean.rb

@@ -0,0 +1,5 @@
+module IGMarkets
+  # Placeholder class for specifying a boolean type.
+  class Boolean
+  end
+end