Merge pull request #95 from Sovereign-Engineering/account-create-api

Add an account creation API.

Author: kevincox

doc/account-creation.md

@@ -2,7 +2,7 @@
 
 Authentication is a simple process.
 
-1. [Create an account](crate::doc::account_creation).
+1. [Create an account](crate::cmd::CreateAccount).
 2. [Exchange Account Number for an auth token](crate::token::AcquireToken).
 3. [Make requests with the auth token.](crate::token::AcquireToken2Output::auth_token)
 

doc/auth.md

@@ -13,6 +13,7 @@ This API is only officially supported for our partners. If you are interested in
 This documentation will be critical to understanding how to manage funding.
 
 - [Account Number](crate::types::AccountId)
+- [Account Creation](crate::cmd::CreateAccount)
 - [Authentication](crate::doc::auth)
 - [Errors](crate::doc::error)
 - [Making Requests](crate::doc::requests)

doc/payments.md

@@ -190,7 +190,7 @@ async fn main() -> anyhow::Result<()> {
         }
         Commands::UseReferralCode { code } => {
             eprintln!("Use referral code: {}", &code);
-            client.run(UseReferralCode { code }).await?;
+            client.run(UseReferralCode { code: ReferralCode(code) }).await?;
         }
         Commands::RotateReferralCode => {
             eprintln!("Rotate referral code");

examples/api_cli.rs

@@ -125,7 +125,7 @@ impl Client {
     pub async fn acquire_auth_token(&self) -> Result<AcquireToken2Output, ClientError> {
         if let Some(auth_token) = self.get_auth_token() {
             return Ok(AcquireToken2Output {
-                auth_token: auth_token.into(),
+                auth_token,
                 url_override: None,
             });
         }
@@ -134,7 +134,7 @@ impl Client {
 
         if let Some(auth_token) = self.get_auth_token() {
             return Ok(AcquireToken2Output {
-                auth_token: auth_token.into(),
+                auth_token,
                 url_override: None,
             });
         }
@@ -143,7 +143,7 @@ impl Client {
 
         let res = self.request_token(&self.account_id).await?;
         let body = res.into_body().context("No auth token in response")?;
-        self.set_auth_token(Some(body.auth_token.clone().into()));
+        self.set_auth_token(Some(body.auth_token.clone()));
 
         drop(acquiring_auth_token);
         Ok(body)
@@ -270,7 +270,7 @@ impl Client {
             .transpose()
             .map_err(|_| ClientError::InvalidHeaderValue)?;
         for _ in 0..3 {
-            let auth_token = self.acquire_auth_token().await?.auth_token.into();
+            let auth_token = self.acquire_auth_token().await?.auth_token;
             if let Some(output) = self.run_once::<C>(&cmd, &auth_token, etag.clone()).await? {
                 return Ok(output);
             }

src/client.rs

@@ -0,0 +1,49 @@
+use crate::cmd::ReferralCode;
+use crate::types::{AccountId, AuthToken};
+use crate::{cmd::Cmd, pow::PowOutput};
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct CreateAccountInfo {
+    pub id: AccountId,
+    pub token: AuthToken,
+}
+
+/// Create an Account
+///
+/// ## Expected Errors
+/// - [`InvalidReferralCode`](crate::cmd::ApiErrorKind::InvalidReferralCode)
+/// - [`SignupLimitExceeded`](crate::cmd::ApiErrorKind::SignupLimitExceeded)
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct CreateAccount {
+    pub pow: Option<PowOutput>,
+    pub referral_code: Option<ReferralCode>,
+}
+
+impl Cmd for CreateAccount {
+    type Output = CreateAccountInfo;
+    const METHOD: http::Method = http::Method::POST;
+    const PATH: &'static str = "account";
+}
+
+#[test]
+fn test_account_info_json() {
+    crate::cmd::check_cmd_json::<CreateAccount>(
+        Some(
+            r###"
+                {
+                    "pow": null,
+                    "referral_code": "1234"
+                }
+            "###,
+        ),
+        Some(
+            r###"
+                {
+                  "id": "0000000000000000000",
+                  "token": "abc-123-xyz"
+                }
+            "###,
+        ),
+    );
+}

src/cmd/account/create.rs

@@ -1,5 +1,7 @@
+mod create;
 mod delete;
 mod info;
 
+pub use create::*;
 pub use delete::*;
 pub use info::*;

src/cmd/account/mod.rs

@@ -2,9 +2,12 @@ use serde::{Deserialize, Serialize};
 
 use super::Cmd;
 
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct ReferralCode(pub String);
+
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct UseReferralCode {
-    pub code: String,
+    pub code: ReferralCode,
 }
 
 impl Cmd for UseReferralCode {

src/cmd/referrals.rs

@@ -1,7 +1,5 @@
 #![doc = include_str!("../doc/index.md")]
 
-#[doc = include_str!("../doc/account-creation.md")]
-pub mod account_creation {}
 #[doc = include_str!("../doc/auth.md")]
 pub mod auth {}
 #[doc = include_str!("../doc/error.md")]

src/doc.rs

@@ -1,5 +1,5 @@
-use crate::pow::PowOutput;
 use crate::types::AccountId;
+use crate::{pow::PowOutput, types::AuthToken};
 use serde::{Deserialize, Serialize};
 use url::Url;
 
@@ -17,7 +17,7 @@ pub struct AcquireToken2Output {
     /// The token is used by adding an `Authorization: Bearer {token}` header to your requests.
     ///
     /// The token has no definite expiry date. It is recommended to cache tokens indefinitely, only acquiring a new one when the API returns a [`MissingOrInvalidAuthToken`](crate::cmd::ApiErrorKind::MissingOrInvalidAuthToken) error.
-    pub auth_token: String,
+    pub auth_token: AuthToken,
 
     /// Internal use.
     pub url_override: Option<UrlOverride>,