orderbook 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20a70a3b134b39779181f6f4137a5200f003593e
-  data.tar.gz: 269d90ef37d27f7925e10f241326cf65c41ad3e1
+  metadata.gz: 63a277ee323ea8765e296998ab126b1e88f18d70
+  data.tar.gz: ea1fabde9aabc5d3b7793e8828add7fa2b6bf0b0
 SHA512:
-  metadata.gz: 255c3b44bb6cb4bee6bd90975bac52f51401d79d0e4374250545e438f2348223ca01e78a348f23bffa1e444d1d0aa479b024872fcdd40b3ec3ff17e415d5e426
-  data.tar.gz: a1581ff672f3e345c5745171754a399f6b552203fa73828976468445d36883a79f72a05d2eaddbe67176c1fc57dd33ff21dea919ec16ab71f649c9944c2f1444
+  metadata.gz: ea24534d04f263018c60e4a1454d4d1eb285edbc7465b71d4480b8a8a7fd13f8e2b82f372a07cb246e8328322430aa621f7c1563eddb50554377138bdf17846b
+  data.tar.gz: 5d968635fc6fdcfb23edbea5db60d0e8b7ed6906a08b0ac47204accd96269ab6419b1bff08195f0ef99226d681d73d4e36d1d09296ba9bcf9488d78ff7b86768

data/README.md

@@ -1,11 +1,13 @@
-# Orderbook 3.0.0
+# Orderbook
 <a href="https://codeclimate.com/github/mikerodrigues/orderbook"><img src="https://codeclimate.com/github/mikerodrigues/orderbook/badges/gpa.svg" /></a>
 
+A gem for creating a realtime order book for the Coinbase Exchange.
+
+Version 4.0.0 switches to keyword arguments, supports other currencies.
+
 Version 3.0.0 has a slightly different interface and properly queues messages
 for an accurate Orderbook.
 
-A gem for creating a realtime order book for the Coinbase Exchange.
-
 Version 1.0.0 and greater now use the official Coinbase Exchange Ruby Gem's
 EventMachine-driven client. It should be more reliable than the previous socket
 code.
@@ -43,24 +45,40 @@ ob = Orderbook.new
 * Create an Orderbook object but don't fetch an orderbook or start live
   updating.
 ```ruby
-ob = Orderbook.new(false)
+ob = Orderbook.new(start: false)
 
 # When you want it to go live:
 
 ob.start!
+
+# When you want to stop it:
+
+ob.stop!
+
+# Reset the orderbook by fetching a fresh orderbook snapshot. This just calls
+# `stop!` and then `start!` again:
+
+ob.reset!
+```
+
+* Get the "BTC-GBP" orderbook instead of "BTC-USD":
+```ruby
+ob = Orderbook.new(product_id: "BTC-GBP")
 ```
 
 * Create a live Orderbook with a callback to fire on each message:
 ```ruby
 ob = Orderbook.new do |message|
-  puts message.fetch 'type'
+  if message.fetch 'type' == 'match'
+    puts ob.spread.to_f('s')
+  end
 end
 ```
 
 * Create or reset the message callback:
 ```ruby
 ob.on_message do |message|
-  puts message.fetch 'sequence'
+  puts ob.count
 end
 ```
 

data/lib/orderbook.rb

@@ -23,6 +23,10 @@ class Orderbook
   #
   attr_reader :asks
 
+  # Product ID of the orderbook
+  #
+  attr_reader :product_id
+
   # Sequence number from the initial level 3 snapshot
   #
   attr_reader :snapshot_sequence
@@ -61,14 +65,15 @@ class Orderbook
   #
   # If a +block+ is given it is passed each message as it is received.
   #
-  def initialize(start = true, &block)
+  def initialize(product_id: "BTC-USD", start: true, &block)
+    @product_id = product_id
     @bids = []
     @asks = []
     @snapshot_sequence = 0
     @last_sequence = 0
     @queue = Queue.new
-    @websocket = Coinbase::Exchange::Websocket.new(keepalive: true)
-    @client = Coinbase::Exchange::Client.new
+    @websocket = Coinbase::Exchange::Websocket.new(keepalive: true, product_id: @product_id)
+    @client = Coinbase::Exchange::Client.new('', '', '', product_id: @product_id)
     @on_message = block if block_given?
     start && start!
   end

data/lib/orderbook/version.rb

@@ -1,5 +1,5 @@
 # Orderbook version number. I try to keep it semantic.
 #
 class Orderbook
-  VERSION = '3.0.0'
+  VERSION = '4.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orderbook
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler