bitex 0.3 → 0.4.0

data/lib/bitex/payment.rb

@@ -1,49 +1,61 @@
 module Bitex
+  ##
+  # Documentation here!
+  #
   class Payment
-    attr_accessor :id, :user_id, :amount, :currency_id, :expected_quantity,
-      :previous_expected_quantity, :confirmed_quantity, :unconfirmed_quantity,
-      :valid_until, :quote_valid_until, :last_quoted_on, :status, :address,
-      :settlement_currency_id, :settlement_amount, :keep, :merchant_reference,
-      :customer_reference
+    attr_accessor :id, :user_id, :amount, :currency_id, :expected_quantity, :previous_expected_quantity, :confirmed_quantity,
+                  :unconfirmed_quantity, :valid_until, :quote_valid_until, :last_quoted_on, :status, :address,
+                  :settlement_currency_id, :settlement_amount, :keep, :merchant_reference, :customer_reference
 
     # @visibility private
     def self.from_json(json)
       new.tap do |thing|
-        json.each do |key,raw_value|
+        json.each do |key, raw_value|
           next if raw_value.nil?
 
-          value = if [:valid_until, :quote_valid_until, :last_quoted_on].include?(key.to_sym)
-            Time.at(raw_value)
-          else
-            raw_value
+          value =
+            if %i[valid_until quote_valid_until last_quoted_on].include?(key)
+              Time.at(raw_value)
+            else
+              raw_value
+            end
+
+          begin
+            thing.send("#{key}=", value)
+          rescue NoMethodError
+            nil
           end
-          thing.send("#{key}=", value) rescue nil
         end
       end
     end
 
     def self.create!(params)
-      from_json(Api.private(:post, "/private/payments", params))
+      from_json(Api.private(:post, base_uri, params))
     end
 
     def self.find(id)
-      from_json(Api.private(:get, "/private/payments/#{id}"))
+      from_json(Api.private(:get, "#{base_uri}/#{id}"))
     end
 
     def self.all
-      Api.private(:get, "/private/payments").collect{|x| from_json(x) }
+      Api.private(:get, base_uri).map { |payment| from_json(payment) }
     end
-    
+
     # Validate a callback and parse the given payment from it.
     # Returns nil if the callback was invalid.
     def self.from_callback(callback_params)
-      from_json(callback_params["payment"]) if callback_params["api_key"] == Bitex.api_key
+      from_json(callback_params['payment']) if callback_params['api_key'] == Bitex.api_key
     end
 
     # Sets up the web-pos
     def self.pos_setup!(params)
-      Api.private(:post, "/private/payments/pos_setup", params)
+      Api.private(:post, "#{base_uri}/pos_setup", params)
+    end
+
+    private_class_method
+
+    def self.base_uri
+      '/private/payments'
     end
   end
 end
-

data/lib/bitex/rates.rb

@@ -8,18 +8,17 @@ module Bitex
   #     Bitex::Rates.calculate_back([:ars, :cash, :usd, :bitex, :more_mt], 200)
   # @see https://bitex.la/developers#rates
   class Rates
-
     # Full exchange rates tree, gets cached locally for 60 seconds.
     def self.tree
       if @tree.nil? || @last_tree_fetch.to_i < (Time.now.to_i - 60)
-        @tree = Api.public("/rates/tree").deep_symbolize_keys
+        @tree = Api.public('/rates/tree').deep_symbolize_keys
         @last_tree_fetch = Time.now.to_i
       end
       @tree
     end
-    
+
     def self.clear_tree_cache
-      @tree = nil 
+      @tree = nil
       @last_tree_fetch = nil
     end
 
@@ -40,7 +39,7 @@ module Bitex
       end
       value
     end
-    
+
     def self.calculate_path_backwards(path, value)
       value = value.to_d
       path_to_calculator(path).each do |step|
@@ -53,13 +52,12 @@ module Bitex
         when :fixed_fee
           value += step[:amount].to_d
         when :minimum_fee
-          value = [value + step[:minimum].to_d,
-            value / (1 - (step[:percentage].to_d / 100.to_d))].max
+          value = [value + step[:minimum].to_d, value / (1 - (step[:percentage].to_d / 100.to_d))].max
         end
       end
       value
     end
