bitex 0.0.2

data/lib/bitex/profile.rb

@@ -0,0 +1,10 @@
+module Bitex
+  # Your balances, fee and deposit addresses
+  class Profile
+    # Your profile conveniently formatted as a ruby hash with symbolized keys.
+    # @see https://bitex.la/developers#profile
+    def self.get
+      Api.private(:GET, '/private/profile').symbolize_keys
+    end
+  end
+end

data/lib/bitex/sell.rb

@@ -0,0 +1,25 @@
+module Bitex
+  # A transaction in which you sold some quantity of specie.
+  class Sell < Match
+    # @!attribute id
+    #   @return [Integer] This sell's unique ID.
+
+    # @!attribute created_at
+    #   @return [Time] Time when this Sell happened.
+
+    # @!attribute specie
+    #   @return [Symbol] :btc or :ltc
+    
+    # @!attribute quantity
+    #   @return [BigDecimal] Quantity of specie sold
+    
+    # @!attribute amount
+    #   @return [BigDecimal] Amount of USD earned
+
+    # @!attribute fee
+    #   @return [BigDecimal] USD amount paid as transaction fee.
+    
+    # @!attribute price
+    #   @return [BigDecimal] Price charged per unit
+  end
+end

data/lib/bitex/specie_deposit.rb

@@ -0,0 +1,27 @@
+module Bitex
+  # A deposit of some specie into your bitex.la balance
+  class SpecieDeposit
+    # @!attribute id
+    #   @return [Integer] This SpecieDeposit's unique ID.
+    attr_accessor :id
+
+    # @!attribute created_at
+    #   @return [Time] Time when this deposit credited.
+    attr_accessor :created_at
+
+    # @!attribute specie
+    #   @return [Symbol] :btc or :ltc
+    attr_accessor :specie
+
+    # @!attribute quantity
+    #   @return [BigDecimal] Quantity deposited
+    attr_accessor :quantity
+
+    # @visibility private
+    def self.from_json(json)
+      Api.from_json(new, json, true) do |thing|
+        thing.quantity = BigDecimal.new(json[4].to_s)
+      end
+    end
+  end
+end

data/lib/bitex/specie_withdrawal.rb

@@ -0,0 +1,56 @@
+module Bitex
+  # A withdrawal of some specie from your bitex.la balance
+  class SpecieWithdrawal
+    # @!attribute id
+    #   @return [Integer] This SpecieWithdrawal's unique ID.
+    attr_accessor :id
+
+    # @!attribute created_at
+    #   @return [Time] Time when this withdrawal was requested by you.
+    attr_accessor :created_at
+
+    # @!attribute specie
+    #   @return [Symbol] :btc or :ltc
+    attr_accessor :specie
+
+    # @!attribute amount
+    #   @return [BigDecimal] Quantity deposited
+    attr_accessor :quantity
+    
+    # @!attribute status
+    #  Returns the status of this withdrawal.
+    #  * :received Our engine is checking if you have enough funds.
+    #  * :pending your withdrawal was accepted and is being processed.
+    #  * :done your withdrawal was processed and published to the network.
+    #  * :cancelled your withdrawal could not be processed.
+    attr_accessor :status
+
+    # @!attribute reason
+    #  Returns the reason for cancellation of this withdrawal, if any.
+    #  * :not_cancelled
+    #  * :insufficient_funds The instruction was received, but you didn't have enough
+    #    funds available
+    #  * :destination_invalid The destination address was invalid.
+    attr_accessor :reason
+
+    # @visibility private
+    def self.from_json(json)
+      status_lookup = {
+        1 => :received,
+        2 => :pending,
+        3 => :done,
+        4 => :cancelled,
+      }
+      reason_lookup = {
+        0 => :not_cancelled,
+        1 => :insufficient_funds,
+        2 => :destination_invalid,
+      }
+      Api.from_json(new, json, true) do |thing|
+        thing.quantity = BigDecimal.new(json[4].to_s)
+        thing.status = status_lookup[json[5]]
+        thing.reason = reason_lookup[json[6]]
+      end
+    end
+  end
+end

data/lib/bitex/transaction.rb

