Skip to main content

auric_runtime/data/adapters/
rest.rs

1use super::super::Adapter;
2use crate::Config;
3use crate::data::QueryRecordOptions;
4use anyhow::{Result, anyhow};
5use async_trait::async_trait;
6use jsonapi_core::Resource;
7use pluralizer::pluralize;
8use reqwest::Client;
9use serde_json::Value;
10use std::collections::HashMap;
11
12#[derive(Default)]
13pub struct RestAdapter {
14    api_url: String,
15}
16
17impl RestAdapter {
18    pub fn new(api_url: String) -> Self {
19        Self { api_url }
20    }
21}
22
23#[async_trait(?Send)]
24impl Adapter for RestAdapter {
25    fn init(&mut self, config: &Config) -> Result<()> {
26        let config = config.as_object().expect("Expected config to be an object");
27        let api_url = match config.get("api_url") {
28            None => return Err(anyhow!("Configuration requires an api_url field")),
29            Some(api_url) => match api_url.as_str() {
30                None => return Err(anyhow!("Expected api_url config field to be a string")),
31                Some(api_url) => api_url.to_owned(),
32            },
33        };
34        self.api_url = api_url;
35        Ok(())
36    }
37
38    async fn create_record(&self, resource: Resource) -> Result<Resource> {
39        // Perform request
40        let url = format!("{}/{}", self.api_url, resource.type_);
41        let client = Client::new();
42        let res = client.post(url).json(&resource.attributes).send().await?;
43
44        // Read response
45        let res_body: HashMap<String, Value> = res.json().await?;
46        let model_name = pluralize(&resource.type_, 1, false);
47        let data = match res_body.get(&model_name) {
48            None => return Err(anyhow!("resource not found")),
49            Some(data) => data,
50        };
51        let id = match data.as_object() {
52            None => return Err(anyhow!("expected an object")),
53            Some(map) => match map.get("id") {
54                None => return Err(anyhow!("expected returned object to include an id")),
55                Some(id) => id.as_str().unwrap_or_default().to_string(),
56            },
57        };
58        let finalized_resource = Resource {
59            type_: resource.type_,
60            id: Some(id),
61            lid: None,
62            attributes: data.clone(),
63            relationships: Default::default(),
64            links: None,
65            meta: None,
66        };
67        Ok(finalized_resource)
68    }
69
70    async fn delete_record(&self, resource: &Resource) -> Result<()> {
71        // Perform request
72        let url = format!(
73            "{}/{}/{}",
74            self.api_url,
75            resource.type_,
76            resource.id.clone().unwrap_or_default()
77        );
78        let client = Client::new();
79        let _res = client.delete(url).send().await?;
80        Ok(())
81    }
82
83    async fn find_record(&self, resource_type: &str, id: &str) -> Result<Resource> {
84        let resource_type = resource_type.to_string();
85        let id = id.to_string();
86
87        // Perform request
88        let url = format!("{}/{resource_type}/{id}", self.api_url);
89        let client = Client::new();
90        let res = client.get(url).send().await?;
91
92        // Read response
93        let res_body: HashMap<String, Value> = res.json().await?;
94        let model_name = pluralize(&resource_type, 1, false);
95        let data = match res_body.get(&model_name) {
96            None => return Err(anyhow!("resource not found")),
97            Some(data) => data,
98        };
99        let resource = Resource {
100            type_: resource_type,
101            id: Some(id),
102            lid: None,
103            attributes: data.clone(),
104            relationships: Default::default(),
105            links: None,
106            meta: None,
107        };
108        Ok(resource)
109    }
110
111    async fn query(&self, _resource_type: &str, _query: Value) -> Result<Vec<Resource>> {
112        todo!()
113    }
114
115    async fn query_record(
116        &self,
117        _resource_type: &str,
118        _query: Value,
119        _options: QueryRecordOptions,
120    ) -> Result<Option<Resource>> {
121        todo!()
122    }
123
124    async fn update_record(&self, resource: Resource) -> Result<Resource> {
125        // Perform request
126        let id = resource.id.clone().unwrap_or_default();
127        let url = format!("{}/{}/{}", self.api_url, resource.type_, id);
128        let client = Client::new();
129        let res = client.put(url).send().await?;
130
131        // Read response
132        let res_body: HashMap<String, Value> = res.json().await?;
133        let model_name = pluralize(&resource.type_, 1, false);
134        let data = match res_body.get(&model_name) {
135            None => return Err(anyhow!("resource not found")),
136            Some(data) => data,
137        };
138        let finalized_resource = Resource {
139            type_: resource.type_,
140            id: Some(resource.id.unwrap_or_default().to_string()),
141            lid: None,
142            attributes: data.clone(),
143            relationships: Default::default(),
144            links: None,
145            meta: None,
146        };
147        Ok(finalized_resource)
148    }
149}
150
151#[cfg(test)]
152mod tests {
153    use super::RestAdapter;
154    use crate::data::Adapter;
155    use httptest::matchers::request;
156    use httptest::responders::{json_encoded, status_code};
157    use httptest::{Expectation, Server};
158    use jsonapi_core::Resource;
159    use serde_json::json;
160
161    #[tokio::test]
162    async fn can_create_record() {
163        // Setup mock server and expections for a posted Customer record
164        let server = Server::run();
165        server.expect(
166            Expectation::matching(request::method_path("POST", "/v1/customers"))
167                .respond_with(json_encoded(json!({"customer": {"id": "123", "name": "Acme Widgets"}}))),
168        );
169
170        // Perform test
171        let customer = Resource {
172            type_: "customers".to_string(),
173            id: None,
174            lid: None,
175            attributes: json!({"name": "Acme Widgets"}),
176            relationships: Default::default(),
177            links: None,
178            meta: None,
179        };
180        let adapter = RestAdapter::new(server.url_str("/v1"));
181        let finalized_customer = adapter
182            .create_record(customer)
183            .await
184            .expect("Expected to create customer record");
185        assert_eq!(finalized_customer.id, Some("123".to_string()));
186        assert!(finalized_customer.attributes.to_string().contains("Acme Widgets"))
187    }
188
189    #[tokio::test]
190    async fn can_delete_record() {
191        // Setup mock server and expections for a delete Customer operation
192        let server = Server::run();
193        server.expect(
194            Expectation::matching(request::method_path("DELETE", "/v1/customers/123")).respond_with(status_code(200)),
195        );
196
197        // Perform test
198        let customer = Resource {
199            type_: "customers".to_string(),
200            id: Some("123".to_string()),
201            lid: None,
202            attributes: json!({}),
203            relationships: Default::default(),
204            links: None,
205            meta: None,
206        };
207        let adapter = RestAdapter::new(server.url_str("/v1"));
208        adapter
209            .delete_record(&customer)
210            .await
211            .expect("Expected to delete customer record");
212    }
213
214    #[tokio::test]
215    async fn can_find_record() {
216        // Setup mock server and expections for a delete Customer operation
217        let server = Server::run();
218        server.expect(
219            Expectation::matching(request::method_path("GET", "/v1/customers/123"))
220                .respond_with(json_encoded(json!({"customer": {"id": "123", "name": "Acme Widgets"}}))),
221        );
222
223        // Perform test
224        let adapter = RestAdapter::new(server.url_str("/v1"));
225        let customer = adapter
226            .find_record("customers", "123")
227            .await
228            .expect("Expected to find customer record");
229        assert_eq!(customer.id, Some("123".to_string()));
230    }
231
232    #[tokio::test]
233    async fn can_update_record() {
234        // Setup mock server and expections for a put-ted Customer record
235        let server = Server::run();
236        server.expect(
237            Expectation::matching(request::method_path("PUT", "/v1/customers/123")).respond_with(json_encoded(
238                json!({"customer": {"id": "123", "name": "Acme Widgets 2"}}),
239            )),
240        );
241
242        // Perform test
243        let customer = Resource {
244            type_: "customers".to_string(),
245            id: Some("123".to_string()),
246            lid: None,
247            attributes: json!({"name": "Acme Widgets"}),
248            relationships: Default::default(),
249            links: None,
250            meta: None,
251        };
252        let adapter = RestAdapter::new(server.url_str("/v1"));
253        let finalized_customer = adapter
254            .update_record(customer)
255            .await
256            .expect("Expected to update customer record");
257        assert_eq!(finalized_customer.id, Some("123".to_string()));
258        assert!(finalized_customer.attributes.to_string().contains("Acme Widgets 2"))
259    }
260}