deribit-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: edee765ee69839379018b56f056e9070afe09f03
-  data.tar.gz: 7398d5ce16099b24fa6433e3456820bc3d34ad48
+SHA256:
+  metadata.gz: 05d5477493865ee6cbb3377f3e3b00b7cf46b4e6b68d521e55330e391a3aa5cd
+  data.tar.gz: bbd48b6395cca467b1f5cb86ab3d7aeea3d888d69a8bddbd98178cbf841af849
 SHA512:
-  metadata.gz: 59e6f1288d0627595fe134b08d6fb8c30ebfe7d768763115d5bde0b3a2a30937a16c29af94f797d516016603f301d623195721c890fcd51e3c92e044189d2438
-  data.tar.gz: a18b33c6b3b17db73fd96c7df5a01b6b74f14c595f4d450d81a3e822cd312742b3c8db8a9863b3a1e8ab9002839fafd414e64cbddf92eebd4073940dffbf7d9c
+  metadata.gz: b0af359c229cc8e7651fe2cbf2c0609ffefce77d09bca0a750cb884d33fb2d17b2de56fd19c1aa7414375ca99149ac581b016c7893732afaaaf86c248398aff6
+  data.tar.gz: 876927c4c4acc286246a5315b66efa642053a925777953fce590ffc6af2627ba0a38ff95e7e49508517646512d8437fde4e3e8b9a15e7891892d23eaec950e51

data/CHANGELOG.md

@@ -5,6 +5,12 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.3] - 2019-03-06
+### Added
+- private HTTP API endpoints
+### Fixed
+- ENV vars loading in bin/console
+
 ## [0.0.2] - 2019-02-27
 ### Added
 - HTTP public endpoints

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deribit-api (0.0.2)
+    deribit-api (0.0.3)
       faraday
       faraday_middleware
       hashie
