max_exchange_api 1.3.0 → 1.4.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Change Log
 
+### [v1.3.0](https://github.com/khiav223577/max_exchange_api/compare/v1.2.0...v1.3.0) 2021/11/29
+- [#12](https://github.com/khiav223577/max_exchange_api/pull/12) Support Ruby 3.0 (@khiav223577)
+- [#11](https://github.com/khiav223577/max_exchange_api/pull/11) Add user agent to headers (@khiav223577)
+- [#10](https://github.com/khiav223577/max_exchange_api/pull/10) Enhance: use query_string only if the action is GET (@khiav223577)
+
 ### [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)
 

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,49 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at khiav223577@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Rumble Huang
-
-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.
+MIT License
+
+Copyright (c) 2020 Rumble Huang
+
+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

@@ -1,4 +1,4 @@
-# MaxExchangeApi
+# MAX Exchange API Ruby SDK
 
 [![Gem Version](https://img.shields.io/gem/v/max_exchange_api.svg?style=flat)](http://rubygems.org/gems/max_exchange_api)
 [![Build Status](https://github.com/khiav223577/max_exchange_api/workflows/Ruby/badge.svg)](https://github.com/khiav223577/max_exchange_api/actions)
@@ -19,7 +19,7 @@ A ruby implementation of MAX exchange API
 
 
 ## Supports
-- Ruby 2.2 ~ 2.7, 3.0
+- Ruby 2.2 ~ 2.7, 3.0 ~ 3.3
 
 ## Installation
 
@@ -69,7 +69,8 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
 ### Public Api Examples
 
 ```rb
-@api = MaxExchangeApi::PublicApi.new
+@api_v2 = MaxExchangeApi::PublicV2Api.new
+@api_v3 = MaxExchangeApi::PublicV3Api.new
 ```
 
 #### [GET /api/v2/vip_levels](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevels)
@@ -80,7 +81,7 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.vip_levels
+@api_v2vip_levels
 ```
 </details>
 
@@ -92,7 +93,7 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.vip_levels(2)
+@api_v2vip_levels(2)
 ```
 </details>
 
@@ -104,7 +105,7 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.currencies
+@api_v2currencies
 ```
 </details>
 
@@ -117,10 +118,10 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   
 ```rb
 # use default parameters
-@api.k('btctwd')
+@api_v2k('btctwd')
 
 # provide all possible parameters
-@api.k('btctwd', limit: 30, period: 1, timestamp: 1624705402)
+@api_v2k('btctwd', limit: 30, period: 1, timestamp: 1624705402)
 ```
 </details>
 
@@ -133,10 +134,10 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   
 ```rb
 # use default parameters
-@api.depth('maxtwd')
+@api_v2depth('maxtwd')
 
 # provide all possible parameters
-@api.depth('maxtwd', limit: 10, sort_by_price: true)
+@api_v2depth('maxtwd', limit: 10, sort_by_price: true)
 ```
 </details>
 
@@ -149,10 +150,10 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   
 ```rb
 # use default parameters
-@api.trades('btctwd')
+@api_v2trades('btctwd')
 
 # provide all possible parameters
-@api.trades(
+@api_v2trades(
   'maxtwd', 
   timestamp: 1624705402,
   from: 68444,
@@ -174,7 +175,7 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.markets
+@api_v2markets
 ```
 </details>
 
@@ -186,7 +187,7 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.summary
+@api_v2summary
 ```
 </details>
 
@@ -198,7 +199,7 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.tickers('btctwd')
+@api_v2tickers('btctwd')
 ```
 </details>
 
@@ -210,7 +211,7 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.tickers
+@api_v2tickers
 ```
 </details>
 
@@ -222,17 +223,32 @@ api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: L
   <summary>Show code</summary>
   
 ```rb
-@api.timestamp
+@api_v2timestamp
 ```
 </details>
 
+#### [GET /api/v3/wallet/m/limits](https://max.maicoin.com/documents/api_list/v3#tag/Public/operation/getApiV3WalletMLimits)
+
+> Get total available loan amount
+
+<details>
+  <summary>Show code</summary>
+  
+```rb
+@api_v3.available_loan_amount
+```
+</details>
+
+---
+
 ### Private Api Examples
 
 ```rb
 access_key = 'YOUR_ACCESS_KEY'
 secret_key = 'YOUR_SECRET_KEY'
 
-@api = MaxExchangeApi::PrivateApi.new(access_key, secret_key)
+@api_v2 = MaxExchangeApi::PrivateV2Api.new(access_key, secret_key)
+@api_v3 = MaxExchangeApi::PrivateV3Api.new(access_key, secret_key)
 ```
 
 ### Trade
@@ -245,10 +261,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use max unique order id
-@api.my_trades_of_order(123456)
+@api_v2my_trades_of_order(123456)
 
 # use user specified order id
-@api.my_trades_of_order('MY_ORDER_123456', use_client_id: true)
+@api_v2my_trades_of_order('MY_ORDER_123456', use_client_id: true)
 ```
 </details>
 
@@ -261,10 +277,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.my_trades('btctwd')
+@api_v2my_trades('btctwd')
 
 # provide all possible parameters
-@api.my_trades(
+@api_v2my_trades(
   'maxtwd',
   timestamp: 1624705402,
   from: 68444,
@@ -288,10 +304,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.withdrawals('max')
+@api_v2withdrawals('max')
 
 # provide all possible parameters
-@api.withdrawals(
+@api_v2withdrawals(
   'max',
   'confirmed',
   from: 68444,
@@ -313,7 +329,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.withdrawal('withdraw_id')
+@api_v2withdrawal('withdraw_id')
 ```
 </details>
 
@@ -325,7 +341,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.create_withdrawal!('twd', 'withdraw_address_id', 100000)
+@api_v2create_withdrawal!('twd', 'withdraw_address_id', 100000)
 ```
 </details>
 
@@ -338,7 +354,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.member_profile
+@api_v2member_profile
 ```
 </details>
 
@@ -350,7 +366,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.me
+@api_v2me
 ```
 </details>
 
@@ -362,7 +378,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.vip_level
+@api_v2vip_level
 ```
 </details>
 
@@ -375,7 +391,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.accounts
+@api_v2accounts
 ```
 </details>
 
@@ -387,7 +403,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.account(currnecy)
+@api_v2account(currnecy)
 ```
 </details>
 
@@ -401,10 +417,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.deposits('max')
+@api_v2deposits('max')
 
 # provide all possible parameters
-@api.deposits(
+@api_v2deposits(
   'max',
   'confirmed',
   from: 68444,
@@ -426,7 +442,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.deposit('transaction_id')
+@api_v2deposit('transaction_id')
 ```
 </details>
 
@@ -440,10 +456,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.deposit_addresses
+@api_v2deposit_addresses
 
 # provide all possible parameters
-@api.deposit_addresses(currency: 'twd', pagination: true, page: 3, limit: 15, offset: 5)
+@api_v2deposit_addresses(currency: 'twd', pagination: true, page: 3, limit: 15, offset: 5)
 ```
 </details>
 
@@ -455,7 +471,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.create_deposit_addresses!('twd')
+@api_v2create_deposit_addresses!('twd')
 ```
 </details>
 
@@ -468,10 +484,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.withdraw_addresses('twd')
+@api_v2withdraw_addresses('twd')
 
 # provide all possible parameters
-@api.withdraw_addresses('usdt', pagination: true, page: 3, limit: 15, offset: 5)
+@api_v2withdraw_addresses('usdt', pagination: true, page: 3, limit: 15, offset: 5)
 ```
 </details>
 
@@ -485,10 +501,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.internal_transfers
+@api_v2internal_transfers
 
 # provide all possible parameters
-@api.internal_transfers(
+@api_v2internal_transfers(
   currency: 'btc',
   side: 'in',
   from: 68444,
@@ -509,7 +525,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.internal_transfer('internal_transfer_id')
+@api_v2internal_transfer('internal_transfer_id')
 ```
 </details>
 
@@ -523,10 +539,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.rewards
+@api_v2rewards
 
 # provide all possible parameters
-@api.rewards(
+@api_v2rewards(
   currency: 'btc',
   from: 68444,
   to: 69444,
@@ -547,10 +563,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.rewards(reward_type: 'airdrop_rewards')
+@api_v2rewards(reward_type: 'airdrop_rewards')
 
 # provide all possible parameters
-@api.rewards(
+@api_v2rewards(
   reward_type: 'airdrop_rewards',
   currency: 'btc',
   from: 68444,
@@ -571,7 +587,7 @@ secret_key = 'YOUR_SECRET_KEY'
   <summary>Show code</summary>
 
 ```rb
-@api.max_rewards_yesterday
+@api_v2max_rewards_yesterday
 ```
 </details>
 
@@ -584,10 +600,10 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.yields
+@api_v2yields
 
 # provide all possible parameters
-@api.yields(
+@api_v2yields(
   currency: 'usdt',
   from: 68444,
   to: 69444,
@@ -609,7 +625,7 @@ secret_key = 'YOUR_SECRET_KEY'
 
 ```rb
 # use default parameters
-@api.orders('maxtwd')
+@api_v2orders('maxtwd')
 
 # provide all possible parameters
 @api.orders(
@@ -708,14 +724,14 @@ secret_key = 'YOUR_SECRET_KEY'
 ```rb
 # use default parameters
 @api.create_orders!('maxtwd', [
-  { side: 'buy', volume: '1000', price: 7.5 },
-  { side: 'buy', volume: '1500', price: 7.2 },
+  { side: 'buy', volume: '1000', price: '7.5' },
+  { side: 'buy', volume: '1500', price: '7.2' },
 ])
 
 # provide all possible parameters
 @api.create_orders!('maxtwd', [
-  { side: 'buy', volume: '1000', price: 7.5, client_oid: 'MY_ORDER_ID_12345', stop_price: 8, ord_type: 'limit' },
-  { side: 'buy', volume: '1500', price: 7.2, client_oid: 'MY_ORDER_ID_12346', stop_price: 8, ord_type: 'limit' },
+  { side: 'buy', volume: '1000', price: '7.5', client_oid: 'MY_ORDER_ID_12345', stop_price: '8', ord_type: 'limit' },
+  { side: 'buy', volume: '1500', price: '7.2', client_oid: 'MY_ORDER_ID_12346', stop_price: '8', ord_type: 'limit' },
 ], group_id: 12345)
 ```
 </details>

data/Rakefile

@@ -1,10 +1,10 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task default: :test
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'max_exchange_api'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'max_exchange_api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/gemfiles/2.2.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_or.gemspec
+
+group :test do
+  gem 'simplecov', '< 0.18'
+  gem 'httparty', '< 0.19'
+  gem 'logger', '< 1.3.0'
+end
+
+gemspec path: '../'

data/gemfiles/Gemfile

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