mexbt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 604151fdb300fb326b4d2a366c034c6206a31bf6
+  data.tar.gz: 7d51e7ad2280adbf0278676b21a65e7f4327161e
+SHA512:
+  metadata.gz: 07d0a969677141a08628aa1dd8d7882781732cb1a40a1647cfb7ca7fef5971537793b124cc7c75eef605e39e4d070f9139380f8f38def1d3b86c5c4fde4980a1
+  data.tar.gz: ac7c77ca0b95104da901b6ee3031f5fc81acc7b18b9de67397925f796ac2cf52e4ec7b478e23a95ae7089067f32b1d8c98822f2e2629274751b906153c65114d

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+gem "activesupport"
+gem "rest_client"
+
+group :test do
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    mexbt (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    i18n (0.6.11)
+    json (1.8.1)
+    minitest (5.4.3)
+    netrc (0.7.9)
+    rake (10.3.2)
+    rest_client (1.8.2)
+      netrc (~> 0.7.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.6)
+  mexbt!
+  rake
+  rest_client
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 williamcoates
+
+MIT License
+
+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,80 @@
+# Mexbt ruby API client
+
+This is a lightweight ruby client for the Mexbt exchange API. It doesn't try and do anything clever with the JSON response from the API, it simply
+returns it as-is.
+
+# Install
+
+If using bundler simply this to your Gemfile:
+
+    gem 'bitstamp'
+
+And run `bundle install` of course.
+
+# Ruby version
+
+You need to be using Ruby 2.1 or higher.
+
+# Public API
+
+You can access all the Public API functions with zero configuration. By default they will use the 'BTCMXN' currency pair.
+
+    Mexbt.ticker
+    Mexbt.order_book
+    Mexbt.trades(start_index: -1, count: 20)
+    Mexbt.trades_by_date(from: Date.civil(2014, 11, 1).to_time.to_i, to: Date.today.to_time.to_i)
+
+If you want to choose another currency pair, you can configure it for all calls:
+
+    Mexbt.configure { |c| c.currency_pair: 'BTCUSD' }
+
+Or alternatively you can set it per call:
+
+    Mexbt.ticker(currency_pair: 'BTCUSD')
+
+# Private API
+
+
+## Configuration
+
+You need to generate an API key pair at https://mexbt.com/api/keys. However if you want to get started quickly we recommend having a play in the sandbox first, see the 'Sandbox' section below.
+
+  Mexbt.configure do |c|
+    mexbt.public_key = "xxx"
+        mexbt.private_key = "yyy"
+        mexbt.user_id = "email@test.com" # Your registered email address
+        mexbt.sandbox = true # Set this to true to use the sandbox
+  end
+
+## Order functions
+
+  Mexbt::Orders.create(amount: 0.1, currency_pair: 'btcmxn') # Create a market buy order for 0.1 BTC for Pesos
+  Mexbt::Orders.create(amount: 2, side: :sell, currency_pair: 'btcusd') # Create a market order to sell 2 BTC for USD
+  Mexbt::Orders.create(amount: 2, price: 1, side: :buy, type: :limit, currency_pair: 'ltcmxn') # Create a limit order to buy 2 LTC for 1 peso
+  Mexbt::Orders.cancel(id: 123, currency_pair: 'btcmxn')
+  Mexbt::Orders.cancel_all() # Cancel all orders for the default currency pair
+
+## Account functions
+
+  Mexbt::Account.balance
+  Mexbt::Account.trades
+  Mexbt::Account.orders
+  Mexbt::Account.deposit_addresses
+  Mexbt::Account.withdraw(amount: 1, currency: :btc, address: 'xxx')  Mexbt::Account.info # Fetches your user info
+
+## Sandbox
+
+It's a good idea to first play with the API in the sandbox, that way you don't need any real money to start trading with the API. Just make sure you configure `sandbox = true`.
+
+You can register a sandbox account at https://sandbox.mexbt.com/en/register. It will ask you to validate your email but there is no need, you can login right away at https://sandbox.mexbt.com/en/login. Now you can setup your API keys at https://sandbox.mexbt.com/en/api/keys.
+
+Your sandbox account will automatically have a bunch of cash to play with.
+
+# API documentation
+
+You can find API docs for the Public API at http://docs.mexbtpublicapi.apiary.io
+
+API docs for the Private API are at http://docs.mexbtprivateapi.apiary.io
+
+There are also docs for the Private API sandbox at http://docs.mexbtprivateapisandbox.apiary.io
+

data/Rakefile

@@ -0,0 +1,5 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/lib/mexbt/account.rb

@@ -0,0 +1,19 @@
+require 'mexbt/private'
+require 'mexbt/common'
+
+module Mexbt
+  module Account
+    include Mexbt::Private
+    include Mexbt::Common
+
+    %w{info balance orders deposit_addresses}.each do |m|
+      define_method(m) do
+        call(m == 'info' ? 'me' : m.dasherize)
+      end
+    end
+
+    def withdraw(amount:, address:, currency: :btc)
+      call("withdraw", { ins: currency, amount: amount, sentToAddress: address })
+    end
+  end
+end

data/lib/mexbt/client.rb

@@ -0,0 +1,36 @@
+require 'rest_client'
+
+module Mexbt
+  module Client
+    include RestClient
+    SSL_VERSION = :TLSv1_2
+
+    def url(path)
+      "#{endpoint()}/v1/#{path}"
+    end
+
+    def auth_params
+      nonce = (Time.now.to_f*10000).to_i
+      {
+        apiKey: Mexbt.public_key,
+        apiNonce: nonce,
+        apiSig: OpenSSL::HMAC.hexdigest('sha256', Mexbt.private_key, "#{nonce}#{Mexbt.user_id}#{Mexbt.public_key}").upcase
+      }
+    end
+
+    def call(path, params={})
+      payload = params
+      params.merge!(auth_params) if self.respond_to?(:private?)
+      res = Request.execute(method: :post, url: url(path), payload: payload.to_json, ssl_version: SSL_VERSION)
+      if res.length === 0
+        raise "Empty response from API"
+      end
+      json_response = JSON.parse(res)
+      if json_response["isAccepted"]
+        json_response
+      else
+        raise json_response["rejectReason"]
+      end
+    end
+  end
+end

data/lib/mexbt/common.rb

@@ -0,0 +1,7 @@
+module Mexbt
+  module Common
+    def trades(currency_pair: Mexbt.currency_pair, start_index: -1, count: 10)
+      call("trades", { ins: currency_pair, startIndex: start_index, count: count })
+    end
+  end
+end

data/lib/mexbt/orders.rb

@@ -0,0 +1,49 @@
+require 'mexbt/private'
+
+module Mexbt
+  module Orders
+    include Mexbt::Private
+
+    def create(amount:, price: nil, currency_pair: Mexbt.currency_pair, side: :buy, type: :market)
+      type =
+        case type
+        when :market, 1
+          1
+        when :limit, 0
+          0
+        else
+          raise "Unknown order type '#{type}'"
+        end
+      params = {
+        ins: currency_pair,
+        side: side,
+        orderType: type,
+        qty: amount,
+        sessionToken: "c545f765-ce47-4ea5-b206-a9ac0db55fc3"
+      }
+      params[:px] = price if price
+      call("orders/create", params)
+    end
+
+    def cancel(id:, currency_pair: Mexbt.currency_pair)
+      call("orders/cancel", { ins: currency_pair, serverOrderId: id })
+    end
+
+    def cancel_all(currency_pair: Mexbt.currency_pair)
+      call("orders/cancel-all", { ins: currency_pair } )
+    end
+
+    def modify(id:, action:, currency_pair: Mexbt.currency_pair)
+      action =
+        case action
+        when :move_to_top, 0
+          0
+        when :execute_now, 1
+          1
+        else
+          raise "Action must be one of: :move_to_top, :execute_now"
+        end
+      call("orders/modify", { ins: currency_pair, serverOrderId: id, modifyAction: action } )
+    end
+  end
+end

data/lib/mexbt/private.rb

@@ -0,0 +1,16 @@
+require 'mexbt/client'
+
+
+module Mexbt
+  module Private
+    include Mexbt::Client
+
+    def private?
+      true
+    end
+
+    def endpoint
+      "https://private-api#{Mexbt.sandbox ? '-sandbox' : nil}.mexbt.com"
+    end
+  end
+end

data/lib/mexbt/public.rb

@@ -0,0 +1,33 @@
+require 'mexbt/client'
+require 'mexbt/common'
+
+module Mexbt
+  module Public
+    include Mexbt::Client
+    include Mexbt::Common
+
+    def endpoint
+      "https://public-api.mexbt.com"
+    end
+
+    def ticker(currency_pair: Mexbt.currency_pair)
+      call("ticker", { productPair: currency_pair })
+    end
+
+    def order_book(currency_pair: Mexbt.currency_pair)
+      call("order-book", { productPair: currency_pair })
+    end
+
+    alias :orders :order_book
+
+    def currency_pairs
+      call("product-pairs")
+    end
+
+    alias :product_pairs :currency_pairs
+
+    def trades_by_date(currency_pair: Mexbt.currency_pair, from:, to:)
+      call("trades-by-date", { ins: currency_pair, startDate: from, endDate: to })
+    end
+  end
+end

data/lib/mexbt/version.rb

@@ -0,0 +1,3 @@
+module Mexbt
+  VERSION = "0.0.1"
+end

data/lib/mexbt.rb

@@ -0,0 +1,30 @@
+require 'active_support/core_ext'
+require 'active_support/inflector'
+require 'mexbt/public'
+require 'mexbt/account'
+require 'mexbt/orders'
+
+module Mexbt
+  mattr_accessor :public_key
+  mattr_accessor :private_key
+  mattr_accessor :user_id
+  mattr_accessor :currency_pair
+  mattr_accessor :sandbox
+
+  @@currency_pair = :btcmxn
+
+  def self.configure
+    yield self
+  end
+
+  extend Mexbt::Public
+
+  module Account
+    extend Mexbt::Account
+  end
+
+  module Orders
+    extend Mexbt::Orders
+  end
+
+end

data/mexbt.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mexbt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mexbt"
+  spec.version       = Mexbt::VERSION
+  spec.authors       = ["williamcoates"]
+  spec.email         = ["william@mexbt.com"]
+  spec.summary       = %q{meXBT API client}
+  spec.homepage      = "https://github.com/meXBT/mexbt-ruby"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/private_api_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Mexbt::Private do
+
+  before do
+    Mexbt.configure do | mexbt |
+      mexbt.public_key = "1d039abd0e667a4e03767ddef11cb8d5"
+      mexbt.private_key = "0e5a8d04838fc43f0f4335c8a380f200"
+      mexbt.user_id = "test@mexbt.com"
+      mexbt.sandbox = true
+    end
+  end
+
+  context Mexbt::Account do
+
+    it "gives a valid response to all public api functions that require no args" do
+      %w{info balance orders deposit_addresses trades}.each do |f|
+        res = Mexbt::Account.send(f)
+        expect(res["isAccepted"]).to be true
+      end
+    end
+
+  end
+
+  context Mexbt::Orders do
+
+    it "allows creating market orders" do
+      res = Mexbt::Orders.create(amount: 0.1, currency_pair: "BTCUSD")
+      expect(res["isAccepted"]).to be true
+      expect(res["serverOrderId"]).to be_a(Fixnum)
+    end
+
+    it "allows creating limit orders" do
+      res = Mexbt::Orders.create(type: :limit, price: 100, amount: 0.1234, currency_pair: "BTCUSD")
+      expect(res["isAccepted"]).to be true
+      expect(res["serverOrderId"]).to be_a(Fixnum)
+    end
+
+    it "raises an exception if order type not recognised" do
+      expect { Mexbt::Orders.create(type: :boom, amount: 0.2) }.to raise_error("Unknown order type 'boom'")
+    end
+
+    context "modifying and cancelling orders" do
+
+      let(:order_id) {Mexbt::Orders.create(type: :limit, price: 100, amount: 0.1, currency_pair: "BTCUSD")["serverOrderId"]}
+
+      it "allows converting limit orders to market orders" do
+        res = Mexbt::Orders.modify(id: order_id, currency_pair: "BTCUSD", action: :execute_now)
+        expect(res["isAccepted"]).to be true
+      end
+
+      it "allows moving orders to the top of the book" do
+        res = Mexbt::Orders.modify(id: order_id, currency_pair: "BTCUSD", action: :move_to_top)
+        expect(res["isAccepted"]).to be true
+      end
+
+      it "allows cancelling individual orders" do
+        res = Mexbt::Orders.cancel(id: order_id, currency_pair: "BTCUSD")
+        expect(res["isAccepted"]).to be true
+        orders = Mexbt::Account.orders["openOrdersInfo"]
+        orders.each do |open_orders|
+          if open_orders["ins"] === "BTCUSD"
+            open_orders["openOrders"].each do |usd_order|
+              if usd_order["ServerOrderId"] === order_id
+                fail("Order was cancelled but still open")
+              end
+            end
+          end
+        end
+      end
+
+      it "allows cancelling all orders" do
+        res = Mexbt::Orders.cancel_all(currency_pair: "BTCUSD")
+        expect(res["isAccepted"]).to be true
+        orders = Mexbt::Account.orders["openOrdersInfo"]
+        orders.each do |open_orders|
+          if open_orders["ins"] === "BTCUSD"
+            expect(open_orders["openOrders"]).to eql([])
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/spec/public_api_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Mexbt do
+
+  it "gives a valid response to all public api functions that require no args" do
+    %w{ticker trades currency_pairs product_pairs orders order_book}.each do |f|
+      res = Mexbt.send(f)
+      expect(res["isAccepted"]).to be true
+    end
+  end
+
+  it "allows passing a custom currency pair to functions that accept it" do
+    %w{ticker trades orders order_book}.each do |f|
+      res = Mexbt.send(f, currency_pair: 'BTCUSD')
+      expect(res["isAccepted"]).to be true
+    end
+  end
+
+  it "allows you to fetch trades by date range" do
+    res = Mexbt.trades_by_date(from: Time.now.to_i, to: Time.now.to_i)
+    expect(res["isAccepted"]).to be true
+    expect(res["trades"]).to eql([])
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'mexbt'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+  config.order = :random
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: mexbt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- williamcoates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- william@mexbt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mexbt.rb
+- lib/mexbt/account.rb
+- lib/mexbt/client.rb
+- lib/mexbt/common.rb
+- lib/mexbt/orders.rb
+- lib/mexbt/private.rb
+- lib/mexbt/public.rb
+- lib/mexbt/version.rb
+- mexbt.gemspec
+- spec/private_api_spec.rb
+- spec/public_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/meXBT/mexbt-ruby
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: meXBT API client
+test_files:
+- spec/private_api_spec.rb
+- spec/public_api_spec.rb
+- spec/spec_helper.rb