sibit 0.18.8 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9754c11ebf54c9b04ce2b44bfc21f58a1758713d51c204b32c03e79e737db1e7
-  data.tar.gz: 3abeb42d2a54d543825f0da9244da1cff4c842180e58f94bc8694a38595852ce
+  metadata.gz: c16c2d9c8fd8acd2635dc38d1b97599dc2138851ffc162db62aa3dc35feec993
+  data.tar.gz: b17f0c383453182402041ac8793eb2e308480b660e4bd79577a846a6517cf66e
 SHA512:
-  metadata.gz: 286f4ac1cbd4244fb7dd7a867e01f36bab27d5cb91813c7d7a5fe5ce9e2a01441eb917e65e8c8f2dc7af87714e71227bfda39ca21e3d5cdc03af26ff950068cf
-  data.tar.gz: 681f6f576a93c2ceb67c633022c57157026e8b516cd6a989ef56d7e1e2a6409859ab8db63e053a16ad34cca1046c6fa050354aa8b7113d3487b1376413b50f47
+  metadata.gz: 3a7234573110a1fd17ed0e67257474f5c07801e0fd74a0212ca1e08453e9088aeae00b803382814119b9e16fe1b22a9f2fab1974724fdc5c1f5f0d11649e5e29
+  data.tar.gz: '089e4b96cf9c5fb0b3e17bd1692e9ee66f553c2752fd8669a520008a533dacc60063c473264f0469d394a5c272209419026f4920dfa3f3f97bbfc422fe359751'

data/.rubocop.yml

@@ -4,6 +4,8 @@ AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.3
 
+Style/ClassAndModuleChildren:
+  Enabled: false
 Metrics/LineLength:
   Max: 100
 Layout/EndOfLine:

data/README.md

@@ -145,7 +145,14 @@ will be used one by one, until a successful response is obtained:
 require 'sibit'
 require 'sibit/btc'
 require 'sibit/cryptoapis'
