regstack 0.2.0__tar.gz → 0.2.1__tar.gz

regstack-0.2.1/.github/workflows/test.yml

@@ -0,0 +1,147 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+    services:
+      mongodb:
+        image: mongo:7
+        ports:
+          - 27017:27017
+        options: >-
+          --health-cmd "mongosh --quiet --eval 'db.runCommand({ping:1}).ok' --port 27017"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 12
+          --health-start-period 10s
+      postgres:
+        image: postgres:16
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_USER: regstack
+          POSTGRES_PASSWORD: regstack
+          POSTGRES_DB: regstack
+        options: >-
+          --health-cmd "pg_isready -U regstack"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 12
+          --health-start-period 10s
+    env:
+      # Drives the parametrized backend fixture in tests/conftest.py.
+      # Connect as superuser so the per-test fixture can CREATE/DROP DATABASE.
+      REGSTACK_TEST_POSTGRES_URL: postgresql+asyncpg://regstack:regstack@localhost:5432
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Pin Python ${{ matrix.python-version }}
+        run: uv python pin ${{ matrix.python-version }}
+
+      - name: Sync dependencies
+        run: uv sync --extra dev
+
+      - name: ruff check
+        run: uv run ruff check src tests
+
+      - name: ruff format check
+        run: uv run ruff format --check src tests
+
+      - name: pytest (parallel, all backends)
+        run: uv run python -m pytest -n auto --tb=short
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - run: uv python pin 3.11
+      - run: uv sync --extra docs --extra dev
+      - run: uv run sphinx-build -b html -W --keep-going docs docs/_build/html
+      - uses: actions/upload-artifact@v4
+        with:
+          name: docs-html
+          path: docs/_build/html
+
+  base-install-smoketest:
+    # Catches the kind of regression that broke 0.2.0: an unconditional
+    # `from bson import ...` (or any other optional-extra import) at module
+    # top level makes `import regstack` fail for any user who didn't opt
+    # into the `mongo` extra. The unit test of the same name exercises the
+    # equivalent in-process via meta_path blocking; this job verifies the
+    # actual built wheel installs and imports against a clean Python.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - run: uv python pin 3.11
+      - name: Build wheel
+        run: uv build --wheel
+      - name: Install wheel into a clean venv (no extras)
+        run: |
+          python -m venv /tmp/smoke
+          /tmp/smoke/bin/pip install --upgrade pip
+          /tmp/smoke/bin/pip install dist/regstack-*.whl
+      - name: Import smoketest
+        run: |
+          /tmp/smoke/bin/python -c "
+          import regstack
+          from regstack import RegStack, RegStackConfig
+          assert RegStack.__module__ == 'regstack.app'
+          print('ok', regstack.__version__)
+          "
+      - name: SQLite end-to-end smoketest
+        run: |
+          /tmp/smoke/bin/python <<'PY'
+          import asyncio, secrets, tempfile
+          from pathlib import Path
+          from regstack import RegStack, RegStackConfig
+          from regstack.models.user import BaseUser
+
+          async def main() -> None:
+              with tempfile.TemporaryDirectory() as td:
+                  cfg = RegStackConfig.load(
+                      toml_path=Path("/dev/null"),
+                      secrets_env_path=Path("/dev/null"),
+                      jwt_secret=secrets.token_urlsafe(64),
+                      database_url=f"sqlite+aiosqlite:///{td}/rs.db",
+                      require_verification=False,
+                      allow_registration=True,
+                      rate_limit_disabled=True,
+                  )
+                  rs = RegStack(config=cfg)
+                  await rs.install_schema()
+                  user = await rs.users.create(
+                      BaseUser(email="a@b.com", hashed_password="h", is_verified=True)
+                  )
+                  assert user.id
+                  await rs.aclose()
+                  print("sqlite ok")
+
+          asyncio.run(main())
+          PY

{regstack-0.2.0 → regstack-0.2.1}/CHANGELOG.md

@@ -5,6 +5,17 @@ authoritative copy lives at
 [`docs/changelog.md`](docs/changelog.md) and is rendered into the
 Sphinx docs.
 
