blockbee 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 971520704d7a73596c7c0fcecff00c295a1b5c1e8fe445e05d15c9c89f58c86a
-  data.tar.gz: ecbd1c47aa90667afa5b0cc6f5401e87bf75022a528b2cf402f9324707d8e617
+  metadata.gz: becf07a555e1c0b7698363dff5c0457f3d410c2a683fb10f17aa4c2534ec1e39
+  data.tar.gz: 5f0b5a6540ecfd72aa0b465452a2acdb6970556e7967e6354c8825872d6043be
 SHA512:
-  metadata.gz: bca5ea223cd24d4b3a47bfaef5f59900c76b63d502f4bf298e8899a8936512801c1f53e0b2bd339b98d1ac1fe7c70d8ed2f46cc36f70fd68225658ef113d2ac2
-  data.tar.gz: 6b67a974bbcecb05c1902b81116edbbe0444667eea1c6e77f8d7ec51be6a45235a2ba036afadd443fb408f3f87719da022d0907e4bdc980145b641d18b511f52
+  metadata.gz: cf2c2c22bfcfbaf8a05ef47f25dadfe0651d9867cc6d95debed0d6d0480976ccdcb55ba354055cc001db011a152dbb3149d42791f35cad644064e73742414732
+  data.tar.gz: 4595ea4e231ab5918e3ac0cc437cbc6f739e843076abf2949ad6f02f3e00d9db6abd5e750afae5d505943d86b408fa0839a5245d2e934584f9effa87c1adeaeb

data/CHANGELOG.md

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

data/README.md

@@ -59,7 +59,7 @@ info = BlockBee::API.get_info(nil, 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
 
@@ -69,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:
 
@@ -98,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
 ```
@@ -124,9 +124,9 @@ 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:
@@ -185,7 +185,7 @@ estimation = BlockBee::API.get_estimate(coin, addresses, priority)
 ```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)
 ```
@@ -408,8 +408,8 @@ If `process` is `false`.
 {
   "status": "success",
   "request_ids": [
-    103227,
-    103228
+    "3825d29b-7a8f-47da-8623-e99850674247",
+    "d9925105-ea5f-4661-8d01-505096212ac5"
   ]
 }
 ```
@@ -418,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
 }
 ```
@@ -450,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",
@@ -508,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": {
@@ -544,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
 }
 ```
@@ -571,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": {
@@ -589,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

@@ -35,23 +35,42 @@ module BlockBee
 
   class CallbackURLMissing < StandardError; end
 
-  VERSION = "1.0.1"
+  class Error < StandardError; end
+
+  VERSION = "1.1.0"
 
   BLOCKBEE_URL = 'https://api.blockbee.io/'
   BLOCKBEE_HOST = 'api.blockbee.io'
 
   class API
     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?
-
-      _cb = URI::parse(callback_url)
+      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
 
-      @callback_url = URI::HTTPS.build(
-        host: _cb.host,
-        path: _cb.path,
-        query: URI.encode_www_form(parameters)
-      )
+      # 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
@@ -93,6 +112,10 @@ module BlockBee
 
     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
 
@@ -237,7 +260,10 @@ module BlockBee
 
   class Checkout
     def initialize(parameters: {}, bb_params: {}, notify_url:, api_key:)
-      raise BlockBee::MissingAPIKeyError, 'Provide your API Key' 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
@@ -245,18 +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 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,

data/sig/blockbee.rbs

@@ -1,111 +1,83 @@
 module BlockBee
-  BLOCKBEE_HOST: string
-  BLOCKBEE_URL: string
+  BLOCKBEE_HOST: String
+  BLOCKBEE_URL: String
   VERSION: String
 
-  class APIError
+  class APIError < StandardError
     @status_code: Integer
 
-    def self.from_status_code: -> 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 MissingAPIKeyError < StandardError
+  end
+
+  class CallbackURLMissing < StandardError
+  end
+
+  class Error < StandardError
+  end
+
   class API
-    @callback_url: string
-    @coin: string
-    @own_address: string
-    @coin: string
+    @callback_url: String
+    @coin: String?
+    @own_address: String
     @parameters: Hash[untyped, untyped]
     @bb_params: Hash[untyped, untyped]
-    @api_key: string
-    @payment_address: string
+    @api_key: String
+    @payment_address: String
 
