cbx 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31c39b5d8c6657a3cfc9a059fb853bd1d9d84d58
-  data.tar.gz: 6dfa0c3f9b5ffaa5e4d6426052468f8ea9a9eb0a
+  metadata.gz: 02f394328c79650fe7c8400394ea033c0b09e4fa
+  data.tar.gz: e5d07d4b718c506b61c4e8ddc8c49003734f8cbd
 SHA512:
-  metadata.gz: fceeb97882bb299241430ff18b6b0e6fbe2a7b75329b79a085794d54bfff724817d2aa91768a5a797c25b115d68e733afbe8840f7a0b32468f2e7ee986fecb12
-  data.tar.gz: cb0d5ca770d8fec2bcb20876896c331e877cf73c6e87d458daef07c781822d517986896acc02d1d980183347b90e4c5cb05e9df8bff7a29b83624374f8ed7c6b
+  metadata.gz: cea5747f231581dce6afcba92bd87660910a762a76109965523adb4440fc0756e4d294facc9436250d4f3d9a7f564b560ba3e070fc34d9d383a11c3ba0111981
+  data.tar.gz: 7d2c645cad6473339bfb2a580f581d4dcb07e60afdfba88bc158c7fe016091a4d32cf5661d596656b1b6efde912f228868537ee85fe1c414a868c0d663cb2602

data/README.md

@@ -13,13 +13,11 @@ allows for unauthenticated access to Market Data and the WebSocket feed.
 
 Create an account at https://exchange.coinbase.com to get started.
 
-### NOTE - As a launch promo, there are [no Coinbase Exchange trading fees](http://blog.coinbase.com/post/109202118547/coinbase-launches-first-regulated-bitcoin-exchange) through the end of March.
-
 ## Installation
 
 Include this in your gemfile for latest version from git:
 
-```gem 'cbx', :git=> 'git://github.com/mikerodrigues/cbx.git'```
+```gem 'cbx', :git => 'git://github.com/mikerodrigues/cbx.git'```
 
 or from Rubygems, usually not far behind git master:
 
@@ -35,21 +33,44 @@ cbe = CBX.new
 
 # List products
 cbe.products
-=> [{"id"=>"BTC-USD", "base_currency"=>"BTC", "quote_currency"=>"USD", "base_min_size"=>0.01, "base_max_size"=>10000, "quote_increment"=>0.01, "display_name"=>"BTC/USD"}]
+=> [{"id"=>"BTC-USD",
+     "base_currency"=>"BTC",
+     "quote_currency"=>"USD",
+     "base_min_size"=>0.01,
+     "base_max_size"=>10000,
+     "quote_increment"=>0.01,
+     "display_name"=>"BTC/USD"}]
 
 # Get product order book at level 1, 2, or 3, (Defaults to level: 1, product_id "BTC-USD")
-cbe.book(1, 'BTC-USD')
-=> {"sequence"=>29349454, "bids"=>[["285.22000000", "0.34800000", 3]], "asks"=>[["285.33000000", "0.28930000", 4]]}
+cbe.orderbook(1, 'BTC-USD')
+=> {"sequence"=>29349454,
+    "bids"=>[["285.22000000","0.34800000", 3]], 
+    "asks"=>[["285.33000000", "0.28930000", 4]]}
 
 # Product tickers (defaults to 'BTC-USD')
 cbe.ticker("BTC-USD")
-=> {"trade_id"=>125681, "price"=>"226.20000000", "size"=>"0.01570000", "time"=>"2015-02-08T04:46:17.352746Z"}
+=> {"trade_id"=>125681,
+    "price"=>"226.20000000",
+    "size"=>"0.01570000", 
+    "time"=>"2015-02-08T04:46:17.352746Z"}
 
 # Product trades (defaults to 'BTC-USD')
 cbe.trades('BTC-USD')
-=> [{"time"=>"2015-03-15 04:43:48.7943+00", "trade_id"=>774500, "price"=>"285.44000000", "size"=>"0.01000000", "side"=>"sell"}, 
-    {"time"=>"2015-03-15 04:42:54.432661+00", "trade_id"=>774499, "price"=>"285.47000000", "size"=>"0.05340000", "side"=>"sell"},
-    {"time"=>"2015-03-15 04:42:54.432306+00", "trade_id"=>774498, "price"=>"285.45000000", "size"=>"0.09100000", "side"=>"sell"}]
+=> [{"time"=>"2015-03-15 04:43:48.7943+00"
+     "trade_id"=>774500
+     "price"=>"285.44000000"
+     "size"=>"0.01000000"
+     "side"=>"sell"}
+    {"time"=>"2015-03-15 04:42:54.432661+00"
+     "trade_id"=>774499
+     "price"=>"285.47000000"
+     "size"=>"0.05340000"
+     "side"=>"sell"},
+    {"time"=>"2015-03-15 04:42:54.432306+00"
+     "trade_id"=>774498
+     "price"=>"285.45000000"
+     "size"=>"0.09100000"
+     "side"=>"sell"}]
 
 
 # For authenticated access:
