FaceTec integration corrections

.vscode/settings.json

@@ -7,5 +7,6 @@
   "rust-analyzer.cargo.runBuildScripts": true,
   "[toml]": {
     "editor.defaultFormatter": "tamasfe.even-better-toml"
-  }
+  },
+  "rust-analyzer.cargo.features": ["logic-integration-tests"]
 }

crates/facetec-api-client/Cargo.toml

@@ -6,8 +6,11 @@ authors = ["Humanode Team <core@humanode.io>"]
 publish = false
 
 [dependencies]
+async-trait = "0.1"
+bytes = "1"
 reqwest = { version = "0.11", features = ["json"] }
 serde = { version = "1", features = ["derive"] }
+serde_json = "1"
 thiserror = "1"
 
 [dev-dependencies]

crates/facetec-api-client/src/db_delete.rs

@@ -0,0 +1,238 @@
+//! POST `/3d-db/delete`
+
+use reqwest::StatusCode;
+use serde::{Deserialize, Serialize};
+
+use super::Client;
+
+impl<RBEI> Client<RBEI>
+where
+    RBEI: crate::response_body_error::Inspector,
+{
+    /// Perform the `/3d-db/delete` call to the server.
+    pub async fn db_delete(&self, req: Request<'_>) -> Result<Response, crate::Error<Error>> {
+        let res = self.build_post("/3d-db/delete", &req).send().await?;
+        match res.status() {
+            StatusCode::OK => Ok(self.parse_json(res).await?),
+            StatusCode::BAD_REQUEST => Err(crate::Error::Call(Error::BadRequest(
+                self.parse_json(res).await?,
+            ))),
+            _ => Err(crate::Error::Call(Error::Unknown(res.text().await?))),
+        }
+    }
+}
+
+/// Input data for the `/3d-db/delete` request.
+#[derive(Debug, Serialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+pub struct Request<'a> {
+    /// The ID of the enrolled FaceMap to delete.
+    pub identifier: &'a str,
+    /// The name of the group to delete the specified FaceMap from.
+    pub group_name: &'a str,
+}
+
+/// The response from `/3d-db/delete`.
+#[derive(Debug, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+pub struct Response {
+    /// Whether the request was successful.
+    pub success: bool,
+}
+
+/// The `/3d-db/delete`-specific error kind.
+#[derive(thiserror::Error, Debug, PartialEq)]
+pub enum Error {
+    /// Bad request error occured.
+    #[error("bad request: {0}")]
+    BadRequest(ErrorBadRequest),
+    /// Some other error occured.
+    #[error("unknown error: {0}")]
+    Unknown(String),
+}
+
+/// The error kind for the `/3d-db/delete`-specific 400 response.
+#[derive(thiserror::Error, Debug, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+#[error("bad request: {error_message}")]
+pub struct ErrorBadRequest {
+    /// Whether the request had any errors during the execution.
+    /// Expected to always be `true` in this context.
+    pub error: bool,
+    /// Whether the request was successful.
+    /// Expected to always be `false` in this context.
+    pub success: bool,
+    /// The error message.
+    pub error_message: String,
+}
+
+#[cfg(test)]
+mod tests {
+    use wiremock::{matchers, Mock, MockServer, ResponseTemplate};
+
+    use crate::tests::test_client;
+
+    use super::*;
+
+    #[test]
+    fn request_serialization() {
+        let expected_request = serde_json::json!({
+            "identifier": "my_test_id",
+            "groupName": ""
+        });
+
+        let actual_request = serde_json::to_value(&Request {
+            identifier: "my_test_id",
+            group_name: "",
+        })
+        .unwrap();
+
+        assert_eq!(expected_request, actual_request);
+    }
+
+    #[test]
+    fn response_deserialization() {
+        let sample_response = serde_json::json!({
+            "additionalSessionData": {
+                "isAdditionalDataPartiallyIncomplete": true
+            },
+            "callData": {
+                "tid": "0haAzpKGLfc4fa345-ee26-11eb-86b0-0232fd4aba88",
+                "path": "/3d-db/delete",
+                "date": "Jul 26, 2021 15:34:37 PM",
+                "epochSecond": 1627313677,
+                "requestMethod": "POST"
+            },
+            "error": false,
+            "serverInfo": {
+                "version": "9.3.1-dev-2021070201",
+                "mode": "Development Only",
+                "notice": "You should only be reading this if you are in server-side code.  Please make sure you do not allow the FaceTec Server to be called from the public internet."
+            },
+            "success": true
+        });
+
+        let response: Response = serde_json::from_value(sample_response).unwrap();
+        assert_matches!(response, Response { success: true })
+    }
+    #[test]
+    fn bad_request_error_response_deserialization() {
+        let sample_response = serde_json::json!({
+            "error": true,
+            "errorMessage": "No entry found in the database.",
+            "success": false
+        });
+
+        let response: ErrorBadRequest = serde_json::from_value(sample_response).unwrap();
+        assert_eq!(
+            response,
+            ErrorBadRequest {
+                error: true,
+                success: false,
+                error_message: "No entry found in the database.".to_owned(),
+            }
+        )
+    }
+
+    #[tokio::test]
+    async fn mock_success() {
+        let mock_server = MockServer::start().await;
+
+        let sample_request = Request {
+            identifier: "my_test_id",
+            group_name: "",
+        };
+        let sample_response = serde_json::json!({
+            "additionalSessionData": {
+                "isAdditionalDataPartiallyIncomplete": true
+            },
+            "callData": {
+                "tid": "0haAzpKGLfc4fa345-ee26-11eb-86b0-0232fd4aba88",
+                "path": "/3d-db/delete",
+                "date": "Jul 26, 2021 15:34:37 PM",
+                "epochSecond": 1627313677,
+                "requestMethod": "POST"
+            },
+            "error": false,
+            "serverInfo": {
+                "version": "9.3.1-dev-2021070201",
+                "mode": "Development Only",
+                "notice": "You should only be reading this if you are in server-side code.  Please make sure you do not allow the FaceTec Server to be called from the public internet."
+            },
+            "success": true
+        });
+
+        let expected_response: Response = serde_json::from_value(sample_response.clone()).unwrap();
+
+        Mock::given(matchers::method("POST"))
+            .and(matchers::path("/3d-db/delete"))
+            .and(matchers::body_json(&sample_request))
+            .respond_with(ResponseTemplate::new(200).set_body_json(&sample_response))
+            .mount(&mock_server)
+            .await;
+
+        let client = test_client(mock_server.uri());
+
+        let actual_response = client.db_delete(sample_request).await.unwrap();
+        assert_eq!(actual_response, expected_response);
+    }
+
+    #[tokio::test]
+    async fn mock_error_unknown() {
+        let mock_server = MockServer::start().await;
+
+        let sample_request = Request {
+            identifier: "my_test_id",
+            group_name: "",
+        };
+        let sample_response = "Some error text";
+
+        Mock::given(matchers::method("POST"))
+            .and(matchers::path("/3d-db/delete"))
+            .and(matchers::body_json(&sample_request))
+            .respond_with(ResponseTemplate::new(500).set_body_string(sample_response))
+            .mount(&mock_server)
+            .await;
+
+        let client = test_client(mock_server.uri());
+
+        let actual_error = client.db_delete(sample_request).await.unwrap_err();
+        assert_matches!(
+            actual_error,
+            crate::Error::Call(Error::Unknown(error_text)) if error_text == sample_response
+        );
+    }
+
+    #[tokio::test]
+    async fn mock_error_bad_request() {
+        let mock_server = MockServer::start().await;
+
+        let sample_request = Request {
+            identifier: "my_test_id",
+            group_name: "",
+        };
+        let sample_response = serde_json::json!({
+            "error": true,
+            "errorMessage": "No entry found in the database.",
+            "success": false
+        });
+
+        let expected_error: ErrorBadRequest =
+            serde_json::from_value(sample_response.clone()).unwrap();
+
+        Mock::given(matchers::method("POST"))
+            .and(matchers::path("/3d-db/delete"))
+            .and(matchers::body_json(&sample_request))
+            .respond_with(ResponseTemplate::new(400).set_body_json(&sample_response))
+            .mount(&mock_server)
+            .await;
+
+        let client = test_client(mock_server.uri());
+
+        let actual_error = client.db_delete(sample_request).await.unwrap_err();
+        assert_matches!(
+            actual_error,
+            crate::Error::Call(Error::BadRequest(err)) if err == expected_error
+        );
+    }
+}