bitex 0.3 → 0.4.0

data/lib/bitex/bid.rb

@@ -0,0 +1,72 @@
+module Bitex
+  # A Bid is an order to buy a given orderbook.
+  # @see BaseOrder
+  class Bid < BaseOrder
+    # @!attribute id
+    #   @return [Integer] This Bid's unique ID.
+
+    # @!attribute created_at
+    #   @return [Time] Time when this Bid was created.
+
+    # @!attribute orderbook
+    #   @return [Symbol] :btc_usd or :btc_ars
+
+    # @!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.
+
+    # @!attribute reason
+    #  The cancellation reason for this Bid, 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.
+
+    # @!attribute produced_quantity
+    #   TODO: rever esta documentacion
+    #   @return [BigDecimal] Quantity of specie produced by this bid so far.
+    attr_accessor :produced_quantity
+
+    # @!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
+      '/bids'
+    end
+
+    # Create a new Bid for spending Amount USD paying no more than price per unit.
+    # @param orderbook [Symbol] :btc_usd or :btc_ars, whatever you're buying.
+    # @param amount [BigDecimal] Amount to spend buying.
+    # @param price [BigDecimal] Maximum price to pay per unit.
+    # @param wait [Boolean] Block the process and wait until this bid moves out of the :received state, defaults to false.
+    # @see https://bitex.la/developers#create-bid
+    def self.create!(orderbook, amount, price, wait = false)
+      super
+    end
+
+    # @visibility private
+    def self.from_json(json, order = nil)
+      super(json, order).tap do |thing|
+        thing.amount = (json[4].presence || 0).to_d
+        thing.remaining_amount = (json[5].presence || 0).to_d
+        thing.produced_quantity = (json[9].presence || 0).to_d
+      end
+    end
+  end
+end

data/lib/bitex/buy.rb

@@ -1,4 +1,5 @@
 module Bitex
+  # TODO: rever esta docu
   # A transaction in which you bought some quantity of specie.
   class Buy < Match
     # @!attribute id
@@ -7,18 +8,20 @@ module Bitex
     # @!attribute created_at
     #   @return [Time] Time when this Buy happened.
 
-    # @!attribute specie
-    #   @return [Symbol] :btc or :ltc
-    
+    # @!attribute orderbook
+    #   @return [Symbol] :btc_usd or :btc_ars
+
     # @!attribute quantity
+    #   TODO: rever esta docu
     #   @return [BigDecimal] Quantity of specie bought
-    
+
     # @!attribute amount
     #   @return [BigDecimal] Amount of USD spent
 
     # @!attribute fee
+    #   TODO: rever esta docu
     #   @return [BigDecimal] Quantity of specie paid as transaction fee.
-    
+
     # @!attribute price
     #   @return [BigDecimal] Price paid per unit
 

data/lib/bitex/kyc_file.rb

@@ -1,18 +1,40 @@
 module Bitex
+  ##
+  # Documentation here!
+  #
   class KycFile
-    attr_accessor :id, :kyc_profile_id, :url, :file_name,
-      :content_type, :file_size
+    # @!attribute id
+    #   @return [Integer] This KycFile's unique ID.
+    attr_accessor :id
+
+    # @!attribute id
+    #   @return [Integer] This KycProfile's unique ID.
+    attr_accessor :kyc_profile_id
+
+    # @!attribute url
+    #   @return [String] url to photo file.
+    attr_accessor :url
+
+    # @!attribute file_name
+    #   @return [String] file name.
+    attr_accessor :file_name
+
+    # @!attribute file_size
+    #   @return [Integer] file size.
+    attr_accessor :file_size
+
+    # @!attribute content_type
+    #   @return [String] Content type.
+    attr_accessor :content_type
 
     def self.from_json(json)
-      t = new
-      t.id, t.kyc_profile_id, t.url, t.file_name, t.content_type, t.file_size =
-        json
-      t
+      new.tap do |file|
+        file.id, file.kyc_profile_id, file.url, file.file_name, file.content_type, file.file_size = json
+      end
     end
-    
+
     def self.all
-      Api.private(:get, "/private/kyc_files").collect{|x| from_json(x) }
+      Api.private(:get, '/private/kyc_files').map { |file| from_json(file) }
     end
   end
 end
-

data/lib/bitex/kyc_profile.rb

@@ -1,40 +1,108 @@
 module Bitex
+  ##
+  # Documentation here!
+  #
   class KycProfile
+    # @!attribute id
+    #   @return [Integer] This KycProfile's unique ID.
+    attr_accessor :id
 
-    attr_accessor :id, :first_name, :last_name, :personal_id_number,
-      :personal_id_issuer, :personal_id_type, :tax_id, :birth_date,
-      :nationality, :gender, :occupation, :home_address, :work_address,
-      :phone_numbers, :legal_entity, :politically_exposed_person,
-      :usage_tier, :accepted_usage_tier
+    # @!attribute first_name
+    #   @return [String] Name.
+    attr_accessor :first_name
+
+    # @!attribute last_name
+    #   @return [String] Last Name.
+    attr_accessor :last_name
+
+    # @!attribute personal_id_number
+    #   @return [String] Personal ID Number.
+    attr_accessor :personal_id_number
+
+    # @!attribute personal_id_issuer
+    #   @return [String] ISO country code for the issuer of this ID.
+    attr_accessor :personal_id_issuer
+
+    # @!attribute personal_id_type
+    #   @return [symbol] Type of ID. [:passport]
+    attr_accessor :personal_id_type
+
+    # @!attribute tax_id
+    #   @return [Intger] Tax ID.
+    attr_accessor :tax_id
+
+    # @!attribute birth_date
+    #   @return [Time] Birth date.
+    attr_accessor :birth_date
+
+    # @!attribute nationality
+    #   @return [String] Nationality.
+    attr_accessor :nationality
+
+    # @!attribute gender
+    #   @return [Symbol] Gender.
+    attr_accessor :gender
+
+    # @!attribute occupation
+    #   @return [String]
+    attr_accessor :occupation
+
+    # @!attribute home_address
+    #   @return [String] Home address.
+    attr_accessor :home_address
+
+    # @!attribute work_address
+    #   @return [String] Work address.
+    attr_accessor :work_address
+
+    # @!attribute phone_numbers
+    #   @return [String] Phone numbers.
+    attr_accessor :phone_numbers
+
+    # @!attribute legal_entity
+    #   @return [Boolean] Is legal entity.
+    attr_accessor :legal_entity
+
+    # @!attribute politically_exposed_person
+    #   @return [Boolean] Is politically exposed.
+    attr_accessor :politically_exposed_person
+
+    # @!attribute usage_tier
+    #   @return [Symbol] Requested usage tier.
+    attr_accessor :usage_tier
+
+    # @!attribute accepted_usage_tier
+    #   @return [Symbol] Current usage tier as accepted by our compliance officers.
+    attr_accessor :accepted_usage_tier
 
     # @visibility private
+    # rubocop:disable Metrics/AbcSize
     def self.from_json(json)
-      new.tap do |thing|
-        thing.id = json[0]
-        thing.first_name = json[1]
-        thing.last_name = json[2]
-        thing.personal_id_number = json[3]
-        thing.personal_id_issuer = json[4]
-        thing.personal_id_type = json[5]
-        thing.tax_id = json[6]
-        thing.birth_date = json[7] ? Time.at(json[7]) : nil
-        thing.nationality = json[8]
-        thing.gender = json[9]
-        thing.occupation = json[10]
-        thing.home_address = json[11]
-        thing.work_address = json[12]
-        thing.phone_numbers = json[13]
-        thing.legal_entity = json[14]
-        thing.politically_exposed_person = json[15]
-        thing.usage_tier = json[16]
-        thing.accepted_usage_tier = json[17]
+      new.tap do |profile|
+        profile.id = json[0]
+        profile.first_name = json[1]
+        profile.last_name = json[2]
+        profile.personal_id_number = json[3]
+        profile.personal_id_issuer = json[4]
+        profile.personal_id_type = json[5].to_sym
+        profile.tax_id = json[6]
+        profile.birth_date = json[7] ? Time.at(json[7]) : nil
+        profile.nationality = json[8]
+        profile.gender = json[9].to_sym
+        profile.occupation = json[10]
+        profile.home_address = json[11]
+        profile.work_address = json[12]
+        profile.phone_numbers = json[13]
+        profile.legal_entity = json[14]
+        profile.politically_exposed_person = json[15]
+        profile.usage_tier = json[16].to_sym
+        profile.accepted_usage_tier = json[17].to_sym
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def self.create!(params)
-      params = params.dup
-        .merge(birth_date: params[:birth_date].strftime('%Y/%m/%d'))
-      from_json(Api.private(:post, "/private/kyc_profiles", params))
+      from_json(Api.private(:post, '/private/kyc_profiles', sanitize(params)))
     end
 
     def self.find(id)
@@ -42,25 +110,32 @@ module Bitex
     end
 
     def self.all
-      Api.private(:get, "/private/kyc_profiles").collect{|x| from_json(x) }
+      Api.private(:get, '/private/kyc_profiles').map { |kyc| from_json(kyc) }
+    end
+
+    private_class_method
+
+    def self.sanitize(params)
+      params.merge(birth_date: params[:birth_date].strftime('%Y/%m/%d'))
     end
 
     def update!(params)
-      params = params.dup
-        .merge(birth_date: params[:birth_date].strftime('%Y/%m/%d'))
-      self.class.from_json(Api.private(:put, "/private/kyc_profiles/#{id}", params))
+      self.class.from_json(Api.private(:put, "/private/kyc_profiles/#{id}", self.class.sanitize(params)))
     end
-    
+
     def add_kyc_file!(path, content_type = nil)
-      response = Api.private(:post, "/private/kyc_profiles/#{id}/kyc_files",
-        {document_content_type: content_type}, {document: path})
+      response = Api.private(
+        :post,
+        "/private/kyc_profiles/#{id}/kyc_files",
+        { document_content_type: content_type },
+        document: path
+      )
+
       KycFile.from_json(response)
     end
