Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 20 additions & 15 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,40 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#versioning-strategy
# Dependabot: security updates only (no version-update PRs).
# Grouped security PRs open weekly on Tuesday morning (Europe/Bucharest).
# Auto-merge: .github/workflows/dependabot-auto-merge.yml (on PR + Tuesday cron).
# https://docs.github.com/en/code-security/dependabot/dependabot-security-updates

version: 2
updates:
# Keep the Python dependencies up to date
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
target-branch: "master"
interval: weekly
day: tuesday
time: "06:00"
timezone: Europe/Bucharest
open-pull-requests-limit: 0
labels:
- "dependabot-security"
- "python dependencies"
groups:
pip:
applies-to: version-updates
pip-security:
applies-to: security-updates
patterns:
- "*"

# Keep the Github Actions dependencies up to date
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
target-branch: "master"
interval: weekly
day: tuesday
time: "06:00"
timezone: Europe/Bucharest
open-pull-requests-limit: 0
labels:
- "dependabot-security"
- "github dependencies"
groups:
github:
applies-to: version-updates
github-actions-security:
applies-to: security-updates
patterns:
- "*"
3 changes: 2 additions & 1 deletion .github/workflows/auto_assign_ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
name: Auto Assign
# Audit 2026-10-14: pull_request_target — do not checkout the PR head here; configuration-path only.

on:
pull_request_target:
Expand All @@ -16,6 +17,6 @@ jobs:
name: Auto assign (me only)
runs-on: ubuntu-latest
steps:
- uses: kentaro-m/auto-assign-action@v2.0.2
- uses: kentaro-m/auto-assign-action@0a2c53d3721e4c5cfcce6afd4014aecc337979f6 # v2.0.2
with:
configuration-path: ".github/auto_assign.yml"
6 changes: 3 additions & 3 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
# 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@v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

# Add any setup steps before running the `github/codeql-action/init` action.
# This includes steps like installing compilers or runtimes (`actions/setup-node`
Expand All @@ -71,7 +71,7 @@ jobs:

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4.37.8
uses: github/codeql-action/init@db488ddef3bf6cb639b32c2e9a7c0a7ea8271d28 # v4.37.8
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
Expand Down Expand Up @@ -100,6 +100,6 @@ jobs:
exit 1

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v4.37.8
uses: github/codeql-action/analyze@db488ddef3bf6cb639b32c2e9a7c0a7ea8271d28 # v4.37.8
with:
category: "/language:${{matrix.language}}"
50 changes: 50 additions & 0 deletions .github/workflows/dependabot-auto-merge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Dependabot security auto-merge

on:
pull_request:
types: [opened, synchronize, reopened]
schedule:
- cron: "0 6 * * 2"
timezone: Europe/Bucharest

permissions:
contents: write
pull-requests: write

jobs:
approve-and-queue-merge:
runs-on: ubuntu-latest
if: >-
github.event_name == 'pull_request'
&& github.event.pull_request.user.login == 'dependabot[bot]'
steps:
- name: Approve Dependabot pull request
run: gh pr review --approve "$PR_URL"
env:
PR_URL: ${{ github.event.pull_request.html_url }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Enable auto-merge when checks pass
run: gh pr merge --auto --merge "$PR_URL"
env:
PR_URL: ${{ github.event.pull_request.html_url }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

weekly-merge-ready:
runs-on: ubuntu-latest
if: github.event_name == 'schedule'
steps:
- name: Approve and queue merge for open Dependabot PRs
run: |
set -euo pipefail
mapfile -t urls < <(gh pr list --author app/dependabot --state open --json url --jq '.[].url')
if [ "${#urls[@]}" -eq 0 ]; then
echo "No open Dependabot pull requests."
exit 0
fi
for url in "${urls[@]}"; do
gh pr review --approve "$url" || true
gh pr merge --auto --merge "$url" || true
done
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
58 changes: 40 additions & 18 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,36 @@ permissions:

jobs:
validate-tag:
outputs:
tag_sha: ${{ steps.tag_sha.outputs.sha }}
name: Validate tag
runs-on: ubuntu-latest
steps:
- name: Validate tag input
env:
TAG: ${{ github.event.inputs.tag }}
run: |
re='^v?[0-9]+\.[0-9]+\.[0-9]+([.+-][0-9A-Za-z.-]+)?$'
if [[ ! "$TAG" =~ $re ]]; then
echo "Error: the tag input must be a release tag such as v1.2.3."
exit 1
fi

- name: Checkout
uses: actions/checkout@v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
ref: ${{ github.event.inputs.tag }}
ref: refs/tags/${{ github.event.inputs.tag }}

persist-credentials: false
- name: Verify tag and package 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
if ! git rev-parse -q --verify "refs/tags/$TAG" >/dev/null; then
echo "Error: Tag '$TAG' does not exist."
exit 1
fi
Expand All @@ -45,19 +58,27 @@ jobs:
fi
echo "Publishing tag: $TAG (zerobouncesdk@$PKG_VERSION)"

- name: Record tag commit SHA
id: tag_sha
env:
TAG: ${{ github.event.inputs.tag }}
run: |
SHA=$(git rev-parse "refs/tags/$TAG^{commit}")
echo "sha=$SHA" >> "$GITHUB_OUTPUT"

test:
name: Test
needs: [validate-tag]
if: ${{ !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
runs-on: ubuntu-latest
steps:
- name: Checkout tag
uses: actions/checkout@v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ github.event.inputs.tag }}

ref: ${{ needs.validate-tag.outputs.tag_sha }}
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v7
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.12"

Expand All @@ -71,7 +92,7 @@ jobs:

publish:
name: Build and publish to PyPI
needs: [test]
needs: [validate-tag, test]
if: ${{ !cancelled() && !failure() }}
runs-on: ubuntu-latest
environment: release
Expand All @@ -80,12 +101,12 @@ jobs:
contents: read
steps:
- name: Checkout tag
uses: actions/checkout@v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ github.event.inputs.tag }}

