zerobounce-sdk 1.1.2 → 2.0.13

data/README.md

@@ -23,19 +23,128 @@ Import
 require 'zerobounce'
 ```
 
-Set a valid ZeroBounce API key.
+## Configuration
+
+### Setting API Key
+
+#### Method 1: Using configure block (recommended)
 ```ruby
 Zerobounce.configure do |config|
   config.apikey = '<zerobounce-api-key>'
-  ...
+  # Optional: Set custom API URLs
+  config.api_root_url = 'https://api.zerobounce.net/v2'
+  config.bulk_api_root_url = 'https://bulkapi.zerobounce.net/v2'
 end
 ```
-or
+
+#### Method 1a: Using ApiUrls constants (convenience)
+```ruby
+# Global API (default)
+Zerobounce.configure do |config|
+  config.apikey = '<zerobounce-api-key>'
+  config.api_root_url = Zerobounce::ApiUrls::DEFAULT_URL
+  config.bulk_api_root_url = Zerobounce::ApiUrls::BULK_DEFAULT_URL
+end
+
+# European API (convenience)
+Zerobounce.configure do |config|
+  config.apikey = '<zerobounce-api-key>'
+  config.api_root_url = Zerobounce::ApiUrls::EU_URL
+  config.bulk_api_root_url = Zerobounce::ApiUrls::BULK_DEFAULT_URL
+end
+
+# US API (convenience)
+Zerobounce.configure do |config|
+  config.apikey = '<zerobounce-api-key>'
+  config.api_root_url = Zerobounce::ApiUrls::US_URL
+  config.bulk_api_root_url = Zerobounce::ApiUrls::BULK_DEFAULT_URL
+end
 ```
+
+#### Method 2: Direct configuration
+```ruby
 Zerobounce.config.apikey = '<zerobounce-api-key>'
-...
+# Optional: Set custom API URLs
+Zerobounce.config.api_root_url = 'https://api.zerobounce.net/v2'
+Zerobounce.config.bulk_api_root_url = 'https://bulkapi.zerobounce.net/v2'
 ```
 
+#### Method 3: Using environment variables
+Create a `.env` file in your project root:
+```bash
+ZEROBOUNCE_API_KEY=your_api_key_here
+ZEROBOUNCE_API_URL=https://api.zerobounce.net/v2
+ZEROBOUNCE_BULK_API_URL=https://bulkapi.zerobounce.net/v2
+```
+
+The gem will automatically load these environment variables when initialized. No additional configuration needed in your code.
+
+#### Method 4: System environment variables
+Set environment variables in your system:
+```bash
+export ZEROBOUNCE_API_KEY=your_api_key_here
+export ZEROBOUNCE_API_URL=https://api.zerobounce.net/v2
+export ZEROBOUNCE_BULK_API_URL=https://bulkapi.zerobounce.net/v2
+```
+
+
+### API URL Configuration Details
+
+#### Default Behavior
+If you don't specify `api_root_url` or `bulk_api_root_url`, the gem will use the following defaults:
+- **Main API**: `https://api.zerobounce.net/v2`
+- **Bulk API**: `https://bulkapi.zerobounce.net/v2`
+
+These defaults are defined in the `Zerobounce::ApiUrls` class constants:
+- `Zerobounce::ApiUrls::DEFAULT_URL` - Main API URL (Global)
+- `Zerobounce::ApiUrls::EU_URL` - European API URL
+- `Zerobounce::ApiUrls::US_URL` - US API URL
+- `Zerobounce::ApiUrls::BULK_DEFAULT_URL` - Bulk API URL
+
+#### Using ApiUrls Constants
+You can use the predefined constants in your configuration. The EU and US URLs are provided as convenience options:
+
+```ruby
+# Global API (default)
+Zerobounce.configure do |config|
+  config.apikey = 'your-api-key'
+  config.api_root_url = Zerobounce::ApiUrls::DEFAULT_URL
+  config.bulk_api_root_url = Zerobounce::ApiUrls::BULK_DEFAULT_URL
+end
+
+# European API
+Zerobounce.configure do |config|
+  config.apikey = 'your-api-key'
+  config.api_root_url = Zerobounce::ApiUrls::EU_URL
+  config.bulk_api_root_url = Zerobounce::ApiUrls::BULK_DEFAULT_URL
+end
+
+# US API
+Zerobounce.configure do |config|
+  config.apikey = 'your-api-key'
+  config.api_root_url = Zerobounce::ApiUrls::US_URL
+  config.bulk_api_root_url = Zerobounce::ApiUrls::BULK_DEFAULT_URL
+end
+```
+
+#### Custom API URLs
+You can override the default URLs for custom deployments or testing:
+
+```ruby
+Zerobounce.configure do |config|
+  config.apikey = 'your-api-key'
+  # Use custom URLs (e.g., for testing or custom deployments)
+  config.api_root_url = 'https://custom-api.example.com/v2'
+  config.bulk_api_root_url = 'https://custom-bulk-api.example.com/v2'
+end
+```
+
+#### Environment Variable Priority
+The configuration follows this priority order (highest to lowest):
+1. Explicitly set in code (`config.api_root_url = '...'`)
+2. Environment variables (`ZEROBOUNCE_API_URL`, `ZEROBOUNCE_BULK_API_URL`)
+3. Default constants (`ApiUrls::DEFAULT_URL`, `ApiUrls::BULK_DEFAULT_URL`)
+
 Credits
 ```ruby
 Zerobounce.credits
@@ -80,10 +189,13 @@ Zerobounce.api_usage(Date.today, Date.today)
  "sub_status_mailbox_quota_exceeded"=>0,
  "sub_status_forcible_disconnect"=>0,
  "sub_status_failed_smtp_connection"=>0,
+ "sub_status_accept_all"=>0,
  "sub_status_mx_forward"=>0,
  "sub_status_alternate"=>0,
- "sub_status_blocked"=>0,
  "sub_status_allowed"=>0,
+ "sub_status_blocked"=>0,
+ "sub_status_gold"=>0,
+ "sub_status_role_based_accept_all"=>0,
  "start_date"=>"4/28/2023",
  "end_date"=>"4/28/2023"}
 ```
