zerobounce-sdk 2.1.8 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +146 -19
  3. data/README.md +472 -410
  4. data/lib/zerobounce/api_urls.rb +9 -0
  5. data/lib/zerobounce/base_request.rb +208 -8
  6. data/lib/zerobounce/client.rb +22 -0
  7. data/lib/zerobounce/configuration.rb +24 -3
  8. data/lib/zerobounce/error.rb +18 -0
  9. data/lib/zerobounce/get_file_helper.rb +3 -7
  10. data/lib/zerobounce/mock_request.rb +31 -12
  11. data/lib/zerobounce/priority3.rb +331 -0
  12. data/lib/zerobounce/request.rb +77 -38
  13. data/lib/zerobounce/response_error.rb +117 -0
  14. data/lib/zerobounce/validate_sub_status.rb +1 -0
  15. data/lib/zerobounce/version.rb +1 -1
  16. data/lib/zerobounce/warmup.rb +467 -0
  17. data/lib/zerobounce.rb +101 -14
  18. metadata +8 -33
  19. data/.dockerignore +0 -17
  20. data/.env.example +0 -3
  21. data/.github/auto_assign.yml +0 -5
  22. data/.github/dependabot.yml +0 -35
  23. data/.github/workflows/auto_assign_ci.yaml +0 -21
  24. data/.github/workflows/codeql.yml +0 -105
  25. data/.github/workflows/publish.yml +0 -131
  26. data/.github/workflows/sdk_ci.yml +0 -29
  27. data/.gitignore +0 -70
  28. data/.rspec +0 -2
  29. data/.ruby-version +0 -1
  30. data/CODE_OF_CONDUCT.md +0 -69
  31. data/CONTRIBUTING.md +0 -112
  32. data/Dockerfile +0 -17
  33. data/Gemfile +0 -13
  34. data/Gemfile.lock +0 -135
  35. data/Rakefile +0 -26
  36. data/SECURITY.md +0 -21
  37. data/bin/bundle +0 -105
  38. data/bin/console +0 -7
  39. data/bin/setup +0 -6
  40. data/data/zerobounce-ai-scoring.csv +0 -31
  41. data/data/zerobounce-batch-validation.csv +0 -31
  42. data/documentation.md +0 -530
  43. data/files/scoring.csv +0 -1
  44. data/files/validation.csv +0 -1
  45. data/files/zerobounce-ai-scoring.csv +0 -31
  46. data/files/zerobounce-batch-validation.csv +0 -31
  47. data/zerobounce.gemspec +0 -49
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: zerobounce-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.8
4
+ version: 2.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Zero Bounce
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2026-08-14 00:00:00.000000000 Z
11
+ date: 2026-11-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rest-client
@@ -31,7 +31,7 @@ dependencies:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
33
  version: '0'
34
- type: :runtime
34
+ type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
@@ -289,52 +289,27 @@ executables: []
289
289
  extensions: []
290
290
  extra_rdoc_files: []
291
291
  files:
292
- - ".dockerignore"
293
- - ".env.example"
294
- - ".github/auto_assign.yml"
295
- - ".github/dependabot.yml"
296
- - ".github/workflows/auto_assign_ci.yaml"
297
- - ".github/workflows/codeql.yml"
298
- - ".github/workflows/publish.yml"
299
- - ".github/workflows/sdk_ci.yml"
300
- - ".gitignore"
301
- - ".rspec"
302
- - ".ruby-version"
303
292
  - CHANGELOG.md
304
- - CODE_OF_CONDUCT.md
305
- - CONTRIBUTING.md
306
- - Dockerfile
307
- - Gemfile
308
- - Gemfile.lock
309
293
  - LICENSE
310
294
  - LICENSE.txt
311
295
  - README.md
312
- - Rakefile
313
- - SECURITY.md
314
- - bin/bundle
315
- - bin/console
316
- - bin/setup
317
- - data/zerobounce-ai-scoring.csv
318
- - data/zerobounce-batch-validation.csv
319
- - documentation.md
320
- - files/scoring.csv
321
- - files/validation.csv
322
- - files/zerobounce-ai-scoring.csv
323
- - files/zerobounce-batch-validation.csv
324
296
  - lib/zerobounce.rb
325
297
  - lib/zerobounce/api_urls.rb
326
298
  - lib/zerobounce/base_request.rb
299
+ - lib/zerobounce/client.rb
327
300
  - lib/zerobounce/configuration.rb
