stackless-integrations 0.3.0

Hosted integration routing for stackless
Documentation
//! `postalform/mail` integration.

use std::collections::BTreeMap;

use serde::Serialize;
use stackless_stripe_projects::catalog::verify::CatalogService;
use stackless_stripe_projects::provision::ProvisionContext;

use super::FamilyResource;
use crate::error::IntegrationError;
use crate::hostable::{ConfigScope, Hostable, IntegrationHosting};

pub const RESOURCE_KIND: &str = "integration-postalform";

#[derive(Debug, Serialize)]
pub struct PostalFormMailConfig {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub webhook_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub workspace_name: Option<String>,
}

impl CatalogService for PostalFormMailConfig {
    const REFERENCE: &'static str = "postalform/mail";
}

#[derive(Debug)]
pub struct PostalFormMail;

impl Hostable for PostalFormMail {
    const PROVIDER: &'static str = "postalform";
    const HOSTING: IntegrationHosting = IntegrationHosting::Managed;
    const CONFIG_SCOPE: ConfigScope = ConfigScope::GlobalOnly;
    const RESOURCE_KIND: &'static str = RESOURCE_KIND;
    const OUTPUTS: &'static [&'static str] = &[
        "api_base",
        "billing",
        "credentials",
        "dashboard_url",
        "env",
        "environment",
        "environment_variables",
        "resource_id",
        "webhooks",
        "workspace_id",
    ];
}

impl FamilyResource for PostalFormMail {
    type Config = PostalFormMailConfig;
    const PROVIDER_PREFIX: &'static str = "POSTALFORM";
    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] = &[
        ("API_BASE", "api_base", true),
        ("BILLING", "billing", true),
        ("CREDENTIALS", "credentials", true),
        ("DASHBOARD_URL", "dashboard_url", true),
        ("ENV", "env", true),
        ("ENVIRONMENT", "environment", true),
        ("ENVIRONMENT_VARIABLES", "environment_variables", true),
        ("RESOURCE_ID", "resource_id", true),
        ("WEBHOOKS", "webhooks", true),
        ("WORKSPACE_ID", "workspace_id", true),
    ];

    fn build_config(ctx: &ProvisionContext<'_>) -> Result<PostalFormMailConfig, IntegrationError> {
        let config = super::integration_config(ctx)?;
        Ok(PostalFormMailConfig {
            webhook_url: super::interp_optional(ctx, &config, "webhook_url")?,
            workspace_name: super::interp_optional(ctx, &config, "workspace_name")?,
        })
    }
}

pub fn validate_config(
    name: &str,
    config: &BTreeMap<String, toml::Value>,
) -> Result<(), IntegrationError> {
    let _ = (name, config);
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ProviderOps;
    use crate::resource::ResourcePayload;
    use stackless_core::def::StackDef;
    use stackless_stripe_projects::stripe::StripeProjects;
    use stackless_stripe_projects::test_support;

    #[test]
    fn config_matches_catalog() {
        const FIXTURE: &str = include_str!(concat!(
            env!("CARGO_MANIFEST_DIR"),
            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
        ));
        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
        let failures = stackless_stripe_projects::verify_service(
            &catalog,
            &PostalFormMailConfig {
                webhook_url: None,
                workspace_name: None,
            },
        );
        assert!(
            failures.is_empty(),
            "postalform/mail catalog gaps:\n{}",
            failures.join("\n")
        );
    }

    const CATALOG_ENVELOPE: &str = r##"{"ok":true,"command":"projects catalog","data":{"last_updated":"2026-07-11T00:00:00Z","services":[{"id":"prvsvc_mail","object":"v2.provisioning.provider_service_detail","provider_id":"prvdr_postalform","provider_name":"PostalForm","service_id":"mail","categories":["database"],"kind":"deployable","scope":"project","availability":"available","development":false,"livemode":true,"pricing":{"type":"paid"},"configuration_schema":{"additionalProperties":true,"properties":{"webhook_url":{"description":"Optional HTTPS endpoint that receives signed PostalForm status webhooks. If supplied, PostalForm creates or reuses a webhook endpoint and returns its signing secret in the access configuration.","pattern":"^https://","type":"string"},"workspace_name":{"description":"Optional display name for the PostalForm Projects workspace.","type":"string"}},"type":"object"}}]}}"##;

    fn test_def() -> StackDef {
        StackDef::parse(
            r#"
[stack]
name = "atto"
[stack.projects.stripe]
project = "project_1"
[integrations.res]
provider = "postalform"
[services.api]
source = { repo = "r", ref = "main" }
env = { OUT = "${integrations.res.api_base}" }
health = { path = "/health" }
[services.api.local]
run = "true"
"#,
        )
        .unwrap()
    }

    #[tokio::test]
    async fn provision_records_outputs() {
        let runner = test_support::provision_script(
            CATALOG_ENVELOPE,
            serde_json::json!({"POSTALFORM_API_BASE": "val_api_base", "POSTALFORM_BILLING": "val_billing", "POSTALFORM_CREDENTIALS": "val_credentials", "POSTALFORM_DASHBOARD_URL": "val_dashboard_url", "POSTALFORM_ENV": "val_env", "POSTALFORM_ENVIRONMENT": "val_environment", "POSTALFORM_ENVIRONMENT_VARIABLES": "val_environment_variables", "POSTALFORM_RESOURCE_ID": "val_resource_id", "POSTALFORM_WEBHOOKS": "val_webhooks", "POSTALFORM_WORKSPACE_ID": "val_workspace_id"}),
            0,
        );
        let dir = tempfile::tempdir().unwrap();
        std::fs::write(
            dir.path().join("stackless.toml"),
            "[stack]\nname=\"atto\"\n",
        )
        .unwrap();
        let stripe = StripeProjects::new(&runner, dir.path());

        let resource = PostalFormMail
            .provision(
                &stripe.as_dyn(),
                &test_def(),
                dir.path(),
                "demo",
                "res",
                "local",
                false,
            )
            .await
            .unwrap();
        assert_eq!(resource.resource_kind, "integration-postalform");
        let payload: ResourcePayload = serde_json::from_str(&resource.payload).unwrap();
        assert_eq!(payload.outputs["api_base"], "val_api_base");
        assert_eq!(payload.outputs["billing"], "val_billing");
        assert_eq!(payload.outputs["credentials"], "val_credentials");
        assert_eq!(payload.outputs["dashboard_url"], "val_dashboard_url");
        assert_eq!(payload.outputs["env"], "val_env");
        assert_eq!(payload.outputs["environment"], "val_environment");
        assert_eq!(
            payload.outputs["environment_variables"],
            "val_environment_variables"
        );
        assert_eq!(payload.outputs["resource_id"], "val_resource_id");
        assert_eq!(payload.outputs["webhooks"], "val_webhooks");
        assert_eq!(payload.outputs["workspace_id"], "val_workspace_id");
    }
}