fars 0.2.0

An unofficial Rust client for the Firebase Auth REST API.
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Implements the sign in anonymously API of Firebase Auth.
//!
//! You can sign in a user anonymously by issuing an HTTP POST request to the Auth signupNewUser endpoint.
//!
//! See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-sign-in-anonymously).

use serde::{Deserialize, Serialize};

use crate::ApiKey;
use crate::Client;
use crate::Endpoint;
use crate::Result;

/// Request body payload for the sign in anonymously API.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-sign-in-anonymously).
#[derive(Serialize)]
pub struct SignInAnonymouslyRequestBodyPayload {
    /// Whether or not to return an ID and refresh token. Should always be true.
    #[serde(rename = "returnSecureToken")]
    return_secure_token: bool,
}

impl SignInAnonymouslyRequestBodyPayload {
    /// Creates a new request body payload for the sign in anonymously API.
    ///
    /// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-sign-in-anonymously).
    pub fn new() -> Self {
        Self {
            return_secure_token: true,
        }
    }
}

impl Default for SignInAnonymouslyRequestBodyPayload {
    fn default() -> Self {
        Self::new()
    }
}

/// Response payload for the sign in anonymously API.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-sign-in-anonymously).
#[derive(Deserialize, Debug)]
pub struct SignInAnonymouslyResponsePayload {
    /// A Firebase Auth ID token for the newly created user.
    #[serde(rename = "idToken")]
    pub id_token: String,
    /// A Firebase Auth refresh token for the newly created user.
    #[serde(rename = "refreshToken")]
    pub refresh_token: String,
    /// The number of seconds in which the ID token expires.
    #[serde(rename = "expiresIn")]
    pub expires_in: String,
    /// The uid of the newly created user.
    #[serde(rename = "localId")]
    pub local_id: String,
}

/// Signs in a user anonymously.
///
/// See also [API reference](https://firebase.google.com/docs/reference/rest/auth#section-sign-in-anonymously).
///
/// ## Arguments
/// - `client` - HTTP client.
/// - `api_key` - Your Firebase project's API key.
/// - `request_payload` - Request body payload.
///
/// ## Errors
/// - `Error::HttpRequestError` - Failed to send a request.
/// - `Error::ReadResponseTextFailed` - Failed to read the response body as text.
/// - `Error::DeserializeResponseJsonFailed` - Failed to deserialize the response body as JSON.
/// - `Error::DeserializeErrorResponseJsonFailed` - Failed to deserialize the error response body as JSON.
/// - `Error::ApiError` - API error on the Firebase Auth.
///
/// ## Common error codes
/// - OPERATION_NOT_ALLOWED: Anonymous user sign-in is disabled for this project.
///
/// ## Example
/// ```
/// use fars::api;
/// use fars::Client;
/// use fars::ApiKey;
///
/// let request_payload = api::SignInAnonymouslyRequestBodyPayload::new();
///
/// let response_payload = api::sign_in_anonymously(
///     Client::new(),
///     ApiKey::new("your-firebase-project-api-key"),
///     request_payload,
/// ).await?;
/// ```
pub async fn sign_in_anonymously(
    client: &Client,
    api_key: &ApiKey,
    request_payload: SignInAnonymouslyRequestBodyPayload,
) -> Result<SignInAnonymouslyResponsePayload> {
    client.send_post::<
        SignInAnonymouslyRequestBodyPayload,
        SignInAnonymouslyResponsePayload,
    >(
        Endpoint::SignUp,
        api_key,
        request_payload,
        None,
    )
    .await
}