ftx_exchange_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 855ee74786a3de1374e5c2bb853f8078d0a8b1bb47d75172086a0f5e70f45f48
-  data.tar.gz: ef9dbf8d6ececa26a46c6c2ccd7bb355a45eeafd24eefb857fb62e5970591f53
+  metadata.gz: 66bd451b62c8206a8910fd8b8a13de11aa21f1d9def06711e271e879dc5d2a9c
+  data.tar.gz: 4c339ee8b7358f2b39a5c2eae3d7dd706680bdf51de35fee4d2712b301517bd0
 SHA512:
-  metadata.gz: 5436d4efcbd409b7c3ba27ed57c527db7b31b7dbf849170000926a5fbd2f0d8a37ef4c5f1dac431ceb2146921fb970b64e4f7ee3f7b71d2ea89572b5cbc2eb99
-  data.tar.gz: 39a5a1002dea3206044e6d70d780dc0cdff9047fe6d3fa94497fdddccd2c59def956ac3f50f88d41a815bc95fd41e60989bb20c74b84139875bd3412a9f98469
+  metadata.gz: ba11caef7c7e5637a55dcede4cb37593efce18e96711e0190e457fe2a7788c8d12a7f4f25db67729d616251b1bb5204f600e4602361bc71a12f4aa85f508a632
+  data.tar.gz: 93961919cb301762ffaa097ecbd6e54cd069623ee0ba5f1583d1a6b04601285f3555d683c868e31883d354fe0f6f916c3c76941f08b356c0b2c7f009b0612676

data/CHANGELOG.md

@@ -1 +1,4 @@
-## Change Log
+## Change Log
+
+### v0.0.1 2021/09/15
+- [#1](https://github.com/khiav223577/ftx_exchange_api/pull/1) Implement markets and orderbook API (@khiav223577)

data/README.md

@@ -1,4 +1,4 @@
-# ftx_exchange_api
+# FtxExchangeApi
 
 [![Gem Version](https://img.shields.io/gem/v/ftx_exchange_api.svg?style=flat)](http://rubygems.org/gems/ftx_exchange_api)
 [![Build Status](https://github.com/khiav223577/ftx_exchange_api/workflows/Ruby/badge.svg)](https://github.com/khiav223577/ftx_exchange_api/actions)
@@ -8,7 +8,6 @@
 
 ## Supports
 - Ruby 2.2 ~ 2.7
-- Rails 3.2, 4.2, 5.0, 5.1, 5.2, 6.0
 
 ## Installation
 
@@ -24,8 +23,89 @@ Or install it yourself as:
 
     $ gem install ftx_exchange_api
 
+## Configuration
+
+### Set timeout time
+
+```rb
+# default config
+FtxExchangeApi.default_config.timeout = 3 # seconds
+
+# custom config
+FtxExchangeApi::PublicApi.new(config: { timeout: 12 })
+FtxExchangeApi::PrivateApi.new(access_key, secret_key, config: { timeout: 12 })
+```
+
+### Logging
+
+```rb
+require 'logger'
+
+# default config
+FtxExchangeApi.default_config.logger = Logger.new(STDOUT) # print log to stdand output
+FtxExchangeApi.default_config.logger = Logger.new('log/api.log')
+
+# custom config
+FtxExchangeApi::PublicApi.new(config: { logger: Logger.new(STDOUT) })
+FtxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: Logger.new(STDOUT) })
+```
+
 ## Usage
 
+### Public Api Examples
+
+```rb
+@api = FtxExchangeApi::PublicApi.new
+```
+
+#### [GET /markets](https://docs.ftx.com/?ruby#get-markets)
+
+> Get markets
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.markets
+```
+</details>
+
+#### [GET /markets/{market_name}](https://docs.ftx.com/?ruby#get-markets)
+
+> Get single market
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.markets(market_name)
+```
+</details>
+
+#### [GET /markets/{market_name}/orderbook?depth={depth}](https://docs.ftx.com/?ruby#get-markets)
+
+> Get orderbook
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.orderbook(market_name)
+
+# provide all possible parameters
+@api.orderbook(market_name, depth: 3)
+```
+</details>
+
+### Private Api Examples
+
+```rb
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+@api = FtxExchangeApi::PrivateApi.new(access_key, secret_key)
+```
 
 ## Development
 

data/lib/ftx_exchange_api/public_api.rb

@@ -21,7 +21,7 @@ module FtxExchangeApi
     protected
 
     def send_request(method, path, query)
-      super(method, path, {}, query)
+      super(method, path, {}, query.reject{|_k, v| v == nil })
     end
   end
 end

data/lib/ftx_exchange_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ftx_exchange_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler