virtex 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e6bcfd56ab2a8ed0d7f367edf108259c918a81d
+  data.tar.gz: c130f2bf7700dfceb4c75c2b51df44182dd5e552
+SHA512:
+  metadata.gz: 087bbe40855dbb163e225df97cb6322e581ef26365a377cbef08b6e827caa2afcd6612457988c39d4e4b5859865e6958398423559a6f1adea4ce271c19158a0f
+  data.tar.gz: 80b7c8c511305af4e44c2bf46335e325aba668364323cfd821ce7c1988b35c7e01e6055de2f0b52da3317797d7dbc18f5b2ae78794d1af38783223d697999ee3

data/.gitignore

@@ -0,0 +1,49 @@
+*.gem
+*.rbc
+*.sw[m-p]
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.env

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ca_virtex.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Coinbase, Zaratan, aianus
+
+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,114 @@
+Virtex
+==========
+
+A thin wrapper around the CaVirtex API
+
+## Usage
+
+See the CaVirtex API docs and source code for more information
+
+### Unauthenticated requests
+
+``` ruby
+require 'virtex'
+@virtex = Virtex::Client.new
+```
+
+#### Orderbook
+
+```ruby
+book = @virtex.orderbook('BTCCAD').orderbook
+
+best_bid = book.bids.first
+expect(best_bid[0]).to eq(631.481850000) # Price
+expect(best_bid[1]).to eq(1.367900000) # Size
+
+best_ask = asks.last
+expect(best_ask[0]).to eq(634.974840000)
+expect(best_ask[1]).to eq(9.727400000)
+```
+
+#### Tradebook
+
+```ruby
+trades = @virtex.tradebook('BTCCAD').trades
+latest = trades.first
+```
+
+#### Ticker
+
+```ruby
+ticker = @virtex.ticker("BTCCAD").ticker.BTCCAD
+```
+
+### Authenticated requests
+
+```ruby
+require 'virtex'
+@virtex = Virtex::Client.new(ENV['VIRTEX_API_KEY'], ENV['VIRTEX_API_SECRET'])
+```
+
+#### View Balance
+
+```ruby
+expect(@virtex.balance.balance.CAD).to eq(0.0385)
+```
+
+#### View Transactions
+
+
+```ruby
+transactions = @virtex.transactions("BTC").transactions
+```
+
+#### View trades
+
+```ruby
+recent_trades = @virtex.trades.trades
+```
+
+#### View orders
+
+```ruby
+recent_orders = @virtex.orders.orders
+```
+
+#### Place an order
+
+```ruby
+# Place a new order to sell 0.1 BTC/CAD at 1000.00
+new_order = @virtex.new_order!('sell', 0.1, 'BTCCAD', 1000.00).order
+```
+
+#### Cancel an order
+
+```ruby
+@virtex.cancel_order! 543468
+```
+
+#### Withdraw to an external wallet
+
+```ruby
+withdrawal = @virtex.withdraw!(0.01, 'BTC', '1DWYffTxhXgBtbswMjNViw9nNCvx3Drpvn').result
+```
+
+## Testing
+
+If you'd like to contribute code or modify this gem, you can run the test suite with:
+
+```ruby
+gem install virtex --dev
+bundle exec rspec
+```
+
+## Contributing
+
+1. Fork this repo and make changes in your own copy
+2. Add a test if applicable and run the existing tests with `rspec` to make sure they pass
+3. Commit your changes and push to your fork `git push origin master`
+4. Create a new pull request and submit it back to me
+
+## Credits
+
+Thanks to @Skizzk for providing an example of correctly authenticating with Virtex
+Thanks to @barmstrong on whose coinbase gem I based this library

data/lib/virtex/client.rb