@@ -0,0 +1,14 @@
+module Bitex
+  # Utility class for fetching an heterogeneous list of objects that
+  # compose your transaction history.
+  class Transaction 
+    # @return [Array<Bitex::Buy, Bitex::Sell, Bitex::SpecieDeposit,
+    #   Bitex::SpecieWithdrawal, Bitex::UsdDeposit, Bitex::UsdWithdrawal>]
+    #   Returns an heterogeneous array with all your transactions for the past
+    #   30 days sorted by descending date.
+    # @see https://bitex.la/developers#user-transactions
+    def self.all
+      Api.private(:GET, '/private/transactions').collect{|o| Api.deserialize(o) }
+    end
+  end
+end

data/lib/bitex/usd_deposit.rb

@@ -0,0 +1,65 @@
+module Bitex
+  # A deposit of USD to your bitex.la balance.
+  class UsdDeposit
+    # @!attribute id
+    #   @return [Integer] This UsdDeposit's unique ID.
+    attr_accessor :id
+
+    # @!attribute created_at
+    #   @return [Time] Time when this deposit was announced by you.
+    attr_accessor :created_at
+
+    # @!attribute amount
+    #   @return [BigDecimal] Final amount credited to your bitex USD balance.
+    attr_accessor :amount
+    
+    # @!attribute deposit_method
+    #   The method used for this deposit
+    #   * :astropay
+    #   * :other
+    attr_accessor :deposit_method
+
+    # @!attribute status
+    #  The status of this deposit.
+    #  * :pending your deposit notice was received, we're waiting for the funds
+    #    to credit.
+    #  * :done your deposit credited correctly, the funds are available in your
+    #    balance.
+    #  * :cancelled your deposit did not credit, check the 'reason' field.
+    attr_accessor :status
+
+    # @!attribute reason
+    #  The reason for cancellation of this deposit, if any.
+    #  * :not_cancelled.
+    #  * :did_not_credit funds never arrived to our end.
+    #  * :sender_unknown we could not accept these funds because you're not the
+    #    sender.
+    #  * :other we'll contact you regarding this deposit.
+    attr_accessor :reason
+
+    # @visibility private
+    def self.from_json(json)
+      deposit_method_lookup = {
+        1 => :astropay,
+        2 => :other,
+      }
+      status_lookup = {
+        1 => :pending,
+        2 => :done,
+        3 => :cancelled,
+      }
+      reason_lookup = {
+        0 => :not_cancelled,
+        1 => :did_not_credit,
+        2 => :sender_unknown,
+        3 => :other,
+      }
+      Api.from_json(new, json) do |thing|
+        thing.amount = BigDecimal.new(json[3].to_s)
+        thing.deposit_method = deposit_method_lookup[json[4]]
+        thing.status = status_lookup[json[5]]
+        thing.reason = reason_lookup[json[6]]
+      end
+    end
+  end
+end

data/lib/bitex/usd_withdrawal.rb

@@ -0,0 +1,56 @@
+module Bitex
+  # A withdrawal of USD from your bitex.la balance
+  class UsdWithdrawal
+    # @!attribute id
+    #   @return [Integer] This UsdWithdrawal's unique ID.
+    attr_accessor :id
+
+    # @!attribute created_at
+    #   @return [Time] Time when this withdrawal was requested by you.
+    attr_accessor :created_at
+
+    # @!attribute amount
+    #   @return [BigDecimal] Amount withdrawn from your bitex USD balance.
+    attr_accessor :amount
+
+    # @!attribute status
+    #  Returns the status of this withdrawal.
+    #  * :received Our engine is checking if you have enough funds.
+    #  * :pending your withdrawal was accepted and is being processed.
+    #  * :done your withdrawal was processed and it's on its way through
+    #    the withdrawal channel you chose.
+    #  * :cancelled your withdrawal could not be processed.
+    attr_accessor :status
+
+    # @!attribute reason
+    #  Returns the reason for cancellation of this withdrawal, if any.
+    #  * :not_cancelled
+    #  * :insufficient_funds The instruction was received, but you didn't have enough
+    #    funds available
+    #  * :no_instructions We could not understand the instructions you provided.
+    #  * :recipient_unknown we could not issue this withdrawal because you're
+    #    not the receiving party.
+    attr_accessor :reason
+
+    # @visibility private
+    def self.from_json(json)
+      status_lookup = {
+        1 => :received,
+        2 => :pending,
+        3 => :done,
+        4 => :cancelled,
+      }
+      reason_lookup = {
+        0 => :not_cancelled,
+        1 => :insufficient_funds,
+        2 => :no_instructions,
+        3 => :recipient_unknown,
+      }
+      Api.from_json(new, json) do |thing|
+        thing.amount = BigDecimal.new(json[3].to_s)
+        thing.status = status_lookup[json[4]]
+        thing.reason = reason_lookup[json[5]]
+      end
+    end
+  end
+end