@@ -412,9 +524,10 @@ When `has_header_row: false` is provided to `scoring_file_send()` method, column
 
 ### Email Finder
 
-Guess Format
+Guess Format by Domain
 ```ruby
-Zerobounce.guessformat("zerobounce.net")
+# New keyword argument syntax (recommended)
+Zerobounce.guessformat(domain: "zerobounce.net")
 =>
 {"email"=>"",
  "domain"=>"zerobounce.net",
@@ -451,21 +564,166 @@ Zerobounce.guessformat("zerobounce.net")
    {"format"=>"lastf", "confidence"=>"medium"},
    {"format"=>"l-first", "confidence"=>"low"},
    {"format"=>"l_first", "confidence"=>"low"}]}
-# Zerobounce.guessformat("zerobounce.net", first_name: "John", middle_name: 'Deere', last_name: "Doe")
+
+# With names for better accuracy (new syntax)
+Zerobounce.guessformat(domain: "zerobounce.net", first_name: "John", middle_name: 'Deere', last_name: "Doe")
+
+# Backwards compatible syntax (still supported)
+Zerobounce.guessformat("zerobounce.net")
+Zerobounce.guessformat("zerobounce.net", first_name: "John", middle_name: 'Deere', last_name: "Doe")
+```
+
+Guess Format by Company Name
+```ruby
+# New keyword argument syntax (recommended)
+Zerobounce.guessformat(company_name: "Zero Bounce")
+=>
+{"email"=>"",
+ "company_name"=>"Zero Bounce",
+ "format"=>"first.last",
+ "status"=>"",
+ "sub_status"=>"",
+ "confidence"=>"high",
+ "did_you_mean"=>"",
+ "failure_reason"=>"",
+ "other_domain_formats"=>[...]}
+
+# With names for better accuracy (new syntax)
+Zerobounce.guessformat(first_name: "John", last_name: "Doe", company_name: "Zero Bounce")
+```
+
+Find Email Address
+```ruby
+# Find email by domain
+Zerobounce.find_email("John", domain: "zerobounce.net")
+=>
+{
+  "email": "john@zerobounce.net",
+  "email_confidence": "medium",
+  "domain": "zerobounce.net",
+  "company_name": "ZeroBounce",
+  "did_you_mean": "",
+  "failure_reason": ""
+}
+
+# Find email by company name
+Zerobounce.find_email("John", company_name: "Zero Bounce")
+=>
+{
+  "email": "john@zerobounce.net",
+  "email_confidence": "medium",
+  "domain": "zerobounce.net",
+  "company_name": "ZeroBounce",
+  "did_you_mean": "",
+  "failure_reason": ""
+}
+
+# With additional name information for better accuracy
+Zerobounce.find_email("John", domain: "zerobounce.net", middle_name: "Deere", last_name: "Doe")
+```
+
+Find Domain Information
+```ruby
+# Find domain format by domain
+Zerobounce.find_domain(domain: "zerobounce.net")
+=>
+{
+  "domain": "zerobounce.net",
+  "company_name": "Hertza, LLC",
+  "format": "first.last",
+  "confidence": "high",
+  "did_you_mean": "",
+  "failure_reason": "",
+  "other_domain_formats": [
+    {"format": "first", "confidence": "high"},
+    {"format": "last.first", "confidence": "high"},
+    {"format": "lastfirst", "confidence": "high"},
+    {"format": "firstl", "confidence": "high"},
+    {"format": "lfirst", "confidence": "high"},
+    {"format": "firstlast", "confidence": "high"},
+    {"format": "last_middle_f", "confidence": "high"},
+    {"format": "last", "confidence": "high"},
+    {"format": "f.last", "confidence": "medium"},
+    {"format": "last-f", "confidence": "medium"},
+    {"format": "l.first", "confidence": "medium"},
+    {"format": "last_f", "confidence": "medium"},
+    {"format": "first.middle.last", "confidence": "medium"},
+    {"format": "first-last", "confidence": "medium"},
+    {"format": "last.f", "confidence": "medium"},
+    {"format": "last_first", "confidence": "medium"},
+    {"format": "f-last", "confidence": "medium"},
+    {"format": "first.l", "confidence": "medium"},
+    {"format": "first-l", "confidence": "medium"},
+    {"format": "first_l", "confidence": "medium"},
+    {"format": "first_last", "confidence": "medium"},
+    {"format": "f_last", "confidence": "medium"},
+    {"format": "last-first", "confidence": "medium"},
+    {"format": "flast", "confidence": "medium"},
+    {"format": "lastf", "confidence": "medium"},
+    {"format": "l_first", "confidence": "medium"},
+    {"format": "l-first", "confidence": "medium"},
+    {"format": "first-middle-last", "confidence": "low"},
+    {"format": "firstmlast", "confidence": "low"},
+    {"format": "last.middle.first", "confidence": "low"},
+    {"format": "last_middle_first", "confidence": "low"},
+    {"format": "first_middle_last", "confidence": "low"},
+    {"format": "last-middle-first", "confidence": "low"},
+    {"format": "first-m-last", "confidence": "low"},
+    {"format": "firstmiddlelast", "confidence": "low"},
+    {"format": "last.m.first", "confidence": "low"},
+    {"format": "lastmfirst", "confidence": "low"},
+    {"format": "lastmiddlefirst", "confidence": "low"},
+    {"format": "last_m_first", "confidence": "low"},
+    {"format": "first.m.last", "confidence": "low"},
+    {"format": "first_m_last", "confidence": "low"},
+    {"format": "last-m-first", "confidence": "low"}
+  ]
+}
+
+# Find domain format by company name
+Zerobounce.find_domain(company_name: "Zero Bounce")
+=>
+{
+  "domain": "zerobounce.net",
+  "company_name": "Zero Bounce",
+  "format": "first.last",
+  "confidence": "high",
+  "did_you_mean": "",
+  "failure_reason": "",
+  "other_domain_formats": [...]
+}
 ```
 
 ## Development
 
