max_exchange_api 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e67831c545b85f3e39db7cdab7dcbf293c8d2958a5fed7affa29b2617d4a79
-  data.tar.gz: '08ba7fe4b157b1abcd9611e47c170c406975dcea7497cc9be6490ec7bd3985f3'
+  metadata.gz: 3f55473cff3a0a3a235b9e164ddc0e35ada7de436ac2fea87d9e17c179ed7135
+  data.tar.gz: 8de22008ea06fe624634099ad7cd1133876ed2182fd515b024c311ac49a4407e
 SHA512:
-  metadata.gz: c10c08e3462a21a8ea9cb5be83327d06bdc8e406757895004ef31ed38df4606903337edbf7c07e0c5944ca88f8817c203abd7319369cbe763fed74785d3a788a
-  data.tar.gz: dd2bc0c74f8ae55bb1df54cfed702c6c908678ebca08f10c4181adc26162b23401ecaaddbbe9ff2698a9a96fb0662a041431044b2f6327d26285dba12b62c10a
+  metadata.gz: 444b86438ad9c6055914ce5413225256cb986b7519dd94c255c6bd88837cf3c549db2193cd950c20fce073431e834163b68c7763f72abca45c586b10a4276708
+  data.tar.gz: 4abfa0033b87e4dab40a5b590c878ec4600e3d56dd94ee9b8db6db9d612b916a84e6e49e009f1d4e489be443e487029ec399d7017f9c6b75f8a54524f2627e05

data/.github/workflows/ruby.yml

@@ -23,6 +23,7 @@ jobs:
           - 2.2
           - 2.6
           - 2.7
+          - 3.0
         gemfile:
           - Gemfile
     env:

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## Change Log
 
