bitex 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151ad0a112110c7ce40e5ce09c5f753a10253bcb
-  data.tar.gz: aecf7f5c80fe3afba0da32ddb4f820f8d4fb7bc4
+  metadata.gz: '03555559d3d82a4f379a04f62d31c8ffaf2ab223'
+  data.tar.gz: 067a8204a071250238538d2b027bc98acc7a8174
 SHA512:
-  metadata.gz: d9785a0c2b14f157e6cdef69079c12c4be59c9463bdff76bf865aa1931f98d46eff6d6b376c1392cf2bd0452870296c58e8e76475b0994ca3e0ce8dfaf6b1b26
-  data.tar.gz: cb426c0e8d50ddd8982e8505d3696374ab637b0822693cfc98d53145dacd02de0fc220389db4195f38d2b0a9f9327b5072148d4505a2f65a2695f30d0f2f4193
+  metadata.gz: 8ff84068e327879b35f21bdb4eebc3ad1a2b23234f482b4705527b748e2184558b6f44c40e4ce0922daefdcd9e2f2b8be63765068b551167d9b1953555bfc56b
+  data.tar.gz: be63b22da048ff45b8048ceb613150d8f0e731ee0182d700038c9fd6fb73ba5e7e4fe6762c9c48011073801924595fff9bfcecdb0eaf68280035a7b37fd13d29

data/.rubocop.yml

@@ -13,9 +13,6 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 20
 
-Metrics/MethodLength:
-  Max: 20
-
 Metrics/ParameterLists:
   Max: 7
 

data/lib/bitex/api.rb

@@ -20,6 +20,7 @@ module Bitex
       @curl
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
     def self.curl(verb, path, options = {}, files = {})
       verb = verb.upcase.to_sym
       query = verb == :GET ? "?#{options.to_query}" : ''
@@ -51,6 +52,7 @@ module Bitex
 
       curl
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
     def self.public(path, _options = {})
       response = curl(:GET, path)

data/lib/bitex/ask.rb

@@ -1,5 +1,5 @@
 module Bitex
-  # An Ask is an order to sell a given orderbook.
+  # An Ask is an order to sell a given order book.
   # @see BaseOrder
   class Ask < BaseOrder
     # @!attribute id
@@ -8,7 +8,7 @@ module Bitex
     # @!attribute created_at
     #   @return [Time] Time when this Ask was created.
 
-    # @!attribute orderbook
+    # @!attribute order_book
     #   @return [Symbol] :btc_usd or :btc_ars
 
     # @!attribute quantity
@@ -53,12 +53,12 @@ module Bitex
 
     # 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 order_book [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)
+    def self.create!(order_book, quantity, price, wait = false)
       super
     end
 

data/lib/bitex/base_order.rb

@@ -9,9 +9,9 @@ module Bitex
     #   @return [Time] Time when this Bid was created.
     attr_accessor :created_at
 
-    # @!attribute orderbook
+    # @!attribute order_book
     #   @return [Symbol] :btc_usd or :btc_ars
-    attr_accessor :orderbook
+    attr_accessor :order_book
 
     # @!attribute price
     #   @return [BigDecimal] Maximum price to pay per unit.
@@ -52,8 +52,8 @@ module Bitex
     end
 
     # @visibility private
-    def self.create!(orderbook, amount, price, wait = false)
-      params = { amount: amount, price: price, orderbook: { btc_usd: 1, btc_ars: 5 }[orderbook] }
+    def self.create!(order_book, amount, price, wait = false)
+      params = { amount: amount, price: price, orderbook: { btc_usd: 1, btc_ars: 5 }[order_book] }
 
       order = from_json(Api.private(:post, "/private#{base_path}", params))
       retries = 0
@@ -75,7 +75,7 @@ module Bitex
     # @visibility private
     def self.from_json(json, order = nil)
       Api.from_json(order || new, json) do |thing|
