zerobounce-sdk 2.1.7 → 2.2.0

data/CONTRIBUTING.md

@@ -1,112 +0,0 @@
-# Contributing to Zero Bounce Ruby SDK
-
-Thank you for your interest in contributing. This document explains how to get set up, run tests, and submit changes.
-
-## Code of Conduct
-
-By participating in this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
-
-## Getting Started
-
-### Prerequisites
-
-* Ruby 3.2+ (see [.ruby-version](.ruby-version))
-* [Bundler](https://bundler.io/) ~> 2.4
-
-### Setup
-
-```bash
-git clone https://github.com/zerobounce/zero-bounce-ruby.git
-cd zero-bounce-ruby
-bundle install
-```
-
-### Running Tests
-
-Tests use [RSpec](https://rspec.info/) with [VCR](https://github.com/vcr/vcr) for recorded HTTP interactions. Use the placeholder key so cassettes match:
-
-```bash
-ZEROBOUNCE_API_KEY=vcr_test_key bundle exec rspec
-```
-
-Or copy `.env.example` to `.env`, set `ZEROBOUNCE_API_KEY=vcr_test_key`, then:
-
-```bash
-bundle exec rspec
-```
-
-**With Docker:**
-
-```bash
-docker build -t zerobounce-ruby-test .
-docker run --rm zerobounce-ruby-test
-```
-
-### Code Style
-
-The project uses [RuboCop](https://github.com/rubocop/rubocop). Run before submitting:
-
-```bash
-bundle exec rubocop
-```
-
-## How to Contribute
-
-### Reporting Bugs
-
-Open an [issue](https://github.com/zerobounce/zero-bounce-ruby/issues) and include:
-
-* Ruby version (`ruby -v`)
-* Steps to reproduce
-* Expected vs actual behavior
-* Relevant code or error messages
-
-### Suggesting Changes
-
-* Check existing issues and pull requests first.
-* Open an issue to discuss larger changes or API design before coding.
-
-### Submitting Changes
-
-1. **Fork** the repository and create a branch from `main`:
-   ```bash
-   git checkout -b feature/your-feature-name
-   ```
-
-2. **Make your changes** and add or update tests where relevant.
-
-3. **Run the suite** and RuboCop:
-   ```bash
-   ZEROBOUNCE_API_KEY=vcr_test_key bundle exec rspec
-   bundle exec rubocop
-   ```
-
-4. **Commit** with a clear message (e.g. `Add X`, `Fix Y`).
-
-5. **Push** your branch and open a **Pull Request** against `main`.
-
-6. In the PR description, briefly explain what changed and why. Link any related issues.
-
-Maintainers will review and may request changes. Once approved, your PR can be merged.
-
-## Project Layout
-
-* `lib/` – SDK source (entry point: `lib/zerobounce.rb`)
-* `spec/` – RSpec tests and VCR cassettes (`spec/cassettes/`)
-* `data/` – Sample CSV files for batch validation and scoring examples
-
-## Re-recording VCR Cassettes
-
-If you change or add API calls and need to re-record cassettes:
-
-1. Use a valid Zero Bounce API key (e.g. from [dashboard](https://www.zerobounce.net/docs/api-dashboard)).
-2. Set `ZEROBOUNCE_API_KEY` and run the specs; VCR will record new HTTP interactions.
-3. Replace any real API key in the new cassette files with `vcr_test_key` before committing, so the repo never contains real credentials.
-
-## Questions
-
-* [Zero Bounce API docs](https://www.zerobounce.net/docs/)
-* [Project homepage](https://zerobounce.net)
-* Contact: **integrations@zerobounce.net**
-
-Thanks for contributing.

data/Dockerfile

@@ -1,17 +0,0 @@
-# ZeroBounce Ruby SDK – test image (Ruby 3.2)
-FROM ruby:3.2-alpine
-
-RUN apk add --no-cache build-base git
-
-WORKDIR /app
-
-COPY . .
-# Gemfile.lock expects Bundler 2.4.x (see gemspec); Ruby 3.2 image may ship Bundler 4.x.
-RUN gem install bundler -v 2.4.22 && \
-    bundle config set --local path 'vendor/bundle' && \
-    bundle _2.4.22_ install
-
-# Dummy key for VCR/cassette-based specs; override with env for live API
-ENV ZEROBOUNCE_API_KEY="${ZEROBOUNCE_API_KEY:-invalid_key_for_tests}"
-
-CMD ["bundle", "_2.4.22_", "exec", "rspec"]

data/Gemfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in zerobounce.gemspec
-gemspec
-
-# Transitive dependency floors (security advisories: REXML DoS/ReDoS, Addressable ReDoS).
-gem 'rexml', '>= 3.4.4'
-gem 'addressable', '>= 2.8.10'
-

data/Gemfile.lock

@@ -1,135 +0,0 @@
-PATH
-  remote: .
-  specs:
-    zerobounce-sdk (2.1.7)
-      dotenv
-      rest-client (~> 2.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.9.0)
-      public_suffix (>= 2.0.2, < 8.0)
-    ast (2.4.2)
-    base64 (0.3.0)
-    bigdecimal (4.0.1)
-    coderay (1.1.3)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    dotenv (3.1.8)
-    hashdiff (1.0.1)
-    http-accept (1.7.0)
-    http-cookie (1.0.5)
-      domain_name (~> 0.5)
-    json (2.6.3)
-    logger (1.7.0)
-    method_source (1.0.0)
-    mime-types (3.5.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2023.0808)
-    netrc (0.11.0)
-    ostruct (0.6.3)
-    parallel (1.22.1)
-    parser (3.2.2.0)
-      ast (~> 2.4.1)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (7.0.5)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rexml (3.4.4)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.49.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
-      rubocop (~> 1.41)
-    rubocop-performance (1.17.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.19.0)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.13.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
-    unicode-display_width (2.4.2)
-    vcr (6.4.0)
-    webmock (3.18.1)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.43)
-
-PLATFORMS
-  arm64-darwin-24
-  arm64-darwin-25
-  x86_64-linux
-
-DEPENDENCIES
-  addressable (>= 2.8.10)
-  base64
-  bigdecimal
-  bundler (~> 2.4.6)
-  logger
-  ostruct
-  pry (~> 0.14.1)
-  rake (~> 13.0)
-  rexml (>= 3.4.4)
-  rspec (~> 3.0)
-  rspec_junit_formatter (~> 0.4.1)
-  rubocop (~> 1.15)
-  rubocop-performance (~> 1.11, >= 1.11.3)
-  rubocop-rake (~> 0.5.1)
-  rubocop-rspec (~> 2.3)
-  simplecov (~> 0.21.2)
-  vcr (~> 6.4)
-  webmock (~> 3.18)
-  yard (~> 0.9.42)
-  zerobounce-sdk!
-
-BUNDLED WITH
-   2.4.22

data/Rakefile

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'yard'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'zerobounce/version'
-
-RSpec::Core::RakeTask.new
-
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec'
-end
-
-YARD::Rake::YardocTask.new do |task|
-  task.options += ['--title', "Zerobounce #{Zerobounce::VERSION} Documentation"]
-  task.options += ['--protected']
-  task.options += ['--no-private']
-  task.stats_options = ['--list-undoc']
-
-  # has to be last
-  extra_files = %w[CODE_OF_CONDUCT.md LICENSE.txt]
-  task.options += ['-'] + extra_files
-end
-
-task default: %i[rubocop spec]

data/SECURITY.md

@@ -1,21 +0,0 @@
-# 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/bin/bundle

@@ -1,105 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'bundle' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "rubygems"
-
-m = Module.new do
-    module_function
-
-  def invoked_as_script?
-    File.expand_path($0) == File.expand_path(__FILE__)
-  end
-
-  def env_var_version
-    ENV["BUNDLER_VERSION"]
-  end
-
-  def cli_arg_version
-    return unless invoked_as_script? # don't want to hijack other binstubs
-    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
-    bundler_version = nil
-    update_index = nil
-    ARGV.each_with_index do |a, i|
-      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
-        bundler_version = a
-      end
-      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-      bundler_version = $1 || ">= 0.a"
-      update_index = i
-    end
-    bundler_version
-  end
-
-  def gemfile
-    gemfile = ENV["BUNDLE_GEMFILE"]
-    return gemfile if gemfile && !gemfile.empty?
-
-    File.expand_path("../../Gemfile", __FILE__)
-  end
-
-  def lockfile
-    lockfile =
-      case File.basename(gemfile)
-      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
-      else "#{gemfile}.lock"
-      end
-    File.expand_path(lockfile)
-  end
-
-  def lockfile_version
-    return unless File.file?(lockfile)
-    lockfile_contents = File.read(lockfile)
-    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
-    Regexp.last_match(1)
-  end
-
-  def bundler_version
-    @bundler_version ||= begin
-      env_var_version || cli_arg_version ||
-        lockfile_version || "#{Gem::Requirement.default}.a"
-    end
-  end
-
-  def load_bundler!
-    ENV["BUNDLE_GEMFILE"] ||= gemfile
-
-    # must dup string for RG < 1.8 compatibility
-    activate_bundler(bundler_version.dup)
-  end
-
-  def activate_bundler(bundler_version)
-    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
-      bundler_version = "< 2"
-    end
-    gem_error = activation_error_handling do
-      gem "bundler", bundler_version
-    end
-    return if gem_error.nil?
-    require_error = activation_error_handling do
-      require "bundler/version"
-    end
-    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
-    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
-    exit 42
-  end
-
-  def activation_error_handling
-    yield
-    nil
-  rescue StandardError, LoadError => e
-    e
-  end
-end
-
-m.load_bundler!
-
-if m.invoked_as_script?
-  load Gem.bin_path("bundler", "bundle")
-end

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'zerobounce'
-require 'pry'
-
-Pry.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/data/zerobounce-ai-scoring.csv

@@ -1,31 +0,0 @@
-email
-disposable@example.com
-invalid@example.com
-valid@example.com
-toxic@example.com
-donotmail@example.com
-spamtrap@example.com
-abuse@example.com
-unknown@example.com
-catch_all@example.com
-antispam_system@example.com
-does_not_accept_mail@example.com
-exception_occurred@example.com
-failed_smtp_connection@example.com
-failed_syntax_check@example.com
-forcible_disconnect@example.com
-global_suppression@example.com
-greylisted@example.com
-leading_period_removed@example.com
-mail_server_did_not_respond@example.com
-mail_server_temporary_error@example.com
-mailbox_quota_exceeded@example.com
-mailbox_not_found@example.com
-no_dns_entries@example.com
-possible_trap@example.com
-possible_typo@example.com
-role_based@example.com
-timeout_exceeded@example.com
-unroutable_ip_address@example.com
-free_email@example.com
-role_based_catch_all@example.com

data/data/zerobounce-batch-validation.csv

@@ -1,31 +0,0 @@
-email,first,last,gender,ip
-disposable@example.com,First,Last,male,127.0.0.1
-invalid@example.com,First,Last,male,127.0.0.1
-valid@example.com,First,Last,male,127.0.0.1
-toxic@example.com,First,Last,male,127.0.0.1
-donotmail@example.com,First,Last,male,127.0.0.1
-spamtrap@example.com,First,Last,male,127.0.0.1
-abuse@example.com,First,Last,male,127.0.0.1
-unknown@example.com,First,Last,male,127.0.0.1
-catch_all@example.com,First,Last,male,127.0.0.1
-antispam_system@example.com,First,Last,male,127.0.0.1
-does_not_accept_mail@example.com,First,Last,male,127.0.0.1
-exception_occurred@example.com,First,Last,male,127.0.0.1
-failed_smtp_connection@example.com,First,Last,male,127.0.0.1
-failed_syntax_check@example.com,First,Last,male,127.0.0.1
-forcible_disconnect@example.com,First,Last,male,127.0.0.1
-global_suppression@example.com,First,Last,male,127.0.0.1
-greylisted@example.com,First,Last,male,127.0.0.1
-leading_period_removed@example.com,First,Last,male,127.0.0.1
-mail_server_did_not_respond@example.com,First,Last,male,127.0.0.1
-mail_server_temporary_error@example.com,First,Last,male,127.0.0.1
-mailbox_quota_exceeded@example.com,First,Last,male,127.0.0.1
-mailbox_not_found@example.com,First,Last,male,127.0.0.1
-no_dns_entries@example.com,First,Last,male,127.0.0.1
-possible_trap@example.com,First,Last,male,127.0.0.1
-possible_typo@example.com,First,Last,male,127.0.0.1
-role_based@example.com,First,Last,male,127.0.0.1
-timeout_exceeded@example.com,First,Last,male,127.0.0.1
-unroutable_ip_address@example.com,First,Last,male,127.0.0.1
-free_email@example.com,First,Last,male,127.0.0.1
-role_based_catch_all@example.com,First,Last,male,127.0.0.1