bitmex-api 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448191dd7c9613d1201fd02d19c14e089e4c58a4b8f0976043d6940b958fdd49
-  data.tar.gz: 5dbaa19973f3ecf4265124adb2e19f2df3e446c826241916bbbc7d971ab1bbcb
+  metadata.gz: b65d3eb22f3a7755e996177401b795eaae4bea1694e4d0de371caa88e828c1c6
+  data.tar.gz: b725cd715818f4679b84e455d323024328b8424d4762b6a9bd1d1941c69ee61e
 SHA512:
-  metadata.gz: 7226c9c0656f4e13af581708a4493ad89a4f5d272a9f8de290cdb35423b7847d3af506cd2a51f4b02428bcb0bdfb39ce69782e5f9a5fc90cd7fc1c57d151e602
-  data.tar.gz: 940894dc0f2af98dc25dbf8a893fddbc14877519e449e11a141a69355833d395206397651ae301b05ff078f10b2f6e2ded2c10be87b3c52f0c5bf7568b90ebc4
+  metadata.gz: efec1809ffe7a59ed89f5039e8198658288543781c8b7f9ad5e4562040b7fd18c1271a5c030d08a75e4976e861b52530444bbce8780cc89c82eef718e39fa94d
+  data.tar.gz: 18ce484b82e20f10fa234f90662a9114c0e0014a84a9e56abda54754aae11ce419db3cef350f8693ceb7e5f2b99e01d523c185a6f1a665cacb4ebbfe9c299b75

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.7.1

data/.travis.yml

@@ -3,14 +3,14 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.3
+  - 2.6.3
 
 env:
   global:
     - CC_TEST_REPORTER_ID=62a2cea238cf89f14f968d9a91fe41af7a11f414f6cc9194df7abc7887e61f6e
 
 before_install:
-  - gem install bundler -v 1.17.1
+  - gem install bundler
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
 

data/CHANGELOG.md

@@ -5,6 +5,42 @@
 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.1.6] - 2020-06-10
+### Added
+- lcov formatter for simplecov
+### Changed
+- update all gems
+- update Ruby to 2.7.1
+### Fixed
+- brittle tests
+
+## [0.1.5] - 2019-12-17
+### Changed
+- update gems
+### Fixed
+- outdated specs
+- typos in README
+
+## [0.1.4] - 2019-09-12
+### Fixed
+- hash filters in user#executions
+- outdated specs
+### Changed
+- update all gems
+
+## [0.1.3] - 2019-07-03
+### Changed
+- update Ruby to 2.6.3
+- update all gems
+### Fixed
+- query params for filtering in GET requests
+
+## [0.1.2] - 2019-04-17
+### Changed
+- update gems
+### Fixed
+- price for limit order spec
+
 ## [0.1.1] - 2019-03-06
 ### Added
 - functional state transfer from one websocket block to the next

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bitmex-api (0.1.1)
+    bitmex-api (0.1.6)
       eventmachine
       faye-websocket
       hashie
@@ -11,97 +11,79 @@ GEM
   remote: https://rubygems.org/
   specs:
     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)
+    bump (0.9.0)
+    coderay (1.1.3)
     diff-lcs (1.3)
-    docile (1.3.1)
-    dotenv (2.7.1)
-    equalizer (0.0.11)
+    docile (1.3.2)
+    dotenv (2.7.5)
     eventmachine (1.2.7)
