btcmarkets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ec99d718599233c0f796f3a963458b7854c314a534745a8e380632d83d2b225
+  data.tar.gz: 73c52c5651426fbce9bfea82a6b609d6ae75c4e205f69e1bbeb6e04aa33d891c
+SHA512:
+  metadata.gz: fe3560881334b4a1599b2702de9e2f7de2d118b6c4c492dee224a996e4ab25fc9a96c4123c8b275157a08e53877e52bd29de22fd1723ed83c7c26756dcce6945
+  data.tar.gz: 218b88ceeb20158f2e3309b3537e64e2339d0318a2a59a16005dfd126f8b7d51f2254eb2c14c62d4290631aa2a39d96e216f6e9512b1ac3e7fa301cbba5e5ede

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and rspec test
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at liang.shi@protonmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in btcmarkets.gemspec
+gemspec
+
+gem 'httparty'
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    btcmarkets (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (1.0.0)
+    httparty (0.17.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    safe_yaml (1.0.5)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  btcmarkets!
+  bundler (~> 2.0)
+  httparty
+  rake (~> 10.0)
+  rspec
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Liang Shi
+
+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,31 @@
+# BTCMarkets API wrapper
+This is Ruby Wrapper for https://btcmarkets.net/
+
+## Supported API
+
+```bash
+# public API
+BTCMarkets::Market.markets
+BTCMarkets::Market.tikers(%w[BTC-AUD LTC-AUD])
+BTCMarkets::Server.time
+
+
+# private API
+# Set up the BTCMakerts API key as environment variables:
+
+ENV['BTCMARKETS_PUBLIC_KEY'] = ''
+ENV['BTCMARKETS_PRIVATE_KEY'] = ''
+
+BTCMarkets::Account.blance
+
+BTCMarkets::Account.transactions({limit: 2, after: xxxxx, before: xxxx})
+BTCMarkets::Account.transactions
+
+BTCMarkets::Trade.trades
+BTCMarkets::Trade.trade('xxxxxx')
+
+BTCMarkets::Fund.deposit_address('BTC')
+```
+
+## Licence
+MIT

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "btcmarkets"
+
+# 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(__FILE__)

data/bin/setup

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

data/btcmarkets.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "btcmarkets/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "btcmarkets"
+  spec.version       = BTCMarkets::VERSION
+  spec.authors       = ["Liang Shi"]
+  spec.email         = ["liang.shi@protonmail.com"]
+
+  spec.summary       = %q{A ruby wrapper for BTCMarkets public API}
+  # spec.description   = %q{}
+  spec.homepage      = "https://github.com/2pd/btcmarkets-ruby"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/2pd/btcmarkets-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/2pd/btcmarkets-ruby/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/btcmarkets.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'helpers/time'
+require 'btcmarkets/version'
+
+require 'btcmarkets/error'
+require 'btcmarkets/client'
+
+require 'btcmarkets/market'
+require 'btcmarkets/server'
+
+require 'btcmarkets/authentication'
+require 'btcmarkets/account'
+require 'btcmarkets/trade'
+require 'btcmarkets/fund'

data/lib/btcmarkets/account.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BTCMarkets
+  class Account
+    class << self
+      def balance
+        Client.private_send(:get, '/v3/accounts/me/balances')
+      end
+
+      def transactions(params = {})
+        Client.private_send(:get, '/v3/accounts/me/transactions', params: params)
+      end
+    end
+  end
+end

data/lib/btcmarkets/authentication.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module BTCMarkets
+  class Authentication
+    class << self
+      def api_public_key
+        ENV['BTCMARKETS_PUBLIC_KEY']
+      end
+
+      def api_private_key
+        ENV['BTCMARKETS_PRIVATE_KEY']
+      end
+
+      def signature(payload)
+        Base64.strict_encode64(OpenSSL::HMAC.digest('sha512', base64_encrypted_key, payload))
+      end
+
+      def base64_encrypted_key
+        Base64.decode64(api_private_key)
+      end
+    end
+  end
+end

data/lib/btcmarkets/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module BTCMarkets
+  class Client
+    include HTTParty
+
+    base_uri 'https://api.btcmarkets.net'
+
+    class << self
+      def public_send(path: '/', params: {})
+        response = get(path, query: params)
+        process(response)
+      end
+
+      def private_send(method, path, params: {})
+        case method
+        when :get
+          response = send(method, path, headers: build_headers(method.to_s, path), query: params)
+        else
+          response = send(method, path, headers: build_headers(method.to_s, path, params), body: params)
+        end
+        process(response)
+      end
+
+      private
+
+      def build_headers(method, path, params = {})
+        timestamp = Helpers::Time.timestamp.to_s
+
+        {
+          "Accept": 'application/json',
+          "Accept-Charset": 'UTF-8',
+          "Content-Type": 'application/json',
+          "BM-AUTH-APIKEY": Authentication.api_public_key,
+          "BM-AUTH-TIMESTAMP": timestamp,
+          "BM-AUTH-SIGNATURE": Authentication.signature(payload(method, path, timestamp, params))
+        }
+      end
+
+      def payload(method, path, timestamp, params)
+        method = method.upcase
+        unless params.empty?
+          return "#{method}#{path}#{timestamp}#{params.to_json}"
+        end
+
+        "#{method}#{path}#{timestamp}"
+      end
+
+      def process(response)
+        data = JSON.parse(response.body, symbolize_names: true)
+        raise Error.new(response.code, data) if Error.error_response?(response)
+
+        data
+      end
+    end
+  end
+end

data/lib/btcmarkets/error.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BTCMarkets
+  class Error < StandardError
+    attr_reader :status, :message, :data
+
+    class << self
+      def error_response?(response)
+        response.code >= 400
+      end
+    end
+
+    def initialize(status, data = {})
+      @status = status
+      @message = data[:message]
+      @data = data
+    end
+  end
+end

data/lib/btcmarkets/fund.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BTCMarkets
+  class Fund
+    class << self
+      def deposit_address(asset)
+        Client.private_send(:get, '/v3/addresses', params: { 'assetName': asset })
+      end
+    end
+  end
+end

data/lib/btcmarkets/market.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BTCMarkets
+  class Market
+    class << self
+      def markets
+        Client.public_send(path: '/v3/markets')
+      end
+
+      def ticker(market_id)
+        Client.public_send(path: "/v3/markets/#{market_id}/ticker")
+      end
+
+      def tickers(market_ids = [])
+        params = { 'marketId': market_ids } unless market_ids.empty?
+        Client.public_send(path: '/v3/markets/tickers', params: params)
+      end
+
+      def trades(market_id, params = {})
+        Client.public_send(path: "/v3/markets/#{market_id}/trades", params: params)
+      end
+
+      def orderbook(market_id, params = {})
+        Client.public_send(path: "/v3/markets/#{market_id}/orderbook", params: params)
+      end
+
+      def orderbooks(market_ids = [])
+        params = { 'marketId': market_ids } unless market_ids.empty?
+        Client.public_send(path: '/v3/markets/orderbooks', params: params)
+      end
+    end
+  end
+end

data/lib/btcmarkets/server.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BTCMarkets
+  class Server
+    class << self
+      def time
+        Client.public_send(path: '/v3/time')
+      end
+    end
+  end
+end

data/lib/btcmarkets/trade.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BTCMarkets
+  class Trade
+    class << self
+      def trades(params = {})
+        Client.private_send(:get, '/v3/trades', params: params)
+      end
+
+      def trade(id)
+        Client.private_send(:get, "/v3/trades/#{id}")
+      end
+    end
+  end
+end

data/lib/btcmarkets/version.rb

@@ -0,0 +1,3 @@
+module BTCMarkets
+  VERSION = "0.1.0"
+end

data/lib/helpers/time.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Helpers
+  class Time
+    def self.timestamp
+      (::Time.now.to_f * 1000).to_i
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: btcmarkets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Liang Shi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- liang.shi@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- btcmarkets.gemspec
+- lib/btcmarkets.rb
+- lib/btcmarkets/account.rb
+- lib/btcmarkets/authentication.rb
+- lib/btcmarkets/client.rb
+- lib/btcmarkets/error.rb
+- lib/btcmarkets/fund.rb
+- lib/btcmarkets/market.rb
+- lib/btcmarkets/server.rb
+- lib/btcmarkets/trade.rb
+- lib/btcmarkets/version.rb
+- lib/helpers/time.rb
+homepage: https://github.com/2pd/btcmarkets-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/2pd/btcmarkets-ruby
+  source_code_uri: https://github.com/2pd/btcmarkets-ruby
+  changelog_uri: https://github.com/2pd/btcmarkets-ruby/blob/master/CHANGELOG.md
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for BTCMarkets public API
+test_files: []