ref: ${{ needs.validate-tag.outputs.tag_sha }}
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v7
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.12"

Expand All @@ -96,34 +117,35 @@ jobs:
run: python -m build

- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
with:
password: ${{ secrets.PYPI_API_TOKEN }}

release:
name: Create GitHub Release
needs: [publish]
needs: [validate-tag, publish]
if: ${{ !cancelled() && !failure() }}
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ github.event.inputs.tag }}
ref: ${{ needs.validate-tag.outputs.tag_sha }}
fetch-depth: 0

persist-credentials: false
- 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
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 }}" \
--repo "$GITHUB_REPOSITORY" \
--title "$TAG" \
--generate-notes
fi
6 changes: 4 additions & 2 deletions .github/workflows/sdk_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ jobs:
name: Test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false

- name: Set up Python
uses: actions/setup-python@v7
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.12"

Expand Down
3 changes: 3 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,8 @@ RUN pip install --no-cache-dir -e ".[test]"
COPY tests/ tests/

# Unit tests only (no API key); use CMD so it can be overridden

USER 65532:65532

CMD ["python", "-m", "pytest", "tests/zero_bounce_test_case.py", "-v", \
"--cov=zerobouncesdk", "--cov-report=term-missing", "--cov-fail-under=50"]
33 changes: 24 additions & 9 deletions src/zerobouncesdk/zerobouncesdk.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
from datetime import date, timedelta
import os
from typing import BinaryIO, List, Optional, Union
from urllib.parse import quote_plus

import requests
from requests.exceptions import RequestException

from .zb_get_file_options import ZBGetFileOptions
from . import (
Expand Down Expand Up @@ -128,11 +130,21 @@ def _should_treat_get_file_body_as_error(body: str, content_type: str) -> bool:
return True
return ZeroBounce.get_file_json_indicates_error(body)

def _redact(self, text) -> str:
"""Mask the API key in text that can end up in exception messages or logs."""
text = str(text)
for secret in (self._api_key, quote_plus(self._api_key)):
text = text.replace(secret, "***")
return text

def _get(self, url, response_class, params=None):
if not params:
params = {}
params["api_key"] = self._api_key
response = requests.get(url, params=params, timeout=self._timeout_s)
try:
response = requests.get(url, params=params, timeout=self._timeout_s)
except RequestException as e:
raise type(e)(self._redact(e)) from None

try:
json_response = response.json()
Expand Down Expand Up @@ -606,22 +618,25 @@ def _get_file(
if not scoring and options.activity_data is not None:
params["activity_data"] = "true" if options.activity_data else "false"

response = requests.get(
f"{self.SCORING_BASE_URL if scoring else self.BULK_BASE_URL}/getfile",
params=params,
timeout=self._timeout_s,
)
try:
response = requests.get(
f"{self.SCORING_BASE_URL if scoring else self.BULK_BASE_URL}/getfile",
params=params,
timeout=self._timeout_s,
)
except RequestException as e:
raise type(e)(self._redact(e)) from None
body_bytes = response.content or b""
body_str = body_bytes.decode("utf-8", errors="replace")
content_type = response.headers.get("Content-Type") or ""

if response.status_code > 299:
if body_str.lstrip().startswith("{"):
raise ZBApiException(self._format_get_file_error_message(body_str))
raise ZBApiException(body_str or f"HTTP {response.status_code}")
raise ZBApiException(self._redact(self._format_get_file_error_message(body_str)))
raise ZBApiException(self._redact(body_str or f"HTTP {response.status_code}"))

if self._should_treat_get_file_body_as_error(body_str, content_type):
raise ZBApiException(self._format_get_file_error_message(body_str))
raise ZBApiException(self._redact(self._format_get_file_error_message(body_str)))

dirname = os.path.dirname(download_path)
if dirname:
Expand Down
Loading