-  
+
     def self.path_to_calculator(path)
       steps = tree
       begin

data/lib/bitex/sell.rb

@@ -7,18 +7,18 @@ module Bitex
     # @!attribute created_at
     #   @return [Time] Time when this Sell happened.
 
-    # @!attribute specie
-    #   @return [Symbol] :btc or :ltc
-    
+    # @!attribute orderbook
+    #   @return [Symbol] :btc_usd or :btc_ars
+
     # @!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
 

data/lib/bitex/specie_deposit.rb

@@ -10,7 +10,7 @@ module Bitex
     attr_accessor :created_at
 
     # @!attribute specie
-    #   @return [Symbol] :btc or :ltc
+    #   @return [Symbol] :btc
     attr_accessor :specie
 
     # @!attribute quantity
@@ -19,8 +19,9 @@ module Bitex
 
     # @visibility private
     def self.from_json(json)
-      Api.from_json(new, json, true) do |thing|
-        thing.quantity = BigDecimal.new(json[4].to_s)
+      Api.from_json(new, json) do |thing|
+        thing.specie = { 1 => :btc }[json[3]]
+        thing.quantity = (json[4] || 0).to_d
       end
     end
 
@@ -29,7 +30,11 @@ module Bitex
     end
 
     def self.all(specie)
-      Api.private(:get, "/private/#{specie}/deposits").collect{|x| from_json(x) }
+      Api.private(:get, "/private/#{specie}/deposits").map { |sd| from_json(sd) }
+    end
+
+    def self.species
+      { 0 => :btc }
     end
   end
 end

data/lib/bitex/specie_withdrawal.rb

@@ -10,13 +10,13 @@ module Bitex
     attr_accessor :created_at
 
     # @!attribute specie
-    #   @return [Symbol] :btc or :ltc
+    #   @return [Symbol] :btc
     attr_accessor :specie
 
     # @!attribute quantity
     #   @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.
@@ -40,32 +40,22 @@ module Bitex
     # @!attribute label
     #   @return [String] A custom label you gave to this address.
     attr_accessor :label
-  
+
     # @!attribute kyc_profile_id
     #   @return [Integer] Kyc profile id for which this request was made.
     attr_accessor :kyc_profile_id
 
     # @!attribute transaction_id
-    #   @return [String] Network transaction id, if available. 
+    #   @return [String] Network transaction id, if available.
     attr_accessor :transaction_id
 
     # @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]]
+      Api.from_json(new, json) do |thing|
+        thing.specie = { 1 => :btc }[json[3]]
+        thing.quantity = (json[4].presence || 0).to_d
+        thing.status = statuses[json[5]]
+        thing.reason = reasons[json[6]]
         thing.to_address = json[7]
         thing.label = json[8]
         thing.kyc_profile_id = json[9]
@@ -73,13 +63,17 @@ module Bitex
       end
     end
 
-    def self.create!(specie, address, amount, label, kyc_profile_id=nil)
-      from_json(Api.private(:post, "/private/#{specie}/withdrawals", {
-        address: address,
-        amount: amount,
-        label: label,
-        kyc_profile_id: kyc_profile_id
-      }))
+    def self.create!(specie, address, amount, label, kyc_profile_id = nil)
+      from_json(
+        Api.private(
+          :post,
+          "/private/#{specie}/withdrawals",
+          address: address,
+          amount: amount,
+          label: label,
+          kyc_profile_id: kyc_profile_id
+        )
+      )
     end
 
     def self.find(specie, id)
@@ -87,8 +81,15 @@ module Bitex
     end
 
     def self.all(specie)
-      Api.private(:get, "/private/#{specie}/withdrawals")
-        .collect{|x| from_json(x) }
+      Api.private(:get, "/private/#{specie}/withdrawals").map { |sw| from_json(sw) }
+    end
+
+    def self.statuses
+      { 1 => :received, 2 => :pending, 3 => :done, 4 => :cancelled }
+    end
+
+    def self.reasons
+      { 0 => :not_cancelled, 1 => :insufficient_funds, 2 => :destination_invalid }
     end
   end
 end

data/lib/bitex/trade.rb

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

data/lib/bitex/transaction.rb

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

data/lib/bitex/usd_deposit.rb

@@ -1,5 +1,6 @@
 module Bitex
   # A deposit of USD to your bitex.la balance.
