blockbee 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c080ab8111b7508dc3daca4996dd881cf24a1efad69689cd3657bc954932e656
-  data.tar.gz: e7887ce185ad0f67b40dd219964238cfabd58ee07ce4c1dd9476ceb4f7f8f65c
+  metadata.gz: 971520704d7a73596c7c0fcecff00c295a1b5c1e8fe445e05d15c9c89f58c86a
+  data.tar.gz: ecbd1c47aa90667afa5b0cc6f5401e87bf75022a528b2cf402f9324707d8e617
 SHA512:
-  metadata.gz: ec6e38347c2af3918cbd4f04e52978698ace2c662c8762f4f371ce69684daa1b04795b2dd4225daa182af5bfc1b6e43a6682e73e9a462744f06ddc8e71b17ad1
-  data.tar.gz: e300deeb203d4da1c92f9093889ef1e3c8329c9c47f50c7318944932203d07a2b648a2d94232dc2539ed26ed69d689147eb4d09c2ff0d439dd6172f97b9a2ebf
+  metadata.gz: bca5ea223cd24d4b3a47bfaef5f59900c76b63d502f4bf298e8899a8936512801c1f53e0b2bd339b98d1ac1fe7c70d8ed2f46cc36f70fd68225658ef113d2ac2
+  data.tar.gz: 6b67a974bbcecb05c1902b81116edbbe0444667eea1c6e77f8d7ec51be6a45235a2ba036afadd443fb408f3f87719da022d0907e4bdc980145b641d18b511f52

data/CHANGELOG.md

@@ -2,5 +2,8 @@
 
 ## 1.0.0
 
+## 1.0.1
+* Minor bugfix
+
 ### Features
 - Support for BlockBee API, Payouts and Checkout page

data/README.md

