deribit 1.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01033c2b53f215d35bbfe632dfa2c36b1892ebe305943d2d126aafe3a026c231
+  data.tar.gz: 82540961814471f3c11dcdd0be67b7bfd7d4a5c8fc57a17d43ed22be3d281509
+SHA512:
+  metadata.gz: 5f8fd1d0aa6c42a4c9f0e0fa4ac89fff4387774e29f4e5e451542a284e9ec8a1c217177cf203f3cab9e0504bbc1ce80f01fad7488a082fa0716d401dff6c448a
+  data.tar.gz: '097fb448d4addd3c5ca370f788dca646d7a2a8ff57509fefb84023b60e7a4547cd90daf973aad73e18b46cf089d6aa56353df5ad6119799459a087758b2705dc'

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexanderdmv@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :test do
+  gem 'webmock'
+  gem 'vcr'
+end
+
+# Specify your gem's dependencies in deribit.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    deribit (1.3.0)
+      websocket-client-simple (~> 0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    event_emitter (0.2.6)
+    hashdiff (0.3.7)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    websocket (1.2.8)
+    websocket-client-simple (0.3.0)
+      event_emitter
+      websocket
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  deribit!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2010-2019 Google, Inc. http://angularjs.org
+
+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,261 @@
+# Deribit
+
+# API Client for v1 [Deribit API](https://www.deribit.com/docs/api/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deribit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deribit
+
+## Usage
+
+
+### Example
+
+```
+require 'deribit'
+
+api = Deribit::API.new("KEY", "SECRET")
+
+api.index
+api.account_info
+```
+
+ENV['DOMAIN'] is changing the default domain https://deribit.com/
+
+```
+DOMAIN=https://test.deribit.com/ bin/console
+```
+
+## API
+
+`Deribit::API.new(key, secret)`
+
+Constructor creates new API client.
+
+**Parameters**
+
+| Name     | Type     | Decription                                                |
+|----------|----------|-----------------------------------------------------------|
+| `key`    | `string` | Optional, Access Key needed to access Private functions   |
+| `secret` | `string` | Optional, Access Secret needed to access Private functions|
+
+
+### Methods
+
+* `getinstruments(expired: false, only_active: true)` - [Doc](https://www.deribit.com/docs/api/#getinstruments), public
+
+  Returns active instruments
+  **Parameters**
+
+  | Name         | Type       | Decription                                                 |
+  |--------------|------------|------------------------------------------------------------|
+  | `expired`    | `boolean`  | Optional, for returning all expired instruments.           |
+  | `only_active`| `boolean`  | Optional, returns only isActive true instruments           |
+
+* `getorderbook(instrument)` - [Doc](https://www.deribit.com/docs/api/#getinstruments), public
+
+  Retrieve the orderbook for a given instrument.
+
+  **Parameters**
+
+  | Name         | Type       | Decription                                                 |
+  |--------------|------------|------------------------------------------------------------|
+  | `instrument` | `string`   | Required, instrument name                                  |
+
+
+* `index()` - [Doc](https://www.deribit.com/docs/api/#index), public
+
+  Get price index, BTC-USD rates.
+
+* `getcurrencies()` - [Doc](https://www.deribit.com/docs/api/#getcurrencies), public
+
+  Get all supported currencies.
+
+* `getlasttrades(instrument, count: count, since: since)` - [Doc](https://www.deribit.com/docs/api/#getlasttrades), public
+
+  Retrieve the latest trades that have occured for a specific instrument.
+
+  **Parameters**
+
+  | Name         | Type       | Decription                                                                    |
+  |--------------|------------|-------------------------------------------------------------------------------|
+  | `instrument` | `string`   | Required, instrument name                                                     |
+  | `count`      | `integer`  | Optional, count of trades returned (limitation: max. count is 100)            |
+  | `since`      | `integer`  | Optional, “since” trade id, the server returns trades newer than that “since” |
+
+
+* `getsummary(instrument)` - [Doc](https://www.deribit.com/docs/api/#getsummary), public
+
+  Retrieve the summary info such as Open Interest, 24H Volume etc for a specific instrument.
+
+  **Parameters**
+
+  | Name         | Type       | Decription                                                 |
+  |--------------|------------|------------------------------------------------------------|
+  | `instrument` | `string`   | Required, instrument name                                  |
+
+
+* `account()` - [Doc](https://www.deribit.com/docs/api/#account), Private
+
+  Get user account summary.
+
+* `buy(instrument, quantity, price, type: "limit", stopPx: stopPx, post_only: post_only, label: label, max_show: max_show, adv: adv)` - [Doc](https://www.deribit.com/docs/api/#buy), private
+
+  Place a buy order in an instrument.
+
+  **Parameters**
+
+  | Name         | Type       | Decription                                                                        |
+  |--------------|------------|-----------------------------------------------------------------------------------|
+  | `instrument` | `string`   | Required, instrument name                                                         |
+  | `quantity`   | `integer`  | Required, quantity, in contracts ($10 per contract for futures, ฿1 — for options) |
+  | `price`      | `float`    | Required, USD for futures, BTC for options                                        |
+  | `post_only`  | `boolean`  | Optional, if true then the order will be POST ONLY                                |
+  | `label`      | `string`   | Optional, user defined maximum 32-char label for the order                        |
+  | `type`       | `string`   | Required, "limit", "market" or for futures only: "stop_limit"                     |
+  | `stopPx`     | `string`   | Required, needed for stop_limit order, defines stop price                         |
+  | `max_show`   | `string`   | Optional, optional parameter, if "0" then the order will be hidden                |
+  | `adv`        | `string`   | Optional, can be "implv", "usd", or absent (advanced order type)                  |
+
+
+* `sell(instrument, quantity, price, post_only: post_only, label: label, max_show: max_show, adv: adv)` - [Doc](https://www.deribit.com/docs/api/#sell), private
+
+  Place a sell order in an instrument.
+
+  **Parameters**
+
+  | Name         | Type       | Decription                                                                        |
+  |--------------|------------|-----------------------------------------------------------------------------------|
+  | `instrument` | `string`   | Required, instrument name                                                         |
+  | `quantity`   | `integer`  | Required, quantity, in contracts ($10 per contract for futures, ฿1 — for options) |
+  | `price`      | `float`    | Required, USD for futures, BTC for options                                        |
+  | `post_only`  | `boolean`  | Optional, if true then the order will be POST ONLY                                |
+  | `label`      | `string`   | Optional, user defined maximum 32-char label for the order                        |
+  | `max_show`   | `string`   | Optional, optional parameter, if "0" then the order will be hidden                |
+  | `adv`        | `string`   | Optional, can be "implv", "usd", or absent (advanced order type)                  |
+
+
+* `edit(order_id, quantity, price, post_only: post_only, adv: adv)` - [Doc](https://www.deribit.com/docs/api/#edit)
+
+  Edit price and/or quantity of the own order. (Authorization is required).
+
+  **Parameters**
+
+  | Name         | Type       | Decription                                                                        |
+  |--------------|------------|-----------------------------------------------------------------------------------|
+  | `order_id`   | `integer`  | Required, ID of the order returned by "sell" or "buy" request                     |
+  | `quantity`   | `integer`  | Required, quantity, in contracts ($10 per contract for futures, ฿1 — for options) |
+  | `price`      | `float`    | Required, USD for futures, BTC for options                                        |
+  | `post_only`  | `boolean`  | Optional, if true then the order will be POST ONLY                                |
+  | `adv`        | `string`   | Optional, can be "implv", "usd", or absent (advanced order type)                  |
+
+`cancel(order_id)` - [Doc](https://www.deribit.com/docs/api/#cancel), private
+
+  Cancell own order by id.
+
+  **Parameters**
+
+  | Name         | Type       | Decription                                                                        |
+  |--------------|------------|-----------------------------------------------------------------------------------|
+  | `order_id`    | `integer`  | Required, ID of the order returned by "sell" or "buy" request
+
+* `getopenorders(instrument)` - [Doc](https://www.deribit.com/docs/api/#getopenorders), private
+
+  Retrieve open orders.
+
+  **Parameters**
+
+  | Name         | Type       | Description                                                           |
+  |--------------|------------|-----------------------------------------------------------------------|
+  | `instrument` | `string`   | Optional, instrument name, use if want orders for specific instrument |
+
+* `positions()` - [Doc](https://www.deribit.com/docs/api/#positions), private
+
+  Retreive positions.
+
+* `orderhistory(count)` - [Doc](https://www.deribit.com/docs/api/#orderhistory), private
+
+  Get history.
+
+  **Parameters**
+
+  | Name       | Type       | Description                                                |
+  |------------|------------|------------------------------------------------------------|
+  | `count`    | `integer`  | Optional, number of requested records                      |
+
+* `tradehistory(count: count, instrument: instrument, start_trade_id: start_trade_id)` - [Doc](https://www.deribit.com/docs/api/#tradehistory), private
+
+  Get private trade history of the account. (Authorization is required). The result is ordered by trade identifiers (trade id-s).
+
+  **Parameters**
+
+  | Name             | Type       | Description                                                                                        |
+  |------------------|------------|----------------------------------------------------------------------------------------------------|
+  | `count`          | `integer`  | Optional, number of results to fetch. Default: 20                                                  |
+  | `instrument`     | `string`   | Optional, name of instrument, also aliases “all”, “futures”, “options” are allowed. Default: "all" |
+  | `start_trade_id` | `integer`  | Optional, number of requested records                                                              |
+
+
+## Websocket API
+
+```
+require 'deribit'
+
+ws = Deribit::WS.new("KEY", "SECRET")
+
+ws.account
+
+#subscribe
+ws.subscribe(['BTC-30NOV18-6500-P'], events: [:order_book])
+```
+
+### Handler
+
+Create inheritance class for handling WS notifications
+
+```
+class MyHandler < Deribit::WS::Handler
+  #event handler
+  def order_book_event(json)
+    #you actions here
+
+    #json example for order_book_event
+    #{"state"=>"open", "settlementPrice"=>0.2105, "instrument"=>"BTC-30NOV18-6500-P", "bids"=>[{"quantity"=>10.0, "amount"=>10.0, "price"=>0.2785, "cm"=>10.0, "cm_amount"=>10.0}, {"quantity"=>1.0, "amount"=>1.0, "price"=>0.05, "cm"=>11.0, "cm_amount"=>11.0}], "asks"=>[{"quantity"=>9.0, "amount"=>9.0, "price"=>0.2935, "cm"=>9.0, "cm_amount"=>9.0}], "tstamp"=>1542650516519, "last"=>0.285, "low"=>0.285, "high"=>0.285, "mark"=>0.286, "uPx"=>5060.54, "uIx"=>"index_price", "iR"=>0, "markIv"=>106.0, "askIv"=>110.45, "bidIv"=>0.0, "delta"=>-0.90264, "gamma"=>0.00019, "vega"=>1.48288, "theta"=>-7.42706}
+  end
+
+  #action handler
+  def getinstruments(json)
+    #you actions here
+  end
+end
+```
+
+Available events you can check in the guide https://deribit.com/main#/pages/docs/api WebSockets API section.
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sunchess/deribit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Deribit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/deribit/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deribit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deribit.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deribit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "deribit"
+  spec.version       = Deribit::VERSION
+  spec.authors       = ["Alexander Dmitriev", "Ivan Tumanov"]
+  spec.email         = ["alexanderdmv@gmail.com"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{Deribit.com v1 API ruby adapter}
+  spec.description   = %q{This gem allows you to use deribit.com exchange}
+  spec.homepage      = "https://github.com/vizakenjack/deribit-ruby"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'websocket-client-simple', '~> 0.3.0'
+end