data/lib/bitex/version.rb

@@ -0,0 +1,3 @@
+module Bitex
+  VERSION = "0.0.2"
+end

data/spec/ask_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Bitex::Ask do
+  let(:as_json) do
+    [2,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,1]
+  end
+  
+  it_behaves_like 'API class'
+  it_behaves_like 'API class with a specie'
+  it_behaves_like 'JSON deserializable order'
+
+  describe 'Api calls' do
+    before(:each){ Bitex.api_key = 'valid_api_key' }
+    it_behaves_like 'Order', 'asks'
+  end
+
+  { quantity: 100.0, remaining_quantity: 100.0}.each do |field, value|
+    it "sets #{field} as BigDecimal" do
+      thing = subject.class.from_json(as_json).send(field)
+      thing.should be_a BigDecimal
+      thing.should == value
+    end
+  end
+end

data/spec/bid_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Bitex::Bid do
+  let(:as_json) do
+    [1,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,1]
+  end
+  
+  it_behaves_like 'API class'
+  it_behaves_like 'API class with a specie'
+  it_behaves_like 'JSON deserializable order'
+
+  describe 'Api calls' do
+    before(:each){ Bitex.api_key = 'valid_api_key' }
+    it_behaves_like 'Order', 'bids'
+  end
+
+  { amount: 100.0, remaining_amount: 100.0}.each do |field, value|
+    it "sets #{field} as BigDecimal" do
+      thing = subject.class.from_json(as_json).send(field)
+      thing.should be_a BigDecimal
+      thing.should == value
+    end
+  end
+end

data/spec/buy_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Bitex::Buy do
+  let(:as_json) do
+    [4,12345678,946685400,1,100.50000000,201.0000000,0.05000000,2.00000000]
+  end
+  
+  it_behaves_like 'API class'
+  it_behaves_like 'API class with a specie'
+  it_behaves_like 'JSON deserializable match'
+end

data/spec/fixtures/aggregated_data.json

@@ -0,0 +1 @@
+[[1403668800, 570.0, 574.0, 570.0, 574.0, 1.06771929, 571.0, 570.917848641659],[1403683200, 560.0, 570.0, 560.0, 570.0, 1.14175147, 565.0, 565.753596095655],[1403697600, 560.0, 560.0, 560.0, 560.0, 0.0, 565.0, 0.0],[1403712000, 560.0, 560.0, 560.0, 560.0, 0.0, 565.0, 0.0]]

data/spec/fixtures/asks_cancel.json

@@ -0,0 +1 @@
+[1,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,3]

data/spec/fixtures/asks_create.json

@@ -0,0 +1 @@
+[2,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,1]

data/spec/fixtures/bids_cancel.json

@@ -0,0 +1 @@
+[1,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,3]

data/spec/fixtures/bids_create.json

@@ -0,0 +1 @@
+[1,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,1]

data/spec/fixtures/market_ticker.json

@@ -0,0 +1 @@
+{"last":639.0,"high":659.0,"low":639.0,"vwap":647.195852839369,"volume":4.80579022,"bid":637.0,"ask":638.5}

data/spec/fixtures/order_book.json

@@ -0,0 +1 @@
+{"bids":[[639.21,1.95],[637.0,0.47],[630.0,1.58]],"asks":[[642.4,0.4],[643.3,0.95],[644.3,0.25]]}

data/spec/fixtures/orders.json

@@ -0,0 +1 @@
+[[1,12345678,946685400,1,100.00000000,10.00000000,1000.00000000,1],[2,12345678,946685400,1,10.00000000,1.00000000,1100.00000000,1]]

data/spec/fixtures/profile.json