+### [v1.2.0](https://github.com/khiav223577/max_exchange_api/compare/v1.1.1...v1.2.0) 2021/08/01
+- [#9](https://github.com/khiav223577/max_exchange_api/pull/9) add yields api (@khiav223577)
+
+### [v1.1.1](https://github.com/khiav223577/max_exchange_api/compare/v1.1.0...v1.1.1) 2021/08/01
+- [#7](https://github.com/khiav223577/max_exchange_api/pull/7) Fix wrong path in rewards API (@khiav223577)
+- [#8](https://github.com/khiav223577/max_exchange_api/pull/8) Adjust: maker fee and min base amount test cases (@khiav223577)
+
+### [v1.1.0](https://github.com/khiav223577/max_exchange_api/compare/v1.0.0...v1.1.0) 2021/06/27
+- [#6](https://github.com/khiav223577/max_exchange_api/pull/6) Allow every api instance to have custom config (@khiav223577)
+
+### [v1.0.0](https://github.com/khiav223577/max_exchange_api/compare/v0.1.0...v1.0.0) 2021/06/27
+- [#5](https://github.com/khiav223577/max_exchange_api/pull/5) Implement all v2 private APIs (@khiav223577)
+- [#4](https://github.com/khiav223577/max_exchange_api/pull/4) Add logger config  (@khiav223577)
+
 ### [v0.1.0](https://github.com/khiav223577/max_exchange_api/compare/v0.0.1...v0.1.0) 2021/06/26
 - [#3](https://github.com/khiav223577/max_exchange_api/pull/3) Add default_timeout config (@khiav223577)
 - [#2](https://github.com/khiav223577/max_exchange_api/pull/2) Implement all v2 public APIs (@khiav223577)

data/README.md

@@ -19,7 +19,7 @@ A ruby implementation of MAX exchange API
 
 
 ## Supports
-- Ruby 2.2 ~ 2.7
+- Ruby 2.2 ~ 2.7, 3.0
 
 ## Installation
 
@@ -37,19 +37,31 @@ Or install it yourself as:
 
 ## Configuration
 
-### Api timeout time
+### Set timeout time
 
 ```rb
+# Set default timeout time
 MaxExchangeApi.default_config.timeout = 3 # seconds
+
+# Create an api instance with custom timeout time
+api = MaxExchangeApi::PublicApi.new(config: { timeout: 12 })
+api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { timeout: 12 })
 ```
 
-### Api logging
+### Logging
 
 ```rb
 require 'logger'
 
-MaxExchangeApi.default_config.logger = Logger.new(STDOUT) # print log to stdand output
+# Print log to standard output
+MaxExchangeApi.default_config.logger = Logger.new(STDOUT)
+
+# Print log to file
 MaxExchangeApi.default_config.logger = Logger.new('log/api.log')
+
+# Create an api instance with custom logger
+api = MaxExchangeApi::PublicApi.new(config: { logger: Logger.new(STDOUT) })
+api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: Logger.new(STDOUT) })
 ```
 
 ## Usage
@@ -60,7 +72,7 @@ MaxExchangeApi.default_config.logger = Logger.new('log/api.log')
 @api = MaxExchangeApi::PublicApi.new
 ```
 
-#### [GET GET /api/v2/vip_levels](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevels)
+#### [GET /api/v2/vip_levels](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevels)
 
 > Get all VIP level fees.
 
@@ -563,6 +575,30 @@ secret_key = 'YOUR_SECRET_KEY'
 ```
 </details>
 
+#### [GET /api/v2/yields](https://max.maicoin.com/documents/api_list#!/private/getApiV2Yields)
+
+> get yields history
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.yields
+
+# provide all possible parameters
+@api.yields(
+  currency: 'usdt',
+  from: 68444,
+  to: 69444,
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+</details>
+
 ### Order
 #### [GET /api/v2/orders](https://max.maicoin.com/documents/api_list#!/private/getApiV2Orders)
 

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install --gemfile=gemfiles/4.2.gemfile
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --gemfile=gemfiles/Gemfile
+
+# Do any other automated setup that you need to do here

data/gemfiles/Gemfile

@@ -3,7 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rails_or.gemspec
 
 group :test do
-  gem 'simplecov', '< 0.18'
+  gem 'simplecov', '< 0.18'
+  gem 'httparty', '< 0.19'
 end
 
 gemspec path: '../'

data/lib/max_exchange_api/base_api.rb

@@ -7,19 +7,31 @@ module MaxExchangeApi
   class BaseApi
     include HTTParty
 
+    attr_reader :config
+
+    def initialize(config: nil)
+      @config = Config.new(config)
+      @config.reverse_merge!(MaxExchangeApi.default_config)
+    end
+
     protected
 
     def send_request(method, path, headers, query)
       uuid = SecureRandom.uuid
       print_log(:info, "[API] #{uuid} #{method.upcase} '#{path}' query = #{query}")
 
+      body_or_query = method == :get ? :query : :body
+
       begin
         response = self.class.send(
           method,
           path,
-          headers: headers,
-          query: query,
-          timeout: MaxExchangeApi.default_config.timeout,
+          headers: headers.merge(
+            'Accept'     => 'application/json',
+            'User-Agent' => "max_exchange_api (#{MaxExchangeApi::VERSION})",
+          ),
+          timeout: @config.timeout,
+          body_or_query => query,
         ).parsed_response
 
         print_log(:info, "[API] #{uuid} response #{response}")
@@ -33,7 +45,7 @@ module MaxExchangeApi
     private
 
     def print_log(method, message)
-      logger = MaxExchangeApi.default_config.logger
+      logger = @config.logger
       logger.send(method, message) if logger
     end
   end

data/lib/max_exchange_api/config.rb

@@ -5,13 +5,20 @@ module MaxExchangeApi
     attr_accessor :timeout
     attr_accessor :logger
 
-    def initialize
-      @timeout = 3
-      @logger = nil
+    def initialize(data = nil)
+      data ||= {}
+      @timeout = data[:timeout]
+      @logger = data[:logger]
+    end
+
+    def reverse_merge!(other)
+      @timeout ||= other.timeout
+      @logger ||= other.logger
     end
   end
 
   @default_config = Config.new
+  @default_config.timeout = 3
 
   class << self
     attr_reader :default_config

data/lib/max_exchange_api/private_api.rb

@@ -6,8 +6,8 @@ module MaxExchangeApi
   class PrivateApi < BaseApi
     base_uri 'https://max-api.maicoin.com/api/v2'
 
-    def initialize(access_key, secret_key)
-      super()
+    def initialize(access_key, secret_key, config: nil)
+      super(config: config)
 
       @access_key = access_key
       @secret_key = secret_key
@@ -148,7 +148,7 @@ module MaxExchangeApi
     end
 
     def rewards(reward_type: nil, currency: nil, from: nil, to: nil, pagination: nil, page: 1, limit: 50, offset: 0)
-      path = reward_type ? '/rewards' : "/rewards/#{reward_type}"
+      path = reward_type ? "/rewards/#{reward_type}" : '/rewards'
       send_request(
         :get,
         path,
@@ -162,6 +162,20 @@ module MaxExchangeApi
       )
     end
 
+    def yields(currency: nil, from: nil, to: nil, pagination: nil, page: 1, limit: 50, offset: 0)
+      send_request(
+        :get,
+        '/yields',
+        currency: currency,
+        from: from,
+        to: to,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
     def max_rewards_yesterday
       send_request(:get, '/max_rewards/yesterday', {})
     end

data/lib/max_exchange_api/version.rb

@@ -1,3 +1,3 @@
 module MaxExchangeApi
-  VERSION = '1.0.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: max_exchange_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler