bitex 0.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5585d9b3c87459de35ecbe8c0f6f215597be0976
-  data.tar.gz: 277eaa74fe7d87546334a7f6fc40c6a9e42df3f0
+  metadata.gz: 151ad0a112110c7ce40e5ce09c5f753a10253bcb
+  data.tar.gz: aecf7f5c80fe3afba0da32ddb4f820f8d4fb7bc4
 SHA512:
-  metadata.gz: afcc613f373bba455e4014491d5649f06b748a64eb055d0b3fe0f53534295e42a4d5a82bb2d873891b0837870aa7ad8ffe4c3cded6a123b822be7a3b5c72e80d
-  data.tar.gz: 0b07c253e3848e571514e75487dc520c5007d7994c1b7cbba146e56e23047a889e5cef753e385d0021975d81492b7e5d74690fb683aee284cc799a99b4b9c8aa
+  metadata.gz: d9785a0c2b14f157e6cdef69079c12c4be59c9463bdff76bf865aa1931f98d46eff6d6b376c1392cf2bd0452870296c58e8e76475b0994ca3e0ce8dfaf6b1b26
+  data.tar.gz: cb426c0e8d50ddd8982e8505d3696374ab637b0822693cfc98d53145dacd02de0fc220389db4195f38d2b0a9f9327b5072148d4505a2f65a2695f30d0f2f4193

data/.circleci/config.yml

@@ -0,0 +1,63 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "bitex.gemspec" }}-{{ checksum "Gemfile" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "bitex.gemspec" }}-{{ checksum "Gemfile" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # run lints
+      - run:
+          name: run lints
+          command: |
+            bundle exec rubocop
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.rubocop.yml

@@ -0,0 +1,32 @@
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 130
+
+Metrics/LineLength:
+  Max: 130
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 7
+
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'Gemfile'
+    - 'Gemfile.lock'
+    - 'LICENSE.txt'
+    - 'README.md'
+    - 'Rakefile'
+    - 'bitex.gemspec'
+    - 'spec/**/*'
+    - 'vendor/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/bitex.gemspec

@@ -4,30 +4,33 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bitex/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bitex"
+  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.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.require_paths = ['lib']
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "curb", "~> 0.9.3"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'curb', '~> 0.9.3'
 
   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"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'webmock'
 end

data/lib/bitex.rb

@@ -3,9 +3,15 @@ require 'active_support/core_ext'
 require 'json'
 require 'curl'
 require 'bigdecimal'
+require 'bigdecimal/util'
 require 'bitex/match'
-Dir[File.expand_path("../bitex/*.rb", __FILE__)].each {|f| require f}
+require 'bitex/base_order'
 
+Dir[File.expand_path('bitex/*.rb', __dir__)].each { |f| require f }
+
+##
+# Documentation here!
+#
 module Bitex
   mattr_accessor :api_key
   mattr_accessor :sandbox

data/lib/bitex/api.rb

@@ -1,5 +1,10 @@
 module Bitex
-  class ApiError < StandardError; end
+  class ApiError < StandardError
+  end
+
+  ##
+  # Documentation here!
+  #
   class Api
     def self.grab_curl
       if @curl
@@ -9,34 +14,27 @@ module Bitex
       end
 
       @curl.ssl_version = Curl::CURL_SSLVERSION_TLSv1
-      if Bitex.debug
-        @curl.on_debug do |t,d|
-          if d.to_s.size < 300
-            puts "DEBUG SSL #{t}, #{d}"
-          end
-        end
-      end
-
+      @curl.on_debug { |t, d| puts "DEBUG SSL #{t}, #{d}" if d.to_s.size < 300 } if Bitex.debug
       @curl.connect_timeout = 30
       @curl.timeout = 30
       @curl
     end
 
-    def self.curl(verb, path, options={}, files={})
+    def self.curl(verb, path, options = {}, files = {})
       verb = verb.upcase.to_sym
       query = verb == :GET ? "?#{options.to_query}" : ''
       prefix = Bitex.sandbox ? 'sandbox.' : ''
 
       curl = grab_curl
       curl.url = "https://#{prefix}bitex.la/api-v1/rest#{path}#{query}"
-      
+
       if verb == :POST
         fields = []
         unless files.empty?
-          fields += files.collect{|k, v| Curl::PostField.file(k.to_s, v) }
+          fields += files.map { |k, v| Curl::PostField.file(k.to_s, v) }
           curl.multipart_form_post = true
         end
-        fields += options.collect do |k,v|
+        fields += options.map do |k, v|
           next unless v
           Curl::PostField.content(k.to_s, v)
         end.compact
@@ -48,50 +46,45 @@ module Bitex
       code = curl.response_code
 
       unless [200, 201, 202].include?(code)
-        raise ApiError.new("Got #{code} fetching #{path} with
-#{options}\n\n#{curl.head}\n\n#{curl.body}")
+        raise ApiError, "Got #{code} fetching #{path} with #{options}\n\n#{curl.head}\n\n#{curl.body}"
       end
 
-      return curl
+      curl
     end
-    
-    def self.public(path, options={})
-      c = curl(:GET, path)
-      JSON.parse(c.body)
+
+    def self.public(path, _options = {})
+      response = curl(:GET, path)
+      JSON.parse(response.body)
     end
-    
-    def self.private(verb, path, options={}, files={})
-      if Bitex.api_key.nil?
-        raise StandardError.new("No api_key available to make private key calls")
-      end
-      c = curl(verb, path, options.merge(api_key: Bitex.api_key), files)
-      JSON.parse(c.body)
+
+    def self.private(verb, path, options = {}, files = {})
+      raise StandardError, 'No api_key available to make private key calls' if Bitex.api_key.nil?
+      response = curl(verb, path, options.merge(api_key: Bitex.api_key), files)
+      JSON.parse(response.body)
     end
-    
-    # Deserialize a single object from a json representation as specified on the
-    # bitex API class reference
+
+    # 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,
+      {
+        1 => Bid,
         2 => Ask,
         3 => Buy,
         4 => Sell,
         5 => SpecieDeposit,
         6 => SpecieWithdrawal,
         7 => UsdDeposit,
-        8 => UsdWithdrawal,
-      }[object.first].from_json(object)
+        8 => UsdWithdrawal
+      }[object[0]].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]]
+    def self.from_json(thing, json, &block)
+      thing.tap do |t|
+        t.id = json[1]
+        t.created_at = Time.at(json[2])
+        block.call(t)
       end