+  #
   class UsdDeposit
     # @!attribute id
     #   @return [Integer] This UsdDeposit's unique ID.
@@ -10,14 +11,13 @@ module Bitex
     attr_accessor :created_at
 
     # @!attribute requested_amount
-    #   @return [BigDecimal] For pre-announced deposits, this is the amount you
-    #     requested to deposit.
+    #   @return [BigDecimal] For pre-announced deposits, this is the amount you requested to deposit.
     attr_accessor :requested_amount
 
     # @!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
@@ -26,10 +26,8 @@ module Bitex
 
     # @!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.
+    #  * :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
 
@@ -37,28 +35,27 @@ module Bitex
     #  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.
+    #  * :sender_unknown we could not accept these funds because you're not the sender.
     #  * :other we'll contact you regarding this deposit.
     #  * :user_cancelled We cancelled this deposit per your request.
     attr_accessor :reason
-  
+
     # @!attribute country
     #  Country of origin for this deposit.
     attr_accessor :country
-    
+
     # @!attribute currency
     #  Local currency for the country.
     attr_accessor :currency
-  
+
     # @!attribute kyc_profile_id
     #  KYC profile on whose behalf this deposit is being created.
     attr_accessor :kyc_profile_id
-  
+
     # @!attribute request_details
     #  Details for our account officers about this deposit.
     attr_accessor :request_details
-  
+
     # @!attribute astropay_response_body
     #  Response from astropay if selected as the deposit method.
     #  The 'url' field should be the astropay payment url for this deposit.
@@ -69,29 +66,14 @@ module Bitex
     attr_accessor :third_party_reference
 
     # @visibility private
+    # rubocop:disable Metrics/AbcSize
     def self.from_json(json, deposit = nil)
-      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,
-        4 => :user_cancelled,
-      }
       Api.from_json(deposit || new, json) do |thing|
-        thing.requested_amount = BigDecimal.new(json[3].to_s)
-        thing.amount = BigDecimal.new(json[4].to_s)
-        thing.deposit_method = deposit_method_lookup[json[5]]
-        thing.status = status_lookup[json[6]]
-        thing.reason = reason_lookup[json[7]]
+        thing.requested_amount = (json[3].presence || 0).to_d
+        thing.amount = (json[4].presence || 0).to_d
+        thing.deposit_method = deposit_methods[json[5]]
+        thing.status = statuses[json[6]]
+        thing.reason = reasons[json[7]]
         thing.country = json[8]
         thing.currency = json[9]
         thing.kyc_profile_id = json[10]
@@ -100,29 +82,46 @@ module Bitex
         thing.third_party_reference = json[13]
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
-    def self.create!(country, amount, currency, method, details, profile=nil)
-      from_json(Api.private(:post, "/private/usd/deposits", {
-        country: country,
-        amount: amount,
-        currency: currency,
-        deposit_method: method,
-        request_details: details,
-        kyc_profile_id: profile,
-      }))
+    def self.create!(country, amount, currency, method, details, profile = nil)
+      from_json(
+        Api.private(
+          :post,
+          '/private/usd/deposits',
+          country: country,
+          amount: amount,
+          currency: currency,
+          deposit_method: method,
+          request_details: details,
+          kyc_profile_id: profile
+        )
+      )
     end
-  
+
     def self.find(id)
       from_json(Api.private(:get, "/private/usd/deposits/#{id}"))
     end
 
     def cancel!
-      path = "/private/usd/deposits/#{self.id}/cancel"
+      path = "/private/usd/deposits/#{id}/cancel"
       self.class.from_json(Api.private(:post, path), self)
     end
 
     def self.all
-      Api.private(:get, "/private/usd/deposits").collect{|x| from_json(x) }
+      Api.private(:get, '/private/usd/deposits').map { |d| from_json(d) }
+    end
+
+    def self.deposit_methods
+      { 1 => :astropay, 2 => :other }
+    end
+
+    def self.statuses
+      { 1 => :pending, 2 => :done, 3 => :cancelled }
+    end
+
+    def self.reasons
+      { 0 => :not_cancelled, 1 => :did_not_credit, 2 => :sender_unknown, 3 => :other, 4 => :user_cancelled }
     end
   end
 end