blockbee 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c080ab8111b7508dc3daca4996dd881cf24a1efad69689cd3657bc954932e656
-  data.tar.gz: e7887ce185ad0f67b40dd219964238cfabd58ee07ce4c1dd9476ceb4f7f8f65c
+  metadata.gz: becf07a555e1c0b7698363dff5c0457f3d410c2a683fb10f17aa4c2534ec1e39
+  data.tar.gz: 5f0b5a6540ecfd72aa0b465452a2acdb6970556e7967e6354c8825872d6043be
 SHA512:
-  metadata.gz: ec6e38347c2af3918cbd4f04e52978698ace2c662c8762f4f371ce69684daa1b04795b2dd4225daa182af5bfc1b6e43a6682e73e9a462744f06ddc8e71b17ad1
-  data.tar.gz: e300deeb203d4da1c92f9093889ef1e3c8329c9c47f50c7318944932203d07a2b648a2d94232dc2539ed26ed69d689147eb4d09c2ff0d439dd6172f97b9a2ebf
+  metadata.gz: cf2c2c22bfcfbaf8a05ef47f25dadfe0651d9867cc6d95debed0d6d0480976ccdcb55ba354055cc001db011a152dbb3149d42791f35cad644064e73742414732
+  data.tar.gz: 4595ea4e231ab5918e3ac0cc437cbc6f739e843076abf2949ad6f02f3e00d9db6abd5e750afae5d505943d86b408fa0839a5245d2e934584f9effa87c1adeaeb

data/CHANGELOG.md

@@ -2,5 +2,11 @@
 
 ## 1.0.0
 
+## 1.0.1
+* Minor bugfix
+
+## 1.1.0
+* Various improvements
+
 ### 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
@@ -60,7 +59,7 @@ info = BlockBee::API.get_info(nil, api_key, prices)
 ```ruby
 require 'blockbee'
 
-blockbee_helper = BlockBee::API.new(coin, own_address, callback_url, parameters, bb_params, api_key)
+blockbee_helper = BlockBee::API.new(coin, callback_url, api_key, own_address: own_address, parameters: parameters, bb_params: bb_params)
 
 address = blockbee_helper.get_address
 
@@ -70,11 +69,11 @@ address = blockbee_helper.get_address
 #### Where:
 
 * ``coin`` is the coin you wish to use, from BlockBee's supported currencies (e.g 'btc', 'eth', 'erc20_usdt', ...).
-* ``own_address`` is your own crypto address, where your funds will be sent to.
 * ``callback_url`` is the URL that will be called upon payment.
-* ``parameters`` is any parameter you wish to send to identify the payment, such as `{orderId: 1234}`.
-* ``bb_params`` parameters that will be passed to BlockBee _(check which extra parameters are available here: https://docs.blockbee.io/#operation/create).
 * ``api_key`` is the API Key provided by BlockBee's [dashboard](https://dash.blockbee.io/).
+* ``own_address`` (optional) is your own crypto address, where your funds will be sent to.
+* ``parameters`` (optional) is any parameter you wish to send to identify the payment, such as `{orderId: 1234}`.
+* ``bb_params`` (optional) parameters that will be passed to BlockBee _(check which extra parameters are available here: https://docs.blockbee.io/#operation/create).
 
 #### Response sample:
 
@@ -99,7 +98,7 @@ address = blockbee_helper.get_address
 ```ruby
 require 'blockbee'
 
-blockbee_helper = BlockBee::API.new(coin, own_address, callback_url, parameters, bb_params, api_key)
+blockbee_helper = BlockBee::API.new(coin, callback_url, api_key, own_address: own_address, parameters: parameters, bb_params: bb_params)
 
 logs = blockbee_helper.get_logs
 ```
@@ -125,16 +124,15 @@ logs = blockbee_helper.get_logs
 ```ruby
 require 'blockbee'
 
-blockbee_helper = BlockBee::API.new(coin, own_address, callback_url, parameters, bb_params, api_key)
+blockbee_helper = BlockBee::API.new(coin, callback_url, api_key, own_address: own_address, parameters: parameters, bb_params: bb_params)
 
