Skip to main content

stackless_integrations/providers/postalform/
mail.rs

1//! `postalform/mail` integration.
2
3use std::collections::BTreeMap;
4
5use serde::Serialize;
6use stackless_stripe_projects::catalog::verify::CatalogService;
7use stackless_stripe_projects::provision::ProvisionContext;
8
9use super::FamilyResource;
10use crate::error::IntegrationError;
11use crate::hostable::{ConfigScope, Hostable, IntegrationHosting};
12
13pub const RESOURCE_KIND: &str = "integration-postalform";
14
15#[derive(Debug, Serialize)]
16pub struct PostalFormMailConfig {
17    #[serde(skip_serializing_if = "Option::is_none")]
18    pub webhook_url: Option<String>,
19    #[serde(skip_serializing_if = "Option::is_none")]
20    pub workspace_name: Option<String>,
21}
22
23impl CatalogService for PostalFormMailConfig {
24    const REFERENCE: &'static str = "postalform/mail";
25}
26
27#[derive(Debug)]
28pub struct PostalFormMail;
29
30impl Hostable for PostalFormMail {
31    const PROVIDER: &'static str = "postalform";
32    const HOSTING: IntegrationHosting = IntegrationHosting::Managed;
33    const CONFIG_SCOPE: ConfigScope = ConfigScope::GlobalOnly;
34    const RESOURCE_KIND: &'static str = RESOURCE_KIND;
35    const OUTPUTS: &'static [&'static str] = &[
36        "api_base",
37        "billing",
38        "credentials",
39        "dashboard_url",
40        "env",
41        "environment",
42        "environment_variables",
43        "resource_id",
44        "webhooks",
45        "workspace_id",
46    ];
47}
48
49impl FamilyResource for PostalFormMail {
50    type Config = PostalFormMailConfig;
51    const PROVIDER_PREFIX: &'static str = "POSTALFORM";
52    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] = &[
53        ("API_BASE", "api_base", true),
54        ("BILLING", "billing", true),
55        ("CREDENTIALS", "credentials", true),
56        ("DASHBOARD_URL", "dashboard_url", true),
57        ("ENV", "env", true),
58        ("ENVIRONMENT", "environment", true),
59        ("ENVIRONMENT_VARIABLES", "environment_variables", true),
60        ("RESOURCE_ID", "resource_id", true),
61        ("WEBHOOKS", "webhooks", true),
62        ("WORKSPACE_ID", "workspace_id", true),
63    ];
64
65    fn build_config(ctx: &ProvisionContext<'_>) -> Result<PostalFormMailConfig, IntegrationError> {
66        let config = super::integration_config(ctx)?;
67        Ok(PostalFormMailConfig {
68            webhook_url: super::interp_optional(ctx, &config, "webhook_url")?,
69            workspace_name: super::interp_optional(ctx, &config, "workspace_name")?,
70        })
71    }
72}
73
74pub fn validate_config(
75    name: &str,
76    config: &BTreeMap<String, toml::Value>,
77) -> Result<(), IntegrationError> {
78    let _ = (name, config);
79    Ok(())
80}
81
82#[cfg(test)]
83mod tests {
84    use super::*;
85    use crate::ProviderOps;
86    use crate::resource::ResourcePayload;
87    use stackless_core::def::StackDef;
88    use stackless_stripe_projects::stripe::StripeProjects;
89    use stackless_stripe_projects::test_support;
90
91    #[test]
92    fn config_matches_catalog() {
93        const FIXTURE: &str = include_str!(concat!(
94            env!("CARGO_MANIFEST_DIR"),
95            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
96        ));
97        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
98        let failures = stackless_stripe_projects::verify_service(
99            &catalog,
100            &PostalFormMailConfig {
101                webhook_url: None,
102                workspace_name: None,
103            },
104        );
105        assert!(
106            failures.is_empty(),
107            "postalform/mail catalog gaps:\n{}",
108            failures.join("\n")
109        );
110    }
111
112    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"}}]}}"##;
113
114    fn test_def() -> StackDef {
115        StackDef::parse(
116            r#"
117[stack]
118name = "atto"
119[stack.projects.stripe]
120project = "project_1"
121[integrations.res]
122provider = "postalform"
123[services.api]
124source = { repo = "r", ref = "main" }
125env = { OUT = "${integrations.res.api_base}" }
126health = { path = "/health" }
127[services.api.local]
128run = "true"
129"#,
130        )
131        .unwrap()
132    }
133
134    #[tokio::test]
135    async fn provision_records_outputs() {
136        let runner = test_support::provision_script(
137            CATALOG_ENVELOPE,
138            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"}),
139            0,
140        );
141        let dir = tempfile::tempdir().unwrap();
142        std::fs::write(
143            dir.path().join("stackless.toml"),
144            "[stack]\nname=\"atto\"\n",
145        )
146        .unwrap();
147        let stripe = StripeProjects::new(&runner, dir.path());
148
149        let resource = PostalFormMail
150            .provision(
151                &stripe.as_dyn(),
152                &test_def(),
153                dir.path(),
154                "demo",
155                "res",
156                "local",
157                false,
158            )
159            .await
160            .unwrap();
161        assert_eq!(resource.resource_kind, "integration-postalform");
162        let payload: ResourcePayload = serde_json::from_str(&resource.payload).unwrap();
163        assert_eq!(payload.outputs["api_base"], "val_api_base");
164        assert_eq!(payload.outputs["billing"], "val_billing");
165        assert_eq!(payload.outputs["credentials"], "val_credentials");
166        assert_eq!(payload.outputs["dashboard_url"], "val_dashboard_url");
167        assert_eq!(payload.outputs["env"], "val_env");
168        assert_eq!(payload.outputs["environment"], "val_environment");
169        assert_eq!(
170            payload.outputs["environment_variables"],
171            "val_environment_variables"
172        );
173        assert_eq!(payload.outputs["resource_id"], "val_resource_id");
174        assert_eq!(payload.outputs["webhooks"], "val_webhooks");
175        assert_eq!(payload.outputs["workspace_id"], "val_workspace_id");
176    }
177}