btcmrb 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec8a35f05f35b27d7d6c10aaa3f27b2b22fe80d3
-  data.tar.gz: 9095913607024c41288bed9de7d8c7c8d90278a4
+  metadata.gz: c2566a4ef1fb0d3202c78ce8c47ffc2de7aaaeac
+  data.tar.gz: 4c73981d2d96c5fcdb12515b23407bdfd1a42e16
 SHA512:
-  metadata.gz: 58ad95b26dcca993dfc154ed03e881d34f433477ea4276992f96b226310053f52d6884a6933e7565665d9eefe6432dd8aae94b4d3ff99b0a87e0a94b4fcbe5c4
-  data.tar.gz: 0b1831011d8019326ed34db735f97f3f56ae4fe8345b7a4323c66fc272cc033494e81ac60b36bd0f908b85fb5fa8fefbec4f5f2dc9f548ac724a890cf113101b
+  metadata.gz: 4af5a8812bd5bb70875e0a85d0a53a930be60f4c7ac19f3273f3cdd9fe21759412ba3a2e67fffa7e09a3d55faede15c235e3be27302de9b30816470852262b81
+  data.tar.gz: 7a3fee908a4b72773d373ba0002b7e89393e5b06d677a581f8979448e9fda11e59ac6fbdd8489a2ef373fc5b6ef6ee1760914c02675052123a02578095f619df

data/README.md

@@ -1,12 +1,18 @@
-# BTCMarkets API Wrapper
+# Btcmrb (BTC Markets Ruby)
+
 
 ## Description
 Unofficial Ruby Gem for btcmarkets.net API and is still very much a work in progress.
 
 ## Installation
 ### Install the gem
-```sh
-gem install btcmrb
+Command line:
+```
+$ gem install btcmrb
+```
+Or in your application's Gemfile:
+```
+gem 'btcmrb', '~> 0.1.3'
 ```
 ### Create some environment variables
 https://btcmarkets.net/account/apikey
@@ -18,9 +24,8 @@ export BTCM_SECRET="YOUR SECRET"
 ### Account Management API
 https://github.com/BTCMarkets/API/wiki/Account-API
 ```ruby
-# Example
-balance_request = Btcmrb::Account.balance
 client = Btcmrb.new
+balance_request = Btcmrb::Account.balance
 client.send_request(balance_request)
 # => [{"balance":1000000000,"pendingFunds":0,"currency":"AUD"},{"balance":1000000000,"pendingFunds":0,"currency":"BTC"},{"balance":1000000000,"pendingFunds":0,"currency":"LTC"}]
 ```
@@ -28,21 +33,33 @@ client.send_request(balance_request)
 ### Market Data API
 https://github.com/BTCMarkets/API/wiki/Market-data-API
 ```ruby
-# Example
-ticker_request = Btcmrb::Marketdata.tick
 client = Btcmrb.new
+ticker_request = Btcmrb::Marketdata.tick
 client.send_request(ticker_request)
 # => {"bestBid":844.0,"bestAsk":844.98,"lastPrice":845.0,"currency":"AUD","instrument":"BTC","timestamp":1476242958,"volume24h":172.60804}
 
-orderbook_request = Btcmrb::Marketdata.orderbook
 client = Btcmrb.new
+orderbook_request = Btcmrb::Marketdata.orderbook
 client.send_request(orderbook_request)
 # => {"currency":"AUD","instrument":"BTC","timestamp":1476243360,"asks":[[844.98,0.45077821],[845.0,2.7069457],[848.68,2.58512],[848.76,0.29745]],"bids":[[844.0,0.00489636],[840.21,0.060724],[840.16,0.1180803],[840.1,0.32130103]]}
 
-trades_requst = Btcmrb::Marketdata.trades
 client = Btcmrb.new