-After checking out the repo run tests
+### Local setup
+```bash
+sudo apt install -y rbenv
+git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
+rbenv install 3.2.1
+rbenv global 3.2.1
+rbenv rehash
+ruby -v
+gem install bundler -v "~>2.4.6"
+bundle install
+```
+
+### Run tests with Docker
+From the **parent repository root** (the folder that contains all SDKs and `docker-compose.yml`):
+
+```bash
+docker compose build ruby
+docker compose run --rm ruby
+```
+
+### Run tests (local)
 ```bash
-rspec --init # if needed
 bundle exec rspec
 ```
 
 You should see an output like this
 ```bash
-Run options: include {:focus=>true}
-running live tests
+running tests
 .....................................................
 
 Finished in 6.81 seconds (files took 0.40587 seconds to load)
@@ -473,18 +731,20 @@ Finished in 6.81 seconds (files took 0.40587 seconds to load)
 ```
 
 ### Test parameters
-The tests use the following environment parameters:
-TEST {unit|live} influences whether mocked unit tests are run or the live server is used (credits may be used if you choose to do this)
-ZEROBOUNCE_API_KEY {<zerobounce-api-key-value>} this key is used to make requests to the live server; it is also used in mock tests as a valid key sample (any value will work for mock tests)
-INCORRECT_API_KEY {any non whitespace string value that is not a valid key} used for tests where the requests are meant to fail due to the API key value.
+The tests use the following environment parameter:
+- **ZEROBOUNCE_API_KEY** – Your API key; used in mock tests as the valid key sample (any value will work for mock tests).
+
+An invalid API key for error-handling tests is hardcoded in the spec; no env var is required.
 