-  
+
     def kyc_files
-      Api.private(:get, "/private/kyc_profiles/#{id}/kyc_files")
-        .collect{|x| KycFile.from_json(x)}
+      Api.private(:get, "/private/kyc_profiles/#{id}/kyc_files").map { |kyc| KycFile.from_json(kyc) }
     end
   end
 end
-

data/lib/bitex/{market.rb → market_data.rb}

@@ -2,7 +2,6 @@ module Bitex
   # Public market data for a specie, do not use directly, use
   # {BitcoinMarketData} instead.
   class MarketData
-
     # The species currency ticker conveniently formatted as a ruby Hash with
     # symbolized keys.
     # @see https://bitex.la/developers#ticker
@@ -12,7 +11,8 @@ module Bitex
 
     # 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
+    # @see https://bitex.la/developers#orderbook
+    # TODO: standarize name for order-books: orderbook | order_book
     def self.order_book
       api_get('/market/order_book').symbolize_keys
     end
@@ -23,7 +23,7 @@ module Bitex
     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

data/lib/bitex/match.rb

@@ -1,24 +1,39 @@
 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.
+  # 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
+    attr_accessor :id, :orderbook, :quantity, :amount, :fee, :price, :created_at
 
     # @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   
+      Api.from_json(new, json) do |thing|
+        thing.orderbook = orderbooks[json[3]]
+        thing.quantity = json[4].to_s.to_d
+        thing.amount = json[5].to_s.to_d
+        thing.fee = json[6].to_s.to_d
+        thing.price = json[7].to_s.to_d
+      end
+    end
+
+    private_class_method
+
+    def self.orderbooks
+      { 1 => :btc_usd, 5 => :btc_ars }
+    end
+
+    def base_currency
+      base_quote[0]
+    end
+
+    def quote_currency
+      base_quote[1]
+    end
+
+    private
+
+    def base_quote
+      orderbook.upcase.to_s.split('_')
     end
   end
 end

data/lib/bitex/order.rb

@@ -1,249 +1,17 @@
 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
-    attr_accessor :reason
-    attr_accessor :issuer
-
-    # 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)
-      from_json(Api.private(:get, "/private#{base_path}/#{id}"))
-    end
-
-    # @visibility private
-    def self.create!(specie, amount, price, wait=false)
-      params = {
-        amount: amount,
-        price: price,
-        specie: {btc: 1, ltc: 2}[specie]
-      }
-      order = from_json(Api.private(:post, "/private#{base_path}", params))
-      retries = 0
-      while wait && order.status == :received
-        sleep 0.2
-        begin
-          order = find(order.id)
-        rescue StandardError => e
-        end
-        retries += 1
-        if retries > 5000 # Wait 15 minutes for the order to be accepted.
-          raise StandardError.new(
-            "Timed out waiting for #{base_path} ##{order.id}")
-        end
-      end
-      return order
-    end
-    
-    def cancel!
-      path = "/private#{self.class.base_path}/#{self.id}/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,
-      }
-      reason_lookup = {
-        0 => :not_cancelled,
-        1 => :not_enough_funds,
-        2 => :user_cancelled,
-        3 => :system_cancelled,
-      }
-      Api.from_json(order || new, json, true) do |thing|
-        thing.price = BigDecimal.new(json[6].to_s)
-        thing.status = status_lookup[json[7]]
-        thing.reason = reason_lookup[json[8]]
-        thing.issuer = json[10]
-      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.
-
-    # @!attribute reason
-    #  The cancellation reason for this Bid, 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.
-
-    # @!attribute produced_quantity
-    #   @return [BigDecimal] Quantity of specie produced by this bid so far.
-    attr_accessor :produced_quantity
-
-    # @!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
-      '/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.
-    # @param amount [BigDecimal] Amount to spend buying.
-    # @param price [BigDecimal] Maximum price to pay per unit.
-    # @param wait [Boolean] Block the process and wait until this
-    #   bid moves out of the :received state, defaults to false.
-    # @see https://bitex.la/developers#create-bid
-    def self.create!(specie, amount, price, wait=false)
-      super
-    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)
-        thing.produced_quantity = BigDecimal.new(json[9].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.
-
-    # @!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
-
-    # 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.
-    # @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!(specie, quantity, price, wait=false)
-      super
-    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)
-        thing.produced_amount = BigDecimal.new(json[9].to_s)
-      end
-    end
-  end
-
-  # Convenience class for fetching heterogeneous lists with all your Bids and
-  # Asks.
+  # 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.
+    # @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) }
+      Api.private(:GET, '/private/orders').map { |response| Api.deserialize(response) }
     end
 
-    # @return [Array<Bitex::Bid, Bitex::Ask>] Returns an heterogeneous array
-    #   with all your active orders.
+    # @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) }
+      Api.private(:GET, '/private/orders/active').map { |response| Api.deserialize(response) }
     end
   end
 end