-sibit = Sibit.new(api: [Sibit::Btc.new, Sibit::Cryptoapis.new('key')])
+sibit = Sibit.new(
+  api: Sibit::FirstOf.new(
+    [
+      Sibit::Btc.new,
+      Sibit::Cryptoapis.new('key')
+    ]
+  )
+)
 ```
 
 If you think we may need to use some other API, you can submit a ticket,

data/bin/sibit

@@ -32,6 +32,7 @@ require_relative '../lib/sibit/blockchain'
 require_relative '../lib/sibit/btc'
 require_relative '../lib/sibit/bitcoinchain'
 require_relative '../lib/sibit/earn'
+require_relative '../lib/sibit/firstof'
 
 begin
   begin
@@ -86,7 +87,7 @@ Options are:"
     api = RetriableProxy.for_object(api, on: Sibit::Error) if opts[:attempts] > 1
     api
   end
-  sibit = Sibit.new(log: log, api: apis)
+  sibit = Sibit.new(log: log, api: Sibit::FirstOf.new(apis, log: log))
   case opts.arguments[0]
   when 'price'
     puts sibit.price

data/lib/sibit.rb

@@ -55,9 +55,7 @@ class Sibit
 
   # Current price of 1 BTC in USD (or another currency), float returned.
   def price(currency = 'USD')
-    first_one do |api|
-      api.price(currency)
-    end
+    @api.price(currency)
   end
 
   # Generates new Bitcon private key and returns in Hash160 format.
@@ -76,29 +74,23 @@ class Sibit
 
   # Gets the balance of the address, in satoshi.
   def balance(address)
-    first_one do |api|
-      api.balance(address)
-    end
+    @api.balance(address)
   end
 
   # Get the height of the block.
   def height(hash)
-    first_one do |api|
-      api.height(hash)
-    end
+    @api.height(hash)
   end
 
   # Get the hash of the next block.
   def next_of(hash)
-    first_one do |api|
-      api.next_of(hash)
-    end
+    @api.next_of(hash)
   end
 
   # Get recommended fees, in satoshi per byte. The method returns
   # a hash: { S: 12, M: 45, L: 100, XL: 200 }
   def fees
-    first_one(&:fees)
+    @api.fees
   end
 
   # Sends a payment and returns the transaction hash.
@@ -124,7 +116,7 @@ class Sibit
     builder = Bitcoin::Builder::TxBuilder.new
     unspent = 0
     size = 100
-    utxos = first_one { |api| api.utxos(sources.keys) }
+    utxos = @api.utxos(sources.keys)
     @log.info("#{utxos.count} UTXOs found, these will be used \
 (value/confirmations at tx_hash):")
     utxos.each do |utxo|
@@ -170,15 +162,13 @@ class Sibit
   Amount: #{num(satoshi, p)}
   Target address: #{target}
   Change address is #{change}")
-    first_one do |api|
-      api.push(tx.to_payload.bth)
-    end
+    @api.push(tx.to_payload.bth)
     tx.hash
   end
 
   # Gets the hash of the latest block.
   def latest
-    first_one(&:latest)
+    @api.latest
   end
 
   # You call this method and provide a callback. You provide the hash
@@ -197,7 +187,7 @@ class Sibit
     wrong = []
     json = {}
     loop do
-      json = first_one { |api| api.block(block) }
+      json = @api.block(block)
       if json[:orphan]
         steps = 4
         @log.info("Orphan block found at #{block}, moving #{steps} steps back...")
@@ -206,7 +196,7 @@ class Sibit
           block = json[:previous]
           wrong << block
           @log.info("Moved back to #{block}")
-          json = first_one { |api| api.block(block) }
+          json = @api.block(block)
         end
         next
       end
@@ -242,26 +232,6 @@ class Sibit
 
   private
 
-  def first_one
-    return yield @api unless @api.is_a?(Array)
-    done = false
-    result = nil
-    @api.each do |api|
-      begin
-        result = yield api
-        done = true
-        break
-      rescue Sibit::Error => e
-        @log.info("The API #{api.class.name} failed: #{e.message}")
-      end
-    end
-    unless done
-      raise Sibit::Error, "No APIs out of #{@api.length} managed to succeed: \
-#{@api.map { |a| a.class.name }.join(', ')}"
-    end
-    result
-  end
-
   def num(satoshi, usd)
     format(
       '%<satoshi>ss/$%<dollars>0.2f',

data/lib/sibit/bestof.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require_relative 'error'
+require_relative 'log'
+
+# API best of.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
+# License:: MIT
+class Sibit
+  # Best of API.
+  class BestOf
+    # Constructor.
+    def initialize(list, log: Sibit::Log.new)
+      @list = list
+      @log = log
+    end
+
+    # Current price of BTC in USD (float returned).
+    def price(currency = 'USD')
+      best_of('price') do |api|
+        api.price(currency)
+      end
+    end
+
+    # Gets the balance of the address, in satoshi.
+    def balance(address)
+      best_of('balance') do |api|
+        api.balance(address)
+      end
+    end
+
+    # Get the height of the block.
+    def height(hash)
+      best_of('height') do |api|
+        api.height(hash)
+      end
+    end
+
+    # Get the hash of the next block.
+    def next_of(hash)
+      best_of('next_of') do |api|
+        api.next_of(hash)
+      end
+    end
+
+    # Get recommended fees, in satoshi per byte. The method returns
+    # a hash: { S: 12, M: 45, L: 100, XL: 200 }
+    def fees
+      best_of('fees', &:fees)
+    end
+
+    # Fetch all unspent outputs per address.
+    def utxos(keys)
+      best_of('utxos') do |api|
+        api.utxos(keys)
+      end
+    end
+
+    # Latest block hash.
+    def latest
+      best_of('latest', &:latest)
+    end
+
+    # Push this transaction (in hex format) to the network.
+    def push(hex)
+      best_of('push') do |api|
+        api.push(hex)
+      end
+    end
+
+    # This method should fetch a block and return as a hash.
+    def block(hash)
+      best_of('block') do |api|
+        api.block(hash)
+      end
+    end
+
+    private
+
+    def best_of(method)
+      return yield @list unless @list.is_a?(Array)
+      results = []
+      @list.each do |api|
+        begin
+          results << yield(api)
+        rescue Sibit::Error => e
+          @log.info("The API #{api.class.name} failed at #{method}(): #{e.message}")
+        end
+      end
+      if results.empty?
+        raise Sibit::Error, "No APIs out of #{@api.length} managed to succeed at #{method}(): \
+#{@api.map { |a| a.class.name }.join(', ')}"
+      end
+      results.group_by(&:to_s).values.max_by(&:size)[0]
+    end
+  end
+end

data/lib/sibit/firstof.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require_relative 'error'
+require_relative 'log'
+
+# API first of.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
+# License:: MIT
+class Sibit
+  # First of API.
+  class FirstOf
+    # Constructor.
+    def initialize(list, log: Sibit::Log.new)
+      @list = list
+      @log = log
+    end
+
+    # Current price of BTC in USD (float returned).
+    def price(currency = 'USD')
+      first_of('price') do |api|
+        api.price(currency)
+      end
+    end
+
+    # Gets the balance of the address, in satoshi.
+    def balance(address)
+      first_of('balance') do |api|
+        api.balance(address)
+      end
+    end
+
+    # Get the height of the block.
+    def height(hash)
+      first_of('height') do |api|
+        api.height(hash)
+      end
+    end
+
+    # Get the hash of the next block.
+    def next_of(hash)
+      first_of('next_of') do |api|
+        api.next_of(hash)
+      end
+    end
+
+    # Get recommended fees, in satoshi per byte. The method returns
+    # a hash: { S: 12, M: 45, L: 100, XL: 200 }
+    def fees
+      first_of('fees', &:fees)
+    end
+
+    # Fetch all unspent outputs per address.
+    def utxos(keys)
+      first_of('utxos') do |api|
+        api.utxos(keys)
+      end
+    end
+
+    # Latest block hash.
+    def latest
+      first_of('latest', &:latest)
+    end
+
+    # Push this transaction (in hex format) to the network.
+    def push(hex)
+      first_of('push') do |api|
+        api.push(hex)
+      end
+    end
+
+    # This method should fetch a block and return as a hash.
+    def block(hash)
+      first_of('block') do |api|
+        api.block(hash)
+      end
+    end
+
+    private
+
+    def first_of(method)
+      return yield @list unless @list.is_a?(Array)
+      done = false
+      result = nil
+      @list.each do |api|
+        begin
+          result = yield api
+          done = true
+          break
+        rescue Sibit::Error => e
+          @log.info("The API #{api.class.name} failed at #{method}(): #{e.message}")
+        end
+      end
+      unless done
+        raise Sibit::Error, "No APIs out of #{@api.length} managed to succeed at #{method}(): \
+#{@api.map { |a| a.class.name }.join(', ')}"
+      end
+      result
+    end
+  end
+end

data/lib/sibit/version.rb

@@ -26,5 +26,5 @@
 # License:: MIT
 class Sibit
   # Current version of the library.
-  VERSION = '0.18.8'
+  VERSION = '0.19.0'
 end

data/test/test_bestof.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require_relative '../lib/sibit'
+require_relative '../lib/sibit/fake'
+require_relative '../lib/sibit/bestof'
+
+# Sibit::BestOf test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
+# License:: MIT
+class TestBestOf < Minitest::Test
+  def test_not_array
+    sibit = Sibit::BestOf.new(Sibit::Fake.new)
+    assert_equal(64, sibit.latest.length)
+    assert_equal(12, sibit.fees[:S])
+  end
+
+  def test_one_apis
+    sibit = Sibit::BestOf.new([Sibit::Fake.new])
+    assert_equal(64, sibit.latest.length)
+    assert_equal(12, sibit.fees[:S])
+  end
+
+  def test_two_apis
+    sibit = Sibit::BestOf.new([Sibit::Fake.new, Sibit::Fake.new])
+    assert_equal(64, sibit.latest.length)
+    assert_equal(12, sibit.fees[:S])
+  end
+end

data/test/test_firstof.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# 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 NONINFINGEMENT. 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.
+
+require 'minitest/autorun'
+require_relative '../lib/sibit'
+require_relative '../lib/sibit/fake'
+require_relative '../lib/sibit/firstof'
+
+# Sibit::FirstOf test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
+# License:: MIT
+class TestFirstOf < Minitest::Test
+  def test_not_array
+    sibit = Sibit::FirstOf.new(Sibit::Fake.new)
+    assert_equal(64, sibit.latest.length)
+    assert_equal(12, sibit.fees[:S])
+  end
+
+  def test_one_apis
+    sibit = Sibit::FirstOf.new([Sibit::Fake.new])
+    assert_equal(64, sibit.latest.length)
+    assert_equal(12, sibit.fees[:S])
+  end
+
+  def test_two_apis
+    sibit = Sibit::FirstOf.new([Sibit::Fake.new, Sibit::Fake.new])
+    assert_equal(64, sibit.latest.length)
+    assert_equal(12, sibit.fees[:S])
+  end
+end

data/test/test_sibit.rb

@@ -27,6 +27,8 @@ require_relative '../lib/sibit'
 require_relative '../lib/sibit/earn'
 require_relative '../lib/sibit/fake'
 require_relative '../lib/sibit/blockchain'
+require_relative '../lib/sibit/firstof'
+require_relative '../lib/sibit/bestof'
 
 # Sibit.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -127,7 +129,7 @@ class TestSibit < Minitest::Test
       'https://blockchain.info/unspent?active=1JvCsJtLmCxEk7ddZFnVkGXpr9uhxZPmJi&limit=1000'
     ).to_return(body: JSON.pretty_generate(json))
     stub_request(:post, 'https://blockchain.info/pushtx').to_return(status: 200)
-    sibit = Sibit.new(api: [Sibit::Earn.new, Sibit::Blockchain.new])
+    sibit = Sibit.new(api: Sibit::FirstOf.new([Sibit::Earn.new, Sibit::Blockchain.new]))
     target = sibit.create(sibit.generate)
     change = sibit.create(sibit.generate)
     tx = sibit.pay(
@@ -156,7 +158,7 @@ class TestSibit < Minitest::Test
       :get,
       'https://blockchain.info/unspent?active=1JvCsJtLmCxEk7ddZFnVkGXpr9uhxZPmJi&limit=1000'
     ).to_return(body: JSON.pretty_generate(json))
-    sibit = Sibit.new
+    sibit = Sibit.new(api: Sibit::BestOf.new([Sibit::Fake.new, Sibit::Fake.new]))
     target = sibit.create(sibit.generate)
     change = sibit.create(sibit.generate)
     assert_raises Sibit::Error do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.18.8
+  version: 0.19.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -281,6 +281,7 @@ files:
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - lib/sibit.rb
+- lib/sibit/bestof.rb
 - lib/sibit/bitcoinchain.rb
 - lib/sibit/blockchain.rb
 - lib/sibit/blockchair.rb
@@ -290,6 +291,7 @@ files:
 - lib/sibit/earn.rb
 - lib/sibit/error.rb
 - lib/sibit/fake.rb
+- lib/sibit/firstof.rb
 - lib/sibit/http.rb
 - lib/sibit/json.rb
 - lib/sibit/log.rb
@@ -297,6 +299,7 @@ files:
 - logo.svg
 - sibit.gemspec
 - test/test__helper.rb
+- test/test_bestof.rb
 - test/test_bitcoinchain.rb
 - test/test_blockchain.rb
 - test/test_blockchair.rb
@@ -304,6 +307,7 @@ files:
 - test/test_cex.rb
 - test/test_cryptoapis.rb
 - test/test_fake.rb
+- test/test_firstof.rb
 - test/test_json.rb
 - test/test_live.rb
 - test/test_sibit.rb
@@ -337,6 +341,7 @@ test_files:
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - test/test__helper.rb
+- test/test_bestof.rb
 - test/test_bitcoinchain.rb
 - test/test_blockchain.rb
 - test/test_blockchair.rb
@@ -344,6 +349,7 @@ test_files:
 - test/test_cex.rb
 - test/test_cryptoapis.rb
 - test/test_fake.rb
+- test/test_firstof.rb
 - test/test_json.rb
 - test/test_live.rb
 - test/test_sibit.rb