-To set them
+To set your key:
 ```bash
-export ZEROBOUNCE_API_KEY=99e7ef20ceea4480a173b07b1be75371
-export INCORRECT_API_KEY=thiskeyisinvalidorotherwiseincorrect
-export TEST=unit
+export ZEROBOUNCE_API_KEY=your_api_key_here
 ```
 
-A .env.sample file is provided.
+A .env.example file is provided.
+
+Tests use webmock and vcr for mocking HTTP requests. This means that actual requests were made and recorded in the spec/cassettes with an (at the time) valid API key used for testing purposes. This key has been invalidated in the meantime, however it is provided in the .env.example file for the mock tests to work. If you do not wish to use this key for mocks, you can replace it with any value in the .yml files under spec/cassettes or delete all of them and rerun the tests so that vcr records them with a new key.
+
+## Publish
 
-Mock tests were generated using webmock and vcr. This means that actual requests were made and recorded in the spec/cassettes with an (at the time) valid API key used for testing purposes. This key has been invalidated in the meantime, however it is provided in the .env.sample file for the mock tests to work. If you do not wish to use this key for mocks, you can replace it with any value in the .yml files under spec/cassettes or delete all of them and rerun the tests so that vcr records them with a new key.
+See the [sdk-docs (RubyGems)](../sdk-docs/rubygems/) guide in the SDKs repo for build and `gem push` steps.

data/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you think you've found a security issue, please report it privately instead of opening a public issue.
+
+**Email:** integrations@zerobounce.net (use a subject like `[zero-bounce-ruby] Security`).
+
+We'll look into reports as we can. If the issue is in the Zero Bounce API or service rather than this SDK, we may forward it to the right team.
+
+## Supported Versions
+
+We focus on the current release line for fixes. Using the [latest version](https://rubygems.org/gems/zerobounce-sdk) is recommended.
+
+## Tips for Using This SDK
+
+* Don't commit API keys or `.env` files—use environment variables or a secrets manager.
+* Keep dependencies up to date with `bundle install` and upgrade when new versions are released.
+* The client uses HTTPS by default; avoid overriding to non-HTTPS in production.
+
+Thanks for helping keep things secure.

data/documentation.md

@@ -76,10 +76,13 @@ Zerobounce.api_usage(Date.today, Date.today)
  "sub_status_mailbox_quota_exceeded"=>0,
  "sub_status_forcible_disconnect"=>0,
  "sub_status_failed_smtp_connection"=>0,
+ "sub_status_accept_all"=>0,
  "sub_status_mx_forward"=>0,
  "sub_status_alternate"=>0,
- "sub_status_blocked"=>0,
  "sub_status_allowed"=>0,
+ "sub_status_blocked"=>0,
+ "sub_status_gold"=>0,
+ "sub_status_role_based_accept_all"=>0,
  "start_date"=>"4/28/2023",
  "end_date"=>"4/28/2023"}
 ```
@@ -400,6 +403,81 @@ Zerobounce.guessformat("zerobounce.net")
 # Zerobounce.guessformat("zerobounce.net", first_name: "John", middle_name: 'Deere', last_name: "Doe")
 ```
 
