Merge pull request #34 from TheEmeraldBee/enrichment_etag

Add etag to us_enrichment_api
Add geo reference data
Add secondary data set

Author: RyanLCox1

.gitignore

@@ -14,3 +14,18 @@
 *.swp
 *.iml
 __MACOSX
+
+# Devenv
+.devenv*
+devenv.local.nix
+
+# direnv
+.direnv
+
+# pre-commit
+.pre-commit-config.yaml
+
+devenv.lock
+devenv.nix
+devenv.yaml
+.envrc

Makefile

@@ -47,6 +47,9 @@ us_street_api:
 us_zipcode_api:
 	RUST_LOG=trace cargo run --example us_zipcode_api
 
+us_enrichment_api:
+	RUST_LOG=trace cargo run --example us_enrichment_api
+
 examples: international_autocomplete_api international_street_api logger us_autocomplete_pro_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api
 
-.PHONY: clean test dependencies package examples clippy international_autocomplete_api international_street_api logger us_autocomplete_pro_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api
+.PHONY: clean test dependencies package examples clippy international_autocomplete_api international_street_api logger us_autocomplete_pro_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api us_enrichment_api

smarty-rust-sdk/examples/us_enrichment_api.rs

@@ -1,10 +1,16 @@
 use smarty_rust_sdk::sdk::authentication::SecretKeyCredential;
 use smarty_rust_sdk::sdk::options::OptionsBuilder;
-use smarty_rust_sdk::us_enrichment_api::client::USEnrichmentClient;
+
+use smarty_rust_sdk::us_enrichment_api::client::*;
+use smarty_rust_sdk::us_enrichment_api::financial::*;
+use smarty_rust_sdk::us_enrichment_api::geo::*;
+use smarty_rust_sdk::us_enrichment_api::principal::*;
+
 use smarty_rust_sdk::us_enrichment_api::lookup::EnrichmentLookup;
-use smarty_rust_sdk::us_enrichment_api::results::{
-    EnrichmentResponse, FinancialResponse, PrincipalResponse,
-};
+use smarty_rust_sdk::us_enrichment_api::response::EnrichmentResponse;
+use smarty_rust_sdk::us_enrichment_api::secondary::SecondaryCountResponse;
+use smarty_rust_sdk::us_enrichment_api::secondary::SecondaryResponse;
+
 use std::error::Error;
 
 #[tokio::main]
@@ -13,12 +19,21 @@ async fn main() -> Result<(), Box<dyn Error>> {
 
     lookup::<FinancialResponse>(key).await?;
     lookup::<PrincipalResponse>(key).await?;
+    lookup::<GeoReferenceResponse>(key).await?;
+    lookup::<GeoReference2010Response>(key).await?;
+    lookup::<GeoReference2020Response>(key).await?;
+    lookup::<SecondaryResponse>(key).await?;
+    lookup::<SecondaryCountResponse>(key).await?;
 
     Ok(())
 }
 
 async fn lookup<R: EnrichmentResponse>(key: u32) -> Result<(), Box<dyn Error>> {
-    let mut lookup = EnrichmentLookup::<R>::new(key);
+    let mut lookup = EnrichmentLookup::<R> {
+        smarty_key: key,
+        etag: "".to_string(),
+        ..Default::default()
+    };
 
     let authentication = SecretKeyCredential::new(
         std::env::var("SMARTY_AUTH_ID").expect("Missing SMARTY_AUTH_ID env variable"),

smarty-rust-sdk/src/sdk/client.rs

@@ -54,8 +54,10 @@ impl Client {
         if let Some(auth) = &self.options.authentication {
             builder = auth.authenticate(builder);
         }
-
-        builder = builder.query(&[("license".to_string(), self.options.license.clone())]);
+        
+        if !self.options.license.is_empty() {
+            builder = builder.query(&[("license".to_string(), self.options.license.clone())]);   
+        }
 
         for (header_key, header_value) in self.options.headers.clone() {
             builder = builder.header(header_key, header_value);

smarty-rust-sdk/src/sdk/mod.rs

@@ -1,4 +1,5 @@
 use crate::sdk::error::SmartyError;
+use reqwest::Response;
 use reqwest_middleware::RequestBuilder;
 use serde::de::DeserializeOwned;
 use serde_repr::{Deserialize_repr, Serialize_repr};
@@ -36,15 +37,16 @@ impl Display for CoordinateLicense {
     }
 }
 
-pub(crate) async fn send_request<C>(request: RequestBuilder) -> Result<C, SmartyError>
-where
-    C: DeserializeOwned,
-{
-    let response = request.send().await.map_err(|e| match e {
+pub(crate) async fn send_request_full(request: RequestBuilder) -> Result<Response, SmartyError> {
+    request.send().await.map_err(|e| match e {
         reqwest_middleware::Error::Middleware(e) => SmartyError::from(e),
         reqwest_middleware::Error::Reqwest(e) => SmartyError::from(e),
-    })?;
+    })
+}
 
+pub(crate) async fn parse_response_json<C: DeserializeOwned>(
+    response: Response,
+) -> Result<C, SmartyError> {
     if !response.status().is_success() {
         let status_code = response.status();
         let body = response.text().await?;
@@ -58,6 +60,13 @@ where
     Ok(response.json::<C>().await?)
 }
 
+pub(crate) async fn send_request<C: DeserializeOwned>(
+    request: RequestBuilder,
+) -> Result<C, SmartyError> {
+    let response = send_request_full(request).await?;
+    parse_response_json(response).await
+}
+
 /// This is only used for Serializing for post
 #[allow(clippy::trivially_copy_pass_by_ref)]
 pub(crate) fn is_zero(num: &i64) -> bool {

smarty-rust-sdk/src/us_enrichment_api/client.rs

@@ -1,13 +1,13 @@
 use crate::sdk::client::Client;
 use crate::sdk::error::SmartyError;
 use crate::sdk::options::Options;
-use crate::sdk::send_request;
+use crate::sdk::{parse_response_json, send_request_full};
 use crate::us_enrichment_api::lookup::EnrichmentLookup;
-use crate::us_enrichment_api::results::EnrichmentResponse;
 use reqwest::Method;
-use serde::de::DeserializeOwned;
 use smarty_rust_proc_macro::smarty_api;
 
+use super::response::EnrichmentResponse;
+
 #[smarty_api(
     api_path = "lookup",
     default_url = "https://us-enrichment.api.smarty.com/",
@@ -22,21 +22,37 @@ impl USEnrichmentClient {
     /// Uses the lookup and the client in
     /// order to build a request and send the message
     /// to the server.
-    pub async fn send<R: EnrichmentResponse + DeserializeOwned>(
+    pub async fn send<R: EnrichmentResponse>(
         &self,
         lookup: &mut EnrichmentLookup<R>,
     ) -> Result<(), SmartyError> {
         let mut url = self.client.url.clone();
         url = url.join(&format!(
-            "/lookup/{}/property/{}",
+            "/lookup/{}/{}",
             lookup.smarty_key,
             R::lookup_type()
         ))?;
 
         let mut req = self.client.reqwest_client.request(Method::GET, url);
+
+        if !lookup.etag.is_empty() {
+            req = req.header("ETag", &lookup.etag);
+        }
+
         req = self.client.build_request(req);
 
-        let candidates = send_request::<Vec<R>>(req).await?;
+        println!("{req:?}");
+
+        let response = send_request_full(req).await?;
+
+        let etag = response
+            .headers()
+            .get("ETag")
+            .map(|x| x.to_str().expect("ETag should always be a string"))
+            .unwrap_or_default();
+        lookup.etag = etag.to_string();
+
+        let candidates = parse_response_json(response).await?;
 
         lookup.set_results(candidates);
 

smarty-rust-sdk/src/us_enrichment_api/financial.rs

@@ -0,0 +1,170 @@
+use serde::Deserialize;
+use serde::Serialize;
+use std::fmt::Debug;
+
+use super::response::EnrichmentResponse;
+
+#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub struct FinancialResponse {
+    pub smarty_key: String,
+    pub data_set_name: String,
+    pub data_subset_name: String,
+    pub attributes: FinancialAttributes,
+}
+
+impl EnrichmentResponse for FinancialResponse {
+    fn lookup_type() -> &'static str {
+        "property/financial"
+    }
+}
+
+#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(default)]
+pub struct FinancialAttributes {
+    pub assessed_improvement_percent: String,
+    pub assessed_improvement_value: String,
+    pub assessed_land_value: String,
+    pub assessed_value: String,
+    pub assessor_last_update: String,
+    pub assessor_taxroll_update: String,
+    pub contact_city: String,
+    pub contact_crrt: String,
+    pub contact_full_address: String,
+    pub contact_house_number: String,
+    pub contact_mail_info_format: String,
+    pub contact_mail_info_privacy: String,
+    pub contact_mailing_county: String,
+    pub contact_mailing_fips: String,
+    pub contact_post_direction: String,
+    pub contact_pre_direction: String,
+    pub contact_state: String,
+    pub contact_street_name: String,
+    pub contact_suffix: String,
+    pub contact_unit_designator: String,
+    pub contact_value: String,
+    pub contact_zip: String,
+    pub contact_zip4: String,
+    pub deed_document_page: String,
+    pub deed_document_book: String,
+    pub deed_document_number: String,
+    pub deed_owner_first_name: String,
+    pub deed_owner_first_name2: String,
+    pub deed_owner_first_name3: String,
+    pub deed_owner_first_name4: String,
+    pub deed_owner_full_name: String,
+    pub deed_owner_full_name2: String,
+    pub deed_owner_full_name3: String,
+    pub deed_owner_full_name4: String,
+    pub deed_owner_last_name: String,
+    pub deed_owner_last_name2: String,
+    pub deed_owner_last_name3: String,
+    pub deed_owner_last_name4: String,
+    pub deed_owner_middle_name: String,
+    pub deed_owner_middle_name2: String,
+    pub deed_owner_middle_name3: String,
+    pub deed_owner_middle_name4: String,
+    pub deed_owner_suffix: String,
+    pub deed_owner_suffix2: String,
+    pub deed_owner_suffix3: String,
+    pub deed_owner_suffix4: String,
+    pub deed_sale_date: String,
+    pub deed_sale_price: String,
+    pub deed_transaction_id: String,
+    pub disabled_tax_exemption: String,
+    pub financial_history: Vec<FinancialHistory>,
+    pub first_name: String,
+    pub first_name_2: String,
+    pub first_name_3: String,
+    pub first_name_4: String,
+    pub homeowner_tax_exemption: String,
+    pub last_name: String,
+    pub last_name_2: String,
+    pub last_name_3: String,
+    pub last_name_4: String,
+    pub market_improvement_percent: String,
+    pub market_improvement_value: String,
+    pub market_land_value: String,
+    pub market_value_year: String,
+    pub match_type: String,
+    pub middle_name: String,
+    pub middle_name_2: String,
+    pub middle_name_3: String,
+    pub middle_name_4: String,
+    pub other_tax_exemption: String,
+    pub owner_full_name: String,
+    pub owner_full_name_2: String,
+    pub owner_full_name_3: String,
+    pub owner_full_name_4: String,
+    pub ownership_transfer_date: String,
+    pub ownership_transfer_doc_number: String,
+    pub ownership_transfer_transaction_id: String,
+    pub ownership_type: String,
+    pub ownership_type_2: String,
+    pub previous_assessed_value: String,
+    pub prior_sale_amount: String,
+    pub prior_sale_date: String,
+    pub sale_amount: String,
+    pub sale_date: String,
+    pub senior_tax_exemption: String,
+    pub suffix: String,
+    pub suffix_2: String,
+    pub suffix_3: String,
+    pub suffix_4: String,
+    pub tax_assess_year: String,
+    pub tax_billed_amount: String,
+    pub tax_delinquent_year: String,
+    pub tax_fiscal_year: String,
+    pub tax_rate_area: String,
+    pub total_market_value: String,
+    pub trust_description: String,
+    pub veteran_tax_exemption: String,
+    pub widow_tax_exemption: String,
+}
+
+#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(default)]
+pub struct FinancialHistory {
+    pub code_title_company: String,
+    pub document_type_description: String,
+    pub instrument_date: String,
+    pub interest_rate_type_2: String,
+    pub lender_address: String,
+    pub lender_address_2: String,
+    pub lender_city: String,
+    pub lender_city_2: String,
+    pub lender_code_2: String,
+    pub lender_first_name: String,
+    pub lender_first_name_2: String,
+    pub lender_last_name: String,
+    pub lender_last_name_2: String,
+    pub lender_name: String,
+    pub lender_name_2: String,
+    pub lender_seller_carry_back: String,
+    pub lender_seller_carry_back_2: String,
+    pub lender_state: String,
+    pub lender_state_2: String,
+    pub lender_zip: String,
+    pub lender_zip_2: String,
+    pub lender_zip_extended: String,
+    pub lender_zip_extended_2: String,
+    pub mortgage_amount: String,
+    pub mortgage_amount_2: String,
+    pub mortgage_due_date: String,
+    pub mortgage_due_date_2: String,
+    pub mortgage_interest_rate: String,
+    pub mortgage_interest_rate_type: String,
+    pub mortgage_lender_code: String,
+    pub mortgage_rate_2: String,
+    pub mortgage_recording_date: String,
+    pub mortgage_recording_date_2: String,
+    pub mortgage_term: String,
+    pub mortgage_term_2: String,
+    pub mortgage_term_type: String,
+    pub mortgage_term_type_2: String,
+    pub mortgage_type: String,
+    pub mortgage_type_2: String,
+    pub multi_parcel_flag: String,
+    pub name_title_company: String,
+    pub recording_date: String,
+    pub transfer_amount: String,
+}