max_exchange_api 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2850870981b0e9f2735fdc35f3e651451f8f9098894bbf5a6143e85e3c66c0b2
-  data.tar.gz: 23d415aae12408c224d3666d95b9b28a24065c92a4bd090ea74bbe20c021510d
+  metadata.gz: 71535a1c969d383e36c7af1860aeab28c78f55fb62d0e2ef4cb05c9fe8d0df27
+  data.tar.gz: c132f2796b57303bfd288a64f0b14cf966d4117568dadb02b606270c316d08c7
 SHA512:
-  metadata.gz: c6be2e2a38315742f6b0cba88399539414e48188b66a71634358eacf312c9fbaf7e35ba65c940defb600a8c998f72a01cb2fa5b8e99d41ffb8cedd8662fc28e7
-  data.tar.gz: 8f2b9a09f71b0f30a3ecc5785851ca6d759751b83ed98d90685f84305b420557f322872bb73b62cd3226a0466e0f81f8386d87d73cbbb027073a6675cd1c923c
+  metadata.gz: f51b1539a5cbc487c325fec8b46e5ef38b6c12f4fd909631769fba2e2d82bdbe8dba39ae0130919ca6951aed220e677ec07f64e5d465907fdb0d4cae7224080d
+  data.tar.gz: 2afa7b1325fe0756f92416b33e762b9fd264abb6ff4615d6495c4e1d92e8c265b92f680ce8ede43c4e408503cacd15f8b0d9adf84ce31799ca2d25a4aa360e1c

data/.rubocop.yml

@@ -243,7 +243,7 @@ Metrics/ModuleLength:
 Metrics/ParameterLists:
   Description: 'Avoid parameter lists longer than three or four parameters.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params'
-  Enabled: true
+  Enabled: false
 
 Metrics/PerceivedComplexity:
   Description: >-
@@ -337,7 +337,7 @@ Rails/HasAndBelongsToMany:
 
 Rails/Output:
   Description: 'Checks for calls to puts, print, etc.'
-  Enabled: true
+  Enabled: false
 
 Rails/ReadWriteAttribute:
   Description: >-
@@ -812,7 +812,7 @@ Style/NumericLiterals:
                  Add underscores to large numeric literals to improve their
                  readability.
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
-  Enabled: true
+  Enabled: false
 
 Style/OneLineConditional:
   Description: >-

data/CHANGELOG.md