-        thing.orderbook = orderbooks[json[3]]
+        thing.order_book = order_books[json[3]]
         thing.price = json[6].to_s.to_d
         thing.status = statuses[json[7]]
         thing.reason = reasons[json[8]]
@@ -91,7 +91,7 @@ module Bitex
       order
     end
 
-    def self.orderbooks
+    def self.order_books
       { 1 => :btc_usd, 5 => :btc_ars }
     end
 

data/lib/bitex/bid.rb

@@ -1,5 +1,5 @@
 module Bitex
-  # A Bid is an order to buy a given orderbook.
+  # A Bid is an order to buy a given order book.
   # @see BaseOrder
   class Bid < BaseOrder
     # @!attribute id
@@ -8,7 +8,7 @@ module Bitex
     # @!attribute created_at
     #   @return [Time] Time when this Bid was created.
 
-    # @!attribute orderbook
+    # @!attribute order_book
     #   @return [Symbol] :btc_usd or :btc_ars
 
     # @!attribute amount
@@ -51,12 +51,12 @@ module Bitex
     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 order_book [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)
+    def self.create!(order_book, amount, price, wait = false)
       super
     end
 

data/lib/bitex/buy.rb

@@ -8,7 +8,7 @@ module Bitex
     # @!attribute created_at
     #   @return [Time] Time when this Buy happened.
 
-    # @!attribute orderbook
+    # @!attribute order_book
     #   @return [Symbol] :btc_usd or :btc_ars
 
     # @!attribute quantity

data/lib/bitex/market_data.rb

@@ -12,7 +12,6 @@ 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#orderbook
-    # TODO: standarize name for order-books: orderbook | order_book
     def self.order_book
       api_get('/market/order_book').symbolize_keys
     end

data/lib/bitex/match.rb

@@ -3,22 +3,24 @@ module Bitex
   # 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, :orderbook, :quantity, :amount, :fee, :price, :created_at
+    attr_accessor :id, :order_book, :quantity, :amount, :fee, :price, :created_at
 
     # @visibility private
+    # rubocop:disable Metrics/AbcSize
     def self.from_json(json)
       Api.from_json(new, json) do |thing|
