Skip to content

armgit / mwmbl

Public Imported from GitHub
0

An open source, non-profit web search engine

Serve paid and volunteer memberships from one v2 endpoint

Claude98abc98075c4
diff --git a/mwmbl/api.py b/mwmbl/api.py
index 930787e..1e3787e 100644
--- a/mwmbl/api.py
+++ b/mwmbl/api.py
@@ -13,6 +13,7 @@ Sub-routers (v2):
/api/v2/search/ — full-text search with optional API-key auth and quota info
/api/v2/super-search/ — multi-source streaming search (SSE), authenticated
/api/v2/combined-search/ — Mwmbl + EUSP + Wikipedia in one ranked response, authenticated
+ /api/v2/membership/ — paid and volunteer memberships and Seed Search usage, authenticated
JWT token endpoints (from NinjaJWTDefaultController) are registered on v1,
typically at /api/v1/platform/token/pair, /api/v1/platform/token/refresh, etc.
@@ -173,6 +174,7 @@ v2_api = NinjaExtraAPI(
"tags": [
{"name": "Search"},
{"name": "Super Search"},
+ {"name": "Membership"},
]
},
)
@@ -201,6 +203,7 @@ def register_routers(ranker, combined_ranker, tiny_index):
import mwmbl.tinysearchengine.search as search_module
import mwmbl.tinysearchengine.super_search as super_search_module
from mwmbl.platform.api import router as platform_router
+ from mwmbl.platform.membership_v2 import router as membership_v2_router
# Initialise routers that depend on runtime objects
search_module.init_router(ranker, tiny_index)
@@ -216,3 +219,4 @@ def register_routers(ranker, combined_ranker, tiny_index):
v2_api.add_router("/search/", search_module.v2_router, tags=["Search"])
v2_api.add_router("/super-search/", super_search_module.router, tags=["Super Search"])
v2_api.add_router("/combined-search/", combined_search_module.router, tags=["Combined Search"])
+ v2_api.add_router("/membership/", membership_v2_router, tags=["Membership"])
diff --git a/mwmbl/platform/api.py b/mwmbl/platform/api.py
index 6102a8e..2b1c75f 100644
--- a/mwmbl/platform/api.py
+++ b/mwmbl/platform/api.py
@@ -85,8 +85,6 @@ from mwmbl.platform.schemas import (
UserProfileResponse,
UserStatsResponse,
UserVoteHistory,
- VolunteerMembershipResponse,
- VolunteerTierResponse,
VoteRemoveRequest,
VoteRequest,
VoteResponse,
@@ -99,7 +97,7 @@ from mwmbl.search_auth import invalidate_api_key_cache, invalidate_user_api_key_
from mwmbl.signals import schedule_blacklist_rebuild
from mwmbl.usernames import generate_username
from mwmbl.utils import normalize_domain, validate_domain
-from mwmbl.volunteer_membership import current_volunteer_membership, user_combined_search_monthly_limit
+from mwmbl.volunteer_membership import user_combined_search_monthly_limit
logger = logging.getLogger(__name__)
@@ -1354,46 +1352,6 @@ def get_membership(request):
return user_membership
- "/membership/volunteer-tiers",
- response=list[VolunteerTierResponse],
- summary="List volunteer tiers",
- description="Returns the tiers earned by crawling rather than bought, with what earns each one and its perks.",
- tags=["Membership"],
-)
-def list_volunteer_tiers(request):
- return [
- VolunteerTierResponse(
- tier=info.tier,
- name=info.tier.label,
- days_per_month=info.days_per_month,
- min_results_per_day=info.min_results_per_day,
- perks=info.perks,
- )
- for info in membership.VOLUNTEER_TIERS
- ]
-
-
- "/membership/volunteer",
- auth=JWTAuth(),
- response=VolunteerMembershipResponse,
- summary="Get current volunteer membership",
- description="Returns the highest volunteer tier the user has earned by crawling, or 404 if they don't "
- "currently hold one. This is separate from a paid membership, and a user can hold both.",
- tags=["Membership"],
-)
-def get_volunteer_membership(request):
- volunteer_membership = current_volunteer_membership(request.user.id)
- if volunteer_membership is None:
- raise InvalidRequest("Not a volunteer member.", status=404)
- return VolunteerMembershipResponse(
- tier=volunteer_membership.tier,
- name=volunteer_membership.get_tier_display(),
- valid_until=volunteer_membership.valid_until,
- )
-
-
@router.get(
"/combined-search/usage",
auth=JWTAuth(),
diff --git a/mwmbl/platform/membership_v2.py b/mwmbl/platform/membership_v2.py
new file mode 100644
index 0000000..eddb5a2
--- /dev/null
+++ b/mwmbl/platform/membership_v2.py
@@ -0,0 +1,73 @@
+"""v2 membership endpoints: paid and volunteer memberships together, so the membership page needs one call."""
+
+from ninja import Router
+from ninja_jwt.authentication import JWTAuth
+
+from mwmbl import membership
+from mwmbl.models import Membership
+from mwmbl.platform.api import get_combined_search_usage, list_membership_tiers
+from mwmbl.platform.schemas import (
+ MembershipTiersV2Response,
+ MembershipV2Response,
+ PaidMembershipResponse,
+ VolunteerMembershipResponse,
+ VolunteerTierResponse,
+)
+from mwmbl.volunteer_membership import current_volunteer_membership
+
+router = Router(tags=["Membership"])
+
+
+ "/",
+ auth=JWTAuth(),
+ response=MembershipV2Response,
+ summary="Get membership",
+ description="Returns the user's paid membership and their highest current volunteer tier, each null if "
+ "they don't hold one, and their Combined Search usage and limit this month. Cancelling or changing a "
+ "paid membership is done through /api/v1/platform/membership/.",
+)
+def get_membership(request):
+ paid = Membership.objects.filter(user=request.user).first()
+ volunteer = current_volunteer_membership(request.user.id)
+ return MembershipV2Response(
+ paid=PaidMembershipResponse(
+ tier=paid.tier,
+ name=paid.get_tier_display(),
+ current_period_end=paid.current_period_end,
+ cancel_at_period_end=paid.cancel_at_period_end,
+ )
+ if paid
+ else None,
+ volunteer=VolunteerMembershipResponse(
+ tier=volunteer.tier,
+ name=volunteer.get_tier_display(),
+ valid_until=volunteer.valid_until,
+ )
+ if volunteer
+ else None,
+ combined_search=get_combined_search_usage(request),
+ )
+
+
+ "/tiers",
+ response=MembershipTiersV2Response,
+ summary="List membership tiers",
+ description="Returns the paid tiers with their monthly prices and perks, and the volunteer tiers, which are "
+ "earned by crawling rather than bought, with what earns each one and its perks.",
+)
+def list_tiers(request):
+ return MembershipTiersV2Response(
+ paid=list_membership_tiers(request),
+ volunteer=[
+ VolunteerTierResponse(
+ tier=info.tier,
+ name=info.tier.label,
+ days_per_month=info.days_per_month,
+ min_results_per_day=info.min_results_per_day,
+ perks=info.perks,
+ )
+ for info in membership.VOLUNTEER_TIERS
+ ],
+ )
diff --git a/mwmbl/platform/schemas.py b/mwmbl/platform/schemas.py
index 0dffa89..772dee6 100644
--- a/mwmbl/platform/schemas.py
+++ b/mwmbl/platform/schemas.py
@@ -79,6 +79,26 @@ class CombinedSearchUsageResponse(Schema):
monthly_limit: int
+class PaidMembershipResponse(Schema):
+ tier: MembershipTier
+ name: str
+ current_period_end: Optional[datetime]
+ cancel_at_period_end: bool
+
+
+class MembershipV2Response(Schema):
+ """Everything the membership page shows: a user can hold a paid and a volunteer membership at once."""
+
+ paid: Optional[PaidMembershipResponse]
+ volunteer: Optional[VolunteerMembershipResponse]
+ combined_search: CombinedSearchUsageResponse
+
+
+class MembershipTiersV2Response(Schema):
+ paid: list[MembershipTierResponse]
+ volunteer: list[VolunteerTierResponse]
+
+
class CombinedSearchPreference(Schema):
enabled: bool
diff --git a/test/test_openapi.py b/test/test_openapi.py
index 88ade65..216957e 100644
--- a/test/test_openapi.py
+++ b/test/test_openapi.py
@@ -211,6 +211,8 @@ def test_v2_openapi_spec_generation():
"/api/v2/combined-search/new-pages",
"/api/v2/combined-search/new-pages/count",
"/api/v2/combined-search/seed-domains",
+ "/api/v2/membership/",
+ "/api/v2/membership/tiers",
}
diff --git a/test/test_volunteer_membership.py b/test/test_volunteer_membership.py
index 3e40a2d..b1f2e6e 100644
--- a/test/test_volunteer_membership.py
+++ b/test/test_volunteer_membership.py
@@ -1,6 +1,6 @@
"""Tests for volunteer tiers earned by crawling."""
-from datetime import date
+from datetime import date, datetime, timezone
from types import SimpleNamespace
from unittest.mock import patch
@@ -184,43 +184,90 @@ def test_the_more_generous_limit_applies(user, today, settings, paid_limit, poll
assert user_combined_search_monthly_limit(user.id) == expected
-def test_list_volunteer_tiers():
- response = Client().get("/api/v1/platform/membership/volunteer-tiers")
+def test_list_tiers():
+ response = Client().get("/api/v2/membership/tiers")
assert response.status_code == 200
- assert response.json()[0] == {
- "tier": "pollinator",
- "name": "Pollinator",
- "days_per_month": 3,
- "min_results_per_day": 100,
- "perks": membership.VOLUNTEER_TIERS[0].perks,
+ body = response.json()
+ assert [tier["tier"] for tier in body["paid"]] == ["sprout", "sapling", "canopy"]
+ assert body["volunteer"] == [
+ {
+ "tier": "pollinator",
+ "name": "Pollinator",
+ "days_per_month": 3,
+ "min_results_per_day": 100,
+ "perks": membership.VOLUNTEER_TIERS[0].perks,
+ }
+ ]
+
+
+def _get_membership(user):
+ with patch("mwmbl.platform.api.get_monthly_combined_search_count", return_value=12):
+ return Client().get("/api/v2/membership/", **auth_headers(user))
+
+
+def test_get_membership_for_a_non_member(user, today):
+ response = _get_membership(user)
+
+ assert response.status_code == 200
+ assert response.json() == {
+ "paid": None,
+ "volunteer": None,
+ "combined_search": {"monthly_usage": 12, "monthly_limit": 30},
}
-def test_get_volunteer_membership(user, today):
+def test_get_membership_for_a_volunteer(user, today):
VolunteerMembership.objects.create(user=user, tier=POLLINATOR, valid_until=date(2026, 11, 30))
- response = Client().get("/api/v1/platform/membership/volunteer", **auth_headers(user))
- assert response.status_code == 200
- assert response.json() == {"tier": "pollinator", "name": "Pollinator", "valid_until": "2026-11-30"}
+ response = _get_membership(user)
+
+ assert response.json() == {
+ "paid": None,
+ "volunteer": {"tier": "pollinator", "name": "Pollinator", "valid_until": "2026-11-30"},
+ "combined_search": {"monthly_usage": 12, "monthly_limit": 300},
+ }
-def test_get_volunteer_membership_returns_the_highest_tier(user, today, two_tiers):
+def test_get_membership_with_paid_and_volunteer_memberships(user, today):
+ Membership.objects.create(
+ user=user,
+ tier=MembershipTier.SAPLING,
+ polar_subscription_id="sub_1",
+ current_period_end=datetime(2026, 11, 3, tzinfo=timezone.utc),
+ )
+ VolunteerMembership.objects.create(user=user, tier=POLLINATOR, valid_until=date(2026, 11, 30))
+
+ body = _get_membership(user).json()
+
+ assert body["paid"] == {
+ "tier": "sapling",
+ "name": "Sapling",
+ "current_period_end": "2026-11-03T00:00:00Z",
+ "cancel_at_period_end": False,
+ }
+ assert body["volunteer"]["tier"] == "pollinator"
+ assert body["combined_search"]["monthly_limit"] == 1_500
+
+
+def test_get_membership_returns_the_highest_volunteer_tier(user, today, two_tiers):
VolunteerMembership.objects.create(user=user, tier="lower", valid_until=date(2026, 12, 31))
VolunteerMembership.objects.create(user=user, tier=POLLINATOR, valid_until=date(2026, 11, 30))
- response = Client().get("/api/v1/platform/membership/volunteer", **auth_headers(user))
- assert response.json()["tier"] == "pollinator"
+ assert _get_membership(user).json()["volunteer"]["tier"] == "pollinator"
-def test_get_volunteer_membership_is_404_once_expired(user, today):
+def test_get_membership_omits_an_expired_volunteer_membership(user, today):
VolunteerMembership.objects.create(user=user, tier=POLLINATOR, valid_until=date(2026, 10, 16))
- response = Client().get("/api/v1/platform/membership/volunteer", **auth_headers(user))
- assert response.status_code == 404
+ assert _get_membership(user).json()["volunteer"] is None
+
+
+def test_get_membership_requires_login(db):
+ assert Client().get("/api/v2/membership/").status_code == 401
-def test_volunteer_membership_is_not_a_paid_membership(user, today):
+def test_v1_membership_ignores_volunteer_memberships(user, today):
VolunteerMembership.objects.create(user=user, tier=POLLINATOR, valid_until=today)
response = Client().get("/api/v1/platform/membership", **auth_headers(user))