@@ -1 +1,4 @@
-## Change Log
+## Change Log
+
+### v0.0.1 2021/06/23
+- [#1](https://github.com/khiav223577/max_exchange_api/pull/1) Implement `/depth` API (@khiav223577)

data/README.md

@@ -35,16 +35,81 @@ Or install it yourself as:
 
     $ gem install max_exchange_api
 
+## Default config
+
+Change default api timeout time (in seconds)
+
+```rb
+MaxExchangeApi.config.default_timeout = 3
+```
+
 ## Usage
 
-### Public Apis
+### Public Api Examples
 
 ```rb
 @api = MaxExchangeApi::PublicApi.new
 ```
 
+#### [GET GET /api/v2/vip_levels](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevels)
+
+> Get all VIP level fees.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.vip_levels
+```
+</details>
+
+#### [GET /api/v2/vip_levels/{level}](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevelsLevel)
+
+> Get VIP level fee by level.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.vip_levels(2)
+```
+</details>
+
+#### [GET /api/v2/currencies](https://max.maicoin.com/documents/api_list#!/public/getApiV2Currencies)
+
+> Get all available currencies.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.currencies
+```
+</details>
+
+#### [GET /api/v2/k](https://max.maicoin.com/documents/api_list#!/public/getApiV2K)
+
+> Get OHLC(k line) of a specific market.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+# use default parameters
+@api.k('btctwd')
+
+# provide all possible parameters
+@api.k('btctwd', limit: 30, period: 1, timestamp: 1624705402)
+```
+</details>
+
 #### [GET /api/v2/depth](https://max.maicoin.com/documents/api_list#!/public/getApiV2Depth)
 
+> Get depth of a specified market.
+
+<details>
+  <summary>Show code</summary>
+  
 ```rb
 # use default parameters
 @api.depth('maxtwd')
@@ -52,6 +117,93 @@ Or install it yourself as:
 # provide all possible parameters
 @api.depth('maxtwd', limit: 10, sort_by_price: true)
 ```
+</details>
+
+#### [GET /api/v2/trades](https://max.maicoin.com/documents/api_list#!/public/getApiV2Trades)
+
+> Get recent trades on market, sorted in reverse creation order.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+# use default parameters
+@api.trades('btctwd')
+
+# provide all possible parameters
+@api.trades(
+  'maxtwd', 
+  timestamp: 1624705402,
+  from: 68444,
+  to: 69444,
+  order_by: 'asc',
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+</details>
+
+#### [GET /api/v2/markets](https://max.maicoin.com/documents/api_list#!/public/getApiV2Markets)
+
+> Get all available markets.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.markets
+```
+</details>
+
+#### [GET /api/v2/summary](https://max.maicoin.com/documents/api_list#!/public/getApiV2Summary)
+
+> Overview of market data for all tickers.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.summary
+```
+</details>
+
+#### [GET /api/v2/tickers/{path_market}](https://max.maicoin.com/documents/api_list#!/public/getApiV2TickersPathMarket)
+
+> Get ticker of specific market.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.tickers('btctwd')
+```
+</details>
+
+#### [GET /api/v2/tickers](https://max.maicoin.com/documents/api_list#!/public/getApiV2Tickers)
+
+> Get ticker of all markets.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.tickers
+```
+</details>
+
+#### [GET /api/v2/timestamp](https://max.maicoin.com/documents/api_list#!/public/getApiV2Timestamp)
+
+> Get server current time, in seconds since Unix epoch.
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api.timestamp
+```
+</details>
 
 ## Development
 

data/lib/max_exchange_api.rb

@@ -1,2 +1,3 @@
 require 'max_exchange_api/version'
+require 'max_exchange_api/config'
 require 'max_exchange_api/public_api'

data/lib/max_exchange_api/base_api.rb

@@ -19,7 +19,7 @@ module MaxExchangeApi
           path,
           headers: headers,
           query: query,
-          timeout: 3,
+          timeout: MaxExchangeApi.config.default_timeout,
         ).parsed_response
 
         print_log(:info, "[API] #{uuid} response #{response}")

data/lib/max_exchange_api/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MaxExchangeApi
+  class Config
+    attr_accessor :default_timeout
+
+    def initialize
+      @default_timeout = 3
+    end
+  end
+
+  @config = Config.new
+
+  class << self
+    attr_reader :config
+  end
+end

data/lib/max_exchange_api/public_api.rb

@@ -6,10 +6,63 @@ module MaxExchangeApi
   class PublicApi < BaseApi
     base_uri 'https://max-api.maicoin.com/api/v2'
 
+    def vip_levels(level = nil)
+      if level
+        send_request(:get, "/vip_levels/#{level}", {})
+      else
+        send_request(:get, '/vip_levels', {})
+      end
+    end
+
+    def currencies
+      send_request(:get, '/currencies', {})
+    end
+
+    def k(market, limit: 30, period: 1, timestamp: nil)
+      send_request(:get, '/k', market: market, limit: limit, period: period, timestamp: timestamp)
+    end
+
     def depth(market, limit: 10, sort_by_price: true)
       send_request(:get, '/depth', market: market, limit: limit, sort_by_price: sort_by_price)
     end
 
+    def trades(market, timestamp: nil, from: nil, to: nil, order_by: 'desc', pagination: true, page: 1, limit: 50,
+               offset: 0)
+      send_request(
+        :get,
+        '/trades',
+        market: market,
+        timestamp: timestamp,
+        from: from,
+        to: to,
+        order_by: order_by,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def markets
+      send_request(:get, '/markets', {})
+    end
+
+    def summary
+      send_request(:get, '/summary', {})
+    end
+
+    def tickers(market = nil)
+      if market
+        send_request(:get, "/tickers/#{market}", {})
+      else
+        send_request(:get, '/tickers', {})
+      end
+    end
+
+    def timestamp
+      send_request(:get, '/timestamp', {})
+    end
+
     protected
 
     def send_request(method, path, query)

data/lib/max_exchange_api/version.rb

@@ -1,3 +1,3 @@
 module MaxExchangeApi
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: max_exchange_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - gemfiles/Gemfile
 - lib/max_exchange_api.rb
 - lib/max_exchange_api/base_api.rb
+- lib/max_exchange_api/config.rb
 - lib/max_exchange_api/helper.rb
 - lib/max_exchange_api/public_api.rb
 - lib/max_exchange_api/version.rb