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 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
/*! * A rust library for interacting with the Shippo API. * * For more information, the Shippo API is documented at [goshippo.com/docs/reference](https://goshippo.com/docs/reference). * * Example: * * ``` * use serde::{Deserialize, Serialize}; * use shippo::Shippo; * * async fn get_shipments() { * // Initialize the Shippo client. * let shippo = Shippo::new_from_env(); * * // List the shipments. * let shipments = shippo.list_shipments().await.unwrap(); * * // Iterate over the shipments. * for shipment in shipments { * println!("{:?}", shipment); * } * } * ``` */ #![allow(clippy::field_reassign_with_default)] use std::env; use std::error; use std::fmt; use std::fmt::Debug; use std::sync::Arc; use chrono::offset::Utc; use chrono::DateTime; use reqwest::{header, Client, Method, Request, StatusCode, Url}; use serde::{Deserialize, Serialize}; /// Endpoint for the Shippo API. const ENDPOINT: &str = "https://api.goshippo.com/"; /// Entrypoint for interacting with the Shippo API. pub struct Shippo { token: String, client: Arc<Client>, } impl Shippo { /// Create a new Shippo client struct. It takes a type that can convert into /// an &str (`String` or `Vec<u8>` for example). As long as the function is /// given a valid API Token your requests will work. pub fn new<K>(token: K) -> Self where K: ToString, { let client = Client::builder().build(); match client { Ok(c) => Self { token: token.to_string(), client: Arc::new(c), }, Err(e) => panic!("creating client failed: {:?}", e), } } /// Create a new Shippo client struct from environment variables. It /// takes a type that can convert into /// an &str (`String` or `Vec<u8>` for example). As long as the function is /// given a valid API Token and your requests will work. pub fn new_from_env() -> Self { let token = env::var("SHIPPO_API_TOKEN").unwrap(); Shippo::new(token) } fn request<B>(&self, method: Method, path: &str, body: B, query: Option<Vec<(&str, String)>>) -> Request where B: Serialize, { let base = Url::parse(ENDPOINT).unwrap(); let url = base.join(path).unwrap(); let bt = format!("{} None", self.token); let bearer = header::HeaderValue::from_str(&bt).unwrap(); // Set the default headers. let mut headers = header::HeaderMap::new(); headers.append(header::AUTHORIZATION, bearer); headers.append(header::CONTENT_TYPE, header::HeaderValue::from_static("application/json")); let mut rb = self.client.request(method.clone(), url).headers(headers); match query { None => (), Some(val) => { rb = rb.query(&val); } } // Add the body, this is to ensure our GET and DELETE calls succeed. if method != Method::GET && method != Method::DELETE { rb = rb.json(&body); } // Build the request. rb.build().unwrap() } /// List shipments. /// FROM: https://goshippo.com/docs/reference#shipments-list /// A maximum date range of 90 days is permitted. Provided dates should be ISO 8601 UTC dates. pub async fn list_shipments(&self) -> Result<Vec<Shipment>, APIError> { // Build the request. // TODO: paginate. let request = self.request(Method::GET, "shipments", (), None); let resp = self.client.execute(request).await.unwrap(); match resp.status() { StatusCode::OK => (), s => { return Err(APIError { status_code: s, body: resp.text().await.unwrap(), }) } }; let r: APIResponse = resp.json().await.unwrap(); Ok(r.shipments) } /// Create a shipment. /// FROM: https://goshippo.com/docs/reference#shipments-create pub async fn create_shipment(&self, ns: NewShipment) -> Result<Shipment, APIError> { // Build the request. let request = self.request(Method::POST, "shipments", ns, None); let resp = self.client.execute(request).await.unwrap(); match resp.status() { StatusCode::OK => (), s => { return Err(APIError { status_code: s, body: resp.text().await.unwrap(), }) } }; Ok(resp.json().await.unwrap()) } /// Get a shipment. /// FROM: https://goshippo.com/docs/reference#shipments-retrieve pub async fn get_shipment(&self, id: &str) -> Result<Shipment, APIError> { // Build the request. let request = self.request(Method::GET, &format!("shipments/{}", id), (), None); let resp = self.client.execute(request).await.unwrap(); match resp.status() { StatusCode::OK => (), s => { return Err(APIError { status_code: s, body: resp.text().await.unwrap(), }) } }; Ok(resp.json().await.unwrap()) } } /// Error type returned by our library. pub struct APIError { pub status_code: StatusCode, pub body: String, } impl fmt::Display for APIError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "APIError: status code -> {}, body -> {}", self.status_code.to_string(), self.body) } } impl fmt::Debug for APIError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "APIError: status code -> {}, body -> {}", self.status_code.to_string(), self.body) } } // This is important for other errors to wrap this one. impl error::Error for APIError { fn source(&self) -> Option<&(dyn error::Error + 'static)> { // Generic error, underlying cause isn't tracked. None } } /// The data type for an API response. #[derive(Clone, Debug, Default, Serialize, Deserialize)] pub struct APIResponse { #[serde(default, deserialize_with = "deserialize_null_string::deserialize", skip_serializing_if = "String::is_empty")] pub next: String, #[serde(default, deserialize_with = "deserialize_null_string::deserialize", skip_serializing_if = "String::is_empty")] pub previous: String, #[serde(default, skip_serializing_if = "Vec::is_empty", alias = "results")] pub shipments: Vec<Shipment>, } /// The data type for a Shipment. /// FROM: https://goshippo.com/docs/reference#shipments #[derive(Clone, Debug, Serialize, Deserialize)] pub struct Shipment { /// "Waiting" shipments have been successfully submitted but not yet been /// processed. "Queued" shipments are currently being processed. "Success" /// shipments have been processed successfully, meaning that rate /// generation has concluded. "Error" does not occur currently and is /// reserved for future use. /// "WAITING" | "QUEUED" | "SUCCESS" | "ERROR" #[serde(default, skip_serializing_if = "String::is_empty")] pub status: String, /// Date and time of Shipment creation. pub object_created: DateTime<Utc>, /// Date and time of last Shipment update. pub object_updated: DateTime<Utc>, /// Unique identifier of the given Shipment object. pub object_id: String, /// Username of the user who created the Shipment object. #[serde(default, skip_serializing_if = "String::is_empty")] pub object_owner: String, /// Address object that should be used as sender Address. #[serde(default)] pub address_from: Address, /// Address object that should be used as recipient Address. #[serde(default)] pub address_to: Address, /// Address object where the shipment will be sent back to if it is not /// delivered (Only available for UPS, USPS, and Fedex shipments). /// If this field is not set, your shipments will be returned to the address_from. #[serde(default)] pub address_return: Address, /// Parcel objects to be shipped. #[serde(default, skip_serializing_if = "Vec::is_empty")] pub parcels: Vec<Parcel>, /// Date the shipment will be tendered to the carrier. /// Must be in the format "2014-01-18T00:35:03.463Z". Defaults to current /// date and time if no value is provided. Please note that some carriers /// require this value to be in the future, on a working day, or similar. pub shipment_date: DateTime<Utc>, /// Customs Declarations object for an international shipment. #[serde(default, skip_serializing_if = "String::is_empty")] pub customs_declaration: String, /// A string of up to 100 characters that can be filled with any additional /// information you want to attach to the object. #[serde(default, skip_serializing_if = "String::is_empty")] pub metadata: String, /// An array with all available rates. If `async` has been set to `false` /// in the request, this will be populated with all available rates in the /// response. Otherwise rates will be created asynchronously and this array /// will initially be empty. #[serde(default, skip_serializing_if = "Vec::is_empty")] pub rates: Vec<Rate>, /// Indicates whether the object has been created in test mode. #[serde(default)] pub test: bool, } /// The data type for an address. /// FROM: https://goshippo.com/docs/reference#addresses #[derive(Clone, Debug, Default, Serialize, Deserialize)] pub struct Address { /// Unique identifier of the given Address object. This ID is required to /// create a Shipment object. #[serde(default, skip_serializing_if = "String::is_empty")] pub object_id: String, /// Complete addresses contain all required values. /// Incomplete addresses have failed one or multiple validations. /// Incomplete Addresses are eligible for requesting rates but lack at /// least one required value for purchasing labels. #[serde(default)] pub is_complete: bool, /// First and Last Name of the addressee #[serde(default, skip_serializing_if = "String::is_empty")] pub name: String, #[serde(default, skip_serializing_if = "String::is_empty")] /// Company Name pub company: String, /// First street line, 35 character limit. Usually street number and street /// name (except for DHL Germany, see street_no). #[serde(default, skip_serializing_if = "String::is_empty")] pub street1: String, /// Second street line, 35 character limit. #[serde(default, skip_serializing_if = "String::is_empty")] pub street2: String, /// Name of a city. When creating a Quote Address, sending a city is /// optional but will yield more accurate Rates. Please bear in mind that /// city names may be ambiguous (there are 34 Springfields in the US). /// Pass in a state or a ZIP code (see below), if known, it will yield /// more accurate results. #[serde(default, skip_serializing_if = "String::is_empty")] pub city: String, /// State/Province values are required for shipments from/to the US, AU, /// and CA. UPS requires province for some countries (i.e Ireland). To /// receive more accurate quotes, passing this field is recommended. Most /// carriers only accept two or three character state abbreviations. #[serde(default, skip_serializing_if = "String::is_empty")] pub state: String, /// Postal code of an Address. When creating a Quote Addresses, sending a /// ZIP is optional but will yield more accurate Rates. #[serde(default, skip_serializing_if = "String::is_empty")] pub zip: String, /// Example: 'US' or 'DE'. All accepted values can be found on the Official /// ISO Website. Sending a country is always required. #[serde(default, skip_serializing_if = "String::is_empty")] pub country: String, /// Addresses containing a phone number allow carriers to call the recipient /// when delivering the Parcel. This increases the probability of delivery /// and helps to avoid accessorial charges after a Parcel has been shipped. #[serde(default, skip_serializing_if = "String::is_empty")] pub phone: String, /// E-mail address of the contact person, RFC3696/5321-compliant. #[serde(default, skip_serializing_if = "String::is_empty")] pub email: String, /// Indicates whether the object has been created in test mode. #[serde(default)] pub test: bool, } /// The data type for a parcel. /// FROM: https://goshippo.com/docs/reference#parcels #[derive(Clone, Debug, Default, Serialize, Deserialize)] pub struct Parcel { /// A Parcel will only be valid when all required values have been sent and /// validated successfully. /// "VALID" #[serde(default, skip_serializing_if = "String::is_empty")] pub object_state: String, /// Date and time of Parcel creation. #[serde(default, skip_serializing_if = "Option::is_none")] pub object_created: Option<DateTime<Utc>>, /// Date and time of last Parcel update. Since you cannot update Parcels /// after they were created, this time stamp reflects the time when the /// Parcel was changed by Shippo's systems for the last time, e.g., /// during sorting the dimensions given. #[serde(default, skip_serializing_if = "Option::is_none")] pub object_updated: Option<DateTime<Utc>>, /// Unique identifier of the given Parcel object. This ID is required to /// create a Shipment object. #[serde(default, skip_serializing_if = "String::is_empty")] pub object_id: String, /// Username of the user who created the Parcel object. #[serde(default, skip_serializing_if = "String::is_empty")] pub object_owner: String, /// Length of the Parcel. Up to six digits in front and four digits after /// the decimal separator are accepted. #[serde(default, skip_serializing_if = "String::is_empty")] pub length: String, /// Width of the Parcel. Up to six digits in front and four digits after /// the decimal separator are accepted. #[serde(default, skip_serializing_if = "String::is_empty")] pub width: String, /// Height of the parcel. Up to six digits in front and four digits after /// the decimal separator are accepted. #[serde(default, skip_serializing_if = "String::is_empty")] pub height: String, /// The unit used for length, width and height. /// "cm" | "in" | "ft" | "mm" | "m" | "yd" #[serde(default, skip_serializing_if = "String::is_empty")] pub distance_unit: String, /// Weight of the parcel. Up to six digits in front and four digits after /// the decimal separator are accepted. #[serde(default, skip_serializing_if = "String::is_empty")] pub weight: String, /// The unit used for weight. /// "g" | "oz" | "lb" | "kg" #[serde(default, skip_serializing_if = "String::is_empty")] pub mass_unit: String, /// A string of up to 100 characters that can be filled with any additional /// information you want to attach to the object. #[serde(default, skip_serializing_if = "String::is_empty")] pub metadata: String, /// Indicates whether the object has been created in test mode. #[serde(default)] pub test: bool, } /// The data type for a rate. /// A rate is an available service of a shipping provider for a given shipment, /// typically including the price and transit time. /// FROM: https://goshippo.com/docs/reference#rates #[derive(Clone, Debug, Serialize, Deserialize)] pub struct Rate { /// Unique identifier of the given Rate object. #[serde(default, skip_serializing_if = "String::is_empty")] pub object_id: String, /// Date and time of Rate creation. pub object_created: DateTime<Utc>, /// Username of the user who created the rate object. #[serde(default, skip_serializing_if = "String::is_empty")] pub object_owner: String, /// An array containing specific attributes of this Rate in context of the /// entire shipment. /// Attributes can be assigned 'CHEAPEST', 'FASTEST', or 'BESTVALUE'. #[serde(default, skip_serializing_if = "Vec::is_empty")] pub attributes: Vec<String>, #[serde(default, skip_serializing_if = "String::is_empty")] pub shipment: String, /// Final Rate price, expressed in the currency used in the sender's country. #[serde(default, skip_serializing_if = "String::is_empty")] pub amount: String, /// Currency used in the sender's country, refers to "amount". The official ISO 4217 currency /// codes are used, e.g. "USD" or "EUR". #[serde(default, skip_serializing_if = "String::is_empty")] pub currency: String, /// Final Rate price, expressed in the currency used in the recipient's country. #[serde(default, skip_serializing_if = "String::is_empty")] pub amount_local: String, /// Currency used in the recipient's country, refers to "amount_local". The official ISO 4217 /// currency codes are used, e.g. "USD" or "EUR". #[serde(default, skip_serializing_if = "String::is_empty")] pub currency_local: String, /// Carrier offering the rate, e.g., "FedEx" or "Deutsche Post DHL". #[serde(default, skip_serializing_if = "String::is_empty")] pub provider: String, /// URL to the provider logo with max. dimensions of 75*75px. /// Please refer to the provider's Logo Usage Guidelines before using the logo. #[serde(default, skip_serializing_if = "String::is_empty")] pub provider_image_75: String, /// URL to the provider logo with max. dimensions of 200*200px. /// Please refer to the provider's Logo Usage Guidelines before using the logo. #[serde(default, skip_serializing_if = "String::is_empty")] pub provider_image_200: String, /// Contains details regarding the service level for the given rate. #[serde(default)] pub servicelevel: ServiceLevel, /// Estimated transit time (duration) in days of the Parcel at the given /// servicelevel. Please note that this is not binding, but only an average /// value as given by the provider. Shippo is not able to guarantee any /// transit times. #[serde(default)] pub estimated_days: i64, /// Further clarification of the transit times. /// Often, this includes notes that the transit time as given in "days" /// is only an average, not a guaranteed time. #[serde(default, skip_serializing_if = "String::is_empty")] pub duration_terms: String, /// Object ID of the carrier account that has been used to retrieve the rate. #[serde(default, skip_serializing_if = "String::is_empty")] pub carrier_account: String, /// Indicates whether the object has been created in test mode. #[serde(default)] pub test: bool, } /// The service level data type. #[derive(Clone, Debug, Default, Serialize, Deserialize)] pub struct ServiceLevel { /// Name of the Rate's servicelevel, e.g. "International Priority" or /// "Standard Post". /// A servicelevel commonly defines the transit time of a Shipment /// (e.g., Express vs. Standard), along with other properties. /// These names vary depending on the provider. #[serde(default, skip_serializing_if = "String::is_empty")] pub name: String, /// Token of the Rate's servicelevel, e.g. "usps_priority" or "fedex_ground". #[serde(default, skip_serializing_if = "String::is_empty")] pub token: String, /// Further clarification of the service. #[serde(default, skip_serializing_if = "String::is_empty")] pub terms: String, } #[derive(Clone, Debug, Default, Serialize, Deserialize)] pub struct NewShipment { /// Address object that should be used as sender Address. #[serde(default)] pub address_from: Address, /// Address object that should be used as recipient Address. #[serde(default)] pub address_to: Address, /// Parcel objects to be shipped. #[serde(default, skip_serializing_if = "Vec::is_empty")] pub parcels: Vec<Parcel>, } pub mod deserialize_null_string { use serde::{self, Deserialize, Deserializer}; // The signature of a deserialize_with function must follow the pattern: // // fn deserialize<'de, D>(D) -> Result<T, D::Error> // where // D: Deserializer<'de> // // although it may also be generic over the output types T. pub fn deserialize<'de, D>(deserializer: D) -> Result<String, D::Error> where D: Deserializer<'de>, { let s = String::deserialize(deserializer).unwrap_or_default(); Ok(s) } }