Merge pull request #175 from tmlee/feature/order_abstraction

Add Order class to abstract formatting into [price, amount, timestamp]

lib/cryptoexchange/exchanges/allcoin/services/order_book.rb

@@ -24,12 +24,21 @@ def adapt(output, market_pair)
           order_book.base      = market_pair.base
           order_book.target    = market_pair.target
           order_book.market    = Allcoin::Market::NAME
-          order_book.asks      = output['asks']
-          order_book.bids      = output['bids']
+          order_book.asks      = adapt_orders output['asks']
+          order_book.bids      = adapt_orders output['bids']
           order_book.timestamp = timestamp
           order_book.payload   = output
           order_book
         end
+
+        def adapt_orders(orders)
+          orders.collect do |order_entry|
+            price, amount = order_entry
+            Cryptoexchange::Models::Order.new(price: price,
+                                              amount: amount,
+                                              timestamp: nil)
+          end
+        end
       end
     end
   end

lib/cryptoexchange/exchanges/coinmate/services/order_book.rb

@@ -32,8 +32,11 @@ def adapt(output, market_pair)
         end
 
         def adapt_orders(orders, timestamp)
-          # Format as: [price, amount, timestamp]
-          orders.collect { |order_entry| order_entry.values << timestamp }
+          orders.collect do |order_entry|
+            Cryptoexchange::Models::Order.new(price: order_entry['price'],
+                                              amount: order_entry['amount'],
+                                              timestamp: timestamp)
+          end
         end
       end
     end

lib/cryptoexchange/exchanges/gemini/services/order_book.rb

@@ -31,8 +31,12 @@ def adapt(output, market_pair)
         end
 
         def adapt_orders(orders)
-          # Format as: [price, amount, timestamp]
-          orders.collect { |order_entry| order_entry.values }
+          orders.collect do |order_entry|
+            price, amount, timestamp = order_entry.values
+            Cryptoexchange::Models::Order.new(price: price,
+                                              amount: amount,
+                                              timestamp: timestamp)
+          end
         end
       end
     end

lib/cryptoexchange/models/order.rb

@@ -0,0 +1,13 @@
+module Cryptoexchange
+  module Models
+    class Order
+      attr_accessor :price, :amount, :timestamp
+
+      def initialize(args={})
+        @price      = args[:price]
+        @amount     = args[:amount]
+        @timestamp  = args[:timestamp] || nil
+      end
+    end
+  end
+end

lib/cryptoexchange/models/order_book.rb

@@ -4,6 +4,16 @@ class OrderBook
       attr_accessor :base, :target, :market, :bids,
                     :asks, :timestamp, :payload
 
+      def initialize(args = {})
+        @base = args[:base]
+        @target = args[:target]
+        @market = args[:market]
+        @bids = args[:bids] || []
+        @asks = args[:asks] || []
+        @timestamp = args[:timestamp]
+        @payload = args[:payload]
+      end
+
       def base
         @base.upcase
       end

spec/exchanges/allcoin/integration/market_spec.rb

@@ -38,8 +38,9 @@
     expect(order_book.market).to eq 'allcoin'
     expect(order_book.asks).to_not be_empty
     expect(order_book.bids).to_not be_empty
-    expect(order_book.asks.first.size).to eq 2
-    expect(order_book.bids.first.size).to eq 2
+    expect(order_book.asks.first.price).to_not be_nil
+    expect(order_book.bids.first.amount).to_not be_nil
+    expect(order_book.bids.first.timestamp).to be_nil
     expect(order_book.asks.count).to be > 10
     expect(order_book.bids.count).to be > 10
     expect(order_book.timestamp).to be_a Numeric

spec/exchanges/coinmate/integration/market_spec.rb

@@ -41,8 +41,9 @@
     expect(order_book.market).to eq market
     expect(order_book.asks).to_not be_empty
     expect(order_book.bids).to_not be_empty
-    expect(order_book.asks.first.size).to eq 3
-    expect(order_book.bids.first.size).to eq 3
+    expect(order_book.asks.first.price).to_not be_nil
+    expect(order_book.bids.first.amount).to_not be_nil
+    expect(order_book.bids.first.timestamp).to_not be_nil
     expect(order_book.asks.count).to be > 10
     expect(order_book.bids.count).to be > 10
     expect(order_book.timestamp).to be_a Numeric

spec/exchanges/gemini/integration/market_spec.rb

@@ -37,8 +37,9 @@
     expect(order_book.market).to eq 'gemini'
     expect(order_book.asks).to_not be_empty
     expect(order_book.bids).to_not be_empty
-    expect(order_book.asks.first.size).to eq 3
-    expect(order_book.bids.first.size).to eq 3
+    expect(order_book.asks.first.price).to_not be_nil
+    expect(order_book.bids.first.amount).to_not be_nil
+    expect(order_book.bids.first.timestamp).to_not be_nil
     expect(order_book.timestamp).to be_a Numeric
     expect(order_book.payload).to_not be nil
   end

spec/models/order.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe Cryptoexchange::Models::Order do
+  let(:time_now) { Time.now.to_i }
+  let(:order) { described_class.new(price: 1000, amount: 9999) }
+  let(:order_with_timestamp) do
+    described_class.new(price: 1000, amount: 9999, timestamp: time_now)
+  end
+
+  it { expect(order.price).to eq 1000 }
+  it { expect(order.amount).to eq 9999 }
+  it { expect(order.timestamp).to be_nil }
+  it { expect(order_with_timestamp.timestamp).to eq time_now }
+end

spec/models/order_book.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Cryptoexchange::Models::OrderBook do
+  let(:new_order_book) { described_class.new }
+  it { expect(new_order_book.bids).to be_empty }
+  it { expect(new_order_book.asks).to be_empty }
+end

spec/models/trade.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+RSpec.describe Cryptoexchange::Models::Trade do
+end