zerobounce-sdk 1.1.2 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d0e54bfd6db4f61595d1ca91ea16090f9a4c3d31a167bbab38bda3b6760155d
-  data.tar.gz: c05b9b9f3b680019d8bac6deddba297b0ba6d2708856fa01fab0038cdff89435
+  metadata.gz: 0ad61a7b25f176cba88173c9da307a70ac39a4526ff754f249c6a1d5aa58c598
+  data.tar.gz: 2de69f283fcfaeb2b1dfa7a8737c52353a7a3e54a7db40af28d0841ccb271a33
 SHA512:
-  metadata.gz: d9a308aca4d26a7a28b6a15d6cde4735c8955c28e1210b23a2fe86779261ac726ebfc418d19b228caff7c37dd09e058e3f86b35bb533434b7aadfd52b7d421b6
-  data.tar.gz: e9512073456e588ac04c14f8ee07dc8b84eae890031cc6ac2adc4766da1b80adce69e6a60112144e72d7561942f6c32674347a1ad24ab11b15ed2622b3b8d071
+  metadata.gz: d822a0fbfbded2214b11769169462c9148afac977edf7975e1ba960710e78fce5ac8b104b896779177e1e9685ec7fa39153dca00d0e6ded5f934ab8738969ae9
+  data.tar.gz: e0e097b43500401d4c0f8c737ffd9cabf9254132aa7da5774603db371363487277fc4738c15738881ef95b50535b555e3a723619a2fffef47d1c555ac57971c3

data/.env.example

@@ -0,0 +1,3 @@
+# ZeroBounce API key (standard). Get your key at https://www.zerobounce.net/docs/api-dashboard
+# Copy this file to .env and set your key.
+ZEROBOUNCE_API_KEY=your_api_key_here

data/.github/auto_assign.yml

@@ -0,0 +1,5 @@
+addReviewers: false
+addAssignees: true
+assignees:
+  - franciscbalint
+numberOfAssignees: 1

data/.github/workflows/auto_assign_ci.yaml

@@ -0,0 +1,21 @@
+name: Auto Assign
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  add-assignee:
+    name: Auto assign (me only)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: kentaro-m/auto-assign-action@v2.0.1
+        with:
+          configuration-path: ".github/auto_assign.yml"

data/.github/workflows/codeql.yml

@@ -0,0 +1,105 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+  schedule:
+    - cron: '19 14 * * 4'
+
+permissions:
+  security-events: write
+  packages: read
+  actions: read
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: ruby
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    # Add any setup steps before running the `github/codeql-action/init` action.
+    # This includes steps like installing compilers or runtimes (`actions/setup-node`
+    # or others). This is typically only required for manual builds.
+    # - name: Setup runtime (example)
+    #   uses: actions/setup-example@v1
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - name: Run manual build steps
+      if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4
+      with:
+        category: "/language:${{matrix.language}}"

data/.github/workflows/sdk_ci.yml

@@ -0,0 +1,29 @@
+# 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@v6
+
+      - 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

@@ -62,3 +62,6 @@ build-iPhoneSimulator/
 # Log files
 output.err
 output.log
+
+.DS_Store
+.env

data/CODE_OF_CONDUCT.md

@@ -54,12 +54,7 @@ further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at afrase91@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+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

data/CONTRIBUTING.md

@@ -1 +1,112 @@
-TODO fill this out
+# 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

@@ -0,0 +1,15 @@
+# ZeroBounce Ruby SDK – test image (Ruby 3.2)
+FROM ruby:3.2-alpine
+
+RUN apk add --no-cache build-base git
+
+WORKDIR /app
+
+COPY . .
+RUN bundle config set --local path 'vendor/bundle' && \
+    bundle 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", "exec", "rspec"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zerobounce-sdk (1.1.1)
+    zerobounce-sdk (2.0.13)
       dotenv
       rest-client (~> 2.1)
 
@@ -11,6 +11,8 @@ GEM
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.3.0)
+    bigdecimal (4.0.1)
     coderay (1.1.3)
     crack (0.4.5)
       rexml
@@ -105,6 +107,8 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  base64
+  bigdecimal
   bundler (~> 2.4.6)
   pry (~> 0.14.1)
   rake (~> 13.0)

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 ZeroBounce
+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

data/LICENSE.txt

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2018 Aaron Frase
+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
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.