sibit 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef4603f30e6d52d2efec48d698778505150df7b5e98400938db804a1a412a053
-  data.tar.gz: 1c30fe4e9d7e1c077204b26282ed78a169b6e86cc630baf376903bb2f8103601
+  metadata.gz: 1e3a925010c38e43c7657cf822c56a377b491b04cd0d048d444e25a66eba824f
+  data.tar.gz: 88a8c7fbd56ebcf3d37b298bdd5df931eaabfc72406da18cacc41fa19e98538f
 SHA512:
-  metadata.gz: 8e1c22106253d2ee0ef9ab0d38e27526b4553c26bd1c01c8cb66910f692c19cd465b85b8104d5ea09c9dd2b22446e917bb333ff8cb7e1db3c730e0e6f3b472aa
-  data.tar.gz: 035dfbccaef19b8ff39c7c404a0b11f058d813a0df492c741a6849ddac8eb0b990892523c186929e4b2822939d6011f246417c31ff3c24a5123732b3fe30b0db
+  metadata.gz: c2d94c940bc0d564090a9079d772fc1006c0bb64fdcc014cf8b77c4bfdfcfb3e09f8be2252ba8c0b5efe42bcad0130220b61c4bf9fbd0178401d8b720a625699
+  data.tar.gz: 6e22d3aad01fdb1eb058fa23d62ce137750f873f11f7afabc5677df240138ce4d0027ff0a77272068a2e4f2bba3359e9be7860d09bc68d3469c63a4a1e6262a6

data/README.md

@@ -123,9 +123,10 @@ work with the following APIs:
   * [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)