+Find Email Address
+```ruby
+Zerobounce.find_email("John", domain: "zerobounce.net")
+=>
+{
+  "email": "john@zerobounce.net",
+  "email_confidence": "medium",
+  "domain": "zerobounce.net",
+  "company_name": "ZeroBounce",
+  "did_you_mean": "",
+  "failure_reason": ""
+}
+
+# With additional name information for better accuracy
+Zerobounce.find_email("John", domain: "zerobounce.net", middle_name: "Deere", last_name: "Doe")
+```
+
+Find Domain Information
+```ruby
+Zerobounce.find_domain(domain: "zerobounce.net")
+=>
+{
+  "domain": "zerobounce.net",
+  "company_name": "Hertza, LLC",
+  "format": "first.last",
+  "confidence": "high",
+  "did_you_mean": "",
+  "failure_reason": "",
+  "other_domain_formats": [
+    {"format": "first", "confidence": "high"},
+    {"format": "last.first", "confidence": "high"},
+    {"format": "lastfirst", "confidence": "high"},
+    {"format": "firstl", "confidence": "high"},
+    {"format": "lfirst", "confidence": "high"},
+    {"format": "firstlast", "confidence": "high"},
+    {"format": "last_middle_f", "confidence": "high"},
+    {"format": "last", "confidence": "high"},
+    {"format": "f.last", "confidence": "medium"},
+    {"format": "last-f", "confidence": "medium"},
+    {"format": "l.first", "confidence": "medium"},
+    {"format": "last_f", "confidence": "medium"},
+    {"format": "first.middle.last", "confidence": "medium"},
+    {"format": "first-last", "confidence": "medium"},
+    {"format": "last.f", "confidence": "medium"},
+    {"format": "last_first", "confidence": "medium"},
+    {"format": "f-last", "confidence": "medium"},
+    {"format": "first.l", "confidence": "medium"},
+    {"format": "first-l", "confidence": "medium"},
+    {"format": "first_l", "confidence": "medium"},
+    {"format": "first_last", "confidence": "medium"},
+    {"format": "f_last", "confidence": "medium"},
+    {"format": "last-first", "confidence": "medium"},
+    {"format": "flast", "confidence": "medium"},
+    {"format": "lastf", "confidence": "medium"},
+    {"format": "l_first", "confidence": "medium"},
+    {"format": "l-first", "confidence": "medium"},
+    {"format": "first-middle-last", "confidence": "low"},
+    {"format": "firstmlast", "confidence": "low"},
+    {"format": "last.middle.first", "confidence": "low"},
+    {"format": "last_middle_first", "confidence": "low"},
+    {"format": "first_middle_last", "confidence": "low"},
+    {"format": "last-middle-first", "confidence": "low"},
+    {"format": "first-m-last", "confidence": "low"},
+    {"format": "firstmiddlelast", "confidence": "low"},
+    {"format": "last.m.first", "confidence": "low"},
+    {"format": "lastmfirst", "confidence": "low"},
+    {"format": "lastmiddlefirst", "confidence": "low"},
+    {"format": "last_m_first", "confidence": "low"},
+    {"format": "first.m.last", "confidence": "low"},
+    {"format": "first_m_last", "confidence": "low"},
+    {"format": "last-m-first", "confidence": "low"}
+  ]
+}
+```
+
 
 #### Development
 
@@ -421,17 +499,17 @@ Finished in 6.81 seconds (files took 0.40587 seconds to load)
 
 ##### Test parameters
 The tests use the following environment parameters:
