sibit 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64cc132d274ca5088ae00fbdacca8c5b7e689c5b13fe78cffacfd0300729d9ae
-  data.tar.gz: 5dd1f2f5bdc4f2450c56d9e177ac8018f81b92a0e0c43ef0a43d3324a70abb1d
+  metadata.gz: ef4603f30e6d52d2efec48d698778505150df7b5e98400938db804a1a412a053
+  data.tar.gz: 1c30fe4e9d7e1c077204b26282ed78a169b6e86cc630baf376903bb2f8103601
 SHA512:
-  metadata.gz: e1ef829b0e6c2b288b4dc1bdf0ed692b825ee560dd2e047f4607a38478aafef9a575e35b0f782fdfc32c7d7883fe5a7ee099374f4879df692aba81a4c8219d7a
-  data.tar.gz: c0c63033b166fb85ea73a25a8b9f5a6aa41020685a5ef9f16c397dd28ea9ea7111cd15f00d5c4ff598cffdd9ecc77a4e68d46cb5268df714035b6470268f14ac
+  metadata.gz: 8e1c22106253d2ee0ef9ab0d38e27526b4553c26bd1c01c8cb66910f692c19cd465b85b8104d5ea09c9dd2b22446e917bb333ff8cb7e1db3c730e0e6f3b472aa
+  data.tar.gz: 035dfbccaef19b8ff39c7c404a0b11f058d813a0df492c741a6849ddac8eb0b990892523c186929e4b2822939d6011f246417c31ff3c24a5123732b3fe30b0db

data/README.md

@@ -113,6 +113,41 @@ tx = sibit.pay(10_000_000, 'XL', { address => pkey }, target, change)
 
 Should work.
 
