zerobounce-sdk 2.1.8 → 3.0.0

data/.github/workflows/publish.yml

@@ -1,131 +0,0 @@
-name: Publish
-
-on:
-  workflow_dispatch:
-    inputs:
-      tag:
-        type: string
-        description: Tag to publish (e.g. v2.1.5)
-        required: true
-
-permissions:
-  contents: read
-
-jobs:
-  validate-tag:
-    name: Validate tag
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v7
-        with:
-          fetch-depth: 0
-          ref: ${{ github.event.inputs.tag }}
-
-      - name: Verify tag and gem version
-        run: |
-          TAG="${{ github.event.inputs.tag }}"
-          if [ -z "$TAG" ]; then
-            echo "Error: Tag is required."
-            exit 1
-          fi
-          if ! git rev-parse "$TAG" >/dev/null 2>&1; then
-            echo "Error: Tag '$TAG' does not exist."
-            exit 1
-          fi
-          TAG_VERSION="${TAG#v}"
-          PKG_VERSION=$(grep -E "VERSION\s*=" lib/zerobounce/version.rb | sed -E "s/.*'([^']+)'.*/\1/")
-          if [ -z "$PKG_VERSION" ]; then
-            echo "Error: Could not read version from lib/zerobounce/version.rb"
-            exit 1
-          fi
-          if [ "$PKG_VERSION" != "$TAG_VERSION" ]; then
-            echo "Error: lib/zerobounce/version.rb ($PKG_VERSION) does not match tag ($TAG)."
-            exit 1
-          fi
-          echo "Publishing tag: $TAG (zerobounce-sdk@$PKG_VERSION)"
-
-  test:
-    name: Test
-    needs: [validate-tag]
-    if: ${{ !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
-    runs-on: ubuntu-latest
-    env:
-      ZEROBOUNCE_API_KEY: "invalid_key_for_tests"
-    steps:
-      - name: Checkout tag
-        uses: actions/checkout@v7
-        with:
-          ref: ${{ github.event.inputs.tag }}
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: true
-
-      - name: Run specs
-        run: bundle exec rspec
-
-  publish:
-    name: Build and publish to RubyGems
-    needs: [test]
-    if: ${{ !cancelled() && !failure() }}
-    runs-on: ubuntu-latest
-    environment: release
-    permissions:
-      id-token: write
-      contents: read
-    steps:
-      - name: Checkout tag
-        uses: actions/checkout@v7
-        with:
-          ref: ${{ github.event.inputs.tag }}
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: true
-
-      - name: Configure RubyGems credentials
-        uses: rubygems/configure-rubygems-credentials@main
-        with:
-          api-token: ${{ secrets.RUBYGEMS_API_TOKEN }}
-
-      - name: Build gem
-        run: gem build zerobounce.gemspec
-
-      - name: Publish to RubyGems
-        run: |
-          GEM_FILE=$(ls zerobounce-sdk-*.gem)
-          echo "Pushing $GEM_FILE"
-          gem push "$GEM_FILE"
-
-  release:
-    name: Create GitHub Release
-    needs: [publish]
-    if: ${{ !cancelled() && !failure() }}
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v7
-        with:
-          ref: ${{ github.event.inputs.tag }}
-          fetch-depth: 0
-
-      - name: Create release if missing
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          TAG="${{ github.event.inputs.tag }}"
-          if gh release view "$TAG" --repo "${{ github.repository }}" >/dev/null 2>&1; then
-            echo "Release $TAG already exists, skipping."
-          else
-            gh release create "$TAG" \
-              --repo "${{ github.repository }}" \
-              --title "$TAG" \
-              --generate-notes
-          fi

data/.github/workflows/sdk_ci.yml

@@ -1,29 +0,0 @@
-# Run RSpec tests (VCR cassettes; no live API key needed for recorded specs).
-name: SDK CI
-
-on:
-  pull_request:
-    types: [opened, synchronize, reopened]
-  push:
-    branches: [main, master]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    name: Test
-    runs-on: ubuntu-latest
-    env:
-      ZEROBOUNCE_API_KEY: "invalid_key_for_tests"
-    steps:
-      - uses: actions/checkout@v7
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: true
-
-      - name: Run specs
-        run: bundle exec rspec

data/.gitignore

@@ -1,70 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-.env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
-
-# Used by RSpec
-.rspec_status
-
-
-# Log files
-output.err
-output.log
-
-.DS_Store
-Thumbs.db
-.idea/
-.cursor/
-.env

data/.rspec

@@ -1,2 +0,0 @@
---require spec_helper
---format progress

data/.ruby-version

@@ -1 +0,0 @@
-3.2.1

data/CODE_OF_CONDUCT.md

@@ -1,69 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at **integrations@zerobounce.net**. All complaints will be reviewed and investigated promptly and fairly. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

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.8)
-      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/LICENSE.txt

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 ZeroBounce
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

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.