-TEST {unit|live} influences whether mocked unit tests are run or the live server is used (credits may be used if you choose to do this)
-ZEROBOUNCE_API_KEY {<zerobounce-api-key-value>} this key is used to make requests to the live server; it is also used in mock tests as a valid key sample (any value will work for mock tests)
-INCORRECT_API_KEY {any non whitespace string value that is not a valid key} used for tests where the requests are meant to fail due to the API key value.
+- **TEST** {unit|live} – Influences whether mocked unit tests are run or the live server is used (credits may be used if you choose to do this).
+- **ZEROBOUNCE_API_KEY** – Your API key; used to make requests to the live server and in mock tests as the valid key sample (any value will work for mock tests).
+
+An invalid API key for error-handling tests is hardcoded in the spec; no env var is required.
 
-To set them
+To set them:
 ```bash
-export ZEROBOUNCE_API_KEY=99e7ef20ceea4480a173b07b1be75371
-export INCORRECT_API_KEY=thiskeyisinvalidorotherwiseincorrect
+export ZEROBOUNCE_API_KEY=your_api_key_here
 export TEST=unit
 ```
 
-A .env.sample file is provided.
+A .env.example file is provided.
 
-Mock tests were generated using webmock and vcr. This means that actual requests were made and recorded in the spec/cassettes with an (at the time) valid API key used for testing purposes. This key has been invalidated in the meantime, however it is provided in the .env.sample file for the mock tests to work. If you do not wish to use this key for mocks, you can replace it with any value in the .yml files under spec/cassettes or delete all of them and rerun the tests so that vcr records them with a new key.
+Mock tests were generated using webmock and vcr. This means that actual requests were made and recorded in the spec/cassettes with an (at the time) valid API key used for testing purposes. This key has been invalidated in the meantime, however it is provided in the .env.example file for the mock tests to work. If you do not wish to use this key for mocks, you can replace it with any value in the .yml files under spec/cassettes or delete all of them and rerun the tests so that vcr records them with a new key.

data/lib/zerobounce/api_urls.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zerobounce
+  # API URL constants for Zerobounce endpoints
+  #
+  # This class provides constant values for different Zerobounce API endpoints
+  # that can be accessed publicly by gem users.
+  #
+  class ApiUrls
+    # API URLs
+    DEFAULT_URL = 'https://api.zerobounce.net/v2/'
+    EU_URL = 'https://api-eu.zerobounce.net/v2/'
+    US_URL = 'https://api-us.zerobounce.net/v2/'
+
+    # Bulk API URLs
+    BULK_DEFAULT_URL = 'https://bulkapi.zerobounce.net/v2/'
+  end
+end

data/lib/zerobounce/base_request.rb

@@ -13,6 +13,34 @@ module Zerobounce
 
     protected
 
+    # Strips trailing slashes from root URL without using a regex (avoids ReDoS).
+    def self.__root_without_trailing_slashes__(root)
+      s = root.to_s
+      s = s.chomp('/') while s.end_with?('/')
+      s
+    end
+
+    # Resolves and validates filepath to prevent path traversal (e.g. ../../etc/passwd).
+    # Returns a canonical path only if the file is under the current directory and is a regular file.
+    def self.__safe_file_path__(filepath)
+      raise ArgumentError, 'File path is required' if filepath.nil? || filepath.to_s.empty?
+      filepath = filepath.to_s
+      expanded = File.expand_path(filepath)
+      base = File.realpath(Dir.pwd)
+      base_with_sep = base + File::SEPARATOR
+      unless expanded == base || expanded.start_with?(base_with_sep)
+        raise ArgumentError, 'File path must be under the current directory'
+      end
+      canonical = File.realpath(expanded)
+      unless canonical == base || canonical.start_with?(base_with_sep)
+        raise ArgumentError, 'File path must be under the current directory'
+      end
+      unless File.file?(canonical)
+        raise ArgumentError, 'File path must point to a regular file'
+      end
+      canonical
+    end
+
     def self._get(root, path, params, content_type='application/json')
 
       # puts path
@@ -21,7 +49,7 @@ module Zerobounce
       raise ("API key must be assigned") if not Zerobounce.config.apikey
 
       params[:api_key] = Zerobounce.config.apikey