+## APIs
+
+The library works through one (or a few) public APIs for fetching
+Bitcoin data and pushing transactions to the network. At the moment we
+work with the following APIs:
+
+  * [Blockchain.com](https://www.blockchain.com/api/blockchain_api)
+  * [BTC.com](https://btc.com/api-doc)
+  * [Cryptoapis.io](https://docs.cryptoapis.io/rest-apis/blockchain-as-a-service-apis/btc/index)
+  * [Bitcoinchain.com](https://bitcoinchain.com/api)
+  * [Earn.com](https://bitcoinfees.earn.com/api)
+
+The first one in this list is used by default. If you want to use a diffent
+one, you just specify it in the constructor of `Sibit` object:
+
+```ruby
+require 'sibit'
+require 'sibit/btc'
+sibit = Sibit.new(api: Sibit::Btc.new)
+```
+
+You may also use a combination of APIs. This may be very useful since
+some APIs are not reliable. You can provide an array of objects and they
+will be used one by one, until a successful response is obtained:
+
+```ruby
+require 'sibit'
+require 'sibit/btc'
+require 'sibit/cryptoapis'
+sibit = Sibit.new(api: [Sibit::Btc.new, Sibit::Cryptoapis.new('key')])
+```
+
+If you think we may need to use some other API, you can submit a ticket,
+or implement it yourself and submit a pull request.
+
 ## How to install
 
 To install on a fresh Ubuntu 18:

data/lib/sibit/bitcoinchain.rb

@@ -45,14 +45,14 @@ class Sibit
 
     # Current price of BTC in USD (float returned).
     def price(_currency)
-      raise Sibit::Error, 'Not implemented yet'
+      raise Sibit::Error, 'Bitcoinchain API doesn\'t provide BTC price'
     end
 
     # Gets the balance of the address, in satoshi.
     def balance(address)
-      Sibit::Json.new(http: @http, log: @log).get(
+      (Sibit::Json.new(http: @http, log: @log).get(
         URI("https://api-r.bitcoinchain.com/v1/address/#{address}")
-      )[0]['balance'] * 100_000_000
+      )[0]['balance'] * 100_000_000).to_i
     end
 
     # Get recommended fees, in satoshi per byte.

data/lib/sibit/btc.rb

@@ -45,7 +45,7 @@ class Sibit
 
     # Current price of BTC in USD (float returned).
     def price(_currency)
-      raise Sibit::Error, 'Not implemented yet'
+      raise Sibit::Error, 'Btc.com API doesn\'t provide BTC price'
     end
 
     # Gets the balance of the address, in satoshi.

data/lib/sibit/cryptoapis.rb

@@ -46,15 +46,15 @@ class Sibit
 
     # Current price of BTC in USD (float returned).
     def price(_currency)
-      raise Sibit::Error, 'Not implemented yet'
+      raise Sibit::Error, 'Cryptoapis doesn\'t provide BTC price'
     end
 
     # Gets the balance of the address, in satoshi.
     def balance(address)
-      Sibit::Json.new(http: @http, log: @log).get(
+      (Sibit::Json.new(http: @http, log: @log).get(
         URI("https://api.cryptoapis.io/v1/bc/btc/mainnet/address/#{address}"),
         headers: headers
-      )['payload']['balance'].to_f * 100_000_000
+      )['payload']['balance'].to_f * 100_000_000).to_i
     end
 
     # Get recommended fees, in satoshi per byte.
@@ -95,8 +95,30 @@ class Sibit
         orphan: false,
         next: head['nextblockhash'],
         previous: head['previousblockhash'],
-        txns: Sibit::Json.new(http: @http, log: @log).get(
-          URI("https://api.cryptoapis.io/v1/bc/btc/mainnet/txs/block/#{hash}"),
+        txns: txns(hash)
+      }
+    end
+
+    private
+
+    def headers
+      {
+        'X-API-Key': @key
+      }
+    end
+
+    def txns(hash)
+      index = 0
+      limit = 200
+      all = []
+      loop do
+        txns = Sibit::Json.new(http: @http, log: @log).get(
+          URI(
+            [
+              'https://api.cryptoapis.io/v1/bc/btc/mainnet/txs/block/',
+              "#{hash}?index=#{index}&limit=#{limit}"
+            ].join
+          ),
           headers: headers
         )['payload'].map do |t|
           {
@@ -109,15 +131,11 @@ class Sibit
             end
           }
         end
-      }
-    end
-
-    private
-
-    def headers
-      {
-        'X-API-Key': @key
-      }
+        all += txns
+        index += txns.length
+        break if txns.length < limit
+      end
+      all
     end
   end
 end

data/lib/sibit/version.rb

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

data/test/test_cryptoapis.rb

@@ -33,9 +33,10 @@ require_relative '../lib/sibit/cryptoapis'
 class TestCryptoapis < Minitest::Test
   def test_fetch_block
     hash = '000000000000000007341915521967247f1dec17b3a311b8a8f4495392f1439b'
-    stub_request(:get, "https://api.cryptoapis.io/v1/bc/btc/mainnet/blocks/#{hash}")
+    url = 'https://api.cryptoapis.io/v1/bc/btc/mainnet'
+    stub_request(:get, "#{url}/blocks/#{hash}")
       .to_return(body: '{"payload": {"nextblockhash": "n", "hash": "h", "previousblockhash": "p"}}')
-    stub_request(:get, "https://api.cryptoapis.io/v1/bc/btc/mainnet/txs/block/#{hash}")
+    stub_request(:get, "#{url}/txs/block/#{hash}?index=0&limit=200")
       .to_return(body: '{"payload": [{"hash": "thash",
         "txouts": [{"addresses": ["a1"], "value": 123}]}]}')
     sibit = Sibit::Cryptoapis.new('-')

data/test/test_live.rb

@@ -30,7 +30,7 @@ require_relative '../lib/sibit'
 # Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
 # License:: MIT
 class TestLive < Minitest::Test
-  def test_fetch_block
+  def test_block
     for_each do |api|
       hash = '000000003031a0e73735690c5a1ff2a4be82553b2a12b776fbd3a215dc8f778d'
       json = api.block(hash)
@@ -55,6 +55,7 @@ class TestLive < Minitest::Test
     for_each do |api|
       hash = '1GkQmKAmHtNfnD3LHhTkewJxKHVSta4m2a'
       satoshi = api.balance(hash)
+      assert(satoshi.is_a?(Integer), "Wrong type of balance: #{satoshi.class.name}")
       assert_equal(5_000_028_421, satoshi)
     end
   end
@@ -73,7 +74,7 @@ class TestLive < Minitest::Test
     WebMock.allow_net_connect!
     apis = []
     require_relative '../lib/sibit/cryptoapis'
-    apis << Sibit::Cryptoapis.new('--api-key--')
+    apis << Sibit::Cryptoapis.new('-key-')
     require_relative '../lib/sibit/btc'
     apis << Sibit::Btc.new
     require_relative '../lib/sibit/bitcoinchain'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Yegor Bugayenko