deribit-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: bd3cbbddf6116cff3d7c90e9fbd29349a6fa0e0fdb4cef927bf347bb1838b710
-  data.tar.gz: be182b02dc7258aaf6f0ea70a7fa09d3e5f695db1eb311b347a2b9b1dd3a5591
+SHA1:
+  metadata.gz: edee765ee69839379018b56f056e9070afe09f03
+  data.tar.gz: 7398d5ce16099b24fa6433e3456820bc3d34ad48
 SHA512:
-  metadata.gz: 931a7625df5e7837b70f355dc941b24a2596940d37f8ec3fab690d207bb3b25ccf97366428de085e2a726c2f55d94fb0e97a7f4a61005b72effbfaaafd88ae4f
-  data.tar.gz: ab2e646407b282cbf122c04c56a3cd4d4fad6edd560fad4f4bcc865bd07f1c42afc5fbaa703ddebe876d2da5cb9aca1139f68f1b80acbfd3a85760d3e7b8f91d
+  metadata.gz: 59e6f1288d0627595fe134b08d6fb8c30ebfe7d768763115d5bde0b3a2a30937a16c29af94f797d516016603f301d623195721c890fcd51e3c92e044189d2438
+  data.tar.gz: a18b33c6b3b17db73fd96c7df5a01b6b74f14c595f4d450d81a3e822cd312742b3c8db8a9863b3a1e8ab9002839fafd414e64cbddf92eebd4073940dffbf7d9c

data/CHANGELOG.md

@@ -5,6 +5,13 @@
 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.2] - 2019-02-27
+### Added
+- HTTP public endpoints
+### Changed
+- use Minitest instead of RSpec
+- use Faraday instead of HTTParty
+
 ## [0.0.1] - 2019-01-04
 ### Added
 - Initial gem release

data/Gemfile.lock

@@ -1,44 +1,30 @@
 PATH
   remote: .
   specs:
-    deribit-api (0.0.1)
+    deribit-api (0.0.2)
+      faraday
+      faraday_middleware
       hashie
-      httparty
 
 GEM
   remote: https://rubygems.org/
   specs:
     bump (0.7.0)
     coderay (1.1.2)
-    diff-lcs (1.3)
     docile (1.3.1)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
     hashie (3.6.0)
-    httparty (0.16.3)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
     json (2.1.0)
     method_source (0.9.2)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
-    multi_xml (0.6.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     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)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -52,10 +38,10 @@ DEPENDENCIES
   bump
   bundler
   deribit-api!
+  minitest
   pry
   rake
-  rspec
   simplecov
 
 BUNDLED WITH
-   1.17.1
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Iulian Costan
+
+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