-      url = "#{root}/#{path}"
+      url = "#{Zerobounce::BaseRequest.__root_without_trailing_slashes__(root)}/#{path}"
 
       response = RestClient.get(url, {params: params})
       return response
@@ -32,11 +60,11 @@ module Zerobounce
       raise ("API key must be assigned") if not Zerobounce.config.apikey
 
       params[:api_key] = Zerobounce.config.apikey
-      url = "#{root}/#{path}"
+      url = "#{Zerobounce::BaseRequest.__root_without_trailing_slashes__(root)}/#{path}"
       response = nil
 
       if filepath or content_type == 'multipart/form-data'
-        params[:file] = File.new(filepath, 'rb')
+        params[:file] = File.new(Zerobounce::BaseRequest.__safe_file_path__(filepath), 'rb')
         params[:multipart] = true
         response = RestClient.post(url, params)
 

data/lib/zerobounce/configuration.rb

@@ -2,6 +2,7 @@
 
 require 'rest-client'
 require 'dotenv'
+require_relative 'api_urls'
 
 module Zerobounce
   # Configuration object for Zerobounce.
@@ -17,20 +18,23 @@ module Zerobounce
   # @attr [String] apikey
   #   A Zerobounce API key.
   #
+  # @attr [String] api_root_url
+  #   The Zerobounce API root URL. Defaults to ApiUrls::DEFAULT_URL.
+  #
+  # @attr [String] bulk_api_root_url
+  #   The Zerobounce bulk API root URL.
+  #
   # @attr [Array<Symbol>] valid_statues
   #   The statuses that are considered valid by {Response#valid?}.
   class Configuration
-    attr_accessor :host
-    attr_accessor :headers
-    attr_accessor :apikey
-    attr_accessor :valid_statuses
-    attr_accessor :mock
+    attr_accessor :headers, :apikey, :api_root_url, :bulk_api_root_url, :valid_statuses, :mock
 
-    def initialize(mock=false)
-      if File.file?(".env") then Dotenv.load(".env") else Dotenv.load end
-      self.host = 'https://api.zerobounce.net'
+    def initialize(mock = false)
+      File.file?('.env') ? Dotenv.load('.env') : Dotenv.load
       self.apikey = ENV['ZEROBOUNCE_API_KEY']
-      self.valid_statuses = %i[valid catch_all]
+      self.api_root_url = ENV['ZEROBOUNCE_API_URL'] || ApiUrls::DEFAULT_URL
+      self.bulk_api_root_url = ENV['ZEROBOUNCE_BULK_API_URL'] || ApiUrls::BULK_DEFAULT_URL
+      self.valid_statuses = %i[valid catch_all accept_all]
       self.headers = { user_agent: "ZerobounceRubyGem/#{Zerobounce::VERSION}" }
       self.mock = mock
     end

data/lib/zerobounce/mock_request.rb

@@ -8,7 +8,7 @@ module Zerobounce
   class MockRequest < BaseRequest
 
     def self.get(path, params, content_type='application/json')
-      response = self._get(Zerobounce::API_ROOT_URL, path, params, content_type)
+      response = self._get(Zerobounce.configuration.api_root_url, path, params, content_type)
       if response.headers[:content_type] == 'application/json'
         response_body = response.body
         response_body_json = JSON.parse(response_body)
@@ -25,7 +25,7 @@ module Zerobounce
     end
 
     def self.bulk_get(path, params, content_type='application/json')
-      response = self._get(Zerobounce::BULK_API_ROOT_URL, path, params, content_type)
+      response = self._get(Zerobounce.configuration.bulk_api_root_url, path, params, content_type)
       if response.headers[:content_type] == 'application/json'
         response_body = response.body
         response_body_json = JSON.parse(response_body)
@@ -42,7 +42,7 @@ module Zerobounce
     end
 
     def self.bulk_post(path, params, content_type='application/json', filepath=nil)
-      response = self._post(Zerobounce::BULK_API_ROOT_URL, path, params, \
+      response = self._post(Zerobounce.configuration.bulk_api_root_url, path, params, \
           content_type, filepath)
       if response.headers[:content_type] == 'application/json'
         response_body = response.body