-        thing.orderbook = orderbooks[json[3]]
+        thing.order_book = order_books[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
+    # rubocop:enable Metrics/AbcSize
 
     private_class_method
 
-    def self.orderbooks
+    def self.order_books
       { 1 => :btc_usd, 5 => :btc_ars }
     end
 
@@ -33,7 +35,7 @@ module Bitex
     private
 
     def base_quote
-      orderbook.upcase.to_s.split('_')
+      order_book.upcase.to_s.split('_')
     end
   end
 end

data/lib/bitex/rates.rb

@@ -22,6 +22,7 @@ module Bitex
       @last_tree_fetch = nil
     end
 
+    # rubocop:disable Metrics/AbcSize
     def self.calculate_path(value, path)
       value = value.to_d
       path_to_calculator(path).each do |step|
@@ -57,12 +58,13 @@ module Bitex
       end
       value
     end
+    # rubocop:enable Metrics/AbcSize
 
     def self.path_to_calculator(path)
       steps = tree
       begin
         path.each { |step| steps = steps[step] }
-      rescue StandardError => e
+      rescue StandardError
         raise "InvalidPath: #{path}"
       end
       steps

data/lib/bitex/sell.rb

@@ -7,7 +7,7 @@ module Bitex
     # @!attribute created_at
     #   @return [Time] Time when this Sell happened.
 
-    # @!attribute orderbook
+    # @!attribute order_book
     #   @return [Symbol] :btc_usd or :btc_ars
 
     # @!attribute quantity

data/lib/bitex/specie_withdrawal.rb

@@ -50,6 +50,7 @@ module Bitex
     attr_accessor :transaction_id
 
     # @visibility private
+    # rubocop:disable Metrics/AbcSize
     def self.from_json(json)
       Api.from_json(new, json) do |thing|
         thing.specie = { 1 => :btc }[json[3]]
@@ -62,6 +63,7 @@ module Bitex
         thing.transaction_id = json[10]
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def self.create!(specie, address, amount, label, kyc_profile_id = nil)
       from_json(

data/lib/bitex/version.rb

@@ -1,3 +1,3 @@
 module Bitex
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/spec/ask_spec.rb

@@ -6,7 +6,7 @@ describe Bitex::Ask do
       1,         #  0 - API class reference
       12345678,  #  1 - id
       946685400, #  2 - created_at
-      1,         #  3 - orderbook
+      1,         #  3 - order_book
       100.0,     #  4 - quantity
       100.0,     #  5 - remaining_quantity
       1000.0,    #  6 - price
@@ -18,7 +18,7 @@ describe Bitex::Ask do
   end
 
   it_behaves_like 'API class'
-  it_behaves_like 'API class with a orderbook'
+  it_behaves_like 'API class with a order book'
   it_behaves_like 'JSON deserializable order'
 
   describe 'Api calls' do

data/spec/bid_spec.rb

@@ -6,7 +6,7 @@ describe Bitex::Bid do
       1,           #  0 - API class reference
       12_345_678,  #  1 - id
       946_685_400, #  2 - created_at
-      1,           #  3 - orderbook
+      1,           #  3 - order_book
       100.0,       #  4 - quantity
       100.0,       #  5 - remaining_quantity
       1_000.0,     #  6 - price
@@ -18,7 +18,7 @@ describe Bitex::Bid do
   end
 
   it_behaves_like 'API class'
-  it_behaves_like 'API class with a orderbook'
+  it_behaves_like 'API class with a order book'
   it_behaves_like 'JSON deserializable order'
 
   describe 'Api calls' do

data/spec/buy_spec.rb

@@ -6,7 +6,7 @@ describe Bitex::Buy do
       4,           #  0 - API class reference
       12_345_678,  #  1 - id
       946_685_400, #  2 - created_at
-      1,           #  3 - orderbook
+      1,           #  3 - order_book
       100.5,       #  4 - quantity
       201,         #  5 - amount
       0.05,        #  6 - fee
@@ -16,7 +16,7 @@ describe Bitex::Buy do
   end
 
   it_behaves_like 'API class'
-  it_behaves_like 'API class with a orderbook'
+  it_behaves_like 'API class with a order book'
   it_behaves_like 'JSON deserializable match'
 
   it 'sets the bid id' do

data/spec/sell_spec.rb

@@ -6,7 +6,7 @@ describe Bitex::Sell do
       3,          #  0 - API class reference
       12_345_678, #  1 - id
       946685400,  #  2 - created_at
-      1,          #  3 - orderbook
+      1,          #  3 - order_book
       100.5,      #  4 - quantity
       201,        #  5 - amount
       0.05,       #  6 - fee
@@ -16,7 +16,7 @@ describe Bitex::Sell do
   end
 
   it_behaves_like 'API class'
-  it_behaves_like 'API class with a orderbook'
+  it_behaves_like 'API class with a order book'
   it_behaves_like 'JSON deserializable match'
 
   it 'sets the ask id' do

data/spec/support/from_json_shared_examples.rb

@@ -9,15 +9,15 @@ shared_examples_for 'API class' do
   end
 end
 
-shared_examples_for 'API class with a orderbook' do
-  it 'makes orderbook 1 into btc_usd' do
+shared_examples_for 'API class with a order book' do
+  it 'makes order book 1 into btc_usd' do
     as_json[3] = 1
-    subject.class.from_json(as_json).orderbook.should == :btc_usd
+    subject.class.from_json(as_json).order_book.should == :btc_usd
   end
 
   it 'makes specie 5 into btc_ars' do
     as_json[3] = 5
-    subject.class.from_json(as_json).orderbook.should == :btc_ars
+    subject.class.from_json(as_json).order_book.should == :btc_ars
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitex
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nubis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport