feat: setup stripe subscriptions

The abstractions are leaky though. Unless you add the concepts of a customer/id and price_id to the basic subscription domain.

app/subscription is for most subscription apis, but there's also app/subscription_portal which just sends users to stripe to handle checkout.

Webhooks are the same either way, but if developing the UI in-house, you wouldn't use app/subscription_portal services.

Author: jifalops

.devcontainer/.env.example

@@ -1,5 +1,18 @@
+# This file is used by ./docker-compose.yml.
+
 # Host ports
-HOST_API_PORT=8000
+#
+# For avoiding conflicts on the host machine.
+HOST_API_DEV_PORT=8000      # Dev server
+HOST_API_DOCKER_PORT=8001   # Docker preview
+HOST_API_SAM_PORT=8002      # AWS SAM preview
 HOST_POSTGRES_PORT=5432
 HOST_NEO4J_PORT=7687
-HOST_NEO4J_BROWSER_PORT=7474
+HOST_NEO4J_BROWSER_PORT=7474
+
+# Stripe test keys
+#
+# These can be shared with developers, but should not be public.
+STRIPE_PUBLIC_KEY=pk_test_   # From Stripe dashboard
+STRIPE_SECRET_KEY=sk_test_   # From Stripe dashboard
+STRIPE_WEBHOOK_SECRET=whsec_ # From Stripe CLI

.devcontainer/Dockerfile

@@ -5,7 +5,7 @@ FROM jifalops/python-lambda:latest
 RUN export DEBIAN_FRONTEND=noninteractive && sudo apt-get update && sudo apt-get install -y --no-install-recommends \
     trash-cli
 
