autumn-billing 0.10.0

Subscription billing plugin (Stripe checkout, portal, webhook mirror, dunning) for autumn-web applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! Error type for the billing plugin.

use autumn_web::AutumnError;
use thiserror::Error;

use crate::money::MoneyError;

/// A billing failure.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum BillingError {
    /// The plugin configuration is not valid.
    #[error("billing config: {0}")]
    Config(String),
    /// The provider call failed (transport or provider error).
    #[error("billing provider {provider}: {message}")]
    Provider {
        /// Provider name.
        provider: &'static str,
        /// Redacted message. Never contains a secret or a request body.
        message: String,
    },
    /// A known event kind could not be decoded.
    #[error("malformed billing event: {0}")]
    Malformed(String),
    /// The operation is not supported by this provider.
    #[error("unsupported billing operation: {0}")]
    Unsupported(&'static str),
    /// The mirror store failed.
    #[error("billing store: {0}")]
    Store(String),
    /// A record was not found.
    #[error("billing {0} not found")]
    NotFound(&'static str),
    /// The request conflicts with the current state.
    #[error("billing conflict: {0}")]
    Conflict(String),
    /// A money value is not valid.
    #[error(transparent)]
    Money(#[from] MoneyError),
    /// No authenticated user in the session.
    #[error("billing requires an authenticated user")]
    Unauthenticated,
    /// The user has no entitlement for the request.
    #[error("billing forbidden: {0}")]
    Forbidden(String),
}

impl BillingError {
    /// Build a provider error.
    #[must_use]
    pub fn provider(provider: &'static str, message: impl Into<String>) -> Self {
        Self::Provider {
            provider,
            message: message.into(),
        }
    }

    /// Build a store error.
    #[must_use]
    pub fn store(message: impl Into<String>) -> Self {
        Self::Store(message.into())
    }
}

impl BillingError {
    /// Map to an HTTP-shaped [`AutumnError`].
    ///
    /// The blanket `From<E: Error>` on `AutumnError` would give every variant
    /// a 500, so handlers call this instead of `?`.
    #[must_use]
    pub fn into_autumn(self) -> AutumnError {
        let message = self.to_string();
        match self {
            Self::Unauthenticated => AutumnError::unauthorized_msg(message),
            Self::Forbidden(_) => AutumnError::forbidden_msg(message),
            Self::NotFound(_) => AutumnError::not_found_msg(message),
            Self::Conflict(_) => AutumnError::conflict_msg(message),
            Self::Money(_) | Self::Unsupported(_) => AutumnError::bad_request_msg(message),
            Self::Provider { .. } => AutumnError::service_unavailable_msg(message),
            Self::Config(_) | Self::Malformed(_) | Self::Store(_) => {
                AutumnError::internal_server_error_msg(message)
            }
        }
    }
}