-    def get_address: -> string
+    def initialize: (String? coin, String callback_url, String api_key, ?own_address: String, ?parameters: Hash[untyped, untyped], ?bb_params: Hash[untyped, untyped]) -> void
 
-    def get_conversion: -> untyped
+    def get_address: () -> Hash[String, untyped]?
 
-    def get_logs: -> untyped
+    def get_logs: () -> Hash[String, untyped]
 
-    def get_qrcode: -> untyped
+    def get_qrcode: (?value: Numeric?, ?size: Integer) -> Hash[String, untyped]
 
-    def self.get_info: -> untyped
+    def get_conversion: (String from_coin, Numeric value) -> Hash[String, untyped]
 
-    def self.get_supported_coins: -> untyped
+    def self.get_info: (String? coin, ?prices: Integer) -> Hash[String, untyped]
 
-    def self.get_estimate: -> untyped
+    def self.get_supported_coins: () -> Hash[String, String]
 
-    def self.create_payout: -> untyped
+    def self.get_estimate: (String coin, String api_key, ?addresses: Integer, ?priority: String) -> Hash[String, untyped]
 
-    def self.list_payouts: -> untyped
+    def self.create_payout: (String coin, Hash[String, Numeric] payout_requests, String api_key, ?process: bool) -> Hash[String, untyped]
 
-    def self.get_payout_wallet: -> untyped
+    def self.list_payouts: (String coin, String api_key, ?status: String, ?page: Integer, ?payout_request: bool) -> Hash[String, untyped]
 
-    def self.create_payout_by_ids: -> untyped
+    def self.get_payout_wallet: (String coin, String api_key, ?bool balance) -> Hash[String, untyped]
 
-    def self.process_payout: -> untyped
+    def self.create_payout_by_ids: (String api_key, Array[Integer] payout_ids) -> Hash[String, untyped]
 
-    def self.check_payout_status: -> untyped
+    def self.process_payout: (String api_key, Integer payout_id) -> Hash[String, untyped]
 
+    def self.check_payout_status: (String api_key, Integer payout_id) -> Hash[String, untyped]
   end
 
   class Checkout
+    @api_key: String
+    @bb_params: Hash[untyped, untyped]
+    @parameters: Hash[untyped, untyped]
+    @notify_url: String
 
-    @api_key: string
-    @bb_params: hash[untyped, untyped]
-    @parameters: hash[untyped, untyped]
-    @notify_url: string
-
-    def self.deposit_logs: -> untyped
+    def initialize: (?parameters: Hash[untyped, untyped], ?bb_params: Hash[untyped, untyped], notify_url: String, api_key: String) -> void
 
-    def self.payment_logs: -> untyped
+    def self.deposit_logs: (String token, String api_key) -> Hash[String, untyped]
 
-    def deposit_request: -> untyped
+    def self.payment_logs: (String token, String api_key) -> Hash[String, untyped]
 
-    def payment_request: -> untyped
+    def deposit_request: () -> Hash[String, untyped]
 
+    def payment_request: (String redirect_url, Numeric value) -> Hash[String, untyped]?
   end
 
   private
 
-  def self.process_request_get: -> untyped
-  def self.process_request_post: -> untyped
-end
-
-class TestBlockBee
-  def test_can_check_payout_status: -> TrueClass
-
-  def test_can_create_checkout_payment: -> TrueClass
-
-  def test_can_create_deposit: -> TrueClass
-
-  def test_can_create_payout_by_is: -> TrueClass
-
-  def test_can_create_payouts: -> TrueClass
-
-  def test_can_fetch_deposit_logs: -> TrueClass
-
-  def test_can_fetch_logs: -> TrueClass
-
-  def test_can_fetch_payment_logs: -> TrueClass
-
-  def test_can_generate_address: -> TrueClass
-
-  def test_can_get_conversion: -> TrueClass
-
-  def test_can_get_estimate: -> TrueClass
-
-  def test_can_get_info: -> TrueClass
-
-  def test_can_get_payout_wallet: -> TrueClass
-
-  def test_can_get_qrcode: -> TrueClass
-
-  def test_can_get_supported_coins: -> TrueClass
-
-  def test_can_list_payouts: -> TrueClass
-
-  def test_can_process_payout_by_id: -> TrueClass
-
-  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.1
+  version: 1.1.0
 platform: ruby
 authors:
 - BlockBee
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-22 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
@@ -32,7 +43,6 @@ 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/master/CHANGELOG.md
-post_install_message:
 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: []