@@ -9,27 +9,62 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    bump (0.7.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bump (0.8.0)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
     coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     docile (1.3.1)
+    dotenv (2.7.1)
+    equalizer (0.0.11)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
     hashie (3.6.0)
-    json (2.1.0)
+    ice_nine (0.11.2)
+    json (2.2.0)
+    kwalify (0.7.2)
     method_source (0.9.2)
     minitest (5.11.3)
     multipart-post (2.0.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    reek (5.3.1)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    yard (0.9.18)
 
 PLATFORMS
   ruby
@@ -38,9 +73,12 @@ DEPENDENCIES
   bump
   bundler
   deribit-api!
+  dotenv
   minitest
   pry
+  pry-doc
   rake
+  reek
   simplecov
 
 BUNDLED WITH

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/icostan/deribit-api-ruby.svg?branch=master)](https://travis-ci.org/icostan/deribit-api-ruby)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1e100fc78c8ebaa8b4b5/maintainability)](https://codeclimate.com/github/icostan/deribit-api-ruby/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/1e100fc78c8ebaa8b4b5/test_coverage)](https://codeclimate.com/github/icostan/deribit-api-ruby/test_coverage)
+[![Inline docs](http://inch-ci.org/github/icostan/deribit-api-ruby.svg?branch=master)](http://inch-ci.org/github/icostan/deribit-api-ruby)
 [![Gem Version](https://badge.fury.io/rb/deribit-api.svg)](https://badge.fury.io/rb/deribit-api)
 [![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/deribit-api)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/icostan/deribit-api-ruby/blob/master/LICENSE)
@@ -31,9 +32,12 @@ Or install it yourself as:
 
 ```ruby
 require 'deribit-api'
+```
 
-client = Deribit::Client.new
+Create a simple client to access public APIs
 
+```ruby
+client = Deribit::Client.new
 trades = client.trades 'options', count: 3
 trades.first
   => #<Hashie::Mash amount=3.0 direction="buy" indexPrice=3817.31 instrument="BTC-29MAR19-4500-C" iv=60.33 price=0.016 quantity=3.0 tickDirection=0 timeStamp=1551274556589 tradeId=16055937 tradeSeq=712>
@@ -41,57 +45,87 @@ trades.first.instrument
   => "BTC-29MAR19-4500-C"
 ```
 
-### API Endpoints
-
-#### Instruments
+Pass key and secret to access private APIs
 
 ```ruby
-instruments = client.instruments
-puts instruments.first
+client = Deribit::Client.new key: 'KEY', secret: 'SECRET'
+account = client.account
+ => #<Hashie::Mash PNL=0.0 SRPL=0.0 SUPL=0.0 availableFunds=9.99995789 balance=9.99995789 currency="BTC" deltaTotal=0.0 depositAddress="2N6SU5Yjn7AfYcT89QyeeHvHyZoqTt2GLyi" equity=9.999957896 futuresPNL=0.0 futuresSRPL=0.0 futuresSUPL=0.0 initialMargin=0.0 maintenanceMargin=0.0 marginBalance=9.99995789 optionsD=0.0 optionsG=0.0 optionsPNL=0.0 optionsSRPL=0.0 optionsSUPL=0.0 optionsTh=0.0 optionsV=0.0 sessionFunding=0.0>
+account.equity
+  => 9.999957896
 ```
 
-#### Currencies
+### Examples
+
+Fetch all tradable instruments:
 
 ```ruby
-currencies = client.currencies
-puts currencies.first
+instruments = client.instruments
+puts instruments.first
 ```
 
-#### Orderbook
+Orderbook for BTCUSD perpetual instrument:
 
 ```ruby
 orderbook = client.orderbook 'BTC-PERPETUAL', depth: 3
-puts orderbook.bids.first
+puts orderbook.asks.first
 ```
 
-#### Trades
+ Place a BTCUSD limit buy order 100 contracts @ 2500:
 
 ```ruby
-trades = client.trades 'options', count: 3
-puts trades.first
+response = client.buy 'BTC-PERPETUAL', 100, price: 2500
+puts response.order.state
 ```
 
-#### Summary
-
+Get last 10 option trades:
 
 ```ruby
-summaries = client.summary :futures
-puts summaries.first
+trades = client.trades 'options', count: 10
+puts trades.first
 ```
 
-#### Announcements
+Options trading summary:
 
 ```ruby
-announcements = client.announcements
-puts announcements.first
+summaries = client.summary :options
+puts summaries.first
 ```
 
-#### Settlements
-
-```ruby
-settlements = client.settlements
-puts settlements.first
-```
+## API Endpoints
+
+All endpoints marked with [X] are fully implemented and ready to use, see the features table below:
+
+API endpoints | Private? | HTTP API | Websocket API | FIX API
+---| :---: | :---: | :---: |
+Time || [X] ||
+Test || [X] ||
+Ping || [X] ||
+Instruments || [X] ||
+Currencies || [X] ||
+Index || [X] ||
+Orderbook || [X] ||
+Trades || [X] ||
+Summary || [X] ||
+Announcements || [X] ||
+Settlements || [X] ||
+Account | YES | [X] ||
+Buy | YES | [X] ||
+Sell | YES | [X] ||
+Edit | YES | [X] ||
+Cancel | YES | [X] ||
+Cancel all | YES | [X] ||
+Orders | YES | [X] ||
+Positions | YES | [X] ||
+Orders history | YES | [X] ||
+Order | YES | [X] ||
+Trades history | YES | [X] ||
+New announcements | YES | [X] ||
+Cancel on disconnect | YES | [X] ||
+Get email lang | YES | [X] ||
+Set email lang | YES | [X] ||
+Set announcements read | YES | [X] ||
+Settlements history | YES | [X] ||
 
 ## Development
 

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'bump/tasks'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'

data/TODOs.org

@@ -3,7 +3,12 @@
    CLOSED: [2019-01-04 Fri] SCHEDULED: <2019-01-04 Fri>
 ** DONE public HTTP API
    CLOSED: [2019-02-27 Wed] SCHEDULED: <2019-02-27 Wed>
-** TODO private HTTP API
+** DONE private HTTP API
+   CLOSED: [2019-03-05 Tue] SCHEDULED: <2019-03-04 Mon>
 ** FIX API
 ** DONE use minitest
    CLOSED: [2019-02-26 Tue] SCHEDULED: <2019-02-26 Tue>
+** extract RPC client
+** Websocket API
+** response middleware
+** check key/secret present for private endpoints

data/bin/console

@@ -1,7 +1,11 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "deribit"
+require 'dotenv'
+Dotenv.load
+Dotenv.require_keys('API_KEY', 'API_SECRET')
+
+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.
@@ -10,5 +14,5 @@ require "deribit"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/deribit.gemspec

@@ -40,9 +40,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hashie'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'bump'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'reek'
   spec.add_development_dependency 'simplecov'
 end

data/lib/deribit.rb

@@ -4,6 +4,7 @@ require 'hashie'
 
 require 'deribit/version'
 require 'deribit/client'
+require 'deribit/authentication'
 
 # Root module
 module Deribit

data/lib/deribit/authentication.rb

@@ -0,0 +1,43 @@
+require 'base64'
+require 'digest'
+
+module Deribit
+  # Deribit authentication implemented as Faraday middleware
+  # @see https://docs.deribit.com/rpc-authentication.html
+  class Authentication < Faraday::Middleware
+    def initialize(app, key, secret)
+      super(app)
+      @key = key
+      @secret = secret
+    end
+
+    def call(env)
+      return @app.call(env) if @key.nil? || @secret.nil?
+
+      nonce = Time.now.to_i
+      env['request_headers']['X-Deribit-Sig'] = signature env, nonce
+
+      @app.call env
+    end
+
+    def signature(env, nonce)
+      params = {
+        _: nonce,
+        _ackey: @key,
+        _acsec: @secret,
+        _action: env['url'].path
+      }
+      # add POST params
+      params.merge! JSON.parse(env['body']) if env['body']
+
+      signature_string = params.map{ |key, value| "#{key}=#{value}" }.sort.join '&'
+      # add GET query
+      signature_string += "&#{env['url'].query}" if env['url'].query
+
+      signature_digest = Digest::SHA256.digest signature_string
+      signature_hash = Base64.encode64 signature_digest
+
+      "#{@key}.#{nonce}.#{signature_hash.chomp}"
+    end
+  end
+end

data/lib/deribit/client.rb

@@ -7,15 +7,18 @@ module Deribit
     MAINNET_URL = 'https://www.deribit.com'
 
     # Create new instance
+    # @param key [String] Deribit Access Key
+    # @param secret [String] Deribit Secret Key
     # @param testnet [Boolean] set to true for testing
     # @param debug [Boolean] set to true for debug output
     # @return [Deribit::Client] the instance of client
-    def initialize(testnet: false, debug: false)
+    def initialize(key: nil, secret: nil, testnet: false, debug: false)
       url = testnet ? TESTNET_URL : MAINNET_URL
       @connection = Faraday::Connection.new(url: url) do |f|
         f.request :json
         f.response :mashify
         f.response :json
+        f.use Deribit::Authentication, key, secret
         f.response :logger if debug
         f.adapter Faraday.default_adapter
       end
@@ -25,7 +28,7 @@ module Deribit
     # @return [Integer] current time in milliseconds
     # @see https://docs.deribit.com/rpc-endpoints.html#time
     def time
-      execute :time
+      get :time
     end
 
     # Tests the connection to the API server, and returns its version.
@@ -33,14 +36,14 @@ module Deribit
     # @return [Hashie::Mash] test data
     # @see https://docs.deribit.com/rpc-endpoints.html#test
     def test(exception: false)
-      execute :test, params: { exception: exception }, raw_body: true
+      get :test, params: { exception: exception }, raw_body: true
     end
 
     # This API endpoint always responds with "pong".
     # @return [Hashie::Mash] ping
     # @see https://docs.deribit.com/rpc-endpoints.html#ping
     def ping
-      execute :ping
+      get :ping
     end
 
     # Retrieves available trading instruments.
@@ -48,21 +51,21 @@ module Deribit
     # @return [Array] the list of instruments
     # @see https://docs.deribit.com/rpc-endpoints.html#getinstruments
     def instruments(expired: false)
-      execute :getinstruments, params: { expired: expired }
+      get :getinstruments, params: { expired: expired }
     end
 
     # Retrieves all cryptocurrencies supported by the API.
     # @return [Array] the list of cryptocurrencies
     # @see https://docs.deribit.com/rpc-endpoints.html#getcurrencies
     def currencies
-      execute :getcurrencies
+      get :getcurrencies
     end
 
     # Retrieves the current index price for the BTC-USD instruments.
     # @return [Hashie::Mash] index price for BTC-USD instrument
     # @see https://docs.deribit.com/rpc-endpoints.html#index
     def index
-      execute :index
+      get :index
     end
 
     # Retrieves the order book, along with other market values for a given instrument.
@@ -73,26 +76,27 @@ module Deribit
     def orderbook(instrument, depth: 10)
       raise ArgumentError, 'instrument param is required' unless instrument
 
-      execute :getorderbook, params: { instrument: instrument, depth: depth }
+      get :getorderbook, params: { instrument: instrument, depth: depth }
     end
 
     # Retrieve the latest trades that have occurred for a specific instrument.
     # @param instrument [String] Either the name of the instrument, or "all" for all active instruments, "futures" for all active futures, or "options" for all active options.
-    # @param filters [Hash] the filters
-    # @option filters [Integer] :count (10) The number of trades returned (clamped to max 1000)
-    # @option filters [Integer] :startId The ID of the first trade to be returned
-    # @option filters [Integer] :endId The ID of the last trade to be returned
-    # @option filters [Integer] :startSeq The trade sequence of the first trade to be returned
-    # @option filters [Integer] :endSeq The trade sequence of the last trade to be returned
-    # @option filters [Integer] :startTimestamp The timestamp (in ms) of the first trade to be returned
-    # @option filters [Integer] :endTimestamp The timestamp (in ms) of the last trade to be returned
-    # @option filters [Boolean] :includeOld (false) to get archived trades for expired instruments when true (added from performance considerations)
+    # @!macro deribit.filters
+    #   @param filters [Hash] extra filters to apply
+    #   @option filters [Integer] :count (10) The number of trades returned (clamped to max 1000)
+    #   @option filters [Integer] :startId The ID of the first trade to be returned
+    #   @option filters [Integer] :endId The ID of the last trade to be returned
+    #   @option filters [Integer] :startSeq The trade sequence of the first trade to be returned
+    #   @option filters [Integer] :endSeq The trade sequence of the last trade to be returned
+    #   @option filters [Integer] :startTimestamp The timestamp (in ms) of the first trade to be returned
+    #   @option filters [Integer] :endTimestamp The timestamp (in ms) of the last trade to be returned
+    #   @option filters [Boolean] :includeOld (false) to get archived trades for expired instruments when true (added from performance considerations)
     # @return [Array] the list of trades
     # @see https://docs.deribit.com/rpc-endpoints.html#getlasttrades
-    def trades(instrument, filters = {})
+    def trades(instrument = :all, filters = {})
       raise ArgumentError, 'instrument param is required' unless instrument
 
-      execute :getlasttrades, params: filters.merge(instrument: instrument)
+      get :getlasttrades, params: filters.merge(instrument: instrument)
     end
 
     # Retrieves the summary information such as open interest, 24h volume, etc. for a specific instrument.
@@ -102,21 +106,21 @@ module Deribit
     def summary(instrument)
       raise ArgumentError, 'instrument argument is required' unless instrument
 
-      execute :getsummary, params: { instrument: instrument }
+      get :getsummary, params: { instrument: instrument }
     end
 
     # Retrieves aggregated 24h trade volumes for different instrument types.
     # @return [Hashie::Mash] the statistics
     # @see https://docs.deribit.com/rpc-endpoints.html#stats
     def stats
-      execute :stats
+      get :stats
     end
 
     # Retrieves announcements from last 30 days.
     # @return [Array] the list of announcements
     # @see https://docs.deribit.com/rpc-endpoints.html#getannouncements
     def announcements
-      execute :getannouncements
+      get :getannouncements
     end
 
     # Retrieves settlement, delivery and bankruptcy events that have occurred.
@@ -129,19 +133,189 @@ module Deribit
     # @return [Hashie::Hash] the settlements
     # @see https://docs.deribit.com/rpc-endpoints.html#getlastsettlements
     def settlements(filters = {})
-      execute :getlastsettlements, params: filters
+      get :getlastsettlements, params: filters
+    end
+
+    # Retrieves user account summary.
+    # @param ext [Boolean] Requests additional fields
+    # @return [Hashie::Mash] the account details
+    # @see https://docs.deribit.com/rpc-endpoints.html#account
+    def account(ext: false)
+      get :account, auth: true
+    end
+
+    # Places a buy order for an instrument.
+    # @param instrument [String] Name of the instrument to buy
+    # @param quantity [Integer] The number of contracts to buy
+    # @!macro deribit.options
+    #   @param options [Hash] more options for the order
+    #   @option options [String] :type (limit) The order type, possible types: "limit", "stop_limit", "market", "stop_market"
+    #   @option options [Float] :price The order price (Only valid for limit and stop_limit orders)
+    #   @option options [String] :label user defined label for the order (maximum 32 characters)
+    #   @option options [String] :time_in_force (good_til_cancelled) Specifies how long the order remains in effect, possible values "good_til_cancelled", "fill_or_kill", "immediate_or_cancel"
+    #   @option options [Integer] :max_show Maximum quantity within an order to be shown to other customers, 0 for invisible order.
+    #   @option options [String] :post_only (true)  If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid.
+    #   @option options [Float] :stopPx Stop price required for stop limit orders (Only valid for stop orders)
+    #   @option options [String] :execInst (index_price) Defines trigger type, required for "stop_limit" order type, possible values "index_price", "mark_price" (Only valid for stop orders)
+    #   @option options [String] :adv Advanced option order type, can be "implv", "usd". (Only valid for options)
+    # @return [Hashie::Mash] the details of new order
+    # @see https://docs.deribit.com/rpc-endpoints.html#buy
+    def buy(instrument, quantity, options = {})
+      post :buy, instrument: instrument, quantity: quantity, price: options[:price]
+    end
+
+    # Places a sell order for an instrument.
+    # @param instrument [String] Name of the instrument to sell
+    # @param quantity [Integer] The number of contracts to sell
+    # @!macro deribit.options
+    # @return [Hashie::Mash] the details of new order
+    # @see https://docs.deribit.com/rpc-endpoints.html#sell
+    def sell(instrument, quantity, options = {})
+      post :sell, options.merge(instrument: instrument, quantity: quantity)
+    end
+
+    # Changes price and/or quantity of the own order.
+    # @param order_id [String] ID of the order to edit
+    # @param quantity [Integer] The new order quantity
+    # @param price [Float] The new order price
+    # @param options [Hash] extra options
+    # @option options [Boolean] :post_only If true, the edited order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the bid (for buy orders) or just above the ask (for sell orders).
+    # @option options [String] :adv The new advanced order type (only valid for option orders)
+    # @option options [Float] :stopPx The new stop price (only valid for stop limit orders)
+    # @return [Hashie::Mash] the edited order
+    # @see https://docs.deribit.com/rpc-endpoints.html#edit
+    def edit(order_id, quantity, price, options = {})
+      post :edit, options.merge(orderId: order_id, quantity: quantity, price: price)
+    end
+
+    # Cancels an order, specified by order id.
+    # @param order_id [String] The order id of the order to be cancelled
+    # @return [Hashie::Mash] details of the cancelled order
+    # @see https://docs.deribit.com/rpc-endpoints.html#cancel
+    def cancel(order_id)
+      post :cancel, orderId: order_id
+    end
+
+    # Cancels all orders, optionally filtered by instrument or instrument type.
+    # @param type [all futures options] Which type of orders to cancel. Valid values are "all", "futures", "options"
+    # @param options [Hash] extra options
+    # @option options [String] :instrument The name of the instrument for which to cancel all orders
+    # @see https://docs.deribit.com/rpc-endpoints.html#cancelall
+    def cancelall(type = :all, options = {})
+      post :cancelall, options.merge(type: type)
+    end
+
+    # Retrieves open orders.
+    # @param options [Hash]
+    # @option options [String] :instrument Instrument to return open orders for
+    # @option options [string] ;orderId order ID
+    # @option options [String] :type Order types to return. Valid values include "limit", "stop_limit", "any"
+    # @return [Array] the list of open orders
+    # @see https://docs.deribit.com/rpc-endpoints.html#getopenorders
+    def orders(options = {})
+      get :getopenorders, auth: true, params: options
+    end
+
+    # Retrieves current positions.
+    # @return [Array] the list of positions
+    # @see https://docs.deribit.com/rpc-endpoints.html#positions
+    def positions
+      get :positions, auth: true
+    end
+
+    # Retrieves history of orders that have been partially or fully filled.
+    # @param options [Hash]
+    # @option options [String] :instrument Instrument to return open orders for
+    # @option options [String] :count The number of items to be returned.
+    # @option options [string] :offset The offset for pagination
+    # @return [Array] the list of history orders
+    # @see https://docs.deribit.com/rpc-endpoints.html#orderhistory
+    def orders_history(options = {})
+      get :orderhistory, auth: true, params: options
+    end
+
+    # Retrieve order details state by order id.
+    # @param order_id [String] the ID of the order to be retrieved
+    # @return [Array] the details of the order
+    # @see https://docs.deribit.com/rpc-endpoints.html#orderstate
+    def order(order_id)
+      get :orderstate, auth: true, params: { orderId: order_id }
+    end
+
+    # Retrieve the trade history of the account
+    # @param instrument [String] Either the name of the instrument, or "all" for instruments, "futures" for all futures, or "options" for all options.
+    # @!macro deribit.filters
+    # @return [Array] the list of trades
+    # @see https://docs.deribit.com/rpc-endpoints.html?q=#tradehistory
+    def trades_history(instrument = :all, filters = {})
+      get :tradehistory, auth: true, params: filters.merge(instrument: instrument)
+    end
+
+    # Retrieves announcements that have not been marked read by the current user.
+    # @return [Array] the list of new announcements
+    def new_announcements
+      get :newannouncements, auth: true
+    end
+
+    # Enables or disables "COD" (cancel on disconnect) for the current connection.
+    # @param state [String] Whether COD is to be enabled for this connection. "enabled" or "disabled"
+    def cancelondisconnect(state)
+      get :cancelondisconnect, auth: true, params: { state: state }
+    end
+
+    # Retrieves the language to be used for emails.
+    # @return [String] the language name (e.g. "en", "ko", "zh")
+    def getemaillang
+      get :getemaillang, auth: true
+    end
+
+    # Changes the language to be used for emails.
+    # @param lang [String] the abbreviated language name. Valid values include "en", "ko", "zh"
+    def setemaillang(lang)
+      post :setemaillang, lang: lang
+    end
+
+    # Marks an announcement as read, so it will not be shown in newannouncements
+    # @param announcement_id [String]  the ID of the announcement
+    # @return [String] ok
+    def setannouncementasread(announcement_id)
+      post :setannouncementasread, announcementid: announcement_id
+    end
+
+    # Retrieves settlement, delivery and bankruptcy events that have affected your account.
+    # @param filters [Hash] the filters
+    # @option filters [String] :instrument The instrument name, or "all" to retrieve settlements for all instruments
+    # @option filters [Integer] :count (10) The number of entries to be returned. This is clamped to max 1000
+    # @option filters [String] :type The type of settlements to return. Possible values "settlement", "delivery", "bankruptcy"
+    # @option filters [Integer] :startTstamp The latest timestamp to return result for
+    # @option filters [String] :continuation Continuation token for pagination. Each response contains a token to be used for continuation
+    # @return [Hashie::Hash] the settlements
+    # @see https://docs.deribit.com/rpc-endpoints.html#settlementhistory
+    def settlements_history(filters = {})
+      get :settlementhistory, auth: true, params: filters
     end
 
     private
 
-    def execute(action, params: {}, raw_body: false)
-      path = "/api/v1/public/#{action}"
-      response = @connection.get path, params
+    def get(action, params: {}, raw_body: false, auth: false)
+      response = @connection.get path(action, auth), params
+      # TODO: move to middleware
       raise response.message unless response.success?
       raise response.body.message unless response.body.success
-
       body = response.body
       raw_body ? body : body.result
     end
+
+    def post(action, params)
+      response = @connection.post path(action, true), params
+      raise response.message unless response.success?
+      raise response.body.message unless response.body.success
+      response.body.result
+    end
+
+    def path(action, auth = false)
+      access = auth ? 'private' : 'public'
+      "/api/v1/#{access}/#{action}"
+    end
   end
 end

data/lib/deribit/version.rb

@@ -1,3 +1,3 @@
 module Deribit
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deribit-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Iulian Costan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +201,7 @@ files:
 - deribit.gemspec
 - lib/deribit-api.rb
 - lib/deribit.rb
+- lib/deribit/authentication.rb
 - lib/deribit/client.rb
 - lib/deribit/version.rb
 homepage: https://github.com/icostan/deribit-api-ruby
@@ -184,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby library for Deribit API