@@ -0,0 +1,145 @@
+require 'httparty'
+require 'hashie'
+
+module Virtex
+  class Client
+    include HTTParty
+
+    # From 0.000000001 to 10,000,000
+    VIRTEX_SIGNIFICANT_DIGITS = 16
+    BASE_URI = 'https://cavirtex.com/api2'
+
+    def initialize(api_key=nil, api_secret=nil, options={})
+      @api_key = api_key
+      @api_secret = api_secret
+
+      # defaults
+      options[:base_uri] ||= BASE_URI
+      @base_uri = options[:base_uri]
+      options.each do |k,v|
+        self.class.send k, v
+      end
+    end
+
+    # Unauthenticated
+
+    def orderbook currencypair
+      do_request '/orderbook.json', { get: { 'currencypair' => currencypair } }
+    end
+
+    def tradebook currencypair, opts = {}
+      params = {
+        'currencypair' => currencypair
+      }.merge(opts)
+      do_request '/trades.json', { get: params }
+    end
+
+    def ticker currencypair
+      do_request '/ticker.json', { get: { 'currencypair' => currencypair } }
+    end
+
+    # Authenticated
+
+    def balance
+      do_request '/user/balance.json'
+    end
+
+    def orders opts = {}
+      do_request '/user/orders.json', { post: opts }
+    end
+
+    def trades opts = {}
+      do_request '/user/trades.json', { post: opts }
+    end
+
+    def transactions currency, opts = {}
+      params = {
+        'currency' => currency
+      }.merge(opts)
+
+      do_request '/user/transactions.json', { post: params }
+    end
+
+    def new_order! mode, amount, currencypair, price, opts = {}
+      params = {
+        'mode' => mode,
+        'amount' => amount,
+        'price' => price,
+        'currencypair' => currencypair
+      }.merge(opts)
+
+      do_request '/user/order.json', { post: params }
+    end
+
+    def cancel_order! id
+      do_request '/user/order_cancel.json', { post: { 'id' => id } }
+    end
+
+    def withdraw! amount, currency, address
+      params = {
+        'amount'   => amount,
+        'currency' => currency,
+        'address'  => address
+      }
+      do_request '/user/withdraw.json', { post: params }
+    end
+
+  protected
+
+    def generate_api_signature(endpoint, nonce, params)
+      # Alphabetically sorted post parameters for signature
+      data = ""
+      params.keys.sort.each do |k|
+        data += params[k].to_s
+      end
+
+      digest = OpenSSL::Digest.new('sha256')
+      OpenSSL::HMAC.hexdigest(digest, @api_secret, nonce.to_s + @api_key + '/api2' + endpoint + data)
+    end
+
+    def do_request(path, options={})
+      options[:get] ||= {}
+      options[:post] ||= {}
+
+      path = "#{path}?#{URI.encode_www_form(options[:get])}" if !options[:get].empty?
+
+      nonce = options[:nonce] || (Time.now.to_f * 1e6).to_i
+
+      if (@api_key && @api_secret)
+        auth_params = {
+          token: @api_key,
+          nonce: nonce,
+          signature: generate_api_signature(path, nonce, options[:post])
+        }
+      else
+        auth_params = {}
+      end
+
+      r = self.class.post(path, body: options[:post].merge(auth_params))
+
+      case r.code
+      when 504
+        raise TimeoutError, "Gateway timeout, please try again later"
+      when 500..600
+        raise ServerError, "Server error: (#{r.code})"
+      when 401
+        raise UnauthorizedError
+      when 404
+        raise NotFoundError
+      end
+
+#      Virtex API is incorrectly returning text/html so ignore this for now
+#      if !r.headers['content-type'].downcase.include? 'json'
+#        raise Error, "Unrecognized content type #{r.headers['content-type']}"
+#      end
+
+      hash = Hashie::Mash.new(JSON.parse(r.body))
+
+      if hash.status == "error"
+        raise Error, hash.message
+      end
+
+      hash
+    end
+  end
+end

data/lib/virtex/exception.rb

@@ -0,0 +1,7 @@
+module Virtex
+  class Error < StandardError; end
+  class ServerError < Error; end
+  class TimeoutError < ServerError; end
+  class UnauthorizedError < Error; end
+  class NotFoundError < Error; end
+end

data/lib/virtex/version.rb

@@ -0,0 +1,3 @@
+module Virtex
+  VERSION = '1.0.0'
+end

data/lib/virtex.rb

@@ -0,0 +1,3 @@
+require 'virtex/version'
+require 'virtex/exception'
+require 'virtex/client'

data/spec/fixtures/vcr_cassettes/virtex_authenticated_cassette.yml