+  * [Blockchair.com](https://blockchair.com/api/docs)
   * [Earn.com](https://bitcoinfees.earn.com/api)
 
-The first one in this list is used by default. If you want to use a diffent
+The first one in this list is used by default. If you want to use a different
 one, you just specify it in the constructor of `Sibit` object:
 
 ```ruby
@@ -135,7 +136,8 @@ 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
+some APIs are not reliable and others don't have all the features required.
+You can provide an array of objects and they
 will be used one by one, until a successful response is obtained:
 
 ```ruby

data/lib/sibit/bitcoinchain.rb

@@ -50,9 +50,13 @@ class Sibit
 
     # Gets the balance of the address, in satoshi.
     def balance(address)
-      (Sibit::Json.new(http: @http, log: @log).get(
+      json = Sibit::Json.new(http: @http, log: @log).get(
         URI("https://api-r.bitcoinchain.com/v1/address/#{address}")
-      )[0]['balance'] * 100_000_000).to_i
+      )[0]
+      raise Sibit::Error, "Address #{address} not found" if json.nil?
+      b = (json['balance'] * 100_000_000).to_i
+      @log.info("The balance of #{address} is #{b} satoshi")
+      b
     end
 
     # Get recommended fees, in satoshi per byte.
@@ -62,9 +66,11 @@ class Sibit
 
     # Gets the hash of the latest block.
     def latest
-      Sibit::Json.new(http: @http, log: @log).get(
+      hash = Sibit::Json.new(http: @http, log: @log).get(
         URI('https://api-r.bitcoinchain.com/v1/status')
       )['hash']
+      @log.info("The latest block hash is #{hash}")
+      hash
     end
 
     # Fetch all unspent outputs per address.

data/lib/sibit/blockchain.rb

@@ -98,9 +98,11 @@ class Sibit
 
     # Gets the hash of the latest block.
     def latest
-      Sibit::Json.new(http: @http, log: @log).get(
+      hash = Sibit::Json.new(http: @http, log: @log).get(
         URI('https://blockchain.info/latestblock')
       )['hash']
+      @log.info("The latest block hash is #{hash}")
+      hash
     end
 
     # This method should fetch a Blockchain block and return as a hash.

data/lib/sibit/blockchair.rb

@@ -0,0 +1,98 @@
+# 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 'uri'
+require 'json'
+require 'cgi'
+require_relative 'version'
+require_relative 'error'
+require_relative 'log'
+require_relative 'http'
+require_relative 'json'
+
+# Blockchair.com API.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
+# License:: MIT
+class Sibit
+  # Btc.com API.
+  class Blockchair
+    # Constructor.
+    def initialize(key: nil, log: Sibit::Log.new, http: Sibit::Http.new, dry: false)
+      @key = key
+      @http = http
+      @log = log
+      @dry = dry
+    end
+
+    # Current price of BTC in USD (float returned).
+    def price(_currency)
+      raise Sibit::Error, 'Blockchair doesn\'t provide BTC price'
+    end
+
+    # Gets the balance of the address, in satoshi.
+    def balance(address)
+      json = Sibit::Json.new(http: @http, log: @log).get(
+        URI("https://api.blockchair.com/bitcoin/dashboards/address/#{address}?#{the_key}")
+      )['data'][address]
+      raise Sibit::Error, "Address #{address} not found" if json.nil?
+      b = json['address']['balance']
+      @log.info("The balance of #{address} is #{b} satoshi")
+      b
+    end
+
+    # Get recommended fees, in satoshi per byte.
+    def fees
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    # Gets the hash of the latest block.
+    def latest
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    # Fetch all unspent outputs per address.
+    def utxos(_sources)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    # Push this transaction (in hex format) to the network.
+    def push(hex)
+      Sibit::Json.new(http: @http, log: @log).post(
+        URI("https://api.blockchair.com/bitcoin/push/transaction?#{the_key}"),
+        "data=#{hex}"
+      )
+    end
+
+    # This method should fetch a Blockchain block and return as a hash.
+    def block(_hash)
+      raise Sibit::Error, 'Not implemented yet'
+    end
+
+    private
+
+    def the_key
+      @key.nil? ? '' : "key=#{CGI.escape(@key)}"
+    end
+  end
+end

data/lib/sibit/cryptoapis.rb

@@ -51,10 +51,13 @@ class Sibit
 
     # Gets the balance of the address, in satoshi.
     def balance(address)
-      (Sibit::Json.new(http: @http, log: @log).get(
+      json = 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).to_i
+      )['payload']
+      b = (json['balance'].to_f * 100_000_000).to_i
+      @log.info("The balance of #{address} is #{b} satoshi")
+      b
     end
 
     # Get recommended fees, in satoshi per byte.
@@ -64,10 +67,12 @@ class Sibit
 
     # Gets the hash of the latest block.
     def latest
-      Sibit::Json.new(http: @http, log: @log).get(
+      hash = Sibit::Json.new(http: @http, log: @log).get(
         URI('https://api.cryptoapis.io/v1/bc/btc/mainnet/blocks/latest'),
         headers: headers
       )['payload']['hash']
+      @log.info("The latest block hash is #{hash}")
+      hash
     end
 
     # Fetch all unspent outputs per address.

data/lib/sibit/version.rb

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

data/test/test_blockchair.rb

@@ -0,0 +1,42 @@
+# 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 'webmock/minitest'
+require 'json'
+require_relative '../lib/sibit'
+require_relative '../lib/sibit/blockchair'
+
+# Sibit::Blockchair test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2020 Yegor Bugayenko
+# License:: MIT
+class TestBlockchair < Minitest::Test
+  def test_fetch_balance
+    hash = '1GkQmKAmHtNfnD3LHhTkewJxKHVSta4m2a'
+    stub_request(:get, "https://api.blockchair.com/bitcoin/dashboards/address/#{hash}")
+      .to_return(body: "{\"data\": {\"#{hash}\": {\"address\": {\"balance\": 1}}}}")
+    sibit = Sibit::Blockchair.new
+    satoshi = sibit.balance(hash)
+    assert_equal(1, satoshi)
+  end
+end

data/test/test_live.rb

@@ -73,6 +73,8 @@ class TestLive < Minitest::Test
     skip
     WebMock.allow_net_connect!
     apis = []
+    require_relative '../lib/sibit/blockchair'
+    apis << Sibit::Blockchair.new
     require_relative '../lib/sibit/cryptoapis'
     apis << Sibit::Cryptoapis.new('-key-')
     require_relative '../lib/sibit/btc'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sibit
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -283,6 +283,7 @@ files:
 - lib/sibit.rb
 - lib/sibit/bitcoinchain.rb
 - lib/sibit/blockchain.rb
+- lib/sibit/blockchair.rb
 - lib/sibit/btc.rb
 - lib/sibit/cryptoapis.rb
 - lib/sibit/earn.rb
@@ -297,6 +298,7 @@ files:
 - test/test__helper.rb
 - test/test_bitcoinchain.rb
 - test/test_blockchain.rb
+- test/test_blockchair.rb
 - test/test_btc.rb
 - test/test_cryptoapis.rb
 - test/test_fake.rb
@@ -335,6 +337,7 @@ test_files:
 - test/test__helper.rb
 - test/test_bitcoinchain.rb
 - test/test_blockchain.rb
+- test/test_blockchair.rb
 - test/test_btc.rb
 - test/test_cryptoapis.rb
 - test/test_fake.rb