Subscriptions: use djstripe for products/features

docs/dev/index.rst

@@ -27,5 +27,6 @@ or taking the open source Read the Docs codebase for your own custom installatio
    i18n
    server-side-search
    search-integration
+   subscriptions
    settings
    tests

docs/dev/subscriptions.rst

@@ -0,0 +1,32 @@
+Subscriptions
+=============
+
+Subscriptions are available on |com_brand|,
+we make use of Stripe to handle the payments and subscriptions.
+
+Local testing
+-------------
+
+To test subscriptions locally, you need to have access to the Stripe account,
+and define the following settings with the keys from Stripe test mode:
+
+- ``STRIPE_SECRET``: https://dashboard.stripe.com/test/apikeys
+- ``STRIPE_TEST_SECRET_KEY``: https://dashboard.stripe.com/test/apikeys
+- ``DJSTRIPE_WEBHOOK_SECRET``: https://dashboard.stripe.com/test/webhooks
+
+To test the webhook locally, you need to run your local instance with ngrok, for example:
+
+.. code-block:: bash
+
+   ngrok http 80
+   inv docker.up --http-domain xxx.ngrok.io
+
+If this is your first time setting up subscriptions, you will to re-sync djstripe with Stripe:
+
+.. code-block:: bash
+
+   inv docker.manage djstripe_sync_models
+
+The subscription settings (``RTD_PRODUCTS``) already mapped to match the Stripe prices from the test mode.
+To subscribe to any plan, you can use any `test card from Stripe <https://stripe.com/docs/testing>`__,
+for example: ``4242 4242 4242 4242`` (use any future date and any value for the other fields).

readthedocs/api/v3/permissions.py

@@ -2,7 +2,7 @@
 
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.subscriptions.constants import TYPE_EMBED_API
-from readthedocs.subscriptions.models import PlanFeature
+from readthedocs.subscriptions.products import get_feature
 
 
 class HasEmbedAPIAccess(BasePermission):
@@ -24,7 +24,7 @@ class HasEmbedAPIAccess(BasePermission):
     def has_permission(self, request, view):
         project = view._get_project()
         # The project is None when the is requesting a section from an external site.
-        if project and not PlanFeature.objects.has_feature(project, TYPE_EMBED_API):
+        if project and not get_feature(project, feature_type=TYPE_EMBED_API):
             return False
         return True
 

readthedocs/api/v3/tests/test_builds.py

@@ -4,16 +4,17 @@
 from django.urls import reverse
 
 from readthedocs.subscriptions.constants import TYPE_CONCURRENT_BUILDS
+from readthedocs.subscriptions.products import RTDProductFeature
 
 from .mixins import APIEndpointMixin
 
 
 @override_settings(
     RTD_ALLOW_ORGANIZATIONS=False,
     ALLOW_PRIVATE_REPOS=False,
-    RTD_DEFAULT_FEATURES={
-        TYPE_CONCURRENT_BUILDS: 4,
-    },
+    RTD_DEFAULT_FEATURES=dict(
+        [RTDProductFeature(TYPE_CONCURRENT_BUILDS, value=4).to_item()]
+    ),
 )
 @mock.patch('readthedocs.projects.tasks.builds.update_docs_task', mock.MagicMock())
 class BuildsEndpointTests(APIEndpointMixin):

readthedocs/builds/tests/test_build_queryset.py

@@ -5,15 +5,16 @@
 from readthedocs.organizations.models import Organization
 from readthedocs.projects.models import Project
 from readthedocs.subscriptions.constants import TYPE_CONCURRENT_BUILDS
+from readthedocs.subscriptions.products import RTDProductFeature
 
 
 @pytest.mark.django_db
 class TestBuildQuerySet:
     @pytest.fixture(autouse=True)
     def setup_method(self, settings):
