max_exchange_api 0.0.1

data/CHANGELOG.md

@@ -0,0 +1 @@
+## Change Log

data/CODE_OF_CONDUCT.md

@@ -0,0 +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/

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,70 @@
+# MaxExchangeApi
+
+[![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)
+[![RubyGems](http://img.shields.io/gem/dt/max_exchange_api.svg?style=flat)](http://rubygems.org/gems/max_exchange_api)
+[![Code Climate](https://codeclimate.com/github/khiav223577/max_exchange_api/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/max_exchange_api)
+[![Test Coverage](https://codeclimate.com/github/khiav223577/max_exchange_api/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/max_exchange_api/coverage)
+
+A ruby implementation of MAX exchange API
+
+* REST API V2
+* Websocket API
+
+## Documentations
+
+* [REST API Introduction](https://max.maicoin.com/documents/api_v2)
+* [REST API End Points](https://max.maicoin.com/documents/api_list)
+* [WebSocket API Documentation](https://maicoin.github.io/max-websocket-docs/)
+
+
+## Supports
+- Ruby 2.2 ~ 2.7
+
+## Installation
+
+```ruby
+gem 'max_exchange_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install max_exchange_api
+
+## Usage
+
+### Public Apis
+
+```rb
+@api = MaxExchangeApi::PublicApi.new
+```
+
+#### [GET /api/v2/depth](https://max.maicoin.com/documents/api_list#!/public/getApiV2Depth)
+
+```rb
+# use default parameters
+@api.depth('maxtwd')
+
+# provide all possible parameters
+@api.depth('maxtwd', limit: 10, sort_by_price: true)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/max_exchange_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +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

data/bin/console

@@ -0,0 +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

data/bin/setup

@@ -0,0 +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

data/gemfiles/Gemfile

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

data/lib/max_exchange_api.rb

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

data/lib/max_exchange_api/base_api.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'max_exchange_api/helper'
+
+module MaxExchangeApi
+  class BaseApi
+    include HTTParty
+
+    protected
+
+    def send_request(method, path, headers, query)
+      uuid = SecureRandom.uuid
+      print_log(:info, "[API] #{uuid} #{method.upcase} '#{path}' query = #{query}")
+
+      begin
+        response = self.class.send(
+          method,
+          path,
+          headers: headers,
+          query: query,
+          timeout: 3,
+        ).parsed_response
+
+        print_log(:info, "[API] #{uuid} response #{response}")
+        return response
+      rescue => error
+        print_log(:error, "[API] #{uuid} raise exception #{error.message}")
+        raise error
+      end
+    end
+
+    private
+
+    def print_log(_method, message)
+      puts message
+    end
+  end
+end

data/lib/max_exchange_api/helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MaxExchangeApi
+  module Helper
+  end
+end

data/lib/max_exchange_api/public_api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'max_exchange_api/base_api'
+
+module MaxExchangeApi
+  class PublicApi < BaseApi
+    base_uri 'https://max-api.maicoin.com/api/v2'
+
+    def depth(market, limit: 10, sort_by_price: true)
+      send_request(:get, '/depth', market: market, limit: limit, sort_by_price: sort_by_price)
+    end
+
+    protected
+
+    def send_request(method, path, query)
+      super(method, path, {}, query)
+    end
+  end
+end

data/lib/max_exchange_api/version.rb

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

data/max_exchange_api.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'max_exchange_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'max_exchange_api'
+  spec.version       = MaxExchangeApi::VERSION
+  spec.authors       = ['khiav reoy']
+  spec.email         = ['mrtmrt15xn@yahoo.com.tw']
+
+  spec.summary       = 'MAX Exchange API Ruby SDK'
+  spec.description   = 'MAX Exchange API Ruby SDK'
+  spec.homepage      = 'https://github.com/khiav223577/max_exchange_api'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.metadata      = {
+    'homepage_uri'      => 'https://github.com/khiav223577/max_exchange_api',
+    'changelog_uri'     => 'https://github.com/khiav223577/max_exchange_api/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/khiav223577/max_exchange_api',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/max_exchange_api',
+    'bug_tracker_uri'   => 'https://github.com/khiav223577/max_exchange_api/issues',
+  }
+
+  spec.add_development_dependency 'bundler', '>= 1.17', '< 3.x'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-color', '~> 0.0.2'
+
+  spec.add_dependency 'httparty', '>= 0.18.1'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: max_exchange_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- khiav reoy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: MAX Exchange API Ruby SDK
+email:
+- mrtmrt15xn@yahoo.com.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/Gemfile
+- lib/max_exchange_api.rb
+- lib/max_exchange_api/base_api.rb
+- lib/max_exchange_api/helper.rb
+- lib/max_exchange_api/public_api.rb
+- lib/max_exchange_api/version.rb
+- max_exchange_api.gemspec
+homepage: https://github.com/khiav223577/max_exchange_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/khiav223577/max_exchange_api
+  changelog_uri: https://github.com/khiav223577/max_exchange_api/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/khiav223577/max_exchange_api
+  documentation_uri: https://www.rubydoc.info/gems/max_exchange_api
+  bug_tracker_uri: https://github.com/khiav223577/max_exchange_api/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.14
+signing_key: 
+specification_version: 4
+summary: MAX Exchange API Ruby SDK
+test_files: []