@@ -0,0 +1,309 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://cavirtex.com/api2/user/balance.json
+    body:
+      encoding: UTF-8
+      string: token=bzv6qarmw4nocmz4wdtmm5tukn9nvng1&nonce=1407048082998318&signature=7a0e066b06a62cfc5189d20afb1ba1d1d2ab06e1db8914f71fd24eb6370cf3ea
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Sun, 03 Aug 2014 06:41:25 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=dc7ab4725531c12e9342d61d2b41188661407048084643; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.cavirtex.com; HttpOnly
+      - sessionid=bb9c19c9b945eedf31d2cc30f2fc98c5; expires=Sun, 03-Aug-2014 10:41:22
+        GMT; httponly; Max-Age=14400; Path=/; secure
+      Last-Modified:
+      - Sun, 03 Aug 2014 06:41:22 GMT
+      Expires:
+      - Sun, 03 Aug 2014 06:41:22 GMT
+      Vary:
+      - Cookie,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Cf-Ray:
+      - 15408780dc6f0bc9-HKG
+    body:
+      encoding: UTF-8
+      string: '{"status": "ok", "apirate": 2, "message": "", "balance": {"LTC": 0,
+        "BTC": 0E-9, "CAD": 0.038500000}}'
+    http_version:
+  recorded_at: Sun, 03 Aug 2014 06:41:25 GMT
+- request:
+    method: post
+    uri: https://cavirtex.com/api2/user/transactions.json
+    body:
+      encoding: UTF-8
+      string: currency=BTC&token=bzv6qarmw4nocmz4wdtmm5tukn9nvng1&nonce=1407052130701530&signature=5447d0703224ceaae6618465dbac7b694185179de000d40752061b708d3e0b0f
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Sun, 03 Aug 2014 07:48:56 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d7f2a4cf67af77489e4c4089d2a7d676c1407052136485; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.cavirtex.com; HttpOnly
+      - sessionid=7e590153f8b43b30106637b785912858; expires=Sun, 03-Aug-2014 11:48:53
+        GMT; httponly; Max-Age=14400; Path=/; secure
+      Last-Modified:
+      - Sun, 03 Aug 2014 07:48:53 GMT
+      Expires:
+      - Sun, 03 Aug 2014 07:48:53 GMT
+      Vary:
+      - Cookie,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Cf-Ray:
+      - 1540ea6d056b052e-YYZ
+    body:
+      encoding: UTF-8
+      string: '{"status": "ok", "apirate": 1, "message": "", "transactions": [{"currency":
+        "BTC", "reason": "deposit", "total": 0.171200000, "id": 2355387, "processed":
+        1407051921}]}'
+    http_version:
+  recorded_at: Sun, 03 Aug 2014 07:48:57 GMT
+- request:
+    method: post
+    uri: https://cavirtex.com/api2/user/order.json
+    body:
+      encoding: UTF-8
+      string: mode=sell&amount=0.1&price=1000.0&currencypair=BTCCAD&token=bzv6qarmw4nocmz4wdtmm5tukn9nvng1&nonce=1407052399159746&signature=e2d4462cf29ce4d0e4e9122cf81272e9b9fa71723d3e79b8d00fa8e0f27f2fa1
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Sun, 03 Aug 2014 07:53:31 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=dc5cbe10953670130feb2e5570d7985cb1407052410931; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.cavirtex.com; HttpOnly
+      - sessionid=36cf235cfaa9581cb7b0eb72e024e3f1; expires=Sun, 03-Aug-2014 11:53:28
+        GMT; httponly; Max-Age=14400; Path=/; secure
+      Last-Modified:
+      - Sun, 03 Aug 2014 07:53:28 GMT
+      Expires:
+      - Sun, 03 Aug 2014 07:53:28 GMT
+      Vary:
+      - Cookie,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Cf-Ray:
+      - 1540f1205e4d0528-YYZ
+    body:
+      encoding: UTF-8
+      string: '{"status": "ok", "apirate": 2, "message": "", "order": {"status": "open",
+        "id": 543468}}'
+    http_version:
+  recorded_at: Sun, 03 Aug 2014 07:53:32 GMT
+- request:
+    method: post
+    uri: https://cavirtex.com/api2/user/order_cancel.json
+    body:
+      encoding: UTF-8
+      string: id=543468&token=bzv6qarmw4nocmz4wdtmm5tukn9nvng1&nonce=1407052456858152&signature=cba571fea974418fea652ac6c698f241723d9aa7622fed906fd699e50f7e3da2
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Sun, 03 Aug 2014 07:54:29 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d6bc11d8c18572860ebd4624c89c4fa201407052462131; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.cavirtex.com; HttpOnly
+      - sessionid=7b5cc98aab3b9f1e91b73b2ed3412d6b; expires=Sun, 03-Aug-2014 11:54:26
+        GMT; httponly; Max-Age=14400; Path=/; secure
+      Last-Modified:
+      - Sun, 03 Aug 2014 07:54:26 GMT
+      Expires:
+      - Sun, 03 Aug 2014 07:54:26 GMT
+      Vary:
+      - Cookie,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Cf-Ray:
+      - 1540f2605db1053a-YYZ
+    body:
+      encoding: UTF-8
+      string: '{"status": "ok", "apirate": 3, "message": "", "id": 543468}'
+    http_version:
+  recorded_at: Sun, 03 Aug 2014 07:54:30 GMT
+- request:
+    method: post
+    uri: https://cavirtex.com/api2/user/orders.json
+    body:
+      encoding: UTF-8
+      string: token=bzv6qarmw4nocmz4wdtmm5tukn9nvng1&nonce=1407052609966936&signature=8e6296434a8ec0b31a867a346d0e842ab774eec4a9d474d9a96a92b81ce1def8
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Sun, 03 Aug 2014 07:56:53 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=dbcf42e9c89809e7b5236b0bc4217fe211407052613068; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.cavirtex.com; HttpOnly
+      - sessionid=ba85c15f4af23edd5598e55e49cbd932; expires=Sun, 03-Aug-2014 11:56:50
+        GMT; httponly; Max-Age=14400; Path=/; secure
+      Last-Modified:
+      - Sun, 03 Aug 2014 07:56:50 GMT
+      Expires:
+      - Sun, 03 Aug 2014 07:56:50 GMT
+      Vary:
+      - Cookie,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Cf-Ray:
+      - 1540f60fafe40528-YYZ
+    body:
+      encoding: UTF-8
+      string: '{"status": "ok", "apirate": 4, "message": "", "orders": [{"status":
+        "canceled", "requested": 1000.000000000, "created": 1407052408, "price": 1000.000000000,
+        "completed": 1407052466, "remaining": 0.100000000, "currency": "BTC", "amount":
+        0.100000000, "mode": "sell", "id": 543468, "with_currency": "CAD"}]}'
+    http_version:
+  recorded_at: Sun, 03 Aug 2014 07:56:53 GMT
+- request:
+    method: post
+    uri: https://cavirtex.com/api2/user/trades.json
+    body:
+      encoding: UTF-8
+      string: token=bzv6qarmw4nocmz4wdtmm5tukn9nvng1&nonce=1407053048063873&signature=44b24561c9314e0a34135df2fb41795d64d5723748fa86cc7f45f76b31c87747
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Sun, 03 Aug 2014 08:04:14 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=db50882cf5c3a616bff9d5deb0672afaf1407053053643; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.cavirtex.com; HttpOnly
+      - sessionid=81e192d540510a5b0d44ae6ed03dbe89; expires=Sun, 03-Aug-2014 12:04:10
+        GMT; httponly; Max-Age=14400; Path=/; secure
+      Last-Modified:
+      - Sun, 03 Aug 2014 08:04:10 GMT
+      Expires:
+      - Sun, 03 Aug 2014 08:04:10 GMT
+      Vary:
+      - Cookie,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Cf-Ray:
+      - 154100d14146052e-YYZ
+    body:
+      encoding: UTF-8
+      string: '{"status": "ok", "apirate": 4, "message": "", "trades": [{"rate": 632.071010000,
+        "for_currency_amount": 0.632000000, "trade_currency_amount": 0.001000000,
+        "date": 1407053027.0, "amount": 0.632000000, "price": 0.00158, "oid": 543503,
+        "id": 202617, "trade_currency": "BTC", "for_currency": "CAD"}]}'
+    http_version:
+  recorded_at: Sun, 03 Aug 2014 08:04:14 GMT
+- request:
+    method: post
+    uri: https://cavirtex.com/api2/user/withdraw.json
+    body:
+      encoding: UTF-8
+      string: amount=0.01&currency=BTC&address=1DWYffTxhXgBtbswMjNViw9nNCvx3Drpvn&token=bzv6qarmw4nocmz4wdtmm5tukn9nvng1&nonce=1407053975001896&signature=7682f10e1bfd901e42f162610aeb61ae9aa3105e977f36526b879b5767a540a3
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Sun, 03 Aug 2014 08:19:57 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d01b57ddf0eafb2511009b744d612b7691407053978507; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.cavirtex.com; HttpOnly
+      - sessionid=f4b9ba0eb85734a1869569270590da3a; expires=Sun, 03-Aug-2014 12:19:54
+        GMT; httponly; Max-Age=14400; Path=/; secure
+      Last-Modified:
+      - Sun, 03 Aug 2014 08:19:54 GMT
+      Expires:
+      - Sun, 03 Aug 2014 08:19:54 GMT
+      Vary:
+      - Cookie,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Cf-Ray:
+      - 15411765ac250528-YYZ
+    body:
+      encoding: UTF-8
+      string: '{"status": "ok", "apirate": 2, "message": "", "result": {"currency":
+        "BTC", "reason": "withdrawal", "fee": 0, "user": "aianus", "wallet": "1DWYffTxhXgBtbswMjNViw9nNCvx3Drpvn",
+        "withdrawalfee": -0.0005, "amount": -0.01, "publictransactionid": "1592b009ebeb1bdc2b53a0ffe1a2ae7a56ef4fe011f235a14fa1d7ba085b3c8a"}}'
+    http_version:
+  recorded_at: Sun, 03 Aug 2014 08:19:58 GMT
+recorded_with: VCR 2.9.2