darwinex 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac904b4f9186682cfffe024d341fe861e68c7265992ebfa8c91f59c670383e58
+  data.tar.gz: e996ae82564e322faaaf9d27748bf6a45d821a61a4bd77498705ce6ab0ff15d6
+SHA512:
+  metadata.gz: 439479c7142d1bfc25954d62fd53ec3c055b654aa3be07e6d442b99f85e2b89e7a22b3708f462a5b3332690ce3b4c84f800d2c03399ec7419be1314fb097c3af
+  data.tar.gz: 208eb9f359cfd3439b131ba23303544b34695aefc52834e5cfbf85107515bd35de2ccc4c50fb6ffa406d9231497222a0ae50628943002aa715384fb89a492948

data/.gitignore

@@ -0,0 +1,120 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/ruby,osx,macos,git
+# Edit at https://www.toptal.com/developers/gitignore?templates=ruby,osx,macos,git
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+*.orig
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### OSX ###
+# General
+
+# Icon must end with two \r
+
+# Thumbnails
+
+# Files that might appear in the root of a volume
+
+# Directories potentially created on remote AFP share
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### Ruby Patch ###
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# End of https://www.toptal.com/developers/gitignore/api/ruby,osx,macos,git

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+script: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 1.0.0
+#### 2020-09-01
+- Initial release.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'httparty', '~> 0.18.1'
+
+group :development, :test do
+  gem 'vcr', '~> 6.0'
+  gem 'webmock', '~> 3.8'
+  gem 'rspec', '~> 3.9'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 James Frost
+
+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,351 @@
+# Darwinex
+
+[![Build Status](https://travis-ci.org/JamesFrost/darwinex.svg?branch=master)](https://travis-ci.org/JamesFrost/darwinex)
+
+Ruby client for the Darwinex API.
+
+## Installation
+
+### Gemfile
+
+```ruby
+gem 'darwinex'
+```
+
+### Install
+
+```bash
+$ gem install darwinex
+```
+
+## Usage
+
+Require the client:
+
+```ruby
+require 'darwinex/client'
+```
+
+Initialise the client:
+
+```ruby
+client = Darwinex::Client.new(
+  consumer_key: "<consumer key>",
+  consumer_secret: "<consumer secret>"
+)
+```
+
+If you would like to use a custom logger:
+
+```ruby
+client = Darwinex::Client.new(
+  consumer_key: "<consumer key>",
+  consumer_secret: "<consumer secret>",
+  logger: Logger.new(STDOUT)
+)
+```
+
+If you would like to configure the maximum number of API call retries:
+
+```ruby
+client = Darwinex::Client.new(
+  consumer_key: "<consumer key>",
+  consumer_secret: "<consumer secret>",
+  max_retries: 10 # Default: 5
+)
+```
+
+Before you use the client, you must generate a new access token for the client to use:
+
+```ruby
+resp = client.refresh_access_token("<refresh token>")
+
+refresh_token = resp["refresh_token"]
+```
+
+The client will now be ready for use.
+
+You will need to persist the refresh token returned by `.refresh_access_token` - you will need it the next time you want to generate a new access token.
+
+## Examples
+
+### Investor Accounts
+
+```ruby
+client.list_investor_accounts
+```
+
+```ruby
+client.investor_account("<account id>")
+```
+
+```ruby
+client.investor_account("<account id>").summary
+```
+
+```ruby
+client.investor_account("<account id>").leverage
+```
+
+```ruby
+client.investor_account("<account id>").update_leverage(3)
+```
+
+```ruby
+buy_order = { long: "eurusd" }
+
+client.investor_account("<account id>").create_buy_order(buy_order)
+```
+
+```ruby
+sell_order = { long: "eurusd" }
+
+client.investor_account("<account id>").create_sell_order(sell_order)
+```
+
+```ruby
+# Will create a stopout for all products
+client.investor_account("<account id>").create_stopout
+```
+
+```ruby
+product_name = 'DWC.4.20'
+
+client.investor_account("<account id>").create_stopout(product_name)
+```
+
+```ruby
+order = {
+  'amount' => 215.15,
+  'productName' => 'DWC.4.20',
+  'quote' => 20.23,
+  'side' => 'BUY',
+  'type' => 'LESS_THAN_EQUAL',
+  'thresholdParameters' => {
+    'quoteStopLoss' => 10.05,
+    'quoteTakeProfit' => 250.1
+  }
+}
+
+client.investor_account("<account id>").create_conditional_order(order)
+```
+
+```ruby
+order_id = 123
+
+order = {
+  'amount' => 215.15,
+  'productName' => 'DWC.4.20',
+  'quote' => 20.23,
+  'side' => 'BUY',
+  'type' => 'LESS_THAN_EQUAL',
+  'thresholdParameters' => {
+    'quoteStopLoss' => 10.05,
+    'quoteTakeProfit' => 250.1
+  }
+}
+
+client.investor_account("<account id>").update_conditional_order(order_id, order)
+```
+
+```ruby
+order_id = 123
+
+client.investor_account("<account id>").delete_conditional_order(order_id)
+```
+
+```ruby
+client.investor_account("<account id>").current_positions
+```
+
+```ruby
+product_name = 'DWC.4.20'
+
+client.investor_account("<account id>").current_positions(product_name)
+```
+
+```ruby
+client.investor_account("<account id>").executed_orders
+```
+
+```ruby
+options = {
+  product_name: 'DWC.4.20',
+  page: 2,
+  per_page: 10
+}
+
+client.investor_account("<account id>").executed_orders(options)
+```
+
+```ruby
+order_id = 'DWC.4.20'
+
+client.investor_account("<account id>").order(order_id)
+```
+
+```ruby
+client.investor_account("<account id>").performance_fees
+```
+
+```ruby
+options = {
+  page: 2,
+  per_page: 10
+}
+
+client.investor_account("<account id>").performance_fees(options)
+```
+
+```ruby
+product_name = 'DWC.4.20'
+
+client.investor_account("<account id>").product_performance_fees(product_name)
+```
+
+```ruby
+trade_status = 'open'
+
+client.investor_account("<account id>").trades(trade_status)
+```
+
+```ruby
+trade_status = 'open'
+
+options = {
+  product_name: 'DWC.4.20',
+  page: 2,
+  per_page: 10
+}
+
+client.investor_account("<account id>").trades(trade_status, options)
+```
+
+```ruby
+trade_id = 'DWC.4.20'
+
+client.investor_account("<account id>").trade(trade_id)
+```
+
+
+### Products
+
+```ruby
+client.list_products
+```
+
+```ruby
+client.product("<product name>")
+```
+
+```ruby
+client.product("<product name>").candles(from: epoch_timestamp, to: epoch_timestamp)
+```
+
+```ruby
+client.product("<product name>").candles(resolution: '1m', from: epoch_timestamp, to: epoch_timestamp)
+```
+
+```ruby
+client.product("<product name>").dxscore
+```
+
+```ruby
+client.product("<product name>").badges
+```
+
+```ruby
+client.product("<product name>").close_strategy
+```
+
+```ruby
+client.product("<product name>").duration_consistency
+```
+
+```ruby
+client.product("<product name>").experience
+```
+
+```ruby
+client.product("<product name>").losing_consistency
+```
+
+```ruby
+client.product("<product name>").market_correlation
+```
+
+```ruby
+client.product("<product name>").performance
+```
+
+```ruby
+client.product("<product name>").open_strategy
+```
+
+```ruby
+client.product("<product name>").capacity
+```
+
+```ruby
+client.product("<product name>").quotes
+```
+
+```ruby
+client.product("<product name>").quotes(from: epoch_timestamp, to: epoch_timestamp)
+```
+
+```ruby
+client.product("<product name>").risk_stability
+```
+
+```ruby
+client.product("<product name>").winning_consistency
+```
+
+```ruby
+client.product("<product name>").order_divergence
+```
+
+```ruby
+client.product("<product name>").return_divergence
+```
+
+```ruby
+client.product("<product name>").monthly_divergence
+```
+
+```ruby
+client.product("<product name>").status
+```
+
+```ruby
+client.product("<product name>").scores
+```
+
+```ruby
+badge = "EXPERIENCE"
+
+client.product("<product name>").scores(badge)
+```
+
+## Exceptions
+
+All exceptions extend the base exception class `Darwinex::Error`.
+
+### Invalid Credentials
+
+Raised when the consumer key or secret passed to the client are not valid.
+
+### Throttled
+
+Raised when you exceed the [API rate limit](https://help.darwinex.com/api-walkthrough#throttling).
+
+The client will automatically back off and retry throttled API responses until the max retries limit is hit.
+
+### Refresh Token Expired
+
+Raised when `Darwinex::Client#refresh_access_token` is called with a refresh token that has expired.
+
+Refresh tokens are only valid for a short period of time, after which they expire. As such, it's important your application regularly refreshes the access tokens to stop them from expiring.
+
+In order to resolve this issue, you must go to the Darwinex Web console and issue a new refresh token.