@@ -57,7 +78,18 @@ cbe = CBX.new API_KEY, API_SECRET, API_PASSPHRASE
 
 # List accounts
 cbe.accounts
-=> [{"id"=>"000ea663...", "currency"=>"USD", "balance"=>"90.0000114750000000", "hold"=>"0.0000000000000000", "available"=>"0.9000114750000000", "profile_id"=>"4409df27..."}, {"id"=>"8bfe", "currency"=>"BTC", "balance"=>"9.4426882700000000", "hold"=>"0.0000000000000000", "available"=>"5.4426882700000000", "profile_id"=>"a8f2d8..."}] 
+=> [{"id"=>"000ea663...",
+     "currency"=>"USD",
+     "balance"=>"90.0000114750000000",
+     "hold"=>"0.0000000000000000",
+     "available"=>"0.9000114750000000",
+     "profile_id"=>"4409df27..."},
+    {"id"=>"8bfe...",
+     "currency"=>"BTC",
+     "balance"=>"9.4426882700000000",
+     "hold"=>"0.0000000000000000",
+     "available"=>"5.4426882700000000",
+     "profile_id"=>"a8f2d8..."}] 
 
 # List orders
 cbe.orders

data/cbx.gemspec

@@ -1,16 +1,16 @@
 Gem::Specification.new do |s|
   s.name        = 'cbx'
-  s.version     = '0.1.1'
-  s.date        = '2015-03-16'
-  s.summary     = "Ruby wrapper for the Coinbase Exchange API"
-  s.description = "A complete interface to the Coinbase Exchange trading API."
-  s.authors     = ["Michael Rodrigues","Dan Silver"]
+  s.version     = '0.1.2'
+  s.date        = Date.today.to_s
+  s.summary     = 'Ruby wrapper for the Coinbase Exchange API'
+  s.description = 'A complete interface to the Coinbase Exchange trading API.'
+  s.authors     = ['Michael Rodrigues', 'Dan Silver']
   s.email       = ['mikebrodrigues@gmail.com', 'dannysilver3@gmail.com']
   s.files       = Dir.glob('{bin,config,lib,test,doc}/**/*') + ['cbx.gemspec']
   s.extra_rdoc_files = ['README.md']
   s.license     = 'MIT'
   s.homepage = 'https://github.com/mikerodrigues/cbx'
-  s.metadata = { "parent_project_homepage" => "https://github.com/dan-silver/coinbase_exchange"}
+  s.metadata = { 'parent_project_homepage' => 'https://github.com/dan-silver/coinbase_exchange' }
   s.add_runtime_dependency 'unirest', '~> 1.1', '>= 1.1.2'
   s.add_runtime_dependency 'websocket-client-simple'
 end

data/lib/cbx.rb

@@ -1,5 +1,5 @@
 require 'unirest'
-require "base64"
+require 'base64'
 require 'openssl'
 require 'json'
 require 'websocket-client-simple'
@@ -7,36 +7,51 @@ require 'cbx/feed'
 require 'cbx/pagination'
 require 'cbx/trading'
 require 'cbx/market_data'
-require 'cbx/cbx_signature_maker'
 require 'cbx/version'
 
+# A CBX object exposes all of the functionality of the API through methods that
+# return JSON objects.
+#
 class CBX
   include MarketData
-  attr_reader :authenticated
 
   API_URL = 'https://api.exchange.coinbase.com/'
 
-  def initialize(key=nil, secret=nil, passphrase=nil)
+  def initialize(key = nil, secret = nil, passphrase = nil)
     if key && secret && passphrase
       @key = key
       @secret = secret
       @passphrase = passphrase
-      @coinbaseExchange = CBXSignatureMaker.new(key, secret, passphrase)
       @authenticated = true
       extend Trading
-    else 
+    else
       @authenticated = false
     end
   end
 
-  def request(method, uri, json=nil)
+  def authenticated?
+    @authenticated
+  end
+
+  def sign(request_url = '', body = '', timestamp = nil, method = 'GET')
+    body = body.to_json if body.is_a?(Hash)
+    timestamp = Time.now.to_i unless timestamp
+
+    what = "#{timestamp}#{method.upcase}#{request_url}#{body}"
+    # create a sha256 hmac with the secret
+    secret = Base64.decode64(@secret)
+    hash  = OpenSSL::HMAC.digest('sha256', secret, what)
+    Base64.strict_encode64(hash)
+  end
+
+  def request(method, uri, json = nil)
     params = json.to_json if json