-      block.call(thing)
-      return thing
     end
   end
 end

data/lib/bitex/ask.rb

@@ -0,0 +1,74 @@
+module Bitex
+  # An Ask is an order to sell a given orderbook.
+  # @see BaseOrder
+  class Ask < BaseOrder
+    # @!attribute id
+    #   @return [Integer] This Ask's unique ID.
+
+    # @!attribute created_at
+    #   @return [Time] Time when this Ask was created.
+
+    # @!attribute orderbook
+    #   @return [Symbol] :btc_usd or :btc_ars
+
+    # @!attribute quantity
+    # TODO: rever esta documentacion
+    #   @return [BigDecimal] Quantity of specie to sell in this Ask.
+    attr_accessor :quantity
+
+    # @!attribute remaining_quantity
+    # TODO: rever esta documentacion
+    #   @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.
+
+    # @!attribute reason
+    #  The cancellation reason of this Ask.
+    #  * :not_cancelled Has not been cancelled.
+    #  * :not_enough_funds Not enough funds to place this order.
+    #  * :user_cancelled Cancelled per user's request.
+    #  * :system_cancelled Bitex cancelled this order, for a good reason.
+
+    # @!attribute produced_amount
+    #   @return [BigDecimal] Amount of USD produced from this sale
+    attr_accessor :produced_amount
+
+    # @!attribute issuer
+    #   @return [String] The issuer of this order, helps you tell apart orders created from the web UI and the API.
+
+    # @visibility private
+    def self.base_path
+      '/asks'
+    end
+
+    # TODO: rever esta documentacion
+    # Create a new Ask for selling a Quantity of specie charging no less than Price per each.
+    # @param orderbook [Symbol] :btc_usd or :btc_ars, whatever you're selling.
+    # @param quantity [BigDecimal] Quantity to sell.
+    # @param price [BigDecimal] Minimum price to charge when selling.
+    # @param wait [Boolean] Block the process and wait until this ask moves out of the :received state, defaults to false.
+    # @see https://bitex.la/developers#create-ask
+    def self.create!(orderbook, quantity, price, wait = false)
+      super
+    end
+
+    # @visibility private
+    def self.from_json(json, order = nil)
+      super(json, order).tap do |thing|
+        thing.quantity = (json[4].presence || 0).to_d
+        thing.remaining_quantity = (json[5].presence || 0).to_d
+        thing.produced_amount = (json[9].presence || 0).to_d
+      end
+    end
+  end
+end