328
301
  - lib/zerobounce/download_type.rb
329
302
  - lib/zerobounce/error.rb
330
303
  - lib/zerobounce/get_file_helper.rb
331
304
  - lib/zerobounce/get_file_options.rb
332
305
  - lib/zerobounce/mock_request.rb
306
+ - lib/zerobounce/priority3.rb
333
307
  - lib/zerobounce/request.rb
308
+ - lib/zerobounce/response_error.rb
334
309
  - lib/zerobounce/validate_status.rb
335
310
  - lib/zerobounce/validate_sub_status.rb
336
311
  - lib/zerobounce/version.rb
337
- - zerobounce.gemspec
312
+ - lib/zerobounce/warmup.rb
338
313
  homepage: https://zerobounce.net
339
314
  licenses:
340
315
  - MIT
@@ -348,7 +323,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
348
323
  requirements:
349
324
  - - ">="
350
325
  - !ruby/object:Gem::Version
351
- version: '2.5'
326
+ version: '3.0'
352
327
  required_rubygems_version: !ruby/object:Gem::Requirement
353
328
  requirements:
354
329
  - - ">="
data/.dockerignore DELETED
@@ -1,17 +0,0 @@
1
- # Keep .git so gemspec `git ls-files` works during `bundle install` in the image.
2
-
3
- # Docs and tooling not needed to run specs in the image
4
- *.md
5
- documentation*.md
6
- .spec
7
- .rspec_status
8
- coverage/
9
- tmp/
10
- pkg/
11
- vendor/bundle
12
-
13
- # OS & env
14
- .DS_Store
15
- Thumbs.db
16
- .env
17
- .env.*
data/.env.example DELETED
@@ -1,3 +0,0 @@
1
- # ZeroBounce API key (standard). Get your key at https://www.zerobounce.net/docs/api-dashboard
2
- # Copy this file to .env and set your key.
3
- ZEROBOUNCE_API_KEY=your_api_key_here
@@ -1,5 +0,0 @@
1
- addReviewers: false
2
- addAssignees: true
3
- assignees:
4
- - franciscbalint
5
- numberOfAssignees: 1
@@ -1,35 +0,0 @@
1
- # To get started with Dependabot version updates, you'll need to specify which
2
- # package ecosystems to update and where the package manifests are located.
3
- # https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#versioning-strategy
4
-
5
- version: 2
6
- updates:
7
- # Keep the Ruby dependencies up to date
8
- - package-ecosystem: "bundler"
9
- directory: "/"
10
- schedule:
11
- interval: "weekly"
12
- day: "monday"
13
- target-branch: "develop"
14
- labels:
15
- - "ruby dependencies"
16
- groups:
17
- bundler:
18
- applies-to: version-updates
19
- patterns:
20
- - "*"
21
-
22
- # Keep the Github Actions dependencies up to date
23
- - package-ecosystem: "github-actions"
24
- directory: "/"
25
- schedule:
26
- interval: "weekly"
27
- day: "monday"
28
- target-branch: "develop"
29
- labels:
30
- - "github dependencies"
31
- groups:
32
- github:
33
- applies-to: version-updates
34
- patterns:
35
- - "*"
@@ -1,21 +0,0 @@
1
- name: Auto Assign
2
-
3
- on:
4
- pull_request_target:
5
- types:
6
- - opened
7
- - synchronize
8
- - reopened
9
-
10
- permissions:
11
- contents: read
12
- pull-requests: write
13
-
14
- jobs:
15
- add-assignee:
16
- name: Auto assign (me only)
17
- runs-on: ubuntu-latest
18
- steps:
19
- - uses: kentaro-m/auto-assign-action@v2.0.2
20
- with:
21
- configuration-path: ".github/auto_assign.yml"
@@ -1,105 +0,0 @@
1
- # For most projects, this workflow file will not need changing; you simply need
2
- # to commit it to your repository.
3
- #
4
- # You may wish to alter this file to override the set of languages analyzed,
5
- # or to provide custom queries or build logic.
6
- #
7
- # ******** NOTE ********
8
- # We have attempted to detect the languages in your repository. Please check
9
- # the `language` matrix defined below to confirm you have the correct set of
10
- # supported CodeQL languages.
11
- #
12
- name: "CodeQL Advanced"
13
-
14
- on:
15
- push:
16
- branches: [ "develop" ]
17
- pull_request:
18
- branches: [ "develop" ]
19
- schedule:
20
- - cron: '19 14 * * 4'
21
-
22
- permissions:
23
- security-events: write
24
- packages: read
25
- actions: read
26
- contents: read
27
-
28
- jobs:
29
- analyze:
30
- name: Analyze (${{ matrix.language }})
31
- # Runner size impacts CodeQL analysis time. To learn more, please see:
32
- # - https://gh.io/recommended-hardware-resources-for-running-codeql
33
- # - https://gh.io/supported-runners-and-hardware-resources
34
- # - https://gh.io/using-larger-runners (GitHub.com only)
35
- # Consider using larger runners or machines with greater resources for possible analysis time improvements.
36
- runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
37
- permissions:
38
- # required for all workflows
39
- security-events: write
40
-
41
- # required to fetch internal or private CodeQL packs
42
- packages: read
43
-
44
- # only required for workflows in private repositories
45
- actions: read
46
- contents: read
47
-
48
- strategy:
49
- fail-fast: false
50
- matrix:
51
- include:
52
- - language: ruby
53
- build-mode: none
54
- # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
55
- # Use `c-cpp` to analyze code written in C, C++ or both
56
- # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
57
- # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
58
- # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
59
- # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
60
- # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
61
- # 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
62
- steps:
63
- - name: Checkout repository
64
- uses: actions/checkout@v7
65
-
66
- # Add any setup steps before running the `github/codeql-action/init` action.
67
- # This includes steps like installing compilers or runtimes (`actions/setup-node`
68
- # or others). This is typically only required for manual builds.
69
- # - name: Setup runtime (example)
70
- # uses: actions/setup-example@v1
71
-
72
- # Initializes the CodeQL tools for scanning.
73
- - name: Initialize CodeQL
74
- uses: github/codeql-action/init@v4.36.3
75
- with:
76
- languages: ${{ matrix.language }}
77
- build-mode: ${{ matrix.build-mode }}
78
- # If you wish to specify custom queries, you can do so here or in a config file.
79
- # By default, queries listed here will override any specified in a config file.
80
- # Prefix the list here with "+" to use these queries and those in the config file.
81
-
82
- # 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
83
- # queries: security-extended,security-and-quality
84
-
85
- # If the analyze step fails for one of the languages you are analyzing with
86
- # "We were unable to automatically build your code", modify the matrix above
87
- # to set the build mode to "manual" for that language. Then modify this step
88
- # to build your code.
89
- # ℹ️ Command-line programs to run using the OS shell.
90
- # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
91
- - name: Run manual build steps
92
- if: matrix.build-mode == 'manual'
93
- shell: bash
94
- run: |
95
- echo 'If you are using a "manual" build mode for one or more of the' \
96
- 'languages you are analyzing, replace this with the commands to build' \
97
- 'your code, for example:'
98
- echo ' make bootstrap'
99
- echo ' make release'
100
- exit 1
101
-
102
- - name: Perform CodeQL Analysis
103
- uses: github/codeql-action/analyze@v4.36.3
104
- with:
105
- category: "/language:${{matrix.language}}"
@@ -1,131 +0,0 @@
1
- name: Publish
2
-
3
- on:
4
- workflow_dispatch:
5
- inputs:
6
- tag:
7
- type: string
8
- description: Tag to publish (e.g. v2.1.5)
9
- required: true
10
-
11
- permissions:
12
- contents: read
13
-
14
- jobs:
15
- validate-tag:
16
- name: Validate tag
17
- runs-on: ubuntu-latest
18
- steps:
19
- - name: Checkout
20
- uses: actions/checkout@v7
21
- with:
22
- fetch-depth: 0
23
- ref: ${{ github.event.inputs.tag }}
24
-
25
- - name: Verify tag and gem version
26
- run: |
27
- TAG="${{ github.event.inputs.tag }}"
28
- if [ -z "$TAG" ]; then
29
- echo "Error: Tag is required."
30
- exit 1
31
- fi
32
- if ! git rev-parse "$TAG" >/dev/null 2>&1; then
33
- echo "Error: Tag '$TAG' does not exist."
34
- exit 1
35
- fi
36
- TAG_VERSION="${TAG#v}"
37
- PKG_VERSION=$(grep -E "VERSION\s*=" lib/zerobounce/version.rb | sed -E "s/.*'([^']+)'.*/\1/")
38
- if [ -z "$PKG_VERSION" ]; then
39
- echo "Error: Could not read version from lib/zerobounce/version.rb"
40
- exit 1
41
- fi
42
- if [ "$PKG_VERSION" != "$TAG_VERSION" ]; then
43
- echo "Error: lib/zerobounce/version.rb ($PKG_VERSION) does not match tag ($TAG)."
44
- exit 1
45
- fi
46
- echo "Publishing tag: $TAG (zerobounce-sdk@$PKG_VERSION)"
47
-
48
- test:
49
- name: Test
50
- needs: [validate-tag]
51
- if: ${{ !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
52
- runs-on: ubuntu-latest
53
- env:
54
- ZEROBOUNCE_API_KEY: "invalid_key_for_tests"
55
- steps:
56
- - name: Checkout tag
57
- uses: actions/checkout@v7
58
- with:
59
- ref: ${{ github.event.inputs.tag }}
60
-
61
- - name: Set up Ruby
62
- uses: ruby/setup-ruby@v1
63
- with:
64
- ruby-version: "3.2"
65
- bundler-cache: true
66
-
67
- - name: Run specs
68
- run: bundle exec rspec
69
-
70
- publish:
71
- name: Build and publish to RubyGems
72
- needs: [test]
73
- if: ${{ !cancelled() && !failure() }}
74
- runs-on: ubuntu-latest
75
- environment: release
76
- permissions:
77
- id-token: write
78
- contents: read
79
- steps:
80
- - name: Checkout tag
81
- uses: actions/checkout@v7
82
- with:
83
- ref: ${{ github.event.inputs.tag }}
84
-
85
- - name: Set up Ruby
86
- uses: ruby/setup-ruby@v1
87
- with:
88
- ruby-version: "3.2"
89
- bundler-cache: true
90
-
91
- - name: Configure RubyGems credentials
92
- uses: rubygems/configure-rubygems-credentials@main
93
- with:
94
- api-token: ${{ secrets.RUBYGEMS_API_TOKEN }}
95
-
96
- - name: Build gem
97
- run: gem build zerobounce.gemspec
98
-
99
- - name: Publish to RubyGems
100
- run: |
101
- GEM_FILE=$(ls zerobounce-sdk-*.gem)
102
- echo "Pushing $GEM_FILE"
103
- gem push "$GEM_FILE"
104
-
105
- release:
106
- name: Create GitHub Release
107
- needs: [publish]
108
- if: ${{ !cancelled() && !failure() }}
109
- runs-on: ubuntu-latest
110
- permissions:
111
- contents: write
112
- steps:
113
- - name: Checkout
114
- uses: actions/checkout@v7
115
- with:
116
- ref: ${{ github.event.inputs.tag }}
117
- fetch-depth: 0
118
-
119
- - name: Create release if missing
120
- env:
121
- GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
122
- run: |
123
- TAG="${{ github.event.inputs.tag }}"
124
- if gh release view "$TAG" --repo "${{ github.repository }}" >/dev/null 2>&1; then
125
- echo "Release $TAG already exists, skipping."
126
- else
127
- gh release create "$TAG" \
128
- --repo "${{ github.repository }}" \
129
- --title "$TAG" \
130
- --generate-notes
131
- fi
@@ -1,29 +0,0 @@
1
- # Run RSpec tests (VCR cassettes; no live API key needed for recorded specs).
2
- name: SDK CI
3
-
4
- on:
5
- pull_request:
6
- types: [opened, synchronize, reopened]
7
- push:
8
- branches: [main, master]
9
-
10
- permissions:
11
- contents: read
12
-
13
- jobs:
14
- test:
15
- name: Test
16
- runs-on: ubuntu-latest
17
- env:
18
- ZEROBOUNCE_API_KEY: "invalid_key_for_tests"
19
- steps:
20
- - uses: actions/checkout@v7
21
-
22
- - name: Set up Ruby
23
- uses: ruby/setup-ruby@v1
24
- with:
25
- ruby-version: "3.2"
26
- bundler-cache: true
27
-
28
- - name: Run specs
29
- run: bundle exec rspec
data/.gitignore DELETED
@@ -1,70 +0,0 @@
1
- *.gem
2
- *.rbc
3
- /.config
4
- /coverage/
5
- /InstalledFiles
6
- /pkg/
7
- /spec/reports/
8
- /spec/examples.txt
9
- /test/tmp/
10
- /test/version_tmp/
11
- /tmp/
12
-
13
- # Used by dotenv library to load environment variables.
14
- .env
15
-
16
- # Ignore Byebug command history file.
17
- .byebug_history
18
-
19
- ## Specific to RubyMotion:
20
- .dat*
21
- .repl_history
22
- build/
23
- *.bridgesupport
24
- build-iPhoneOS/
25
- build-iPhoneSimulator/
26
-
27
- ## Specific to RubyMotion (use of CocoaPods):
28
- #
29
- # We recommend against adding the Pods directory to your .gitignore. However
30
- # you should judge for yourself, the pros and cons are mentioned at:
31
- # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
32
- #
33
- # vendor/Pods/
34
-
35
- ## Documentation cache and generated files:
36
- /.yardoc/
37
- /_yardoc/
38
- /doc/
39
- /rdoc/
40
-
41
- ## Environment normalization:
42
- /.bundle/
43
- /vendor/bundle
44
- /lib/bundler/man/
45
-
46
- # for a library or gem, you might want to ignore these files since the code is
47
- # intended to run in multiple environments; otherwise, check them in:
48
- # Gemfile.lock
49
- # .ruby-version
50
- # .ruby-gemset
51
-
52
- # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
53
- .rvmrc
54
-
55
- # Used by RuboCop. Remote config files pulled in from inherit_from directive.
56
- # .rubocop-https?--*
57
-
58
- # Used by RSpec
59
- .rspec_status
60
-
61
-
62
- # Log files
63
- output.err
64
- output.log
65
-
66
- .DS_Store
67
- Thumbs.db
68
- .idea/
69
- .cursor/
70
- .env
data/.rspec DELETED
@@ -1,2 +0,0 @@
1
- --require spec_helper
2
- --format progress
data/.ruby-version DELETED
@@ -1 +0,0 @@
1
- 3.2.1
data/CODE_OF_CONDUCT.md DELETED
@@ -1,69 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- In the interest of fostering an open and welcoming environment, we as
6
- contributors and maintainers pledge to making participation in our project and
7
- our community a harassment-free experience for everyone, regardless of age, body
8
- size, disability, ethnicity, gender identity and expression, level of experience,
9
- nationality, personal appearance, race, religion, or sexual identity and
10
- orientation.
11
-
12
- ## Our Standards
13
-
14
- Examples of behavior that contributes to creating a positive environment
15
- include:
16
-
17
- * Using welcoming and inclusive language
18
- * Being respectful of differing viewpoints and experiences
19
- * Gracefully accepting constructive criticism
20
- * Focusing on what is best for the community
21
- * Showing empathy towards other community members
22
-
23
- Examples of unacceptable behavior by participants include:
24
-
25
- * The use of sexualized language or imagery and unwelcome sexual attention or
26
- advances
27
- * Trolling, insulting/derogatory comments, and personal or political attacks
28
- * Public or private harassment
29
- * Publishing others' private information, such as a physical or electronic
30
- address, without explicit permission
31
- * Other conduct which could reasonably be considered inappropriate in a
32
- professional setting
33
-
34
- ## Our Responsibilities
35
-
36
- Project maintainers are responsible for clarifying the standards of acceptable
37
- behavior and are expected to take appropriate and fair corrective action in
38
- response to any instances of unacceptable behavior.
39
-
40
- Project maintainers have the right and responsibility to remove, edit, or
41
- reject comments, commits, code, wiki edits, issues, and other contributions
42
- that are not aligned to this Code of Conduct, or to ban temporarily or
43
- permanently any contributor for other behaviors that they deem inappropriate,
44
- threatening, offensive, or harmful.
45
-
46
- ## Scope
47
-
48
- This Code of Conduct applies both within project spaces and in public spaces
49
- when an individual is representing the project or its community. Examples of
50
- representing a project or community include using an official project e-mail
51
- address, posting via an official social media account, or acting as an appointed
52
- representative at an online or offline event. Representation of a project may be
53
- further defined and clarified by project maintainers.
54
-
55
- ## Enforcement
56
-
57
- 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.
58
-
59
- Project maintainers who do not follow or enforce the Code of Conduct in good
60
- faith may face temporary or permanent repercussions as determined by other
61
- members of the project's leadership.
62
-
63
- ## Attribution
64
-
65
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
66
- available at [http://contributor-covenant.org/version/1/4][version]
67
-
68
- [homepage]: http://contributor-covenant.org
69
- [version]: http://contributor-covenant.org/version/1/4/