-    faye-websocket (0.10.7)
+    faye-websocket (0.10.9)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
-    hashie (3.6.0)
-    httparty (0.16.4)
+    hashie (4.1.0)
+    httparty (0.18.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    ice_nine (0.11.2)
-    jaro_winkler (1.5.2)
-    json (2.2.0)
     kwalify (0.7.2)
-    method_source (0.9.2)
-    mime-types (3.2.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2020.0512)
     multi_xml (0.6.0)
-    parallel (1.14.0)
-    parser (2.6.0.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-doc (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-doc (1.1.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)
+    rake (13.0.1)
+    reek (6.0.1)
       kwalify (~> 0.7.0)
-      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
       psych (~> 3.1.0)
       rainbow (>= 2.0, < 4.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)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.65.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      psych (>= 3.1.0)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    unicode-display_width (1.4.1)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
-    websocket-driver (0.7.0)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    simplecov-lcov (0.8.0)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
-    yard (0.9.18)
+    websocket-extensions (0.1.5)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
@@ -118,6 +100,7 @@ DEPENDENCIES
   rspec
   rubocop
   simplecov
+  simplecov-lcov
 
 BUNDLED WITH
-   1.17.1
+   2.1.4

data/README.md

@@ -43,7 +43,7 @@ client = Bitmex::Client.new api_key: 'KEY', api_secret: 'SECRET'
 
 #### REST API
 
-Get last 10 messages in English channel:
+Get last 10 messages from English channel:
 
 ```ruby
 messages = client.chat.messages channelID: 1, count: 10, reverse: true
@@ -86,7 +86,7 @@ All Websocket API blocks yield a pseudo-object `Bitmex::Mash`.
 
 #### Whales watching
 
-Filtering traders bigger than 10 XBT {file:bin/whales-watching.rb}
+Filtering trades bigger than 10 XBT {file:bin/whales-watching.rb}
 
 ```ruby
 client = Bitmex::Client.new

data/TODOs.org

@@ -1,4 +1,16 @@
-* Tasks                                                              :BITMEX:
+* [[elisp:(org-projectile-open-project%20"bitmex-api-ruby")][bitmex-api-ruby]] [17/18]
+  :PROPERTIES:
+  :CATEGORY: bitmex
+  :END:
+** TODO bitmex-api-ruby maintenance
+   SCHEDULED: <2020-12-09 Wed +6m>
+   :PROPERTIES:
+   :LAST_REPEAT: [2020-06-10 Wed 08:12]
+   :END:
+   - State "DONE"       from "TODO"       [2020-06-10 Wed 08:12]
+   - State "DONE"       from "TODO"       [2019-12-17 Tue 10:53]
+   - State "DONE"       from "TODO"       [2019-09-12 Thu 18:25]
+   - State "DONE"       from "TODO"       [2019-07-03 Wed 18:52]
 ** DONE initial gem release
    SCHEDULED: <2019-01-03 Thu> CLOSED: <2019-01-03 Thu>
 ** DONE websocket API
@@ -7,8 +19,6 @@
    CLOSED: [2019-01-16 Wed] SCHEDULED: <2019-01-15 Tue> DEADLINE: <2019-01-16 Wed>
 ** DONE auth for private subscription topics
    CLOSED: [2019-02-01 Fri] SCHEDULED: <2019-02-01 Fri>
-** move from rspec to minitest
-** configure autorun
 ** hearbeat, ping/pong
 ** DONE implement user actions get/put/post
    CLOSED: [2019-01-22 Tue] SCHEDULED: <2019-01-17 Thu>
@@ -19,7 +29,13 @@
 ** DONE orderbook, order resource
    CLOSED: [2019-01-29 Tue] SCHEDULED: <2019-01-29 Tue>
 ** refactoring: use class methods when working with multiple entities
-** bug: {"error":{"message":"Signature not valid.","name":"HTTPError"}} in user#executions
+** DONE bug: {"error":{"message":"Signature not valid.","name":"HTTPError"}} in user#executions
+   CLOSED: [2019-09-12 Thu 18:24]
+** DONE bug: handle query in websocket and skip in POST/PUT/DELETE operations
+   CLOSED: [2019-07-03 Wed 18:06]
+   :LOGBOOK:
+   CLOCK: [2019-07-03 Wed 17:55]--[2019-07-03 Wed 18:06] =>  0:11
+   :END:
 ** DONE liquidation, leaderboard, insurance, instrument, funding, execution, chat, announcement
    CLOSED: [2019-01-30 Wed] SCHEDULED: <2019-01-30 Wed>
 ** DONE refactoring: extract websocket common logic

data/bitmex.gemspec

@@ -49,4 +49,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-lcov'
 end

data/lib/bitmex.rb

@@ -28,22 +28,26 @@ module Bitmex
   TESTNET_HOST = 'testnet.bitmex.com'.freeze
   MAINNET_HOST = 'www.bitmex.com'.freeze
 
-  def self.signature(api_secret, verb, path, expires, params)
-    params = '' if params.nil?
-    params = params.to_s unless params.is_a? String
+  def self.signature(api_secret, verb, path, expires, body, query)
+    body = '' if body.nil?
+    body = body.to_s unless body.is_a? String
 
-    data = verb + path + expires.to_s + params
+    if query != nil && query.is_a?(Hash) && !query.empty?
+      path += "?#{URI.encode_www_form(query)}"
+    end
+
+    data = verb + path + expires.to_s + body
     OpenSSL::HMAC.hexdigest 'SHA256', api_secret, data
   end
 
-  def self.headers(api_key, api_secret, verb, path, body)
+  def self.headers(api_key, api_secret, verb, path, body, query)
     return {} unless api_key || api_secret
 
     expires = Time.now.utc.to_i + 60
     {
       'api-expires' => expires.to_s,
       'api-key' => api_key,
-      'api-signature' => Bitmex.signature(api_secret, verb, path, expires, body)
+      'api-signature' => Bitmex.signature(api_secret, verb, path, expires, body, query)
     }
   end
 end

data/lib/bitmex/rest.rb

@@ -29,7 +29,7 @@ module Bitmex
 
       options = {}
       options[:query] = params unless params.empty?
-      options[:headers] = rest_headers 'GET', path, '' if auth
+      options[:headers] = rest_headers 'GET', path, '', params if auth
 
       response = self.class.get "#{domain_url}#{path}", options
       block_given? ? yield(response) : response_handler(response)
@@ -40,7 +40,7 @@ module Bitmex
 
       options = {}
       options[:body] = body
-      options[:headers] = rest_headers 'PUT', path, body, json: json if auth
+      options[:headers] = rest_headers 'PUT', path, body, nil, json: json if auth
 
       response = self.class.put "#{domain_url}#{path}", options
       block_given? ? yield(response) : response_handler(response)
@@ -51,7 +51,7 @@ module Bitmex
 
       options = {}
       options[:body] = body
-      options[:headers] = rest_headers 'POST', path, body, json: json if auth
+      options[:headers] = rest_headers 'POST', path, body, nil, json: json if auth
 
       response = self.class.post "#{domain_url}#{path}", options
       block_given? ? yield(response) : response_handler(response)
@@ -62,7 +62,7 @@ module Bitmex
 
       options = {}
       options[:body] = body
-      options[:headers] = rest_headers 'DELETE', path, body, json: json if auth
+      options[:headers] = rest_headers 'DELETE', path, body, nil, json: json if auth
 
       response = self.class.delete "#{domain_url}#{path}", options
       block_given? ? yield(response) : response_handler(response)
@@ -72,8 +72,8 @@ module Bitmex
       "/api/v1/#{resource}/#{action}"
     end
 
-    def rest_headers(verb, path, body, json: true)
-      headers = headers verb, path, body
+    def rest_headers(verb, path, body, query, json: true)
+      headers = headers verb, path, body, query
       if json
         headers['Content-Type'] = 'application/json'
       else
@@ -82,8 +82,8 @@ module Bitmex
       headers
     end
 
-    def headers(verb, path, body)
-      Bitmex.headers api_key, api_secret, verb, path, body
+    def headers(verb, path, body, query)
+      Bitmex.headers api_key, api_secret, verb, path, body, query
     end
 
     def response_handler(response)

data/lib/bitmex/user.rb

@@ -154,7 +154,11 @@ module Bitmex
       # TODO: find a better way to handle multiple parameters, dig into HTTParty
       path += '?' if params.size.positive?
       params.each do |key, value|
-        path += "#{key}=#{value}&"
+        if value.is_a? Hash
+          path += "#{key}=#{URI.escape(value.to_json)}&"
+        else
+          path += "#{key}=#{value}&"
+        end
       end
       path
     end

data/lib/bitmex/version.rb

@@ -1,3 +1,3 @@
 module Bitmex
-  VERSION = '0.1.1'
+  VERSION = '0.1.6'
 end

data/lib/bitmex/websocket.rb

@@ -97,7 +97,7 @@ module Bitmex
     end
 
     def headers
-      Bitmex.headers api_key, api_secret, 'GET', '/realtime', ''
+      Bitmex.headers api_key, api_secret, 'GET', '/realtime', '', ''
     end
 
     # def authenticate

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitmex-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Iulian Costan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  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'
 description: Fully-featured, idiomatic Ruby library for BitMEX API
 email:
 - iulian.costan@gmail.com
@@ -255,7 +269,7 @@ metadata:
   homepage_uri: https://github.com/icostan/bitmex-api-ruby
   source_code_uri: https://github.com/icostan/bitmex-api-ruby.git
   changelog_uri: https://github.com/icostan/bitmex-api-ruby/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,9 +284,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Fully-featured, idiomatic Ruby library for BitMEX API
 test_files: []