-    if authenticated
+    if authenticated?
       headers = { 
-        'CB-ACCESS-SIGN'=> @coinbaseExchange.signature('/'+uri, params, nil, method),
-        'CB-ACCESS-TIMESTAMP'=> Time.now.to_i,
-        'CB-ACCESS-KEY'=> @key,
-        'CB-ACCESS-PASSPHRASE'=> @passphrase,
+        'CB-ACCESS-SIGN' => sign('/' + uri, params, nil, method),
+        'CB-ACCESS-TIMESTAMP' => Time.now.to_i,
+        'CB-ACCESS-KEY' => @key,
+        'CB-ACCESS-PASSPHRASE' => @passphrase,
         'Content-Type' => 'application/json'
       }
     else
@@ -44,25 +59,25 @@ class CBX
     end
 
     if method == :get
-      r=Unirest.get(API_URL + uri, headers: headers)
+      r = Unirest.get(API_URL + uri, headers: headers)
     elsif method == :post
-      r=Unirest.post(API_URL + uri, headers: headers, parameters: params)
+      r = Unirest.post(API_URL + uri, headers: headers, parameters: params)
     elsif method == :delete
-      r=Unirest.delete(API_URL + uri, headers: headers, parameters: params)
+      r = Unirest.delete(API_URL + uri, headers: headers, parameters: params)
     end
     yield r.body if block_given?
-    return r.body
+    r.body
   end
 
-  def get(uri, json=nil, &block)
+  def get(uri, json = nil, &block)
     request(:get, uri, json, &block)
   end
 
-  def post(uri, json=nil, &block)
+  def post(uri, json = nil, &block)
     request(:post, uri, json, &block)
   end
 
-  def delete(uri, json=nil, &block)
+  def delete(uri, json = nil, &block)
     request(:delete, uri, json, &block)
   end
 end

data/lib/cbx/feed.rb

@@ -1,30 +1,28 @@
 class CBX
+  # Provides an interface to the Coinbase Exchange WebSocket feed.
+  #
   class Feed
     API_URL = 'wss://ws-feed.exchange.coinbase.com'
-    def initialize(on_message, on_close=nil, on_error=nil)
-      subscription_request = { "type" => "subscribe", "product_id" => "BTC-USD" }
+    SUBSCRIPTION_REQUEST = { 'type' => 'subscribe', 'product_id' => 'BTC-USD' }
+    def initialize(on_message, on_close = nil, on_error = nil)
       ws = WebSocket::Client::Simple.connect API_URL
       @ws = ws
       ws.on :message do |event|
         msg = JSON.parse event.data
-        on_message.call(msg) 
+        on_message.call(msg)
       end
 
       ws.on :open do
-        ws.send subscription_request.to_json
+        ws.send SUBSCRIPTION_REQUEST.to_json
       end
 
       ws.on :close do |e|
-        if on_close
-          on_close.call(e)
-        end
+        on_close && on_close.call(e)
         exit 1
       end
 
       ws.on :error do |e|
-        if on_error
-          on_error.call(e)
-        end
+        on_error && on_error.call(e)
       end
     end
 

data/lib/cbx/market_data.rb

@@ -1,4 +1,7 @@
 class CBX
+  # Provides an interface to the Market Data section of the Coinbase Exchange
+  # API.
+  #
   module MarketData
     include ::CBX::Pagination
 
@@ -6,19 +9,19 @@ class CBX
       get('products', nil, &block)
     end
 
-    def orderbook(level='1', product_id='BTC-USD', &block)
+    def orderbook(level = '1', product_id = 'BTC-USD', &block)
       get('products/' + product_id + '/book?level=' + String(level), nil, &block)
     end
 
-    def ticker(product_id='BTC-USD', &block)
+    def ticker(product_id = 'BTC-USD', &block)
       get('products/' + product_id + '/ticker', nil, &block)
     end
 
-    def trades(product_id='BTC-USD', &block)
+    def trades(product_id = 'BTC-USD', &block)
       get('products/' + product_id + '/trades', nil, &block)
     end
 
-    def candles(level='1', product_id='BTC-USD', &block)
+    def candles(product_id = 'BTC-USD', &block)
       get('products/' + product_id + '/candles', nil, &block)
     end
 

data/lib/cbx/pagination.rb

@@ -1,13 +1,14 @@
 class CBX