-qrcode = blockbee_helper.get_qrcode(value, size)
+qrcode = blockbee_helper.get_qrcode(value: value, size: 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.
 
@@ -188,7 +185,7 @@ estimation = BlockBee::API.get_estimate(coin, addresses, priority, api_key)
 ```ruby
 require 'blockbee'
 
-blockbee_helper = BlockBee::API.new(coin, own_address, callback_url, parameters, bb_params, api_key)
+blockbee_helper = BlockBee::API.new(coin, callback_url, api_key, own_address: own_address, parameters: parameters, bb_params: bb_params)
 
 conversion = blockbee_helper.get_conversion(from_coin, value)
 ```
@@ -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:
@@ -414,8 +408,8 @@ If `process` is `false`.
 {
   "status": "success",
   "request_ids": [
-    103227,
-    103228
+    "3825d29b-7a8f-47da-8623-e99850674247",
+    "d9925105-ea5f-4661-8d01-505096212ac5"
   ]
 }
 ```
@@ -424,6 +418,22 @@ If `process` is `true`.
 ```json
 {
   "status": "success",
+  "payout_info": {
+    "id": "d9219d07-a8e5-4d89-a869-3c5717a25b27",
+    "status": "Created",
+    "from": "",
+    "requests": {
+      "0xA8EbeD50f2e05fB4a25b2DdCdc651A7CA769B5CF": "0.300000000000000000",
+      "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.200000000000000000"
+    },
+    "total_requested": "0.5",
+    "total_with_fee": "0.505",
+    "total_fiat": "",
+    "fee": "0.005",
+    "coin": "bep20_usdt",
+    "txid": "",
+    "timestamp": "05/03/2024 15:00:00"
+  },
   "queued": true
 }
 ```
@@ -456,7 +466,7 @@ list_payouts = BlockBee::API.list_payouts(coin, status, page, api_key, payout_re
   "status": "success",
   "payouts": [
     {
-      "id": 2460,
+      "id": "3825d29b-7a8f-47da-8623-e99850674247",
       "status": "Done",
       "total_requested": "0.6",
       "total_with_fee": "0.606",
@@ -514,7 +524,7 @@ payout = BlockBee::API.create_payout_by_ids(api_key, payout_ids)
 {
   "status": "success",
   "payout_info": {
-    "id": 2461,
+    "id": "d9219d07-a8e5-4d89-a869-3c5717a25b27",
     "status": "Created",
     "from": "",
     "requests": {
@@ -550,7 +560,23 @@ payout = BlockBee::API.process_payout(api_key, payout_ids)
 
 ```json
 { 
-  "status": "success", 
+  "status": "success",
+  "payout_info": {
+    "id": "d9219d07-a8e5-4d89-a869-3c5717a25b27",
+    "status": "Created",
+    "from": "",
+    "requests": {
+      "0xA8EbeD50f2e05fB4a25b2DdCdc651A7CA769B5CF": "0.300000000000000000",
+      "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.200000000000000000"
+    },
+    "total_requested": "0.5",
+    "total_with_fee": "0.505",
+    "total_fiat": "",
+    "fee": "0.005",
+    "coin": "bep20_usdt",
+    "txid": "",
+    "timestamp": "05/03/2024 15:00:00"
+  },
   "queued": true
 }
 ```
@@ -577,7 +603,7 @@ status = BlockBee::API.check_payout_status(api_key, payout_id)
 {
   "status": "success",
   "payout_info": {
-    "id": 2463,
+    "id": "d9219d07-a8e5-4d89-a869-3c5717a25b27",
     "status": "Done",
     "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589",
     "requests": {
@@ -595,6 +621,42 @@ status = BlockBee::API.check_payout_status(api_key, payout_id)
 }
 ```
 
+## Testing
+
+### Option 1: Using .env file (Recommended)
+
+1. Copy the example environment file:
+```bash
+cp .env.example .env
+```
+
+2. Edit `.env` with your actual API credentials:
+```bash
+# Required: Your BlockBee API Key from https://dash.blockbee.io/
+BLOCKBEE_API_KEY=your-actual-api-key-here
+
+# Required: Callback URL for payment notifications
+BLOCKBEE_CALLBACK_URL=https://your-domain.com/webhook
+```
+
+3. Install dependencies and run tests:
+```bash
+bundle install
+bundle exec rake test
+```
+
+### Option 2: Using environment variables
+
+Alternatively, you can set environment variables directly:
+
+```bash
+export BLOCKBEE_API_KEY="your-api-key-here"
+export BLOCKBEE_CALLBACK_URL="https://your-domain.com/webhook"
+bundle exec rake test
+```
+
+**Note:** If no API key is provided, only basic tests (like version check) will run. The `.env` file is automatically ignored by git to keep your credentials secure.
+
 ## Help
 
 Need help?  

data/lib/blockbee.rb

@@ -5,36 +5,79 @@ require 'uri'
 require 'json'
 
 module BlockBee
+  class APIError < StandardError
+    attr_reader :status_code
+
+    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
+
   class Error < StandardError; end
 
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 
   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?
-
-      raise 'Callback URL Missing' if callback_url.nil?
-
-      @callback_url = callback_url
-      @coin = coin
-      @own_address = own_address
-      @parameters = parameters || {}
-      @bb_params = bb_params || {}
-      @api_key = api_key
-      @payment_address = ''
-
-      if parameters
-        _cb = URI::parse(callback_url)
+    def initialize(coin, callback_url, api_key, own_address: '', parameters: {}, bb_params: {})
+      raise BlockBee::MissingAPIKeyError, 'Provide your API Key' if api_key.nil? || api_key.empty?
+      raise BlockBee::CallbackURLMissing, 'Provide your callback URL' if callback_url.nil? || callback_url.empty?
+      raise ArgumentError, 'Coin must be a string' unless coin.nil? || coin.is_a?(String)
+      raise ArgumentError, 'Parameters must be a hash' unless parameters.is_a?(Hash)
+      raise ArgumentError, 'BB params must be a hash' unless bb_params.is_a?(Hash)
+      
+      begin
+        _cb = URI.parse(callback_url)
+        raise ArgumentError, 'Invalid callback URL' unless _cb.scheme && _cb.host
+      rescue URI::InvalidURIError
+        raise ArgumentError, 'Invalid callback URL format'
+      end
 
+      # Preserve original scheme (HTTP/HTTPS) for development flexibility
+      if _cb.scheme.downcase == 'https'
         @callback_url = URI::HTTPS.build(
           host: _cb.host,
           path: _cb.path,
           query: URI.encode_www_form(parameters)
         )
+      else
+        @callback_url = URI::HTTP.build(
+          host: _cb.host,
+          path: _cb.path,
+          query: URI.encode_www_form(parameters)
+        )
       end
+
+      @coin = coin
+      @own_address = own_address
+      @parameters = parameters
+      @bb_params = bb_params
+      @api_key = api_key
+      @payment_address = ''
     end
 
     def get_address
@@ -46,12 +89,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,17 +105,17 @@ 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?
+      
+      raise ArgumentError, 'Size must be a positive integer' unless size.is_a?(Integer) && size > 0
+      raise ArgumentError, 'Value must be numeric if provided' unless value.nil? || value.is_a?(Numeric)
+      raise ArgumentError, 'Value must be positive if provided' if value.is_a?(Numeric) && value <= 0
 
       address = @payment_address
 
@@ -82,15 +123,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 +139,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 +174,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 +240,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 +260,10 @@ 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? || api_key.empty?
+      raise BlockBee::CallbackURLMissing, 'Provide your notify URL' if notify_url.nil? || notify_url.empty?
+      raise ArgumentError, 'Parameters must be a hash' unless parameters.is_a?(Hash)
+      raise ArgumentError, 'BB params must be a hash' unless bb_params.is_a?(Hash)
 
       @parameters = parameters
       @bb_params = bb_params
@@ -257,20 +271,42 @@ module BlockBee
       @notify_url = notify_url
 
       if @parameters
-        _nu = URI::parse(notify_url)
+        begin
+          _nu = URI.parse(notify_url)
+          raise ArgumentError, 'Invalid notify URL' unless _nu.scheme && _nu.host
+        rescue URI::InvalidURIError
+          raise ArgumentError, 'Invalid notify URL format'
+        end
 
-        @notify_url = URI::HTTPS.build(
-          host: _nu.host,
-          path: _nu.path,
-          query: URI.encode_www_form(parameters)
-        )
+        # Preserve original scheme (HTTP/HTTPS) for development flexibility
+        if _nu.scheme.downcase == 'https'
+          @notify_url = URI::HTTPS.build(
+            host: _nu.host,
+            path: _nu.path,
+            query: URI.encode_www_form(parameters)
+          )
+        else
+          @notify_url = URI::HTTP.build(
+            host: _nu.host,
+            path: _nu.path,
+            query: URI.encode_www_form(parameters)
+          )
+        end
       end
     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)