+## 0.2.1 — 2026-04-28
+
+Hotfix for 0.2.0: `import regstack` failed on a base install because
+several modules in the import path (`models/_objectid.py`,
+`backends/protocols.py`, four routers, and the SQL `mfa_code_repo`)
+had unconditional `from bson …` / `from regstack.backends.mongo …`
+imports — but `pymongo` became an optional `mongo` extra in 0.2.0.
+Added a CI smoketest that builds the wheel and imports it in a
+no-extras venv, plus an in-process regression test that blocks `bson`
+/ `pymongo` via `sys.meta_path`.
+
 ## 0.2.0 — 2026-04-28
 
 Multi-backend support — SQLite (default), Postgres, MongoDB — switched

{regstack-0.2.0 → regstack-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regstack
-Version: 0.2.0
+Version: 0.2.1
 Summary: Embeddable user registration, login, and account management for FastAPI apps. SQLite / Postgres / MongoDB.
 Project-URL: Homepage, https://github.com/jdrumgoole/regstack
 Project-URL: Repository, https://github.com/jdrumgoole/regstack

{regstack-0.2.0 → regstack-0.2.1}/docs/changelog.md

@@ -3,6 +3,36 @@
 All notable changes to this project are documented here. Versions follow
 [Semantic Versioning](https://semver.org/) once `1.0.0` ships.
 
+## 0.2.1 — 2026-04-28
+
+**Hotfix for 0.2.0.** `import regstack` was broken on any install that
+didn't include the new `mongo` extra: `models/_objectid.py` imported
+`bson` unconditionally, and four routers + the SQL MFA repo imported
+shared error / enum types out of `regstack.backends.mongo.*`, which
+in turn imports `pymongo` at module top level.
+
+### Fixed
+
+- `models/_objectid.py` now imports `bson.ObjectId` lazily inside a
+  `try / except ImportError` and only uses it for `isinstance` checks
+  when present.
+- `UserAlreadyExistsError`, `PendingAlreadyExistsError`,
+  `MfaVerifyOutcome`, and `MfaVerifyResult` moved from their backend
+  modules to `regstack.backends.protocols` (the backend-agnostic
+  location). Mongo modules re-export them for backwards compatibility.
+- All consumer modules (`routers/register.py`, `routers/account.py`,
+  `routers/login.py`, `routers/phone.py`, the SQL MFA repo) updated to
+  import from `regstack.backends.protocols`.
+
+### Added
+
+- New `base-install-smoketest` CI job: builds the wheel and runs
+  `import regstack` + a SQLite end-to-end RegStack lifecycle in a
+  fresh venv with **no extras**. Will catch any future regression.
+- New `tests/unit/test_base_install_imports.py` regression test that
+  uses `sys.meta_path` to block `bson` / `pymongo` and confirm
+  `import regstack` still succeeds.
+
 ## 0.2.0 — 2026-04-28
 
 **Multi-backend support + Alembic migrations.** SQLite is now the

{regstack-0.2.0 → regstack-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "regstack"
-version = "0.2.0"
+version = "0.2.1"
 description = "Embeddable user registration, login, and account management for FastAPI apps. SQLite / Postgres / MongoDB."
 readme = "README.md"
 requires-python = ">=3.11"

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/backends/mongo/repositories/mfa_code_repo.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
 from datetime import datetime
-from enum import StrEnum
 from typing import TYPE_CHECKING
 
 from regstack.auth.tokens import hash_token
+from regstack.backends.protocols import MfaVerifyOutcome, MfaVerifyResult
 from regstack.models.mfa_code import MfaCode, MfaKind
 
 if TYPE_CHECKING:
@@ -14,18 +13,7 @@ if TYPE_CHECKING:
     from regstack.auth.clock import Clock
 
 
-class MfaVerifyOutcome(StrEnum):
-    OK = "ok"
-    WRONG = "wrong"
-    EXPIRED = "expired"
-    LOCKED = "locked"
-    MISSING = "missing"
-
-
-@dataclass(slots=True, frozen=True)
-class MfaVerifyResult:
-    outcome: MfaVerifyOutcome
-    attempts_remaining: int = 0
+__all__ = ["MfaCodeRepo", "MfaVerifyOutcome", "MfaVerifyResult"]
 
 
 class MfaCodeRepo:

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/backends/mongo/repositories/pending_repo.py

@@ -6,14 +6,14 @@ from typing import TYPE_CHECKING, Any
 from bson import ObjectId
 from pymongo.errors import DuplicateKeyError
 
+from regstack.backends.protocols import PendingAlreadyExistsError
 from regstack.models.pending_registration import PendingRegistration
 
 if TYPE_CHECKING:
     from pymongo.asynchronous.database import AsyncDatabase
 
 
-class PendingAlreadyExistsError(Exception):
-    """A pending registration with this email already exists."""
+__all__ = ["PendingAlreadyExistsError", "PendingRepo"]
 
 
 class PendingRepo:

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/backends/mongo/repositories/user_repo.py

@@ -7,14 +7,14 @@ from bson import ObjectId
 from pymongo.errors import DuplicateKeyError
 
 from regstack.auth.clock import Clock, SystemClock
+from regstack.backends.protocols import UserAlreadyExistsError
 from regstack.models.user import BaseUser
 
 if TYPE_CHECKING:
     from pymongo.asynchronous.database import AsyncDatabase
 
 
-class UserAlreadyExistsError(Exception):
-    """Raised when an attempt is made to insert a user with a duplicate email."""
+__all__ = ["UserAlreadyExistsError", "UserRepo"]
 
 
 def _bulk_revoke_cutoff(now: datetime) -> datetime:

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/backends/protocols.py

@@ -11,7 +11,9 @@ or Mongo idiom feels "right" to the implementer.
 
 from __future__ import annotations
 
+from dataclasses import dataclass
 from datetime import datetime, timedelta
+from enum import StrEnum
 from typing import Protocol, runtime_checkable
 
 from regstack.models.mfa_code import MfaCode, MfaKind
@@ -19,6 +21,20 @@ from regstack.models.pending_registration import PendingRegistration
 from regstack.models.user import BaseUser
 
 
+class MfaVerifyOutcome(StrEnum):
+    OK = "ok"
+    WRONG = "wrong"
+    EXPIRED = "expired"
+    LOCKED = "locked"
+    MISSING = "missing"
+
+
+@dataclass(slots=True, frozen=True)
+class MfaVerifyResult:
+    outcome: MfaVerifyOutcome
+    attempts_remaining: int = 0
+
+
 class UserAlreadyExistsError(Exception):
     """Raised when an attempt is made to insert a user with a duplicate email,
     or to set an email that another user already owns.
@@ -28,6 +44,14 @@ class UserAlreadyExistsError(Exception):
     """
 
 
+class PendingAlreadyExistsError(Exception):
+    """A pending registration with this email already exists.
+
+    Backend-agnostic: each repo raises this on its own duplicate path so
+    callers can branch on the type without importing a backend module.
+    """
+
+
 @runtime_checkable
 class UserRepoProtocol(Protocol):
     async def create(self, user: BaseUser) -> BaseUser: ...
@@ -155,9 +179,3 @@ class MfaCodeRepoProtocol(Protocol):
     async def find(self, *, user_id: str, kind: MfaKind) -> MfaCode | None: ...
 
     async def purge_expired(self, now: datetime | None = None) -> int: ...
-
-
-# Re-exported here so callers don't need a deeper import. Lives in the
-# Mongo backend module because it predates the SQL backend; the dataclass
-# is backend-agnostic, only the import path is historical.
-from regstack.backends.mongo.repositories.mfa_code_repo import MfaVerifyResult  # noqa: E402

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/backends/sql/repositories/mfa_code_repo.py

@@ -6,10 +6,7 @@ from typing import TYPE_CHECKING
 from sqlalchemy import and_, delete, select, update
 
 from regstack.auth.tokens import hash_token
-from regstack.backends.mongo.repositories.mfa_code_repo import (
-    MfaVerifyOutcome,
-    MfaVerifyResult,
-)
+from regstack.backends.protocols import MfaVerifyOutcome, MfaVerifyResult
 from regstack.backends.sql.schema import mfa_codes_table
 from regstack.models.mfa_code import MfaCode, MfaKind
 

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/models/_objectid.py

@@ -17,10 +17,18 @@ from __future__ import annotations
 
 from typing import Annotated, Any
 
-from bson import ObjectId
 from pydantic import GetCoreSchemaHandler
 from pydantic_core import CoreSchema, core_schema
 
+# bson is imported lazily so the package remains importable on a base
+# install (the `mongo` extra is what pulls pymongo, and pymongo is the
+# only consumer of bson). When the Mongo backend is in use, bson is
+# always present.
+try:
+    from bson import ObjectId as _BsonObjectId  # type: ignore[import-not-found]
+except ImportError:  # pragma: no cover — exercised only without the mongo extra
+    _BsonObjectId = None  # type: ignore[assignment,misc]
+
 
 class _IdValidator:
     @classmethod
@@ -28,7 +36,7 @@ class _IdValidator:
         cls, source_type: Any, handler: GetCoreSchemaHandler
     ) -> CoreSchema:
         def validate(value: Any) -> str:
-            if isinstance(value, ObjectId):
+            if _BsonObjectId is not None and isinstance(value, _BsonObjectId):
                 return str(value)
             if isinstance(value, str) and value:
                 return value

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/routers/account.py

@@ -7,7 +7,7 @@ from fastapi import APIRouter, Body, Depends, HTTPException, status
 from pydantic import BaseModel, ConfigDict, EmailStr, Field
 
 from regstack.auth.jwt import TokenError
-from regstack.backends.mongo.repositories.user_repo import UserAlreadyExistsError
+from regstack.backends.protocols import UserAlreadyExistsError
 from regstack.config.secrets import derive_secret
 from regstack.models.user import BaseUser, UserPublic
 from regstack.routers._schemas import MessageResponse, PasswordStr

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/routers/login.py

@@ -9,7 +9,7 @@ from pydantic import BaseModel, ConfigDict, Field
 
 from regstack.auth.jwt import TokenError
 from regstack.auth.mfa import generate_mfa_code
-from regstack.backends.mongo.repositories.mfa_code_repo import MfaVerifyOutcome
+from regstack.backends.protocols import MfaVerifyOutcome
 from regstack.models.mfa_code import MfaCode
 from regstack.routers._schemas import LoginRequest, TokenResponse
 from regstack.sms.base import SmsMessage

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/routers/phone.py

@@ -8,7 +8,7 @@ from pydantic import BaseModel, ConfigDict, Field
 
 from regstack.auth.jwt import TokenError
 from regstack.auth.mfa import generate_mfa_code
-from regstack.backends.mongo.repositories.mfa_code_repo import MfaVerifyOutcome
+from regstack.backends.protocols import MfaVerifyOutcome
 from regstack.models.mfa_code import MfaCode
 from regstack.models.user import BaseUser, UserPublic
 from regstack.routers._schemas import MessageResponse

{regstack-0.2.0 → regstack-0.2.1}/src/regstack/routers/register.py

@@ -6,8 +6,7 @@ from typing import TYPE_CHECKING
 from fastapi import APIRouter, HTTPException, status
 
 from regstack.auth.tokens import generate_verification_token
-from regstack.backends.mongo.repositories.pending_repo import PendingAlreadyExistsError
-from regstack.backends.mongo.repositories.user_repo import UserAlreadyExistsError
+from regstack.backends.protocols import PendingAlreadyExistsError, UserAlreadyExistsError
 from regstack.models.pending_registration import PendingRegistration
 from regstack.models.user import BaseUser, UserCreate, UserPublic
 from regstack.routers._schemas import PendingResponse

regstack-0.2.1/src/regstack/version.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

regstack-0.2.1/tests/unit/test_base_install_imports.py

@@ -0,0 +1,69 @@
+"""Regression test: ``import regstack`` must not require optional extras.
+
+regstack 0.2.0 shipped to PyPI broken because several modules in the
+hot import path (`routers/account.py`, `routers/login.py`,
+`models/_objectid.py`, …) had unconditional ``from bson …`` /
+``from pymongo …`` / ``from regstack.backends.mongo …`` statements.
+On a base install (no ``mongo`` extra) ``import regstack`` raised
+``ModuleNotFoundError: No module named 'bson'``.
+
+This test runs ``import regstack`` in a subprocess with ``bson`` and
+``pymongo`` blocked, so a future regression is caught even when the
+test environment happens to have pymongo installed for other reasons.
+"""
+
+from __future__ import annotations
+
+import subprocess
+import sys
+import textwrap
+
+
+def test_import_regstack_without_pymongo() -> None:
+    """``import regstack`` and ``from regstack import RegStack, RegStackConfig``
+    must work on a base install — no optional extras.
+
+    We can't actually uninstall pymongo from the test venv, so we
+    simulate "not installed" by inserting a finder that raises
+    ImportError for ``bson`` and ``pymongo`` at the top of sys.meta_path.
+    """
+    program = textwrap.dedent(
+        """
+        import importlib.abc, importlib.machinery, sys
+
+        BLOCKED = {"bson", "pymongo"}
+
+        class BlockMongo(importlib.abc.MetaPathFinder):
+            def find_spec(self, name, path, target=None):
+                root = name.split(".", 1)[0]
+                if root in BLOCKED:
+                    raise ModuleNotFoundError(f"No module named {name!r}")
+                return None
+
+        sys.meta_path.insert(0, BlockMongo())
+        # Drop anything pymongo-touching that may have been pre-imported
+        # by pytest's collection of sibling test modules.
+        for mod in list(sys.modules):
+            root = mod.split(".", 1)[0]
+            if root in BLOCKED or mod.startswith("regstack"):
+                del sys.modules[mod]
+
+        import regstack
+        from regstack import RegStack, RegStackConfig
+
+        assert RegStack.__module__ == "regstack.app"
+        assert RegStackConfig.__module__ == "regstack.config.schema"
+        print("ok", regstack.__version__)
+        """
+    )
+    result = subprocess.run(
+        [sys.executable, "-c", program],
+        capture_output=True,
+        text=True,
+        timeout=30,
+    )
+    assert result.returncode == 0, (
+        f"import regstack failed without pymongo:\nstdout={result.stdout!r}"
+        f"\nstderr={result.stderr!r}"
+    )
+    assert result.stdout.startswith("ok "), result.stdout

{regstack-0.2.0 → regstack-0.2.1}/uv.lock

@@ -1978,7 +1978,7 @@ wheels = [
 
 [[package]]
 name = "regstack"
-version = "0.2.0"
+version = "0.2.1"
 source = { editable = "." }
 dependencies = [
     { name = "aiosmtplib" },

regstack-0.2.0/.github/workflows/test.yml

@@ -1,86 +0,0 @@
-name: test
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-  workflow_dispatch:
-
-concurrency:
-  group: test-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  pytest:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.11", "3.12"]
-    services:
-      mongodb:
-        image: mongo:7
-        ports:
-          - 27017:27017
-        options: >-
-          --health-cmd "mongosh --quiet --eval 'db.runCommand({ping:1}).ok' --port 27017"
-          --health-interval 5s
-          --health-timeout 5s
-          --health-retries 12
-          --health-start-period 10s
-      postgres:
-        image: postgres:16
-        ports:
-          - 5432:5432
-        env:
-          POSTGRES_USER: regstack
-          POSTGRES_PASSWORD: regstack
-          POSTGRES_DB: regstack
-        options: >-
-          --health-cmd "pg_isready -U regstack"
-          --health-interval 5s
-          --health-timeout 5s
-          --health-retries 12
-          --health-start-period 10s
-    env:
-      # Drives the parametrized backend fixture in tests/conftest.py.
-      # Connect as superuser so the per-test fixture can CREATE/DROP DATABASE.
-      REGSTACK_TEST_POSTGRES_URL: postgresql+asyncpg://regstack:regstack@localhost:5432
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: astral-sh/setup-uv@v3
-        with:
-          enable-cache: true
-          cache-dependency-glob: "uv.lock"
-
-      - name: Pin Python ${{ matrix.python-version }}
-        run: uv python pin ${{ matrix.python-version }}
-
-      - name: Sync dependencies
-        run: uv sync --extra dev
-
-      - name: ruff check
-        run: uv run ruff check src tests
-
-      - name: ruff format check
-        run: uv run ruff format --check src tests
-
-      - name: pytest (parallel, all backends)
-        run: uv run python -m pytest -n auto --tb=short
-
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v3
-        with:
-          enable-cache: true
-          cache-dependency-glob: "uv.lock"
-      - run: uv python pin 3.11
-      - run: uv sync --extra docs --extra dev
-      - run: uv run sphinx-build -b html -W --keep-going docs docs/_build/html
-      - uses: actions/upload-artifact@v4
-        with:
-          name: docs-html
-          path: docs/_build/html

regstack-0.2.0/src/regstack/version.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"