@@ -4,6 +4,8 @@
 [![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)
 [![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)
 
 Ruby library for [Deribit API](https://docs.deribit.com)
 
@@ -25,14 +27,70 @@ Or install it yourself as:
 
 ## Usage
 
+### Overview
+
 ```ruby
-require 'deribit'
+require 'deribit-api'
 
 client = Deribit::Client.new
 
-trades = client.getlasttrades
-trades.size
+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>
+trades.first.instrument
+  => "BTC-29MAR19-4500-C"
+```
+
+### API Endpoints
+
+#### Instruments
+
+```ruby
+instruments = client.instruments
+puts instruments.first
+```
+
+#### Currencies
+
+```ruby
+currencies = client.currencies
+puts currencies.first
+```
+
+#### Orderbook
+
+```ruby
+orderbook = client.orderbook 'BTC-PERPETUAL', depth: 3
+puts orderbook.bids.first
+```
+
+#### Trades
+
+```ruby
+trades = client.trades 'options', count: 3
+puts trades.first
+```
+
+#### Summary
+
+
+```ruby
+summaries = client.summary :futures
+puts summaries.first
+```
+
+#### Announcements
+
+```ruby
+announcements = client.announcements
+puts announcements.first
+```
+
+#### Settlements
+
+```ruby
+settlements = client.settlements
+puts settlements.first
 ```
 
 ## Development
@@ -43,7 +101,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/icostan/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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/icostan/deribit-api-ruby. 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
 

data/Rakefile

@@ -1,6 +1,10 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
 
-task :default => :spec
+task default: :test

data/TODOs.org

@@ -0,0 +1,9 @@
+* Tasks                                                             :DERIBIT:
+** DONE Initial deribit gem release
+   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
+** FIX API
+** DONE use minitest
+   CLOSED: [2019-02-26 Tue] SCHEDULED: <2019-02-26 Tue>

data/deribit.gemspec

@@ -35,12 +35,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
   spec.add_dependency 'hashie'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'bump'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'simplecov'

data/lib/deribit-api.rb

@@ -0,0 +1 @@
+require_relative 'deribit'

data/lib/deribit.rb

@@ -1,10 +1,12 @@
-require 'httparty'
+require 'faraday'
+require 'faraday_middleware'
 require 'hashie'
 
 require 'deribit/version'
 require 'deribit/client'
 
+# Root module
 module Deribit
+  # Base error class
   class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/deribit/client.rb

@@ -1,36 +1,147 @@
 module Deribit
+  # @author Iulian Costan
   class Client
-    include HTTParty
-    base_uri 'https://test.deribit.com/api/v1/public'
+    # URL for testnet
+    TESTNET_URL = 'https://test.deribit.com'
+    # URL for mainnet
+    MAINNET_URL = 'https://www.deribit.com'
 
-    def initialize
-      @options = {}
+    # Create new instance
+    # @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)
+      url = testnet ? TESTNET_URL : MAINNET_URL
+      @connection = Faraday::Connection.new(url: url) do |f|
+        f.request :json
+        f.response :mashify
+        f.response :json
+        f.response :logger if debug
+        f.adapter Faraday.default_adapter
+      end
     end
 
-    def getinstruments
-      execute '/getinstruments'
+    # Retrieves the current time (in ms).
+    # @return [Integer] current time in milliseconds
+    # @see https://docs.deribit.com/rpc-endpoints.html#time
+    def time
+      execute :time
     end
 
-    def getlasttrades(type = :all)
-      execute '/getlasttrades', query: { instrument: type }
+    # Tests the connection to the API server, and returns its version.
+    # @param exception [any] Provide this parameter force an error message.
+    # @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
     end
 
-    def getsummary(type = :all)
-      execute '/getsummary', query: { instrument: type }
+    # This API endpoint always responds with "pong".
+    # @return [Hashie::Mash] ping
+    # @see https://docs.deribit.com/rpc-endpoints.html#ping
+    def ping
+      execute :ping
     end
 
+    # Retrieves available trading instruments.
+    # @param expired [Boolean] Set to true to show expired instruments instead of active ones.
+    # @return [Array] the list of instruments
+    # @see https://docs.deribit.com/rpc-endpoints.html#getinstruments
+    def instruments(expired: false)
+      execute :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
+    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
+    end
+
+    # Retrieves the order book, along with other market values for a given instrument.
+    # @param instrument [String] The instrument name for which to retrieve the order book, (see #instruments)  to obtain instrument names.
+    # @param depth [Integer] the depth of the order book
+    # @return [Hashie::Mash] the order book
+    # @see https://docs.deribit.com/rpc-endpoints.html#getorderbook
+    def orderbook(instrument, depth: 10)
+      raise ArgumentError, 'instrument param is required' unless instrument
+
+      execute :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)
+    # @return [Array] the list of trades
+    # @see https://docs.deribit.com/rpc-endpoints.html#getlasttrades
+    def trades(instrument, filters = {})
+      raise ArgumentError, 'instrument param is required' unless instrument
+
+      execute :getlasttrades, params: filters.merge(instrument: instrument)
+    end
+
+    # Retrieves the summary information such as open interest, 24h volume, etc. 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.
+    # @return [Array, Hashie::Hash] the summary as array or hash based on instrument param
+    # @see https://docs.deribit.com/rpc-endpoints.html#getsummary
+    def summary(instrument)
+      raise ArgumentError, 'instrument argument is required' unless instrument
+
+      execute :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'
+      execute :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
+    end
+
+    # Retrieves settlement, delivery and bankruptcy events that have occurred.
+    # @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#getlastsettlements
+    def settlements(filters = {})
+      execute :getlastsettlements, params: filters
     end
 
     private
 
-    def execute(uri, options = {})
-      response = self.class.get uri, options
-      fail response.message unless response.success?
-      fail response.body unless response['success']
+    def execute(action, params: {}, raw_body: false)
+      path = "/api/v1/public/#{action}"
+      response = @connection.get path, params
+      raise response.message unless response.success?
+      raise response.body.message unless response.body.success
 
-      Hashie::Mash.new(response.to_hash).result
+      body = response.body
+      raw_body ? body : body.result
     end
   end
 end

data/lib/deribit/version.rb

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

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: deribit-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Iulian Costan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -130,18 +144,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
+- TODOs.org
 - bin/console
 - bin/setup
 - deribit.gemspec
+- lib/deribit-api.rb
 - lib/deribit.rb
 - lib/deribit/client.rb
 - lib/deribit/version.rb
@@ -168,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby library for Deribit API

data/.rspec

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