+      raise ArgumentError, 'Value must be positive' unless value > 0
+      raise ArgumentError, 'Redirect URL cannot be empty' if redirect_url.nil? || redirect_url.empty?
+      
+      # Validate redirect URL format
+      begin
+        _redirect = URI.parse(redirect_url)
+        raise ArgumentError, 'Invalid redirect URL' unless _redirect.scheme && _redirect.host
+      rescue URI::InvalidURIError
+        raise ArgumentError, 'Invalid redirect URL format'
+      end
 
       _params = {
         'redirect_url' => redirect_url,
@@ -279,7 +315,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 +323,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 +358,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 +391,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

@@ -1,103 +1,83 @@
 module BlockBee
-  BLOCKBEE_HOST: string
-  BLOCKBEE_URL: string
+  BLOCKBEE_HOST: String
+  BLOCKBEE_URL: String
   VERSION: String
 
-  class API
-    @callback_url: string
-    @coin: string
-    @own_address: string
-    @coin: string
-    @parameters: Hash[untyped, untyped]
-    @bb_params: Hash[untyped, untyped]
-    @api_key: string
-    @payment_address: string
-
-    def get_address: -> string
-
-    def get_conversion: -> untyped
-
-    def get_logs: -> untyped
-
-    def get_qrcode: -> untyped
-
-    def get_info: -> untyped
+  class APIError < StandardError
+    @status_code: Integer
 
-    def self.get_supported_coins: -> untyped
-
-    def self.get_estimate: -> untyped
-
-    def self.create_payout: -> untyped
-
-    def self.list_payouts: -> untyped
-
-    def self.get_payout_wallet: -> untyped
-
-    def self.create_payout_by_ids: -> untyped
-
-    def self.process_payout: -> untyped
-
-    def self.check_payout_status: -> untyped
+    def initialize: (String message, Integer status_code) -> void
+    def self.from_status_code: (Integer status_code, String message) -> APIError
 
+    attr_reader status_code: Integer
   end
 
-  class Checkout
-
-    @api_key: string
-    @bb_params: hash[untyped, untyped]
-    @parameters: hash[untyped, untyped]
-    @notify_url: string
+  class MissingAPIKeyError < StandardError
+  end
 
-    def self.deposit_logs: -> untyped
+  class CallbackURLMissing < StandardError
+  end
 
-    def self.payment_logs: -> untyped
+  class Error < StandardError
+  end
 
-    def deposit_request: -> untyped
+  class API
+    @callback_url: String
+    @coin: String?
+    @own_address: String
+    @parameters: Hash[untyped, untyped]
+    @bb_params: Hash[untyped, untyped]
+    @api_key: String
+    @payment_address: String
 
-    def payment_request: -> untyped
+    def initialize: (String? coin, String callback_url, String api_key, ?own_address: String, ?parameters: Hash[untyped, untyped], ?bb_params: Hash[untyped, untyped]) -> void
 
-  end
+    def get_address: () -> Hash[String, untyped]?
 
-  private
+    def get_logs: () -> Hash[String, untyped]
 
-  def self.process_request_get: -> untyped
-  def self.process_request_post: -> untyped
-end
+    def get_qrcode: (?value: Numeric?, ?size: Integer) -> Hash[String, untyped]
 
-class TestBlockBee
-  def test_can_check_payout_status: -> TrueClass
+    def get_conversion: (String from_coin, Numeric value) -> Hash[String, untyped]
 
-  def test_can_create_checkout_payment: -> TrueClass
+    def self.get_info: (String? coin, ?prices: Integer) -> Hash[String, untyped]
 
-  def test_can_create_deposit: -> TrueClass
+    def self.get_supported_coins: () -> Hash[String, String]
 
-  def test_can_create_payout_by_is: -> TrueClass
+    def self.get_estimate: (String coin, String api_key, ?addresses: Integer, ?priority: String) -> Hash[String, untyped]
 
-  def test_can_create_payouts: -> TrueClass
+    def self.create_payout: (String coin, Hash[String, Numeric] payout_requests, String api_key, ?process: bool) -> Hash[String, untyped]
 
-  def test_can_fetch_deposit_logs: -> TrueClass
+    def self.list_payouts: (String coin, String api_key, ?status: String, ?page: Integer, ?payout_request: bool) -> Hash[String, untyped]
 
-  def test_can_fetch_logs: -> TrueClass
+    def self.get_payout_wallet: (String coin, String api_key, ?bool balance) -> Hash[String, untyped]
 
-  def test_can_fetch_payment_logs: -> TrueClass
+    def self.create_payout_by_ids: (String api_key, Array[Integer] payout_ids) -> Hash[String, untyped]
 
-  def test_can_generate_address: -> TrueClass
+    def self.process_payout: (String api_key, Integer payout_id) -> Hash[String, untyped]
 
-  def test_can_get_conversion: -> TrueClass
+    def self.check_payout_status: (String api_key, Integer payout_id) -> Hash[String, untyped]
+  end
 
-  def test_can_get_estimate: -> TrueClass
+  class Checkout
+    @api_key: String
+    @bb_params: Hash[untyped, untyped]
+    @parameters: Hash[untyped, untyped]
+    @notify_url: String
 
-  def test_can_get_info: -> TrueClass
+    def initialize: (?parameters: Hash[untyped, untyped], ?bb_params: Hash[untyped, untyped], notify_url: String, api_key: String) -> void
 
-  def test_can_get_payout_wallet: -> TrueClass
+    def self.deposit_logs: (String token, String api_key) -> Hash[String, untyped]
 
-  def test_can_get_qrcode: -> TrueClass
+    def self.payment_logs: (String token, String api_key) -> Hash[String, untyped]
 
-  def test_can_get_supported_coins: -> TrueClass
+    def deposit_request: () -> Hash[String, untyped]
 
-  def test_can_list_payouts: -> TrueClass
+    def payment_request: (String redirect_url, Numeric value) -> Hash[String, untyped]?
+  end
 
-  def test_can_process_payout_by_id: -> TrueClass
+  private
 
-  def test_that_it_has_a_version_number: -> TrueClass
+  def self.process_request_get: (String? coin, String endpoint, ?params: Hash[String, untyped]) -> Hash[String, untyped]
+  def self.process_request_post: (String? coin, String endpoint, String api_key, ?body: Hash[String, untyped]?, ?is_json: bool) -> Hash[String, untyped]
 end

metadata

@@ -1,23 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: blockbee
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - BlockBee
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 2025-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 email:
 - info@blockbee.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -31,8 +42,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
-post_install_message:
+  changelog_uri: https://github.com/blockbee-io/ruby-blockbee/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -47,8 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Ruby implementation of BlockBee's payment gateway
 test_files: []