-        settings.RTD_DEFAULT_FEATURES = {
-            TYPE_CONCURRENT_BUILDS: 4,
-        }
+        settings.RTD_DEFAULT_FEATURES = dict(
+            [RTDProductFeature(type=TYPE_CONCURRENT_BUILDS, value=4).to_item()]
+        )
 
     def test_concurrent_builds(self):
         project = fixture.get(

readthedocs/core/resolver.py

@@ -8,7 +8,7 @@
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.core.utils.url import unsafe_join_url_path
 from readthedocs.subscriptions.constants import TYPE_CNAME
-from readthedocs.subscriptions.models import PlanFeature
+from readthedocs.subscriptions.products import get_feature
 
 log = structlog.get_logger(__name__)
 
@@ -416,7 +416,7 @@ def _use_subdomain(self):
 
     def _use_cname(self, project):
         """Test if to allow direct serving for project on CNAME."""
-        return PlanFeature.objects.has_feature(project, type=TYPE_CNAME)
+        return bool(get_feature(project, feature_type=TYPE_CNAME))
 
 
 class Resolver(SettingsOverrideObject):

readthedocs/embed/tests/test_api.py

@@ -13,6 +13,7 @@
 from readthedocs.projects.constants import MKDOCS, PUBLIC
 from readthedocs.projects.models import Project
 from readthedocs.subscriptions.constants import TYPE_EMBED_API
+from readthedocs.subscriptions.products import RTDProductFeature
 
 data_path = Path(__file__).parent.resolve() / 'data'
 
@@ -34,10 +35,10 @@ def setup_method(self, settings):
         self.version.save()
 
         settings.USE_SUBDOMAIN = True
-        settings.PUBLIC_DOMAIN = 'readthedocs.io'
-        settings.RTD_DEFAULT_FEATURES = {
-            TYPE_EMBED_API: 1,
-        }
+        settings.PUBLIC_DOMAIN = "readthedocs.io"
+        settings.RTD_DEFAULT_FEATURES = dict(
+            [RTDProductFeature(TYPE_EMBED_API).to_item()]
+        )
 
     def get(self, client, *args, **kwargs):
         """Wrapper around ``client.get`` to be overridden in the proxied api tests."""

readthedocs/embed/v3/tests/test_access.py

@@ -12,15 +12,14 @@
 from readthedocs.projects.constants import PRIVATE, PUBLIC
 from readthedocs.projects.models import Project
 from readthedocs.subscriptions.constants import TYPE_EMBED_API
+from readthedocs.subscriptions.products import RTDProductFeature
 
 
 @override_settings(
     USE_SUBDOMAIN=True,
     PUBLIC_DOMAIN="readthedocs.io",
     RTD_ALLOW_ORGAZATIONS=False,
-    RTD_DEFAULT_FEATURES={
-        TYPE_EMBED_API: 1,
-    },
+    RTD_DEFAULT_FEATURES=dict([RTDProductFeature(TYPE_EMBED_API).to_item()]),
 )
 @mock.patch("readthedocs.embed.v3.views.build_media_storage")
 class TestEmbedAPIV3Access(TestCase):

readthedocs/embed/v3/tests/test_internal_pages.py

@@ -11,6 +11,7 @@
 
 from readthedocs.projects.models import Project
 from readthedocs.subscriptions.constants import TYPE_EMBED_API
+from readthedocs.subscriptions.products import RTDProductFeature
 
 from .utils import srcdir
 
@@ -24,9 +25,9 @@ def setup_method(self, settings):
         settings.USE_SUBDOMAIN = True
         settings.PUBLIC_DOMAIN = 'readthedocs.io'
         settings.RTD_EMBED_API_EXTERNAL_DOMAINS = []
-        settings.RTD_DEFAULT_FEATURES = {
-            TYPE_EMBED_API: 1,
-        }
+        settings.RTD_DEFAULT_FEATURES = dict(
+            [RTDProductFeature(TYPE_EMBED_API).to_item()]
+        )
 
         self.api_url = reverse('embed_api_v3')
 

readthedocs/organizations/tests/test_views.py

@@ -17,6 +17,7 @@
 from readthedocs.projects.models import Project
 from readthedocs.rtd_tests.base import RequestFactoryTestMixin
 from readthedocs.subscriptions.constants import TYPE_AUDIT_LOGS
+from readthedocs.subscriptions.products import RTDProductFeature
 
 
 @override_settings(RTD_ALLOW_ORGANIZATIONS=True)
@@ -150,9 +151,9 @@ def test_add_owner(self):
 
 @override_settings(
     RTD_ALLOW_ORGANIZATIONS=True,
-    RTD_DEFAULT_FEATURES={
-        TYPE_AUDIT_LOGS: 90,
-    },
+    RTD_DEFAULT_FEATURES=dict(
+        [RTDProductFeature(type=TYPE_AUDIT_LOGS, value=90).to_item()]
+    ),
 )
 class OrganizationSecurityLogTests(TestCase):
 
@@ -380,9 +381,7 @@ def test_organization_signup(self):
 
 @override_settings(
     RTD_ALLOW_ORGANIZATIONS=True,
-    RTD_DEFAULT_FEATURES={
-        TYPE_AUDIT_LOGS: 90,
-    },
+    RTD_DEFAULT_FEATURES=dict([RTDProductFeature(TYPE_AUDIT_LOGS, value=90).to_item()]),
 )
 class OrganizationUnspecifiedChooser(TestCase):
     def setUp(self):
@@ -428,9 +427,7 @@ def test_choose_organization_edit(self):
 
 @override_settings(
     RTD_ALLOW_ORGANIZATIONS=True,
-    RTD_DEFAULT_FEATURES={
-        TYPE_AUDIT_LOGS: 90,
-    },
+    RTD_DEFAULT_FEATURES=dict([RTDProductFeature(TYPE_AUDIT_LOGS, value=90).to_item()]),
 )
 class OrganizationUnspecifiedSingleOrganizationRedirect(TestCase):
     def setUp(self):
@@ -456,9 +453,7 @@ def test_unspecified_slug_redirects_to_organization_edit(self):
 
 @override_settings(
     RTD_ALLOW_ORGANIZATIONS=True,
-    RTD_DEFAULT_FEATURES={
-        TYPE_AUDIT_LOGS: 90,
-    },
+    RTD_DEFAULT_FEATURES=dict([RTDProductFeature(TYPE_AUDIT_LOGS, value=90).to_item()]),
 )
 class OrganizationUnspecifiedNoOrganizationRedirect(TestCase):
     def setUp(self):

readthedocs/organizations/views/private.py

@@ -30,7 +30,7 @@
 )
 from readthedocs.projects.utils import get_csv_file
 from readthedocs.subscriptions.constants import TYPE_AUDIT_LOGS
