bitex 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitex.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nubis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Bitex
+
+[Bitex.la](https://bitex.la/developers) API Client library.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bitex'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitex
+
+
+## Use Public Market Data
+
+Bitex::BitcoinMarketData and Bitex::LitecoinMarketData classes have methods for
+fetching all public market data available.
+
+### Ticker
+
+    ruby > Bitex::BitcoinMarketData.ticker
+    => {:last=>632.0, :high=>648.0, :low=>625.94, :vwap=>633.670289779918,
+        :volume=>9.49595029, :bid=>632.0, :ask=>648.0}
+
+### Order Book
+
+    ruby > Bitex::BitcoinMarketData.order_book
+    => {:bids=>[[632.0, 38.910443037975], [630.87, 1.8], ...],
+        :asks=>[[634.9, 0.95], [648.0, 0.4809267], ...]}
+
+### Transactions
+
+    ruby > Bitex::BitcoinMarketData.transactions
+    => [[1404501180, 1335, 632.0, 0.95], [1404501159, 1334, 632.0, 0.95], ...]
+
+## Use for Private Trading
+
+### Authentication
+
+Sign in to [https://bitex.la/developers](https://bitex.la/developers) and create
+an `api_key`. You can find more information about our authentication security
+on that page. Once done you can start using it as follows:
+
+    ruby > Bitex.api_key = 'your_api_key'
+    => "your_api_key"
+
+### Get your balances, deposit addresses, fee
+
+    ruby > Bitex::Profile.get
+
+### Place a Bid
+
+    ruby > Bitex::Bid.create!(:btc, 1000, 500) # Spend 1000 USD in btc, paying up to 500 each
+
+### Place an Ask
+
+    ruby > Bitex::Ask.create!(:ltc, 2, 500) # Sell 2 LTC
+
+### List your pending or recently active orders
+
+    ruby > Bitex::Order.all
+
+### List your recent transactions
+
+    ruby > Bitex::Transaction.all
+
+## Want more?
+
+Find the full API description at
+[https://bitex.la/developers](https://bitex.la/developers)
+
+Read this gems full documentation at
+[http://rubydoc.info/github/bitex-la/bitex-ruby/master/frames/file/README.md](http://rubydoc.info/github/bitex-la/bitex-ruby/master/frames/file/README.md)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bitex.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitex"
+  spec.version       = Bitex::VERSION
+  spec.authors       = ["Nubis", "Eromirou"]
+  spec.email         = ["nb@bitex.la", "tr@bitex.la"]
+  spec.description   = %q{API client library for bitex.la. Fetch public market
+                        data and build trading robots}
+  spec.summary       = "API client library for bitex.la"
+  spec.homepage      = "http://bitex.la/developers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "curb"
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "shoulda-matchers"
+end

data/lib/bitex.rb

@@ -0,0 +1,11 @@
+require 'active_support/core_ext'
+require 'json'
+require 'curl'
+require 'bigdecimal'
+require 'active_support'
+require 'bitex/match'
+Dir[File.expand_path("../bitex/*.rb", __FILE__)].each {|f| require f}
+
+module Bitex
+  mattr_accessor :api_key
+end

data/lib/bitex/api.rb

@@ -0,0 +1,57 @@
+module Bitex
+  class ApiError < Exception; end
+  class Api
+    def self.curl(verb, path, options={})
+      verb = verb.upcase.to_sym
+      query = verb == :GET ? "?#{options.to_query}" : ''
+
+      curl = Curl::Easy.new("https://bitex.la/api-v1/rest#{path}#{query}")
+      curl.post_body = options.to_query if verb == :POST
+      curl.http(verb)
+      code = curl.response_code
+
+      unless [200, 201, 202].include?(code)
+        raise ApiError.new("Got #{code} fetching #{path} with #{options}")
+      end
+
+      return curl
+    end
+    
+    def self.public(path, options={})
+      JSON.parse(curl(:GET, path).body)
+    end
+    
+    def self.private(verb, path, options={})
+      if Bitex.api_key.nil?
+        raise Exception.new("No api_key available to make private key calls")
+      end
+      JSON.parse(curl(verb, path, options.merge(api_key: Bitex.api_key)).body)
+    end
+    
+    # Deserialize a single object from a json representation as specified on the
+    # bitex API class reference
+    # @see https://bitex.la/developers#api-class-reference
+    def self.deserialize(object)
+      { 1 => Bid,
+        2 => Ask,
+        3 => Buy,
+        4 => Sell,
+        5 => SpecieDeposit,
+        6 => SpecieWithdrawal,
+        7 => UsdDeposit,
+        8 => UsdWithdrawal,
+      }[object.first].from_json(object)
+    end
+    
+    # @visibility private
+    def self.from_json(thing, json, with_specie=false, &block)
+      thing.id = json[1]
+      thing.created_at = Time.at(json[2])
+      if with_specie
+        thing.specie = {1 => :btc, 2 => :ltc}[json[3]]
+      end
+      block.call(thing)
+      return thing
+    end
+  end
+end

data/lib/bitex/buy.rb

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

data/lib/bitex/market.rb

@@ -0,0 +1,67 @@
+module Bitex
+  # Public market data for a specie, do not use directly, use
+  # {BitcoinMarketData} and {LitecoinMarketData} instead.
+  class MarketData
+
+    # The species currency ticker conveniently formatted as a ruby Hash with
+    # symbolized keys.
+    # @see https://bitex.la/developers#ticker
+    def self.ticker
+      api_get('/market/ticker').symbolize_keys
+    end
+
+    # The species order book as a Hash with two keys: bids and asks.
+    # Each of them is a list of list consisting of [price, quantity]
+    # @see https://bitex.la/developers#order_book
+    def self.order_book
+      api_get('/market/order_book').symbolize_keys
+    end
+
+    # The species transactions for the past hour as a list of lists,
+    # each composed of [unix_timestamp, transaction_id, price, quantity]
+    # @see https://bitex.la/developers#transactions
+    def self.transactions
+      api_get('/market/transactions')
+    end
+    
+    # Returns a list of lists with aggregated transaction data for each hour
+    # from the last 24 hours.
+    # @see https://bitex.la/developers#last_24_hours
+    def self.last_24_hours
+      api_get('/market/last_24_hours')
+    end
+
+    # Returns a list of lists with aggregated transaction data for each 4 hour
+    # period from the last 7 days.
+    # @see https://bitex.la/developers#last_7_days
+    def self.last_7_days
+      api_get('/market/last_7_days')
+    end
+
+    # Returns a list of lists with aggregated transaction data for each day
+    # from the last 30 days.
+    # @see https://bitex.la/developers#last_30_days
+    def self.last_30_days
+      api_get('/market/last_30_days')
+    end
+
+    # @visibility private
+    def self.api_get(path, options = {})
+      Api.public("/#{specie}#{path}", options)
+    end
+  end
+
+  # A {MarketData} for Bitcoin.
+  class BitcoinMarketData < MarketData
+    def self.specie
+      'btc'
+    end
+  end
+
+  # A {MarketData} for Litecoin.
+  class LitecoinMarketData < MarketData
+    def self.specie
+      'ltc'
+    end
+  end
+end

data/lib/bitex/match.rb

@@ -0,0 +1,24 @@
+module Bitex
+  # @visibility private
+  # Both Buy and Sell are a kind of Match, they deserialize the same
+  # and have very similar fields, although their documentation may differ.
+  class Match
+    attr_accessor :id
+    attr_accessor :created_at
+    attr_accessor :specie
+    attr_accessor :quantity
+    attr_accessor :amount
+    attr_accessor :fee
+    attr_accessor :price
+
+    # @visibility private
+    def self.from_json(json)
+      Api.from_json(new, json, true) do |thing|
+        thing.quantity = BigDecimal.new(json[4].to_s)
+        thing.amount = BigDecimal.new(json[5].to_s)
+        thing.fee = BigDecimal.new(json[6].to_s)
+        thing.price = BigDecimal.new(json[7].to_s)
+      end   
+    end
+  end
+end

data/lib/bitex/order.rb

@@ -0,0 +1,185 @@
+module Bitex
+  
+  # Base class for Bids and Asks
+  class OrderBase
+    attr_accessor :id
+    attr_accessor :created_at
+    attr_accessor :specie
+    attr_accessor :price
+    attr_accessor :status
+
+    # Returns an array with all your active orders
+    # of this type, and any other order of this type that was active in the
+    # last 2 hours. Uses {Order.all} under the hood.
+    def self.all
+      Order.all.select{|o| o.is_a?(self) }
+    end
+
+    # Returns an array with all your active orders of this type
+    # Uses {Order.active} under the hood.
+    def self.active
+      Order.active.select{|o| o.is_a?(self) }
+    end
+    
+    # Find an order in your list of active orders.
+    # Uses {Order.active} under the hood.
+    def self.find(id)
+      all.select{|o| o.id == id}.first
+    end
+    
+    def cancel!
+      path = "/private#{self.class.base_path}/cancel"
+      self.class.from_json(Api.private(:post, path), self)
+    end
+    
+    # @visibility private
+    def self.from_json(json, order = nil)
+      status_lookup = {
+        1 => :received,
+        2 => :executing,
+        3 => :cancelling,
+        4 => :cancelled,
+        5 => :completed,
+      }
+      Api.from_json(order || new, json, true) do |thing|
+        thing.price = BigDecimal.new(json[6].to_s)
+        thing.status = status_lookup[json[7]]
+      end   
+    end
+  end
+  
+  # A Bid is an order to buy a given specie.
+  # @see OrderBase
+  class Bid < OrderBase
+    # @!attribute id
+    #   @return [Integer] This Bid's unique ID.
+
+    # @!attribute created_at
+    #   @return [Time] Time when this Bid was created.
+
+    # @!attribute specie
+    #   @return [Symbol] :btc or :ltc
+    
+    # @!attribute amount
+    #   @return [BigDecimal] Amount of USD to spend in this Bid.
+    attr_accessor :amount
+
+    # @!attribute remaining_amount
+    #   @return [BigDecimal] Amount of USD left to be spent in this Bid.
+    attr_accessor :remaining_amount
+
+    # @!attribute price
+    #   @return [BigDecimal] Maximum price to pay per unit.
+
+    # @!attribute status
+    #  The status of this Bid in its lifecycle.
+    #  * :received queued to check if you have enough funds.
+    #  * :executing available in our ourderbook waiting to be matched.
+    #  * :cancelling To be cancelled as soon as our trading engine unlocks it.
+    #  * :cancelled no further executed. May have some Remaining Amount.
+    #  * :completed Fully executed, Remaining Amount should be 0.
+
+    # @visibility private
+    def self.base_path
+      '/bids'
+    end
+
+    # Create a new Bid for spending Amount USD paying no more than
+    # price per unit.
+    # @param specie [Symbol] :btc or :ltc, whatever you're buying.
+    # @see https://bitex.la/developers#create-bid
+    def self.create!(specie, amount, price)
+      params = {
+        amount: amount,
+        price: price,
+        specie: {btc: 1, ltc: 2}[specie]
+      }
+      from_json(Api.private(:post, "/private#{base_path}", params))
+    end
+    
+    # @visibility private
+    def self.from_json(json, order = nil)
+      super(json, order).tap do |thing|
+        thing.amount = BigDecimal.new(json[4].to_s)
+        thing.remaining_amount = BigDecimal.new(json[5].to_s)
+      end
+    end
+  end
+
+  # An Ask is an order to sell a given specie.
+  # @see OrderBase
+  class Ask < OrderBase
+    # @!attribute id
+    #   @return [Integer] This Ask's unique ID.
+
+    # @!attribute created_at
+    #   @return [Time] Time when this Ask was created.
+
+    # @!attribute specie
+    #   @return [Symbol] :btc or :ltc
+    
+    # @!attribute quantity
+    #   @return [BigDecimal] Quantity of specie to sell in this Ask.
+    attr_accessor :quantity
+
+    # @!attribute remaining_quantity
+    #   @return [BigDecimal] Quantity of specie left to sell in this Ask.
+    attr_accessor :remaining_quantity
+
+    # @!attribute price
+    #   @return [BigDecimal] Minimum price to charge per unit.
+
+    # @!attribute status
+    #  The status of this Ask in its lifecycle.
+    #  * :received queued to check if you have enough funds.
+    #  * :executing available in our ourderbook waiting to be matched.
+    #  * :cancelling To be cancelled as soon as our trading engine unlocks it.
+    #  * :cancelled no further executed. May have some Remaining Quantity.
+    #  * :completed Fully executed, Remaining Quantity should be 0.
+
+    # @visibility private
+    def self.base_path
+      '/asks'
+    end
+
+    # Create a new Ask for selling a Quantity of specie charging no less than
+    # Price per each.
+    # @param specie [Symbol] :btc or :ltc, whatever you're selling.
+    # @see https://bitex.la/developers#create-ask
+    def self.create!(specie, quantity, price)
+      params = {
+        amount: quantity,
+        price: price,
+        specie: {btc: 1, ltc: 2}[specie]
+      }
+      from_json(Api.private(:post, "/private#{base_path}", params))
+    end
+
+    # @visibility private
+    def self.from_json(json, order = nil)
+      super(json, order).tap do |thing|
+        thing.quantity = BigDecimal.new(json[4].to_s)
+        thing.remaining_quantity = BigDecimal.new(json[5].to_s)
+      end
+    end
+  end
+
+  # Convenience class for fetching heterogeneous lists with all your Bids and
+  # Asks.
+  class Order
+    # @return [Array<Bitex::Bid, Bitex::Ask>] Returns an heterogeneous array
+    #   with all your active orders and any other order that was active in the
+    #   last 2 hours.
+    # @see https://bitex.la/developers#orders
+    def self.all
+      Api.private(:GET, '/private/orders').collect{|o| Api.deserialize(o) }
+    end
+
+    # @return [Array<Bitex::Bid, Bitex::Ask>] Returns an heterogeneous array
+    #   with all your active orders.
+    # @see https://bitex.la/developers#active-orders
+    def self.active
+      Api.private(:GET, '/private/orders/active').collect{|o| Api.deserialize(o) }
+    end
+  end
+end