Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

5.1 KB
Raw Blame
from typing import Optional, cast

from products.warehouse_sources.sources.sdk import (
    CanonicalDescriptions,
    DataWarehouseSourceCategory,
    ExternalDataSourceType,
    FieldType,
    ReleaseStatus,
    ResumableSource,
    ResumableSourceManager,
    SourceConfig,
    SourceFieldInputConfig,
    SourceFieldInputConfigType,
    SourceInputs,
    SourceRegistry,
    SourceResponse,
    SourceSchema,
    build_endpoint_schemas,
    detect,
)
from products.warehouse_sources.sources.simplecast._config import SimpleCastSourceConfig
from products.warehouse_sources.sources.simplecast.settings import (
    DEFAULT_VERSION,
    ENDPOINTS,
    INCREMENTAL_FIELDS,
    SIMPLECAST_ENDPOINTS,
    SUPPORTED_VERSIONS,
)
from products.warehouse_sources.sources.simplecast.simplecast import (
    SimpleCastResumeConfig,
    simplecast_source,
    validate_credentials as _validate_credentials,
)


@SourceRegistry.register
class SimpleCastSource(ResumableSource[SimpleCastSourceConfig, SimpleCastResumeConfig]):
    codebase_detection = detect(env=("^(SIMPLE_CAST|SIMPLECAST)_",))

    api_docs_url = "https://apidocs.simplecast.com"

    supported_versions = SUPPORTED_VERSIONS
    default_version = DEFAULT_VERSION

    lists_tables_without_credentials = True  # static endpoint catalog — safe for public docs

    @property
    def source_type(self) -> ExternalDataSourceType:
        return ExternalDataSourceType.SIMPLECAST

    @property
    def get_source_config(self) -> SourceConfig:
        return SourceConfig(
            name=ExternalDataSourceType.SIMPLECAST,
            category=DataWarehouseSourceCategory.MARKETING___EMAIL,
            label="SimpleCast",
            releaseStatus=ReleaseStatus.BETA,
            caption="""Enter your Simplecast API token to pull your podcast data into the PostHog Data warehouse.

You can create an API token on the **Private Apps** page in [Simplecast](https://dashboard.simplecast.com). The token grants read access to the podcasts your account can see.
""",
            iconPath="/static/services/simplecast.png",
            docsUrl="https://posthog.com/docs/cdp/sources/simplecast",
            fields=cast(
                list[FieldType],
                [
                    SourceFieldInputConfig(
                        name="api_key",
                        label="API token",
                        type=SourceFieldInputConfigType.PASSWORD,
                        required=True,
                        placeholder="",
                        secret=True,
                    ),
                ],
            ),
        )

    def get_canonical_descriptions(self) -> CanonicalDescriptions:
        from products.warehouse_sources.sources.simplecast.canonical_descriptions import (
            CANONICAL_DESCRIPTIONS,  # noqa: PLC0415
        )

        return CANONICAL_DESCRIPTIONS

    def get_non_retryable_errors(self) -> dict[str, str | None]:
        return {
            "401 Client Error: Unauthorized for url: https://api.simplecast.com": "Your Simplecast API token is invalid or has been revoked. Generate a new token on the Private Apps page, then reconnect.",
            "403 Client Error: Forbidden for url: https://api.simplecast.com": "Your Simplecast API token does not have access to this data. Check the token's permissions, then reconnect.",
        }

    def get_schemas(
        self,
        config: SimpleCastSourceConfig,
        team_id: int,
        with_counts: bool = False,
        names: list[str] | None = None,
        force_refresh: bool = False,
        api_version: str | None = None,
    ) -> list[SourceSchema]:
        # Every endpoint is full refresh only — Simplecast's list endpoints expose no reliably
        # ordered server-side timestamp filter, so there is no incremental cursor to advance.
        return build_endpoint_schemas(ENDPOINTS, INCREMENTAL_FIELDS, names)

    def validate_credentials(
        self,
        config: SimpleCastSourceConfig,
        team_id: int,
        schema_name: Optional[str] = None,
        api_version: str | None = None,
    ) -> tuple[bool, str | None]:
        # The token is account-wide, so a single probe validates access to every schema.
        return _validate_credentials(config.api_key)

    def get_resumable_source_manager(self, inputs: SourceInputs) -> ResumableSourceManager[SimpleCastResumeConfig]:
        return ResumableSourceManager[SimpleCastResumeConfig](inputs, SimpleCastResumeConfig)

    def source_for_pipeline(
        self,
        config: SimpleCastSourceConfig,
        resumable_source_manager: ResumableSourceManager[SimpleCastResumeConfig],
        inputs: SourceInputs,
    ) -> SourceResponse:
        if inputs.schema_name not in SIMPLECAST_ENDPOINTS:
            raise ValueError(f"Unknown Simplecast schema '{inputs.schema_name}'")

        return simplecast_source(
            api_key=config.api_key,
            endpoint=inputs.schema_name,
            team_id=inputs.team_id,
            job_id=inputs.job_id,
            resumable_source_manager=resumable_source_manager,
            db_incremental_field_last_value=None,  # every Simplecast endpoint is full refresh
        )