mexbt-transfer-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a28e39628022d32ddc4e0faa6ec20145813afc6
+  data.tar.gz: d2ec9b0aa7e33fc6b6382f64f6c2df9eaa9f23ad
+SHA512:
+  metadata.gz: 7cb4bd82e69e2fe21d937cafdfcf762a22a329ddc489f8a14ca3ff063d2d94840e5519a4368b88212771bfa68417f8a7bd5d9056827b60e3d48ca57fa1b533e3
+  data.tar.gz: 787ea49e4d206e602d6004eca6f7bfe7a4eca0dff68c3807358d749f4e123d20161ae8528b3e2a14bec17330808b779ad5af3145c0c88dbbb4e558dd6a7d5235

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Exchange of the Americas SAPI de CV
+
+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,37 @@
+# Mexbt Transfer API Ruby client
+
+This is a lightweight ruby client for the [meXBT](https://mexbt.com) Transfer 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 'mexbt-transfer-api'
+
+And run `bundle install` of course.
+
+## Ruby version
+
+You need to be using Ruby 2.1 or higher.
+
+
+## Setting up a client
+
+    api = Mexbt::TransferApi.new("your-api-key", "your-api-key", your_client_id)
+
+If you want to work against another endpoint, you can configure that like:
+
+    api = Mexbt::TransferApi.new("your-api-key", "your-api-key", your_client_id, endpoint: "https://transfer-staging.mexbt.com/v1")
+
+## Checking api is up and you can authenticate ok
+
+    api.ping()
+
+## Creating orders
+
+    api.create_order(in_currency: 'btc', out_currency: 'mxn', out_via: 'atm', out_amount: 100, webhook: 'http://your.domain/hook')
+
+## Fetching an order
+
+    api.get_order(1)

data/Rakefile

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

data/lib/mexbt_transfer_api/version.rb

@@ -0,0 +1,5 @@
+module Mexbt
+  class TransferApi
+    CLIENT_VERSION = "0.0.1"
+  end
+end

data/lib/mexbt_transfer_api.rb

@@ -0,0 +1,74 @@
+require 'rest_client'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'json'
+
+module Mexbt
+  class TransferApi
+    DEFAULT_ENDPOINT = "https://transfer.mexbt.com/v1"
+    SSL_VERSION = :TLSv1_2
+
+    def initialize(api_key, api_secret, client_id, endpoint: DEFAULT_ENDPOINT)
+      @api_key = api_key
+      @api_secret = api_secret
+      @client_id = client_id
+      @endpoint = endpoint
+    end
+
+    def create_order(in_currency:, out_currency:, out_via:, webhook:, in_amount: 0, out_amount: 0, sender_info: {}, recipient_info: {})
+      params = {
+        in_currency: in_currency,
+        out_currency: out_currency,
+        out_via: out_via,
+        webhook: webhook,
+        sender_info: sender_info,
+        recipient_info: recipient_info
+      }
+      if in_amount > 0
+        params[:in] = in_amount
+      elsif out_amount > 0
+        params[:out] = out_amount
+      else
+        raise "You must specify a value for either in or out"
+      end
+      call("/orders", params)
+    end
+
+    def get_order(id)
+      call("/orders/#{id}")
+    end
+
+    def ping
+      call("/ping")
+    end
+
+    private
+
+    def url(path)
+      "#{@endpoint}#{path}"
+    end
+
+    def call(path, params={})
+      url = url(path)
+      params.merge!(auth_params)
+      res = RestClient::Request.execute(method: :post, url: url, payload: params.to_json, ssl_version: SSL_VERSION, headers: { content_type: :json, accept: :json }) do |response, request, result|
+        case response.code
+        when 200, 400
+          response
+        else
+          response.return!(request, result)
+        end
+      end
+      ActiveSupport::HashWithIndifferentAccess.new(JSON.parse(res))
+    end
+
+    def auth_params
+      nonce = (Time.now.to_f*10000).to_i
+      {
+        api_key: @api_key,
+        nonce: nonce,
+        signature: OpenSSL::HMAC.hexdigest('sha512', @api_secret, "#{nonce}#{@client_id}#{@api_key}").upcase
+      }
+    end
+
+  end
+end

data/mexbt_transfer_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mexbt_transfer_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mexbt-transfer-api"
+  spec.description   = "A lightweight ruby client for the meXBT Transfer API"
+  spec.version       = Mexbt::TransferApi::CLIENT_VERSION
+  spec.authors       = ["williamcoates"]
+  spec.email         = ["william@mexbt.com"]
+  spec.summary       = %q{meXBT Transfer API client}
+  spec.homepage      = "https://github.com/meXBT/transfer-api-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_runtime_dependency "activesupport", ["~> 4.1.8"]
+  spec.add_runtime_dependency "rest_client", ["= 1.8.2"]
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+end

data/spec/cassettes/Mexbt_TransferApi/creating_orders/allows_creating_a_btc_-_mxn_transfer_order_for_5000_pesos_cashed_out_via_ATM.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/v1/orders
+    body:
+      encoding: UTF-8
+      string: '{"in_currency":"btc","out_currency":"mxn","out_via":"atm","webhook":"http://requestb.in/11rzly71","sender_info":{},"recipient_info":{},"out":5000,"api_key":"e22a52802d6db99d524f51a93a413536","nonce":14189157550507,"signature":"94C7D4D1E024E178D955D63ED4536D19177A69AFE1106D0FEC956590DFB02891C7347D85F60960EDF9D9CA295CFA90A88EA455F3B28FD571914FED3CDCB35FE4"}'
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '357'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: 'OK '
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"e00e97c34919a5c1de7a0f64c8137a55"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 36dd8164-5eac-4e83-93f6-5484b149e9c1
+      X-Runtime:
+      - '1.763409'
+      Server:
+      - WEBrick/1.3.1 (Ruby/2.1.2/2014-05-08)
+      Date:
+      - Thu, 18 Dec 2014 15:15:56 GMT
+      Content-Length:
+      - '341'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: '{"id":6,"in":{"currency":"btc","amount":1.15173726},"out":{"currency":"mxn","amount":5000.0},"out_via":"atm","sender_info":null,"recipient_info":null,"withdraw_info":null,"quote_valid_until":1418916655,"deposit_info":{"address":"ByNafb7C39BB7JqdkSVFUPzJoGsumUA4ks"},"webhook":"http://requestb.in/11rzly71","confirmations":0,"status":"quote"}'
+    http_version: 
+  recorded_at: Thu, 18 Dec 2014 15:15:56 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/Mexbt_TransferApi/ping/returns_a_200_response_if_authentication_successful.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/v1/ping
+    body:
+      encoding: UTF-8
+      string: '{"api_key":"e22a52802d6db99d524f51a93a413536","nonce":14189139204916,"signature":"B50005D7C66BD97C4E0CC53B11D234D42DA9CF98E30D52553602B3DC8B0F5B0A1BBA73E35D65B63CB273D584F4DBC552ADAAE981D75DC4C1A3E6AAD4EA42A88B"}'
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '212'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: 'OK '
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"82380d1e263b6093f3c7535690fcdd75"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 68e4ae20-94ef-4e83-9d7e-4167e795859e
+      X-Runtime:
+      - '0.033339'
+      Server:
+      - WEBrick/1.3.1 (Ruby/2.1.2/2014-05-08)
+      Date:
+      - Thu, 18 Dec 2014 14:45:20 GMT
+      Content-Length:
+      - '11'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":true}'
+    http_version: 
+  recorded_at: Thu, 18 Dec 2014 14:45:20 GMT
+recorded_with: VCR 2.9.3

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'mexbt_transfer_api'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+  config.order = :random
+end

data/spec/transfer_api_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Mexbt::TransferApi do
+
+  subject(:transfer_api) do
+    Mexbt::TransferApi.new("e22a52802d6db99d524f51a93a413536", "3bf5501c8149958a3e2494e1f0f24f5a71a52a80248198bf0f1c6570fc89e095", 1, endpoint: "http://localhost:3000/v1")
+  end
+
+  context "ping", :vcr do
+    it "returns a 200 response if authentication successful" do
+      expect(transfer_api.ping).to eql({ "ok" => true })
+    end
+  end
+
+  context "creating orders", :vcr do
+    it "allows creating a btc -> mxn transfer order for 5000 pesos, cashed out via ATM" do
+      res = transfer_api.create_order(in_currency: 'btc', out_currency: 'mxn', out_amount: 5000, out_via: 'atm', webhook: 'http://requestb.in/11rzly71')
+      expect(res).to eql({
+        "id"=>6,
+        "in"=>{"currency"=>"btc", "amount"=>1.15173726},
+        "out"=>{"currency"=>"mxn", "amount"=>5000.0},
+        "out_via"=>"atm",
+        "sender_info"=>nil,
+        "recipient_info"=>nil,
+        "withdraw_info"=>nil,
+        "quote_valid_until"=>1418916655,
+        "deposit_info"=>{"address"=>"ByNafb7C39BB7JqdkSVFUPzJoGsumUA4ks"},
+        "webhook"=>"http://requestb.in/11rzly71",
+        "confirmations"=>0,
+        "status"=>"quote"
+      })
+    end
+  end
+
+  context "getting orders" do
+    # TODO
+    it "allows you to fetch orders you own"
+
+  end
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: mexbt-transfer-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- williamcoates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: A lightweight ruby client for the meXBT Transfer API
+email:
+- william@mexbt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mexbt_transfer_api.rb
+- lib/mexbt_transfer_api/version.rb
+- mexbt_transfer_api.gemspec
+- spec/cassettes/Mexbt_TransferApi/creating_orders/allows_creating_a_btc_-_mxn_transfer_order_for_5000_pesos_cashed_out_via_ATM.yml
+- spec/cassettes/Mexbt_TransferApi/ping/returns_a_200_response_if_authentication_successful.yml
+- spec/spec_helper.rb
+- spec/transfer_api_spec.rb
+homepage: https://github.com/meXBT/transfer-api-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 Transfer API client
+test_files:
+- spec/cassettes/Mexbt_TransferApi/creating_orders/allows_creating_a_btc_-_mxn_transfer_order_for_5000_pesos_cashed_out_via_ATM.yml
+- spec/cassettes/Mexbt_TransferApi/ping/returns_a_200_response_if_authentication_successful.yml
+- spec/spec_helper.rb
+- spec/transfer_api_spec.rb