-# Install neo4j-migrations
+# Install neo4j-migrations (The SDKMAN installer on https://containers.dev/features is extremely slow)
 RUN VERSION=$(basename $(curl -Ls -o /dev/null -w %{url_effective} https://github.com/michael-simons/neo4j-migrations/releases/latest)) && \
     ZIP_LINUX=https://github.com/michael-simons/neo4j-migrations/releases/download/${VERSION}/neo4j-migrations-${VERSION}-linux-x86_64.zip && \
     curl -L $ZIP_LINUX -o nmig.zip && \

.devcontainer/devcontainer.json

@@ -7,6 +7,9 @@
   "initializeCommand": ".devcontainer/host-init.sh",
   "postCreateCommand": ".devcontainer/post-create.sh",
   "postStartCommand": ".devcontainer/post-start.sh",
+  "features": {
+    "ghcr.io/nullcoder/devcontainer-features/stripe-cli:1": {}
+  },
   "customizations": {
     "vscode": {
       "settings": {

.devcontainer/docker-compose.yml

@@ -4,21 +4,30 @@ services:
       context: ..
       dockerfile: .devcontainer/Dockerfile
     ports:
-      - ${HOST_API_PORT}:8000
+      - ${HOST_API_DEV_PORT}:8000
+      - ${HOST_API_DOCKER_PORT}:8001
+      - ${HOST_API_SAM_PORT}:8002
     command: sleep infinity
     depends_on:
       - postgres
       - neo4j
     volumes:
       - ..:/api-python:cached
     environment:
-      TZ: ${TZ} # Timezone
+      # From host machine
+      TZ: ${TZ}                     # Timezone
       GITHUB_TOKEN: ${GITHUB_TOKEN} # Github CLI
-      LOGGING_LEVEL: DEBUG # Python logging
-      HOST_API_PORT: ${HOST_API_PORT}
+      # Python
+      LOGGING_LEVEL: DEBUG
+      # Postgres
       POSTGRES_URI: postgresql://postgres:developer@postgres:5432/postgres
+      # Neo4j
       NEO4J_URI: neo4j://neo4j:7687
       NEO4J_PASSWORD: developer
+      # Stripe (test mode)
+      STRIPE_PUBLIC_KEY: ${STRIPE_PUBLIC_KEY}
+      STRIPE_SECRET_KEY: ${STRIPE_SECRET_KEY}
+      STRIPE_WEBHOOK_SECRET: ${STRIPE_WEBHOOK_SECRET}
 
   postgres:
     image: postgres

.devcontainer/post-create.sh

@@ -21,3 +21,8 @@ fi
 
 # Activate the virtual environment.
 echo "source \"$(pwd)/.venv/bin/activate\"" >> ~/.bashrc
+
+# Add bash completion for the Stripe CLI.
+mkdir -p ~/.local/share/bash-completion/completions && \
+stripe completion --shell bash && \
+mv stripe-completion.bash ~/.local/share/bash-completion/completions/stripe

.env.example

@@ -1,20 +1,34 @@
-# Define development environment variables in a bash-compliant format.
+# This file is sourced by bash scripts in the ./scripts/admin directory.
 
-# AWS config for local administration.
+# Config for the AWS and SAM CLIs (`aws` and `sam`).
 AWS_ACCESS_KEY_ID=''
 AWS_SECRET_ACCESS_KEY=''
 AWS_DEFAULT_REGION=''
 AWS_DEFAULT_OUTPUT='json'
 
-# Visit the endpoint at least once to generate some logs, then:
-# aws logs describe-log-groups | grep api-python
-PROD_LAMBDA_LOG_GROUP='api-python-ApiFunction-XXXXXXXXXXXX'
+# Environment variables for the API when deployed manually.
+PROD_LOGGING_LEVEL='INFO'
+PROD_WORKERS=1
+PROD_POSTGRES_URI=''
+PROD_NEO4J_URI=''
+PROD_NEO4J_PASSWORD=''
 
+# The API Gateway endpoint URL. Clients can use this to interact with the API.
+#
+# ```sh
 # aws apigatewayv2 get-apis --query 'Items[?Name==`api-python`].ApiEndpoint' --output text
-PROD_API_URL=''
+# ```
+PROD_API_URL_AWS=''
 
-PROD_LOGGING_LEVEL='INFO'
-PROD_WORKERS=1
-PROD_POSTGRES_URI='postgres://postgres:password@host:5432/postgres'
-PROD_NEO4J_URI='neo4j://neo4j:7687'
-PROD_NEO4J_PASSWORD='password'
+# The CloudWatch log group for the Lambda function.
+#
+# You may need to visit the API endpoint before logs are generated.
+#
+# ```sh
+# aws logs describe-log-groups | grep api-python
+# ```
+PROD_LAMBDA_LOG_GROUP=''
+
+# Stripe production keys
+PROD_STRIPE_SECRET_KEY=''
+PROD_STRIPE_WEBHOOK_SECRET=''

.gitignore

@@ -7,4 +7,5 @@ __pycache__
 .env
 .env.*
 !.env.example
-.aws-sam
+.aws-sam
+Pipfile*

.vscode/settings.json

@@ -35,19 +35,29 @@
     {
       "splitTerminals": [
         {
-          "name": "preview Docker",
+          "name": "Docker preview",
           "commands": [
             "./scripts/preview_docker.sh"
           ]
         },
         {
-          "name": "preview SAM",
+          "name": "SAM preview",
           "commands": [
             "./scripts/preview_sam.sh"
           ]
         },
       ]
     },
+    {
+      "splitTerminals": [
+        {
+          "name": "stripe",
+          "commands": [
+            "./scripts/stripe-listen.sh"
+          ]
+        },
+      ]
+    },
     {
       "splitTerminals": [
         {

app/app.py

@@ -1,8 +1,10 @@
 from dataclasses import dataclass
-from typing import List
 
 from app.auth.service import AuthService
-from app.base_service import BaseService
+from app.service import Service
+from app.subscription.service import SubscriptionService
+from app.subscription_portal.service import SubscriptionPortalService
+from app.user.service import UserService
 
 
 @dataclass
@@ -14,10 +16,16 @@ class App:
     """
 
     auth: AuthService
+    subscription: SubscriptionService
+    subscription_portal: SubscriptionPortalService
+    user: UserService
 
     def __post_init__(self):
-        self._services: List[BaseService] = [
+        self._services: list[Service] = [
             self.auth,
+            self.subscription,
+            self.subscription_portal,
+            self.user,
         ]
         for service in self._services:
             service._set_app(self)  # type: ignore

app/auth/service.py

@@ -1,11 +1,21 @@
+import logging
+from typing import Optional
+
 import shortuuid
 
 from app.auth.models import SignUpData
-from app.base_service import BaseService
+from app.service import Service
+from app.subscription.models import SubscriptionLevel
 
 
-class AuthService(BaseService):
+class AuthService(Service):
     """The service that contains the core business logic for authentication."""
 
     async def sign_up(self, data: SignUpData) -> str:
         return f"user_{shortuuid.uuid()}"
+
+    async def set_subscription_level(
+        self, user_id: str, level: Optional[SubscriptionLevel]
+    ) -> None:
+        logging.debug(f"Setting subscription level for user {user_id} to {level}")
+        # raise NotImplementedError()