-from readthedocs.subscriptions.models import PlanFeature
+from readthedocs.subscriptions.products import get_feature
 
 
 # Organization views
@@ -265,8 +265,9 @@ def _get_csv_data(self):
     def get_context_data(self, **kwargs):
         organization = self.get_organization()
         context = super().get_context_data(**kwargs)
-        context["enabled"] = self._is_feature_enabled(organization)
-        context["days_limit"] = self._get_retention_days_limit(organization)
+        feature = self._get_feature(organization)
+        context["enabled"] = bool(feature)
+        context["days_limit"] = feature.value if feature else 0
         context["filter"] = self.filter
         context["AuditLog"] = AuditLog
         return context
@@ -275,18 +276,17 @@ def _get_start_date(self):
         """Get the date to show logs from."""
         organization = self.get_organization()
         creation_date = organization.pub_date.date()
-        retention_limit = self._get_retention_days_limit(organization)
-        if retention_limit in [None, -1]:
-            # Unlimited.
+        feature = self._get_feature(organization)
+        if feature.unlimited:
             return creation_date
-        start_date = timezone.now().date() - timezone.timedelta(days=retention_limit)
+        start_date = timezone.now().date() - timezone.timedelta(days=feature.value)
         # The max we can go back is to the creation of the organization.
         return max(start_date, creation_date)
 
     def _get_queryset(self):
         """Return the queryset without filters."""
         organization = self.get_organization()
-        if not self._is_feature_enabled(organization):
+        if not self._get_feature(organization):
             return AuditLog.objects.none()
         start_date = self._get_start_date()
         queryset = AuditLog.objects.filter(
@@ -308,22 +308,11 @@ def get_queryset(self):
         queryset = self._get_queryset()
         # Set filter on self, so we can use it in the context.
         # Without executing it twice.
-        # pylint: disable=attribute-defined-outside-init
         self.filter = OrganizationSecurityLogFilter(
             self.request.GET,
             queryset=queryset,
         )
         return self.filter.qs
 
-    def _get_retention_days_limit(self, organization):
-        """From how many days we need to show data for this organization?"""
-        return PlanFeature.objects.get_feature_value(
-            organization,
-            type=self.feature_type,
-        )
-
-    def _is_feature_enabled(self, organization):
-        return PlanFeature.objects.has_feature(
-            organization,
-            type=self.feature_type,
-        )
+    def _get_feature(self, organization):
+        return get_feature(organization, self.feature_type)

readthedocs/projects/querysets.py

@@ -5,6 +5,7 @@
 from readthedocs.core.permissions import AdminPermission
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.projects import constants
+from readthedocs.subscriptions.products import get_feature
 
 
 class ProjectQuerySetBase(models.QuerySet):
@@ -105,20 +106,18 @@ def max_concurrent_builds(self, project):
         :rtype: int
         """
         from readthedocs.subscriptions.constants import TYPE_CONCURRENT_BUILDS
-        from readthedocs.subscriptions.models import PlanFeature
 
         max_concurrent_organization = None
         organization = project.organizations.first()
         if organization:
             max_concurrent_organization = organization.max_concurrent_builds
 
+        feature = get_feature(project, feature_type=TYPE_CONCURRENT_BUILDS)
+        feature_value = feature.value if feature else 1
         return (
             project.max_concurrent_builds
             or max_concurrent_organization
-            or PlanFeature.objects.get_feature_value(
-                project,
-                type=TYPE_CONCURRENT_BUILDS,
-            )
+            or feature_value
         )
 
     def prefetch_latest_build(self):

readthedocs/projects/tests/test_domain_views.py

@@ -6,10 +6,13 @@
 from readthedocs.organizations.models import Organization
 from readthedocs.projects.models import Domain, Project
 from readthedocs.subscriptions.constants import TYPE_CNAME
-from readthedocs.subscriptions.models import Plan, PlanFeature, Subscription
+from readthedocs.subscriptions.products import RTDProductFeature
 
 
-@override_settings(RTD_ALLOW_ORGANIZATIONS=False)
+@override_settings(
+    RTD_ALLOW_ORGANIZATIONS=False,
+    RTD_DEFAULT_FEATURES=dict([RTDProductFeature(type=TYPE_CNAME).to_item()]),
+)
 class TestDomainViews(TestCase):
     def setUp(self):
         self.user = get(User, username="user")
@@ -103,17 +106,3 @@ def setUp(self):
         self.org = get(
             Organization, owners=[self.user], projects=[self.project, self.subproject]
         )
-        self.plan = get(
-            Plan,
-            published=True,
-        )
-        self.subscription = get(
-            Subscription,
-            plan=self.plan,
-            organization=self.org,
-        )
-        self.feature = get(
-            PlanFeature,
-            plan=self.plan,
-            feature_type=TYPE_CNAME,
-        )