+trades_requst = Btcmrb::Marketdata.trades
 client.send_request(trades_requst)
 # => [{"tid":4432702312,"amount":0.01959674,"price":845.0,"date":1378878093},{"tid":59861212129,"amount":1.21434000,"price":845.15,"date":1377840783}]
 ```
+
+### Trading API
+https://github.com/BTCMarkets/API/wiki/Trading-API
+```ruby
+client = Btcmrb.new
+all_orders = Btcmrb::Order.all
+# this one doesn't work yet, not sure why not - would you care to submit a pull request?
+client.send_request(all_orders)
+# => {"success":true,"errorCode":null,"errorMessage":null,"orders":[{"id":1003245675,"currency":"AUD","instrument":"BTC","orderSide":"Bid","ordertype":"Limit","creationTime":1378862733366,"status":"Placed","errorMessage":null,"price":13000000000,"volume":10000000,"openVolume":10000000,"clientRequestId":null,"trades":[]},{"id":4345675,"currency":"AUD","instrument":"BTC","orderSide":"Ask","ordertype":"Limit","creationTime":1378636912705,"status":"Fully Matched","errorMessage":null,"price":13000000000,"volume":10000000,"openVolume":0,"clientRequestId":null,"trades":[{"id":5345677,"creationTime":1378636913151,"description":null,"price":13000000000,"volume":10000000,"fee":100000}]}]}
+```
+
+
+
 ## License
 MIT - For terms refer to LICENSE.md

data/lib/btcmrb/client.rb

@@ -12,10 +12,7 @@ module Btcmrb
     BASE_URI              = 'https://api.btcmarkets.net'
     include HTTParty
 
-    attr_accessor :base_uri, :timestamp
-
     def initialize
-      @base_uri = BASE_URI
     end
 
     def send_request(object)
@@ -38,7 +35,8 @@ module Btcmrb
           { :method => object[:verb],
             :authentication => object[:auth],
             :timestamp => timestamp,
-            :encoded_signature => encoded_signature
+            :encoded_signature => encoded_signature,
+            :body => object[:body]
         })
       end
 
@@ -51,38 +49,39 @@ module Btcmrb
       end
 
       def format_request(options)
-        default = options[:uri] + "\n" + options[:timestamp] + "\n"
+        default = options[:uri] + "\n" + options[:timestamp] + "\n"#+ '{"currency":"AUD", "instrument":"BTC", "limit":"10"}'
         unless options[:body].empty?
-          default = primary + options[:body]
+          default = default + options[:body].to_json.to_s
         end
         default
       end
 
       def send(uri, options={})
         response = nil
-        default_headers = {
+        headers = {
           'Accept-Charset' => 'UTF-8',
           'Accept' => 'application/json',
           'Content-Type' => 'application/json',
           'User-Agent' => "BTCMRB Ruby Gem v#{Btcmrb::VERSION}"
         }
 
-        if options[:authentication] && options[:method] == "POST"
-          default_headers.merge!(
-            { 'apikey' => BTCM_ACCESS_KEY ,
-              'signature' => options[:encoded_signature],
-              'timestamp' => options[:timestamp]
+        if options[:authentication]
+          headers.merge!(
+          { 'apikey' => BTCM_ACCESS_KEY ,
+            'signature' => options[:encoded_signature],
+            'timestamp' => options[:timestamp]
             }).to_json
-            # TODO
+        end
+
+        if options[:authentication] && options[:method] == "POST"
+          HTTParty.post(BASE_URI + uri, :headers => headers, :body => options[:body].to_json)
+
         elsif options[:authentication] && options[:method] == "GET"
-          default_headers.merge!(
-            { 'apikey' => BTCM_ACCESS_KEY ,
-              'signature' => options[:encoded_signature],
-              'timestamp' => options[:timestamp]
-            }).to_json
-          HTTParty.get(BASE_URI + uri, headers: default_headers)
+          HTTParty.get(BASE_URI + uri, :headers => headers)
+
         else
-          response = HTTParty.get(BASE_URI + uri)
+          HTTParty.get(BASE_URI + uri)
+
         end
       end
 

data/lib/btcmrb/order.rb

@@ -0,0 +1,104 @@
+module Btcmrb
+  class Order
+
+    def self.all
+      # Documentation
+      # POST "/order/history"
+      # since parameter - an order id.
+      # {"currency":"AUD","instrument":"BTC","limit":10,"since":33434568724}
+      # {"success":true,"errorCode":null,"errorMessage":null,"orders":[{"id":1003245675,"currency":"AUD","instrument":"BTC","orderSide":"Bid","ordertype":"Limit","creationTime":1378862733366,"status":"Placed","errorMessage":null,"price":13000000000,"volume":10000000,"openVolume":10000000,"clientRequestId":null,"trades":[]},{"id":4345675,"currency":"AUD","instrument":"BTC","orderSide":"Ask","ordertype":"Limit","creationTime":1378636912705,"status":"Fully Matched","errorMessage":null,"price":13000000000,"volume":10000000,"openVolume":0,"clientRequestId":null,"trades":[{"id":5345677,"creationTime":1378636913151,"description":null,"price":13000000000,"volume":10000000,"fee":100000}]}]}
+
+
+      # Implementation
+      {
+        :uri => "/order/history",
+        :body => {:currency => "AUD", :instrument => "BTC", :limit => 10},
+        :verb => "POST",
+        :auth => true
+      }
+    end
+
+    # Similar to Index, but only returns open orders
+    def open
+      # Documentation
+      # POST "/order/open"
+      # {"currency":"AUD","instrument":"BTC","limit":10,"since":33434568724}
+      # {"success":true,"errorCode":null,"errorMessage":null,"orders":[{"id":1003245675,"currency":"AUD","instrument":"BTC","orderSide":"Bid","ordertype":"Limit","creationTime":1378862733366,"status":"Placed","errorMessage":null,"price":13000000000,"volume":10000000,"openVolume":10000000,"clientRequestId":null,"trades":[]},{"id":4345675,"currency":"AUD","instrument":"BTC","orderSide":"Ask","ordertype":"Limit","creationTime":1378636912705,"status":"Fully Matched","errorMessage":null,"price":13000000000,"volume":10000000,"openVolume":0,"clientRequestId":null,"trades":[{"id":5345677,"creationTime":1378636913151,"description":null,"price":13000000000,"volume":10000000,"fee":100000}]}]}
+
+
+      # Implementation
+      # {
+      #   :uri => "/order/open",
+      #   :body => {"currency":"AUD","instrument":"BTC","limit":10,"since":33434568724}, # Sample Body
+      #   :verb => "POST",
+      #   :auth => true
+      # }
+    end
+
+    def trade_history
+      # Documentation
+      # POST "/order/trade/history"
+      # since parameter - a trade id.
+      # {"currency":"AUD","instrument":"BTC","limit":10,"since":33434568724}
+
+
+      # Implementation
+      # {
+      #   :uri => "/order/trade/history",
+      #   :body => {"currency":"AUD","instrument":"BTC","limit":10,"since":33434568724}, # Sample Body
+      #   :verb => "POST",
+      #   :auth => true
+      # }
+    end
+
+    def show
+      # Documentation
+      # POST "/order/detail"
+      # {"orderIds":[6840125478]}
+
+
+      # Implementation
+      # {
+      #   :uri => "/order/detail",
+      #   :body => {"orderIds":[6840125478]}, # Sample Body
+      #   :verb => "POST",
+      #   :auth => true
+      # }
+    end
+
+    def create
+      # Documentation
+      # POST "/order/create"
+      # The clientRequestId is not currently used but must be specified. Any string is valid.
+      # Price of $130 = 13000000000 (i.e x 100000000)
+      # Volume of 1 BTC = 100000000 (i.e x 100000000)
+      # {"currency":"AUD","instrument":"BTC","price":13000000000,"volume":10000000,"orderSide":"Bid","ordertype":"Limit","clientRequestId":"abc-cdf-1000"}
+      # => {"success":true,"errorCode":null,"errorMessage":null,"id":100,"clientRequestId":"abc-cdf-1000"}
+      # => {"success":false,"errorCode":3,"errorMessage":"Invalid argument.","id":0,"clientRequestId":"abc-cdf-1000"}
+
+      # Implementation
+      # {
+      #   :uri => "/order/create",
+      #   :body => {"currency":"AUD","instrument":"BTC","price":13000000000,"volume":10000000,"orderSide":"Bid","ordertype":"Limit","clientRequestId":"abc-cdf-1000"}, # Sample Body
+      #   :verb => "POST",
+      #   :auth => true
+      # }
+    end
+
+    def cancel
+      # Documentation
+      # POST "/order/cancel"
+      # {"orderIds":[6840125478]}
+      # => {"success":true,"errorCode":null,"errorMessage":null,"responses":[{"success":false,"errorCode":3,"errorMessage":"order does not exist.","id":6840125478}]}
+
+      # Implementation
+      # {
+      #   :uri => "/order/cancel",
+      #   :body => {"orderIds":[6840125478]}, # Sample Body
+      #   :verb => "POST",
+      #   :auth => true
+      # }
+    end
+
+  end
+end

data/lib/btcmrb/version.rb

@@ -1,3 +1,3 @@
 module Btcmrb
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: btcmrb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jeremy Tennant
@@ -37,6 +37,7 @@ files:
 - lib/btcmrb/account.rb
 - lib/btcmrb/client.rb
 - lib/btcmrb/marketdata.rb
+- lib/btcmrb/order.rb
 - lib/btcmrb/version.rb
 homepage: https://github.com/tennantje/btcmrb
 licenses: