cbx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f63ca10d81b008dedae9cbae3d368aae9b15913c
+  data.tar.gz: 57838a381e03f8e9b984727113332ac0068dc065
+SHA512:
+  metadata.gz: 947eb218522c03eaa6baca54fa9005aad22bb032c5852f92215a8fcac35ac6b94795aa6483e2adf880019997739eda9cc9f7d7a558be82fd0e2843fe32df8768
+  data.tar.gz: f7722a5e01299cd37dcaf0e11cc97abaae1cecb68a9883abd2a5cb26b8928db584b0f24acda945f033e9357cb35a3f8b08ce0a6a777d63e14458b5c18bf03a63

data/README.md

@@ -0,0 +1,100 @@
+This is a fork of a project originally authored by Daniel Silver
+(https://github.com/dan-silver/cbx)
+
+The fork features convenience methods for all endpoint functionality and
+allows for unauthenticated access to Market Data and the WebSocket feed.
+
+# Coinbase Exchange Ruby Client
+The library wraps the http request and message signing.  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:
+
+```gem 'cbx', :git=> 'git://github.com/mikerodrigues/cbx.git'```
+
+## Example
+```ruby
+require "cbx"
+
+# For unauthenticated access:
+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"}]
+
+# 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]]}
+
+# 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"}
+
+# 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"}]
+
+
+# For authenticated access:
+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..."}] 
+
+# List orders
+cbe.orders
+
+# List orders with pagination
+cbe.order({'limit'=>5, after=>1})
+
+# Get specific order by order_id
+cbe.order('4488340..')
+
+# Place an order (size, price, side)
+cbe.place_order("0.01", "250.000", "buy")
+cbe.place_order("0.02", "265.000", "sell")
+
+# Cancel an order by order_id
+cbe.cancel_order('488224434...')
+
+# Product fills
+cbe.fills
+
+# Get a live feed from the websocket. You'll need to create a lambda to pass
+messages to as they are received:
+feed = CBX::Feed.new(->{|msg| puts msg.fetch('type')})
+
+# Close the feed if needed
+feed.close
+
+
+```
+
+Block syntax is fully supported
+
+```ruby
+
+cbe.accounts do |response|
+  puts response
+end
+
+cbe.post('orders', {
+
+    "size" => 1.01,
+    "price" => 1.100,
+    "side" => "buy",
+    "product_id" => "BTC-USD"
+}) do |response|
+  puts response
+end
+
+```
+
+Use at your own risk. I assume no liability for gains or losses you incur while using this gem.

data/cbx.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'cbx'
+  s.version     = '0.0.1'
+  s.date        = '2015-03-15'
+  s.summary     = "Ruby wrapper for the Coinbase Exchange API"
+  s.description = "A complete interface to Coinbase Exchange's 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.add_runtime_dependency 'unirest', '~> 1.1', '>= 1.1.2'
+  s.add_runtime_dependency 'websocket-client-simple'
+end

data/lib/cbx.rb

@@ -0,0 +1,68 @@
+require 'unirest'
+require "base64"
+require 'openssl'
+require 'json'
+require 'websocket-client-simple'
+require 'cbx/feed'
+require 'cbx/pagination'
+require 'cbx/trading'
+require 'cbx/market_data'
+require 'cbx/coinbase_signature_maker'
+require 'cbx/version'
+
+class CBX
+  include MarketData
+  attr_reader :authenticated
+
+  API_URL = 'https://api.exchange.coinbase.com/'
+
+  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 
+      @authenticated = false
+    end
+  end
+
+  def request(method, uri, json=nil)
+    params = json.to_json if json
+    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,
+        'Content-Type' => 'application/json'
+      }
+    else
+      headers = { 'Content-Type' => 'application/json' }
+    end
+
+    if method == :get
+      r=Unirest.get(API_URL + uri, headers: headers)
+    elsif method == :post
+      r=Unirest.post(API_URL + uri, headers: headers, parameters: params)
+    elsif method == :delete
+      r=Unirest.delete(API_URL + uri, headers: headers, parameters: params)
+    end
+    yield r.body if block_given?
+    return r.body
+  end
+
+  def get(uri, json=nil, &block)
+    request(:get, uri, json, &block)
+  end
+
+  def post(uri, json=nil, &block)
+    request(:post, uri, json, &block)
+  end
+
+  def delete(uri, json=nil, &block)
+    request(:delete, uri, json, &block)
+  end
+end

data/lib/cbx/cbx_signature_maker.rb

@@ -0,0 +1,18 @@
+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

data/lib/cbx/feed.rb

@@ -0,0 +1,35 @@
+class CBX
+  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" }
+      ws = WebSocket::Client::Simple.connect API_URL
+      @ws = ws
+      ws.on :message do |event|
+        msg = JSON.parse event.data
+        on_message.call(msg) 
+      end
+
+      ws.on :open do
+        ws.send subscription_request.to_json
+      end
+
+      ws.on :close do |e|
+        if on_close
+          on_close.call(e)
+        end
+        exit 1
+      end
+
+      ws.on :error do |e|
+        if on_error
+          on_error.call(e)
+        end
+      end
+    end
+
+    def close
+      @ws.close
+    end
+  end
+end

data/lib/cbx/market_data.rb

@@ -0,0 +1,21 @@
+class CBX
+  module MarketData
+    include ::CBX::Pagination
+
+    def products(&block)
+      get('products', nil, &block)
+    end
+
+    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)
+      get('products/' + product_id + '/ticker', nil, &block)
+    end
+
+    def trades(product_id='BTC-USD', &block)
+      get('products/' + product_id + '/trades', nil, &block)
+    end
+  end
+end

data/lib/cbx/pagination.rb

@@ -0,0 +1,13 @@
+class CBX
+  module Pagination
+    private
+
+    def paginate(hash)
+      string = ""
+      hash.keys.each do |key|
+        string << "&#{key}=#{hash.fetch(key)}"
+      end
+      return string.sub(/^&/, '?')
+    end
+  end
+end

data/lib/cbx/trading.rb

@@ -0,0 +1,64 @@
+class CBX
+  module Trading
+    include ::CBX::Pagination
+    
+    # Account methods
+    #
+    def accounts(account_id=nil, &block)
+      if account_id.nil? then
+        get('accounts', nil, &block)
+      else
+        get('accounts/' + account_id.to_s, nil, &block)
+      end
+    end
+
+    def ledger(account_id, pagination = {}, &block)
+      get('accounts/' + account_id.to_s + '/ledger' + paginate(pagination), nil, &block)
+    end
+
+    def holds(account_id, pagination = {}, &block)
+      get('accounts/' + account_id.to_s + '/holds' + paginate(pagination), nil, &block)
+    end
+
+    # Order methods
+    #
+    def orders(pagination = {}, &block)
+      get('orders' + paginate(pagination), nil, &block)
+    end
+
+    def order(order_id=nil, &block)
+      if order_id.nil? then
+        get('orders', nil, &block)
+      else
+        get('orders/' + order_id.to_s, nil, &block)
+      end
+    end
+
+    def cancel_order(order_id, &block)
+      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}
+      post('orders', order, &block)
+    end
+
+    # Transfer funds methods
+    #
+    def deposit(amount, coinbase_account_id, &block)
+      order = { 'type' => 'deposit', 'amount' => amount, 'coinbase_account_id' => coinbase_account_id }
+      post('orders', order, &block)
+    end
+
+    def withdraw(amount, coinbase_account_id, &block)
+      order = { 'type' => 'withdraw', 'amount' => amount, 'coinbase_account_id' => coinbase_account_id }
+      post('orders', order, &block)
+    end
+
+    # Fill methods
+    #
+    def fills(pagination = {}, &block)
+      get('fills' + paginate(pagination), nil, &block)
+    end
+  end
+end

data/lib/cbx/version.rb

@@ -0,0 +1,3 @@
+class CBX
+  VERSION="0.0.1"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: cbx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Rodrigues
+- Dan Silver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A complete interface to Coinbase Exchange's trading API.
+email:
+- mikebrodrigues@gmail.com
+- dannysilver3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+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
+- lib/cbx/trading.rb
+- lib/cbx/version.rb
+homepage: https://github.com/mikerodrigues/cbx
+licenses:
+- MIT
+metadata:
+  parent_project_homepage: https://github.com/dan-silver/coinbase_exchange
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Coinbase Exchange API
+test_files: []