Merge pull request #93 from Sovereign-Engineering/primary-funding

Add flag for primary funding method.

Author: kevincox

src/cmd/account/info.rs

@@ -25,6 +25,7 @@ fn test_account_info_json() {
           "subscription": null,
           "apple_subscription": null,
           "google_subscription": null,
+          "primary_funding": "top_up",
           "monero_pending_payments": [{
             "id": "asdas",
             "status": "confirming"

src/types.rs

@@ -75,6 +75,16 @@ pub struct AccountInfo {
     #[serde(default)]
     pub google_subscription: Option<GoogleSubscriptionInfo>,
     pub monero_pending_payments: Vec<MoneroPaymentInProgress>,
+
+    /// The most relevant funding method for the account.
+    ///
+    /// This is not specifically defined and the policy may change over time as payment methods and implementations change. However it is the go-to field for what funding method should be highlighted in any sort of interface that doesn't list them all.
+    ///
+    /// Invariants:
+    /// - If the account is active this will point at an active method.
+    /// - If this is `None` the account has never been funded or hasn't been funded recently.
+    pub primary_funding: Option<FundingMethod>,
+
     pub stripe_subscription: Option<StripeSubscriptionInfo>,
     #[cfg(feature = "server")]
     pub subscription: Option<StripeSubscriptionInfo>,
@@ -97,6 +107,44 @@ pub struct AccountInfo {
     pub auto_renews: Option<i64>,
 }
 
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(rename_all = "snake_case")]
+pub enum FundingMethod {
+    AppleSubscription,
+    GoogleSubscription,
+    StripeSubscription,
+    TopUp,
+
+    /// The client doesn't understand the funding method. Never emitted.
+    #[serde(other)]
+    Unknown,
+}
+
+#[test]
+fn test_funding_method() {
+    assert_eq!(serde_json::to_string(&FundingMethod::TopUp).unwrap(), r#""top_up""#,);
+
+    assert_eq!(
+        serde_json::from_str::<FundingMethod>(
+            r#"
+                "top_up"
+            "#
+        )
+        .unwrap(),
+        FundingMethod::TopUp,
+    );
+
+    assert_eq!(
+        serde_json::from_str::<FundingMethod>(
+            r#"
+                "snail_mail"
+            "#
+        )
+        .unwrap(),
+        FundingMethod::Unknown,
+    );
+}
+
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct TopUp {
     pub active: bool,