sentinelsup 0.2.4__tar.gz → 0.2.5__tar.gz

{sentinelsup-0.2.4 → sentinelsup-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sentinelsup
-Version: 0.2.4
+Version: 0.2.5
 Summary: Official Maskbreak SDK for browser-backed fraud checks and cloud/Tor IP lookups.
 Project-URL: Homepage, https://maskbreak.com
 Project-URL: Documentation, https://maskbreak.com/api
@@ -49,7 +49,7 @@ env var, and a test:
 
 > Fetch https://maskbreak.com/integrate.md and follow it to add Maskbreak fraud
 > protection to this app — protect signup, login, and checkout. Read the API key
-> from the server-only SENTINEL_KEY environment variable; I will configure the
+> from the server-only MASKBREAK_API_KEY environment variable; I will configure the
 > secret separately. Never put it in client-side code. Show me how to test it.
 
 [`integrate.md`](https://maskbreak.com/integrate.md) is the canonical
@@ -69,7 +69,7 @@ Python 3.8+. Get a free API key (no credit card) at [maskbreak.com/signup](https
 import os
 from sentinel import Sentinel
 
-s = Sentinel(api_key=os.environ["SENTINEL_KEY"])  # or omit — reads the env var itself
+s = Sentinel(api_key=os.environ["MASKBREAK_API_KEY"])  # or omit — reads the env var itself
 
 result = s.evaluate(
     token=request.json["sentinelToken"],
@@ -90,6 +90,9 @@ to your verification/review flow; only `allow` is an approval. Keep API keys on
 the server. An unavailable device layer or `raw["degraded"]` is not proof of a
 clean visit; `degraded` describes the network layer only.
 
+Since v0.2.5, `Sentinel()` without a key reads `MASKBREAK_API_KEY`; the older
+`SENTINEL_KEY` and `SENTINEL_API_KEY` names are still read as fallbacks.
+
 Check the signup email against the disposable-domain feed (checked
 transiently, never stored), or look up an arbitrary IP with no browser
 token at all:
@@ -171,7 +174,7 @@ from flask import Flask, request, abort, jsonify
 from sentinel import Sentinel, SentinelError
 
 app = Flask(__name__)
-sentinel = Sentinel()  # reads SENTINEL_KEY (or SENTINEL_API_KEY) from env
+sentinel = Sentinel()  # reads MASKBREAK_API_KEY from env
 
 @app.route("/signup", methods=["POST"])
 def signup():
@@ -202,7 +205,7 @@ def signup():
 from django.http import JsonResponse
 from sentinel import Sentinel, SentinelError
 
-sentinel = Sentinel()  # reads SENTINEL_KEY (or SENTINEL_API_KEY) from env
+sentinel = Sentinel()  # reads MASKBREAK_API_KEY from env
 
 class FraudCheckMiddleware:
     def __init__(self, get_response):
@@ -233,7 +236,7 @@ Runnable versions live in [`examples/`](./examples/).
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `api_key` | `$SENTINEL_KEY` (falls back to `$SENTINEL_API_KEY`) | Your key starting with `sk_live_` |
+| `api_key` | `$MASKBREAK_API_KEY` (falls back to `$SENTINEL_KEY`, then `$SENTINEL_API_KEY`) | Your key starting with `sk_live_` |
 | `endpoint` | `https://maskbreak.com` | Override base URL (for testing) |
 | `timeout` | `5.0` | Per-request timeout in seconds |
 

{sentinelsup-0.2.4 → sentinelsup-0.2.5}/README.md

@@ -20,7 +20,7 @@ env var, and a test:
 
 > Fetch https://maskbreak.com/integrate.md and follow it to add Maskbreak fraud
 > protection to this app — protect signup, login, and checkout. Read the API key
-> from the server-only SENTINEL_KEY environment variable; I will configure the
+> from the server-only MASKBREAK_API_KEY environment variable; I will configure the
 > secret separately. Never put it in client-side code. Show me how to test it.
 
 [`integrate.md`](https://maskbreak.com/integrate.md) is the canonical
@@ -40,7 +40,7 @@ Python 3.8+. Get a free API key (no credit card) at [maskbreak.com/signup](https
 import os
 from sentinel import Sentinel
 
-s = Sentinel(api_key=os.environ["SENTINEL_KEY"])  # or omit — reads the env var itself
+s = Sentinel(api_key=os.environ["MASKBREAK_API_KEY"])  # or omit — reads the env var itself
 
 result = s.evaluate(
     token=request.json["sentinelToken"],
@@ -61,6 +61,9 @@ to your verification/review flow; only `allow` is an approval. Keep API keys on
 the server. An unavailable device layer or `raw["degraded"]` is not proof of a
 clean visit; `degraded` describes the network layer only.
 
+Since v0.2.5, `Sentinel()` without a key reads `MASKBREAK_API_KEY`; the older
+`SENTINEL_KEY` and `SENTINEL_API_KEY` names are still read as fallbacks.
+
 Check the signup email against the disposable-domain feed (checked
 transiently, never stored), or look up an arbitrary IP with no browser
 token at all:
@@ -142,7 +145,7 @@ from flask import Flask, request, abort, jsonify
 from sentinel import Sentinel, SentinelError
 
 app = Flask(__name__)
-sentinel = Sentinel()  # reads SENTINEL_KEY (or SENTINEL_API_KEY) from env
+sentinel = Sentinel()  # reads MASKBREAK_API_KEY from env
 
 @app.route("/signup", methods=["POST"])
 def signup():
@@ -173,7 +176,7 @@ def signup():
 from django.http import JsonResponse
 from sentinel import Sentinel, SentinelError
 
-sentinel = Sentinel()  # reads SENTINEL_KEY (or SENTINEL_API_KEY) from env
+sentinel = Sentinel()  # reads MASKBREAK_API_KEY from env
 
 class FraudCheckMiddleware:
     def __init__(self, get_response):
@@ -204,7 +207,7 @@ Runnable versions live in [`examples/`](./examples/).
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `api_key` | `$SENTINEL_KEY` (falls back to `$SENTINEL_API_KEY`) | Your key starting with `sk_live_` |
+| `api_key` | `$MASKBREAK_API_KEY` (falls back to `$SENTINEL_KEY`, then `$SENTINEL_API_KEY`) | Your key starting with `sk_live_` |
 | `endpoint` | `https://maskbreak.com` | Override base URL (for testing) |
 | `timeout` | `5.0` | Per-request timeout in seconds |
 

{sentinelsup-0.2.4 → sentinelsup-0.2.5}/examples/django_middleware.py

@@ -24,7 +24,7 @@ _GUARDED_PATHS = ("/api/checkout", "/api/withdraw", "/api/transfer")
 class SentinelMiddleware:
     def __init__(self, get_response):
         self.get_response = get_response
-        self.sentinel = Sentinel()  # reads SENTINEL_KEY, with legacy fallback
+        self.sentinel = Sentinel()  # reads MASKBREAK_API_KEY, older names as fallback
 
     def __call__(self, request):
         if not request.path.startswith(_GUARDED_PATHS):

{sentinelsup-0.2.4 → sentinelsup-0.2.5}/examples/flask_signup_guard.py

@@ -2,7 +2,7 @@
 
 Run:
     pip install flask sentinelsup
-    export SENTINEL_KEY=sk_live_...
+    export MASKBREAK_API_KEY=sk_live_...
     python flask_signup_guard.py
 """
 
@@ -12,7 +12,7 @@ from flask import Flask, abort, jsonify, request
 from sentinel import Sentinel, SentinelError
 
 app = Flask(__name__)
-sentinel = Sentinel()  # reads SENTINEL_KEY, with SENTINEL_API_KEY fallback
+sentinel = Sentinel()  # reads MASKBREAK_API_KEY (older SENTINEL_KEY still works)
 
 
 @app.route("/signup", methods=["POST"])

{sentinelsup-0.2.4 → sentinelsup-0.2.5}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 # would install a stranger's code. "sentinelsup" matches the npm scope
 # (@sentinelsup/sdk).
 name = "sentinelsup"
-version = "0.2.4"
+version = "0.2.5"
 description = "Official Maskbreak SDK for browser-backed fraud checks and cloud/Tor IP lookups."
 readme = "README.md"
 requires-python = ">=3.8"

{sentinelsup-0.2.4 → sentinelsup-0.2.5}/sentinel/__init__.py

@@ -4,7 +4,7 @@ fraud detection API at https://maskbreak.com/v1/evaluate.
 
 Usage:
     from sentinel import Sentinel
-    s = Sentinel()  # reads SENTINEL_KEY or SENTINEL_API_KEY from the env
+    s = Sentinel()  # reads MASKBREAK_API_KEY from the env
     result = s.evaluate(token=request.json["sentinelToken"])
     if result.is_blocked:
         abort(403)
@@ -18,7 +18,7 @@ from urllib import error, parse, request
 
 DEFAULT_ENDPOINT = "https://maskbreak.com"
 DEFAULT_TIMEOUT = 5.0
-__version__ = "0.2.4"
+__version__ = "0.2.5"
 
 
 class _NoRedirect(request.HTTPRedirectHandler):
@@ -78,13 +78,20 @@ class Sentinel:
         endpoint: str = DEFAULT_ENDPOINT,
         timeout: float = DEFAULT_TIMEOUT,
     ) -> None:
-        # SENTINEL_KEY is the name every doc surface uses; SENTINEL_API_KEY
-        # is kept for existing installs that already adopted it.
-        api_key = api_key or os.environ.get("SENTINEL_KEY") or os.environ.get("SENTINEL_API_KEY")
+        # MASKBREAK_API_KEY is the name every doc surface uses. SENTINEL_KEY
+        # and SENTINEL_API_KEY are older names, still read so existing installs
+        # keep working; the first non-empty one wins.
+        api_key = (
+            api_key
+            or os.environ.get("MASKBREAK_API_KEY")
+            or os.environ.get("SENTINEL_KEY")
+            or os.environ.get("SENTINEL_API_KEY")
+        )
         if not api_key or not isinstance(api_key, str):
             raise SentinelError(
                 "Sentinel: api_key is required. "
-                "Pass it explicitly or set SENTINEL_KEY. "
+                "Pass it explicitly or set MASKBREAK_API_KEY "
+                "(the older SENTINEL_KEY still works). "
                 "Get one free at https://maskbreak.com/signup"
             )
         self.api_key = api_key

{sentinelsup-0.2.4 → sentinelsup-0.2.5}/tests/test_client.py

@@ -108,12 +108,29 @@ class ClientTests(unittest.TestCase):
         self.assertEqual(len(self.server.calls), 1, "redirect target must not receive the API key")
 
     def test_environment_key_precedence(self):
-        with patch.dict(os.environ, {"SENTINEL_KEY": "primary", "SENTINEL_API_KEY": "legacy"}):
-            self.assertEqual(Sentinel().api_key, "primary")
+        env = {"MASKBREAK_API_KEY": "current", "SENTINEL_KEY": "primary", "SENTINEL_API_KEY": "legacy"}
+        with patch.dict(os.environ, env):
+            self.assertEqual(Sentinel().api_key, "current")
             self.assertEqual(Sentinel("explicit").api_key, "explicit")
+            os.environ.pop("MASKBREAK_API_KEY")
+            self.assertEqual(Sentinel().api_key, "primary")
             os.environ.pop("SENTINEL_KEY")
             self.assertEqual(Sentinel().api_key, "legacy")
 
+    def test_environment_key_new_name_alone(self):
+        with patch.dict(os.environ, {"MASKBREAK_API_KEY": "current"}):
+            for old in ("SENTINEL_KEY", "SENTINEL_API_KEY"):
+                os.environ.pop(old, None)
+            self.assertEqual(Sentinel().api_key, "current")
+
+    def test_missing_key_names_the_current_variable(self):
+        with patch.dict(os.environ, {}):
+            for name in ("MASKBREAK_API_KEY", "SENTINEL_KEY", "SENTINEL_API_KEY"):
+                os.environ.pop(name, None)
+            with self.assertRaises(SentinelError) as caught:
+                Sentinel()
+            self.assertIn("MASKBREAK_API_KEY", str(caught.exception))
+
     def test_result_helpers_keep_review_distinct_from_block(self):
         for decision in ("allow", "review", "block"):
             result = EvaluateResult(decision=decision)
@@ -132,7 +149,7 @@ class DjangoGuardTests(unittest.TestCase):
         ]:
             with self.subTest(decision=decision, flag=flag):
                 view = Mock(return_value=SimpleNamespace(status_code=200))
-                with patch.dict(os.environ, {"SENTINEL_KEY": "sk_test_fixture"}):
+                with patch.dict(os.environ, {"MASKBREAK_API_KEY": "sk_test_fixture"}):
                     middleware = example["SentinelMiddleware"](view)
                 middleware.sentinel = Mock()
                 middleware.sentinel.evaluate.return_value = EvaluateResult(