+  # Handles constructing the pagination portion of a URL.
+  #
   module Pagination
     private
 
     def paginate(hash)
-      string = ""
-      hash.keys.each do |key|
-        string << "&#{key}=#{hash.fetch(key)}"
+      hash.keys.each.with_index.reduce('?') do |string, (key, index)|
+        index > 0 ? string << '&' : ''
+        string << "#{key}=#{hash.fetch(key)}"
       end
-      return string.sub(/^&/, '?')
     end
   end
 end

data/lib/cbx/trading.rb

@@ -1,11 +1,12 @@
 class CBX
+  # Provides an interface to the Trading section of the Coinbase Exchange API.
+  #
   module Trading
     include ::CBX::Pagination
-    
     # Account methods
     #
-    def accounts(account_id=nil, &block)
-      if account_id.nil? then
+    def accounts(account_id = nil, &block)
+      if account_id.nil?
         get('accounts', nil, &block)
       else
         get('accounts/' + account_id.to_s, nil, &block)
@@ -26,8 +27,8 @@ class CBX
       get('orders' + paginate(pagination), nil, &block)
     end
 
-    def order(order_id=nil, &block)
-      if order_id.nil? then
+    def order(order_id = nil, &block)
+      if order_id.nil?
         get('orders', nil, &block)
       else
         get('orders/' + order_id.to_s, nil, &block)
@@ -38,20 +39,35 @@ class CBX
       delete('orders/' + order_id.to_s, nil, &block)
     end
 
-    def place_order(size, price, side, product_id='BTC-USD', &block)
-      order = { 'size' => size, 'price' => price, 'side' => side, 'product_id' => product_id}
+    def place_order(size, price, side, product_id = 'BTC-USD', &block)
+      order = { 
+        'size' => size,
+        'price' => price,
+        'side' => side,
+        'product_id' => product_id
+      }
       post('orders', order, &block)
     end
 
-    # Transfer funds methods
+    # Deposit funds into your Exchange account from a Coinbase wallet.
     #
     def deposit(amount, coinbase_account_id, &block)
-      order = { 'type' => 'deposit', 'amount' => amount, 'coinbase_account_id' => coinbase_account_id }
+      order = { 
+        'type' => 'deposit',
+        'amount' => amount,
+        'coinbase_account_id' => coinbase_account_id
+      }
       post('orders', order, &block)
     end
 
+    # Withdraw funds to your Coinbase wallet.
+    #
     def withdraw(amount, coinbase_account_id, &block)
-      order = { 'type' => 'withdraw', 'amount' => amount, 'coinbase_account_id' => coinbase_account_id }
+      order = {
+        'type' => 'withdraw',
+        'amount' => amount,
+        'coinbase_account_id' => coinbase_account_id
+      }
       post('orders', order, &block)
     end
 
@@ -60,5 +76,22 @@ class CBX
     def fills(pagination = {}, &block)
       get('fills' + paginate(pagination), nil, &block)
     end
+
+    # Create a report
+    #
+    def create_report(start_date = nil, end_date = nil, type = 'fill', &block)
+      params = {
+        'type' => type,
+        'start_date' => start_date,
+        'end_date' => end_date
+      }
+      post('reports', params, &block)
+    end
+
+    # Get info about a report
+    #
+    def report_info(report_id, &block)
+      get('reports/' + report_id)
+    end
   end
 end

data/lib/cbx/version.rb

@@ -1,3 +1,3 @@
 class CBX
-  VERSION="0.1.1"
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cbx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael Rodrigues
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest
@@ -57,7 +57,6 @@ files:
 - README.md
 - cbx.gemspec
 - lib/cbx.rb
-- lib/cbx/cbx_signature_maker.rb
 - lib/cbx/feed.rb
 - lib/cbx/market_data.rb
 - lib/cbx/pagination.rb
@@ -84,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Coinbase Exchange API

data/lib/cbx/cbx_signature_maker.rb

@@ -1,18 +0,0 @@
-class CBXSignatureMaker
-  def initialize(key, secret, passphrase)
-    @key = key
-    @secret = secret
-    @passphrase = passphrase
-  end
-
-  def signature(request_url='', body='', timestamp=nil, method='GET')
-    body = body.to_json if body.is_a?(Hash)
-    timestamp = Time.now.to_i if !timestamp
-
-    what = "#{timestamp}#{method.upcase}#{request_url}#{body}";
-    # create a sha256 hmac with the secret
-    secret = Base64.decode64(@secret)
-    hash  = OpenSSL::HMAC.digest('sha256', secret, what)
-    Base64.strict_encode64(hash)
-  end
-end