@@ -0,0 +1 @@
+{"usd_balance":10000.00,"usd_reserved":2000.00,"usd_available":8000.00,"btc_balance":20.00000000,"btc_reserved":5.00000000,"btc_available":15.00000000,"ltc_balance":250.00000000,"ltc_reserved":100.00000000,"ltc_available":150.00000000,"fee":0.5,"btc_deposit_address":"1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","ltc_deposit_address":"LXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}

data/spec/fixtures/transactions.json

@@ -0,0 +1 @@
+[[1404259180, 1272, 650.0, 0.5], [1404259179, 1271, 639.0, 0.46948356]]

data/spec/fixtures/user_transactions.json

@@ -0,0 +1 @@
+[[3,12345678,946685400,1,2.00000000,600.00000000,0.05000000,300.00000000],[4,12345678,946685400,1,2.00000000,600.00000000,0.05000000,300.00000000],[5,12345678,946685400,1,100.00000000],[6,12345678,946685400,1,100.00000000,1,0],[7,12345678,946685400,100.00000000,1,1,0],[8,12345678,946685400,100.00000000,1,0]]

data/spec/market_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Bitex::MarketData do
+
+  { btc: Bitex::BitcoinMarketData,
+    ltc: Bitex::LitecoinMarketData
+  }.each do |specie, market_data|
+    describe "when getting #{specie} market data" do
+      it "gets the ticker" do
+        stub_get("/#{specie}/market/ticker", 'market_ticker')
+        market_data.ticker.should == {
+          last: 639.0, high: 659.0, low: 639.0, vwap: 647.195852839369,
+          volume: 4.80579022, bid: 637.0, ask: 638.5
+        }
+      end
+      
+      it "gets the order book" do
+        stub_get("/#{specie}/market/order_book", 'order_book')
+        market_data.order_book.should == {
+          bids: [[639.21,1.95],[637.0,0.47],[630.0,1.58]],
+          asks: [[642.4,0.4],[643.3,0.95],[644.3,0.25]]
+        }
+      end
+      
+      it "gets the transactions" do
+        stub_get("/#{specie}/market/transactions", 'transactions')
+        market_data.transactions.should == [
+          [1404259180, 1272, 650.0, 0.5],
+          [1404259179, 1271, 639.0, 0.46948356]
+        ]
+      end
+      
+      %w(last_24_hours last_7_days last_30_days).each do |method|
+        it "gets aggregated data for #{method}" do
+          stub_get("/#{specie}/market/#{method}", 'aggregated_data')
+          market_data.send(method).should == [
+            [1403668800, 570.0, 574.0, 570.0, 574.0, 1.06771929, 571.0, 570.917848641659],
+            [1403683200, 560.0, 570.0, 560.0, 570.0, 1.14175147, 565.0, 565.753596095655],
+            [1403697600, 560.0, 560.0, 560.0, 560.0, 0.0, 565.0, 0.0],
+            [1403712000, 560.0, 560.0, 560.0, 560.0, 0.0, 565.0, 0.0]
+          ]
+        end
+      end
+    end
+  end
+end

data/spec/order_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Bitex::Order do
+  before(:each) do
+    Bitex.api_key = 'valid_api_key'
+  end
+
+  it 'gets all orders' do
+    stub_private(:get, "/private/orders", 'orders')
+    bid, ask, empty = Bitex::Order.all
+    bid.should be_a Bitex::Bid
+    ask.should be_a Bitex::Ask
+    empty.should be_nil
+  end
+
+  it 'gets active orders' do
+    stub_private(:get, "/private/orders/active", 'orders')
+    bid, ask, empty = Bitex::Order.active
+    bid.should be_a Bitex::Bid
+    ask.should be_a Bitex::Ask
+    empty.should be_nil
+  end
+end

data/spec/profile_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Bitex::Profile do
+  before(:each){ Bitex.api_key = 'valid_api_key' }
+
+  it 'gets your profile' do
+    stub_private(:get, '/private/profile', 'profile')
+    Bitex::Profile.get.should == {
+      usd_balance: 10000.0,
+      usd_reserved: 2000.0,
+      usd_available: 8000.0,
+      btc_balance: 20.0,
+      btc_reserved: 5.0,
+      btc_available: 15.0,
+      ltc_balance: 250.0,
+      ltc_reserved: 100.0,
+      ltc_available: 150.0,
+      fee: 0.5,
+      btc_deposit_address: "1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+      ltc_deposit_address: "LXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+    }
+  end
+end