data/lib/bitex/base_order.rb

@@ -0,0 +1,106 @@
+module Bitex
+  # Base class for Bids and Asks
+  class BaseOrder
+    # @!attribute id
+    #   @return [Integer] This Bid's unique ID.
+    attr_accessor :id
+
+    # @!attribute created_at
+    #   @return [Time] Time when this Bid was created.
+    attr_accessor :created_at
+
+    # @!attribute orderbook
+    #   @return [Symbol] :btc_usd or :btc_ars
+    attr_accessor :orderbook
+
+    # @!attribute price
+    #   @return [BigDecimal] Maximum price to pay per unit.
+    attr_accessor :price
+
+    # @!attribute status
+    #  The status in its lifecycle, was defined into Ask/Bid subclass.
+    attr_accessor :status
+
+    # @!attribute reason
+    #  The cancellation reason for your Ask/Bid subclass, if any.
+    #  * :not_cancelled Has not been cancelled.
+    #  * :not_enough_funds Not enough funds to place this order.
+    #  * :user_cancelled Cancelled per user's request
+    #  * :system_cancelled Bitex cancelled this order, for a good reason.
+    attr_accessor :reason
+
+    # @!attribute issuer
+    #   @return [String] The issuer of this order, helps you tell apart orders created from the web UI and the API.
+    attr_accessor :issuer
+
+    # Returns an array with all your active orders of this type and another order of this type that was active 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)
+      from_json(Api.private(:get, "/private#{base_path}/#{id}"))
+    end
+
+    # @visibility private
+    def self.create!(orderbook, amount, price, wait = false)
+      params = { amount: amount, price: price, orderbook: { btc_usd: 1, btc_ars: 5 }[orderbook] }
+
+      order = from_json(Api.private(:post, "/private#{base_path}", params))
+      retries = 0
+      while wait && order.status == :received
+        sleep(0.2)
+        order = find_order(order)
+        retries += 1
+        # Wait 15 minutes for the order to be accepted.
+        raise StandardError, "Timed out waiting for #{base_path} ##{order.id}" if retries > 5000
+      end
+      order
+    end
+
+    def cancel!
+      path = "/private#{self.class.base_path}/#{id}/cancel"
+      self.class.from_json(Api.private(:post, path), self)
+    end
+
+    # @visibility private
+    def self.from_json(json, order = nil)
+      Api.from_json(order || new, json) do |thing|
+        thing.orderbook = orderbooks[json[3]]
+        thing.price = json[6].to_s.to_d
+        thing.status = statuses[json[7]]
+        thing.reason = reasons[json[8]]
+        thing.issuer = json[10]
+      end
+    end
+
+    private_class_method
+
+    def self.find_order(order)
+      find(order.id)
+    rescue StandardError
+      order
+    end
+
+    def self.orderbooks
+      { 1 => :btc_usd, 5 => :btc_ars }
+    end
+
+    def self.reasons
+      { 0 => :not_cancelled, 1 => :not_enough_funds, 2 => :user_cancelled, 3 => :system_cancelled }
+    end
+
+    def self.statuses
+      { 1 => :received, 2 => :executing, 3 => :cancelling, 4 => :cancelled, 5 => :completed }
+    end
+  end
+end