@@ -19,15 +19,15 @@ Ruby >= 3
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add blockbee
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install blockbee
+
+[RubyGem Page](https://rubygems.org/gems/blockbee/versions/1.0.0)
 
 ## API and utils
 
@@ -42,17 +42,16 @@ require 'blockbee'
 ```ruby
 require 'blockbee'
 
-info = BlockBee::API.get_info(coin, api_key, prices)
+info = BlockBee::API.get_info(coin, prices)
 
 # or if you wish to get full BlockBee service information
 
-info = BlockBee::API.get_info(nil, api_key, prices)
+info = BlockBee::API.get_info(nil, prices)
 
 ```
 
 ### Where
 * ``coin`` is the coin you wish to use, from BlockBee's supported currencies (e.g 'btc', 'eth', 'erc20_usdt', ...).
-* ``api_key`` is the API Key provided by BlockBee's [dashboard](https://dash.blockbee.io/).
 * ``prices`` by default `0`. If `1` will return the prices of the cryptocurrencies converted to all supported FIAT currencies.
 
 ### Generating a new Address
@@ -133,8 +132,7 @@ qrcode = blockbee_helper.get_qrcode(value, size)
 #### Where:
 
 * ``value`` is the value requested to the user in the coin to which the request was done. **Optional**, can be empty if you don't wish to add the value to the QR Code.
-* ``size`` Size of the QR Code image in pixels. Optional, leave empty to use the default size of 512.
-* ``api_key`` is the API Key provided by BlockBee's [dashboard](https://dash.blockbee.io/).
+* ``size`` Size of the QR Code image in pixels. Optional, leave empty to use the default size of 300.
 
 > Response is an object with `qr_code` (base64 encoded image data) and `payment_uri` (the value encoded in the QR), see https://docs.blockbee.io/#operation/qrcode for more information.
 
@@ -157,14 +155,13 @@ qrcode = blockbee_helper.get_qrcode(value, size)
 ```ruby
 require 'blockbee'
 
-estimation = BlockBee::API.get_estimate(coin, addresses, priority, api_key)
+estimation = BlockBee::API.get_estimate(coin, addresses, priority)
 ```
 
 #### Where:
 * ``coin`` is the coin you wish to check, from BlockBee's supported currencies (e.g 'btc', 'eth', 'erc20_usdt', ...)
 * ``addresses`` The number of addresses to forward the funds to. Optional, defaults to 1.
 * ``priority`` Confirmation priority, (check [this](https://support.blockbee.io/article/how-the-priority-parameter-works) article to learn more about it). Optional, defaults to ``default``.
-* ``api_key`` is the API Key provided by BlockBee's [dashboard](https://dash.blockbee.io/).
 
 > Response is an object with ``estimated_cost`` and ``estimated_cost_usd``, see https://docs.blockbee.io/#operation/estimate for more information.
 
@@ -215,12 +212,9 @@ conversion = blockbee_helper.get_conversion(from_coin, value)
 ```ruby
 require 'blockbee'
 
-supported_coins = BlockBee::API.get_supported_coins(api_key)
+supported_coins = BlockBee::API.get_supported_coins
 ```
 
-### Where:
-* ``api_key`` is the API Key provided by BlockBee's [dashboard](https://dash.blockbee.io/).
-
 > Response is an array with all supported coins.
 
 #### Response sample:

data/lib/blockbee.rb

@@ -5,36 +5,60 @@ require 'uri'
 require 'json'
 
 module BlockBee
-  class Error < StandardError; end
+  class APIError < StandardError
+    attr_reader :status_code
 
-  VERSION = "1.0.0"
+    def initialize(message, status_code)
+      super(message)
+      @status_code = status_code
+    end
+
+    def self.from_status_code(status_code, message)
+      case status_code
+      when 400
+        new("Bad Request: #{message}", 400)
+      when 401
+        new("Unauthorized: #{message}", 401)
+      when 403
+        new("Forbidden: #{message}", 403)
+      when 404
+        new("Not Found: #{message}", 404)
+      when 500
+        new("Internal Server Error", 500)
+      else
+        new("Unexpected Error: #{message}", status_code)
+      end
+    end
+  end
+
+  class MissingAPIKeyError < StandardError; end
+
+  class CallbackURLMissing < StandardError; end
+
+  VERSION = "1.0.1"
 
   BLOCKBEE_URL = 'https://api.blockbee.io/'
   BLOCKBEE_HOST = 'api.blockbee.io'
 
   class API
-    def initialize(coin, own_address = '', callback_url, parameters, bb_params, api_key)
-      raise 'API Key Missing' if api_key.nil?
+    def initialize(coin, callback_url, api_key, own_address: '', parameters: {}, bb_params: {})
+      raise BlockBee::MissingAPIKeyError, 'Provide your API Key' if api_key.nil?
+      raise BlockBee::CallbackURLMissing, 'Provide your callback URL' if callback_url.nil?
 
-      raise 'Callback URL Missing' if callback_url.nil?
+      _cb = URI::parse(callback_url)
+
+      @callback_url = URI::HTTPS.build(
+        host: _cb.host,
+        path: _cb.path,
+        query: URI.encode_www_form(parameters)
+      )
 
-      @callback_url = callback_url
       @coin = coin
       @own_address = own_address
-      @parameters = parameters || {}
-      @bb_params = bb_params || {}
+      @parameters = parameters
+      @bb_params = bb_params
       @api_key = api_key
       @payment_address = ''
-
-      if parameters
-        _cb = URI::parse(callback_url)
-
-        @callback_url = URI::HTTPS.build(
-          host: _cb.host,
-          path: _cb.path,
-          query: URI.encode_www_form(parameters)
-        )
-      end
     end
 
     def get_address
@@ -46,12 +70,10 @@ module BlockBee
       }.merge(@bb_params)
 
       if !@own_address.nil? && !@own_address.empty?
-       (_params['address'] = @own_address)
+        (_params['address'] = @own_address)
       end
 
-      _address = BlockBee::process_request_get(@coin, 'create', _params)
-
-      return nil unless _address
+      _address = BlockBee::process_request_get(@coin, 'create', params: _params)
 
       @payment_address = _address['address_in']
 
@@ -64,16 +86,12 @@ module BlockBee
         'apikey' => @api_key
       }
 
-      _logs = BlockBee::process_request_get(@coin, 'logs', _params)
-
-      return nil unless _logs
-
-      p _logs
+      _logs = BlockBee::process_request_get(@coin, 'logs', params: _params)
 
       _logs
     end
 
-    def get_qrcode(value = '', size = 300)
+    def get_qrcode(value: nil, size: 300)
       return nil if @coin.nil?
 
       address = @payment_address
@@ -82,15 +100,14 @@ module BlockBee
 
       _params = {
         'address' => address,
-        'size' => size,
-        'apikey' => @api_key
+        'size' => size
       }
 
-      _params['value'] = value unless value.empty?
-
-      _qrcode = BlockBee::process_request_get(@coin, 'qrcode', _params)
+      if value.is_a? Numeric
+        _params['value'] = value
+      end
 
-      return nil unless _qrcode
+      _qrcode = BlockBee::process_request_get(@coin, 'qrcode', params: _params)
 
       _qrcode
     end
@@ -99,35 +116,23 @@ module BlockBee
       _params = {
         'from' => from_coin,
         'value' => value,
-        'apikey' => @api_key
       }
 
-      _conversion = BlockBee::process_request_get(@coin, 'convert', _params)
-
-      return nil unless _conversion
+      _conversion = BlockBee::process_request_get(@coin, 'convert', params: _params)
 
       _conversion
     end
 
-    def self.get_info(coin, api_key, prices = 0)
-      raise 'API Key Missing' if api_key.nil?
-
+    def self.get_info(coin, prices: 0)
       _params = {
         'prices' => prices,
-        'apikey' => api_key
       }
 
-      _info = BlockBee::process_request_get(coin, 'info', _params)
-
-      return nil unless _info
-
-      _info
+      _info = BlockBee::process_request_get(coin, 'info', params: _params)
     end
 
-    def self.get_supported_coins(api_key)
-      raise 'API Key Missing' if api_key.nil?
-
-      _info = get_info(nil, api_key )
+    def self.get_supported_coins()
+      _info = get_info(nil)
 
       _info.delete('fee_tiers')
 
@@ -146,67 +151,62 @@ module BlockBee
       _coins
     end
 
-    def self.get_estimate(coin, addresses = 1, priority = 'default', api_key)
-      raise 'API Key Missing' if api_key.nil?
+    def self.get_estimate(coin, api_key, addresses: 1, priority: 'default')
+      raise BlockBee::MissingAPIKeyError, 'Provide your API Key' if api_key.nil?
 
-      params = {
+      _params = {
         'addresses' => addresses,
         'priority' => priority,
-        'apikey' => api_key
       }
 
-      _estimate = BlockBee::process_request_get(coin, 'estimate', params)
-
-      return nil unless _estimate
+      _estimate = BlockBee::process_request_get(coin, 'estimate', params: _params)
 
       _estimate
     end
 
-    def self.create_payout(coin, payout_requests, api_key, process = false)
-      raise 'No requests provided' if payout_requests.nil? || payout_requests.empty?
-
+    def self.create_payout(coin, payout_requests, api_key, process: false)
       body = { 'outputs' => payout_requests }
 
       endpoint = 'payout/request/bulk'
 
       endpoint += '/process' if process
 
-      _payout = BlockBee::process_request_post(coin, endpoint, api_key, body, true)
-
-      return nil unless _payout['status'] == 'success'
+      _payout = BlockBee::process_request_post(coin, endpoint, api_key, body: body, is_json: true)
 
       _payout
     end
 
-    def self.list_payouts(coin, status: 'all', page: 1, api_key:, payout_request: false)
-      return nil if api_key.nil?
-
+    def self.list_payouts(coin, api_key, status: 'all', page: 1, payout_request: false)
       _params = {
         'apikey' => api_key,
         'status' => status,
-        'page' => page
+        'p' => page
       }
 
       endpoint = 'payout/list'
 
       endpoint = 'payout/request/list' if payout_request
 
-      _payouts = BlockBee::process_request_get(coin, endpoint, _params)
-
-      return nil unless _payouts['status'] == 'success'
+      _payouts = BlockBee::process_request_get(coin, endpoint, params: _params)
 
       _payouts
     end
 
     def self.get_payout_wallet(coin, api_key, balance = false)
-      wallet = BlockBee::process_request_get(coin, 'payout/address', 'apikey' => api_key)
+      wallet = BlockBee::process_request_get(coin, 'payout/address', params: { 'apikey' => api_key })
 
-      return nil unless wallet['status'] == 'success'
+      if wallet['status'] == 'error'
+        raise BlockBee::Error, wallet['error']
+      end
 
       output = { 'address' => wallet['address'] }
 
       if balance
-        wallet_balance = BlockBee::process_request_get(coin, 'payout/balance', 'apikey' => api_key)
+        wallet_balance = BlockBee::process_request_get(coin, 'payout/balance', params: { 'apikey' => api_key })
+
+        if wallet_balance['status'] == 'error'
+          raise BlockBee::Error, wallet_balance['error']
+        end
 
         if wallet_balance['status'] == 'success'
           output['balance'] = wallet_balance['balance']
@@ -217,31 +217,19 @@ module BlockBee
     end
 
     def self.create_payout_by_ids(api_key, payout_ids)
-      raise 'Please provide the Payout Request(s) ID(s)' if payout_ids.nil? || payout_ids.empty?
-
-      _payout = BlockBee::process_request_post(nil, 'payout/create', api_key, { 'request_ids' => payout_ids.join(',') })
-
-      return nil unless _payout['status'] == 'success'
+      _payout = BlockBee::process_request_post(nil, 'payout/create', api_key, body: { 'request_ids' => payout_ids.join(',') })
 
       _payout
     end
 
     def self.process_payout(api_key, payout_id)
-      return nil if payout_id.nil?
-
-      _process = BlockBee::process_request_post(nil, 'payout/process', api_key, { 'payout_id' => payout_id })
-
-      return nil unless _process['status'] == 'success'
+      _process = BlockBee::process_request_post(nil, 'payout/process', api_key, body: { 'payout_id' => payout_id })
 
       _process
     end
 
     def self.check_payout_status(api_key, payout_id)
-      raise 'Please provide the Payout ID' if payout_id.nil? or (payout_id.is_a? String and payout_id.empty?)
-
-      _status = BlockBee::process_request_post(nil, 'payout/status', api_key, { 'payout_id' => payout_id })
-
-      return nil unless _status['status'] == 'success'
+      _status = BlockBee::process_request_post(nil, 'payout/status', api_key, body: { 'payout_id' => payout_id })
 
       _status
     end
@@ -249,7 +237,7 @@ module BlockBee
 
   class Checkout
     def initialize(parameters: {}, bb_params: {}, notify_url:, api_key:)
-      raise 'API Key Missing' if api_key.nil?
+      raise BlockBee::MissingAPIKeyError, 'Provide your API Key' if api_key.nil?
 
       @parameters = parameters
       @bb_params = bb_params
@@ -268,9 +256,7 @@ module BlockBee
     end
 
     def payment_request(redirect_url, value)
-      raise 'Please provide a redirect url' if redirect_url.nil? or redirect_url.empty?
-
-      raise 'Value must be a integer' unless value.is_a?(Integer)
+      raise ArgumentError, 'Provide a valid number' unless value.is_a?(Numeric)
 
       _params = {
         'redirect_url' => redirect_url,
@@ -279,7 +265,7 @@ module BlockBee
         'apikey' => @api_key
       }.merge(@bb_params)
 
-      _request = BlockBee::process_request_get(nil, 'checkout/request', _params)
+      _request = BlockBee::process_request_get(nil, 'checkout/request', params: _params)
 
       return nil unless _request['status'] == 'success'
 
@@ -287,48 +273,34 @@ module BlockBee
     end
 
     def self.payment_logs(token, api_key)
-      raise 'API Key required' if api_key.nil? or api_key.empty?
-
-      raise 'Token required' if token.nil? or token.empty?
-
       _params = {
         'apikey' => api_key,
         'token' => token
       }
 
-      _logs = BlockBee::process_request_get(nil, 'checkout/logs', _params)
-
-      return nil unless _logs['status'] == 'success'
+      _logs = BlockBee::process_request_get(nil, 'checkout/logs', params: _params)
 
       _logs
     end
 
-    def deposit_request()
+    def deposit_request
       _params = {
         'notify_url' => @notify_url,
         'apikey' => @api_key
       }.merge(@bb_params)
 
-      _request = BlockBee::process_request_get(nil, 'deposit/request', _params)
-
-      return nil unless _request['status'] == 'success'
+      _request = BlockBee::process_request_get(nil, 'deposit/request', params: _params)
 
       _request
     end
 
     def self.deposit_logs(token, api_key)
-      raise 'API Key required' if api_key.nil? or api_key.empty?
-
-      raise 'Token required' if token.nil? or token.empty?
-
       _params = {
         'apikey' => api_key,
         'token' => token
       }
 
-      _logs = BlockBee::process_request_get(nil, 'deposit/logs', _params)
-
-      return nil unless _logs['status'] == 'success'
+      _logs = BlockBee::process_request_get(nil, 'deposit/logs', params: _params)
 
       _logs
     end
@@ -336,24 +308,27 @@ module BlockBee
 
   private
 
-  def self.process_request_get(coin = '', endpoint = '', params = nil)
+  def self.process_request_get(coin, endpoint, params: {})
     coin = coin.nil? ? '' : "#{coin.tr('_', '/')}/"
 
-    response = Net::HTTP.get(URI.parse("#{BLOCKBEE_URL}#{coin}#{endpoint}/?#{URI.encode_www_form(params)}"))
+    response = Net::HTTP.get_response(URI.parse("#{BLOCKBEE_URL}#{coin}#{endpoint}/?#{URI.encode_www_form(params)}"))
+
+    response_obj = JSON.parse(response.body)
 
-    JSON.parse(response)
+    if !response.is_a?(Net::HTTPSuccess) || response_obj['status'] == 'error'
+      error = APIError.from_status_code(response.code.to_i, response_obj['error'])
+      raise error
+    end
+
+    response_obj
   end
 
-  def self.process_request_post(coin = '', endpoint = '', api_key = '', body = nil, is_json = false)
+  def self.process_request_post(coin, endpoint, api_key, body: nil, is_json: false)
     coin_path = coin.nil? ? '' : "#{coin.tr('_', '/')}/"
 
-    p coin_path
-
     url = "#{BLOCKBEE_URL}#{coin_path}#{endpoint}/?apikey=#{api_key}"
     uri = URI.parse(url)
 
-    p url
-
     req = Net::HTTP::Post.new(uri)
     req['Host'] = BLOCKBEE_HOST
 
@@ -366,6 +341,14 @@ module BlockBee
 
     res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
 
-    JSON.parse(res.body)
+    response_obj = JSON.parse(res.body)
+
+    if res.is_a?(Net::HTTPSuccess) && response_obj['status'] == 'success'
+      response_obj
+    else
+      error_message = response_obj['error'] || "Unexpected error occurred"
+      error = APIError.from_status_code(res.code.to_i, error_message)
+      raise error
+    end
   end
 end

data/sig/blockbee.rbs

@@ -3,6 +3,14 @@ module BlockBee
   BLOCKBEE_URL: string
   VERSION: String
 
+  class APIError
+    @status_code: Integer
+
+    def self.from_status_code: -> untyped
+
+    attr_reader status_code: Integer
+  end
+
   class API
     @callback_url: string
     @coin: string
@@ -21,7 +29,7 @@ module BlockBee
 
     def get_qrcode: -> untyped
 
-    def get_info: -> untyped
+    def self.get_info: -> untyped
 
     def self.get_supported_coins: -> untyped
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blockbee
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - BlockBee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -31,7 +31,7 @@ licenses:
 metadata:
   homepage_uri: https://blockbee.io
   source_code_uri: https://github.com/blockbee-io/ruby-blockbee
-  changelog_uri: https://github.com/blockbee-io/ruby-blockbee/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/blockbee-io/ruby-blockbee/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: