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 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
//! Main logic use crate::{groups::*, EsiBuilder, EsiError, EsiResult}; use log::{debug, error}; use reqwest::{ header::{self, HeaderMap, HeaderValue}, Client, Method, }; use serde::{de::DeserializeOwned, Deserialize}; use serde_json::{json, Value}; use std::str::FromStr; const BASE_URL: &str = "https://esi.evetech.net/"; const OAUTH_URL: &str = "https://login.eveonline.com/oauth/"; const AUTHORIZE_URL: &str = "https://login.eveonline.com/oauth/authorize"; const TOKEN_URL: &str = "https://login.eveonline.com/oauth/token"; const SPEC_URL_START: &str = "https://esi.evetech.net/_"; const SPEC_URL_END: &str = "/swagger.json"; /// Response from SSO when exchanging a SSO code for tokens. #[derive(Debug, Deserialize)] pub(crate) struct AuthenticateResponse { pub(crate) access_token: String, pub(crate) token_type: String, pub(crate) expires_in: u64, pub(crate) refresh_token: Option<String>, } /// Information about the currently-authenticated user. #[derive(Debug, Deserialize)] #[serde(rename_all = "PascalCase")] pub struct WhoAmIResponse { #[serde(rename = "CharacterID")] pub character_id: u64, pub character_name: String, pub expires_on: String, pub scopes: String, pub token_type: String, pub character_owner_hash: String, pub intellectual_property: String, } /// Which base URL to start with - the public URL for unauthenticated /// calls, or the authenticated URL for making calls to endpoints that /// require an access token. #[derive(Debug, PartialEq)] pub enum RequestType { /// Endpoints that do not require authentication Public, /// Endpoints that require acting on behalf of an authenticated character Authenticated, } /// Struct to interact with ESI. /// /// Construct an instance of this struct using [`EsiBuilder`](./struct.EsiBuilder.html). /// /// # Example /// ```rust,no_run /// use rfesi::EsiBuilder; /// // the struct must be mutable for some functionality /// let mut esi = EsiBuilder::new() /// .user_agent("some user agent") /// .client_id("your_client_id") /// .client_secret("your_client_secret") /// .callback_url("your_callback_url") /// .build() /// .unwrap(); /// ``` #[derive(Clone, Debug)] pub struct Esi { pub(crate) version: String, pub(crate) client_id: String, pub(crate) client_secret: String, pub(crate) callback_url: String, pub(crate) scope: String, /// The access token from ESI, if set. pub access_token: Option<String>, /// The expiration timestamp of the access token, if set. pub access_expiration: Option<u64>, /// The refresh token from ESI, if set. pub refresh_token: Option<String>, /// HTTP client pub(crate) client: Client, pub(crate) spec: Option<Value>, } impl Esi { /// Consume the builder, creating an instance of this struct. pub(crate) fn from_builder(builder: EsiBuilder) -> EsiResult<Self> { let client = builder.construct_client()?; let version = builder.version.unwrap_or_else(|| "latest".to_owned()); // let spec = Esi::get_spec(&client, &version).await?; let e = Esi { version, client_id: builder .client_id .ok_or_else(|| EsiError::EmptyClientValue("client_id".to_owned()))?, client_secret: builder .client_secret .ok_or_else(|| EsiError::EmptyClientValue("client_secret".to_owned()))?, callback_url: builder .callback_url .ok_or_else(|| EsiError::EmptyClientValue("callback_url".to_owned()))?, scope: builder.scope.unwrap_or_else(|| "".to_owned()), access_token: builder.access_token, access_expiration: builder.access_expiration, refresh_token: builder.refresh_token, client, spec: None, }; Ok(e) } /// Get the Swagger spec from ESI and store it in this struct. /// /// If you are making use of the `try_get_endpoint_for_op_id`, /// then this function will be called there when needed /// (which should only really be when the struct is /// constructed unless the struct is kept in memory for a very /// long time). When using `get_endpoint_for_op_id` however, /// you are responsible for calling this function beforehand. /// /// # Example /// ```rust,no_run /// # async fn run() { /// # use rfesi::EsiBuilder; /// # let mut esi = EsiBuilder::new() /// # .user_agent("some user agent") /// # .client_id("your_client_id") /// # .client_secret("your_client_secret") /// # .callback_url("your_callback_url") /// # .build() /// # .unwrap(); /// esi.update_spec().await.unwrap(); /// # } pub async fn update_spec(&mut self) -> EsiResult<()> { debug!("Updating spec with version {}", self.version); let resp = self .client .get(&format!( "{}{}{}", SPEC_URL_START, self.version, SPEC_URL_END )) .send() .await?; if !resp.status().is_success() { error!("Got status {} when requesting spec", resp.status()); return Err(EsiError::InvalidStatusCode(resp.status().as_u16())); } let data: Value = resp.json().await?; self.spec = Some(data); Ok(()) } /// Generate and return the URL required for the user to grant you an auth code. /// /// # Example /// ```rust,no_run /// # use rfesi::EsiBuilder; /// # let mut esi = EsiBuilder::new() /// # .user_agent("some user agent") /// # .client_id("your_client_id") /// # .client_secret("your_client_secret") /// # .callback_url("your_callback_url") /// # .build() /// # .unwrap(); /// let url = esi.get_authorize_url(); /// // then send your user to that URL /// ``` pub fn get_authorize_url(&self) -> String { format!( "{}?response_type=code&redirect_uri={}&client_id={}&scope={}", AUTHORIZE_URL, self.callback_url, self.client_id, self.scope ) } fn get_auth_headers(&self) -> EsiResult<HeaderMap> { let mut map = HeaderMap::new(); let value = base64::encode(format!("{}:{}", self.client_id, self.client_secret)) .replace("\n", "") .replace(" ", ""); map.insert( header::AUTHORIZATION, HeaderValue::from_str(&format!("Basic {}", value))?, ); Ok(map) } /// Authenticate with ESI, exchanging a code from the authorize flow /// for an access token that is used to make authenticated calls to ESI. /// /// Note that this is one of the functions that requires the struct be /// mutable, as the struct mutates to include the resulting access token. /// /// # Example /// ```rust,no_run /// # async fn run() { /// # use rfesi::EsiBuilder; /// # let mut esi = EsiBuilder::new() /// # .user_agent("some user agent") /// # .client_id("your_client_id") /// # .client_secret("your_client_secret") /// # .callback_url("your_callback_url") /// # .build() /// # .unwrap(); /// esi.authenticate("abcdef").await.unwrap(); /// # } /// ``` pub async fn authenticate(&mut self, code: &str) -> EsiResult<()> { debug!("Authenticating with code {}", code); let resp = self .client .post(TOKEN_URL) .headers(self.get_auth_headers()?) .json(&json!({ "grant_type": "authorization_code", "code": code, })) .send() .await?; if resp.status() != 200 { error!( "Got status {} when making call to authenticate", resp.status() ); return Err(EsiError::InvalidStatusCode(resp.status().as_u16())); } let data: AuthenticateResponse = resp.json().await?; self.access_token = Some(data.access_token); self.access_expiration = Some(data.expires_in + chrono::Utc::now().timestamp() as u64); self.refresh_token = data.refresh_token; Ok(()) } /// Make a request to ESI. /// /// This is mainly used as the underlying function for this /// library when making calls to ESI; the other functions that /// you should primarily be using contain more functionality, /// including matching endpoint with deserialization struct, /// evaluating & replacing URL parameters, etc. /// /// In the event that there is not a wrapper function for the /// endpoint that you want to use, you can use this function /// to make an API call without waiting for the library to /// be updated. /// /// # Example /// ```rust,no_run /// # async fn run() { /// # use serde::Deserialize; /// # use rfesi::{EsiBuilder, RequestType}; /// # let mut esi = EsiBuilder::new() /// # .user_agent("some user agent") /// # .client_id("your_client_id") /// # .client_secret("your_client_secret") /// # .callback_url("your_callback_url") /// # .build() /// # .unwrap(); /// #[derive(Deserialize)] /// struct ReturnedData {} /// let data: ReturnedData = esi.query("GET", RequestType::Public, "abc", None, None).await.unwrap(); /// # } /// ``` pub async fn query<T: DeserializeOwned>( &self, method: &str, request_type: RequestType, endpoint: &str, query: Option<&[(&str, &str)]>, body: Option<&str>, ) -> EsiResult<T> { debug!( "Making {} request to {:?}{} with query {:?}", method, request_type, endpoint, query ); if request_type == RequestType::Authenticated && self.access_token.is_none() { return Err(EsiError::MissingAuthentication); } // TODO caching let headers = { let mut map = HeaderMap::new(); // The 'user-agent' and 'content-type' headers are set in the default headers // from the builder, so all that's required here is to set the authorization // header, if present. match &self.access_token { Some(at) => { map.insert( header::AUTHORIZATION, HeaderValue::from_str(&format!("Bearer {}", at))?, ); } None => (), } map }; let url = format!( "{}{}", match request_type { RequestType::Public => BASE_URL, RequestType::Authenticated => OAUTH_URL, }, endpoint ); let mut req_builder = self .client .request(Method::from_str(method)?, &url) .headers(headers) .query(query.unwrap_or_else(|| &[])); req_builder = match body { Some(b) => req_builder.body(b.to_owned()), None => req_builder, }; let req = req_builder.build()?; let resp = self.client.execute(req).await?; if !resp.status().is_success() { error!( "Got status {} when requesting data from {}", resp.status(), url ); return Err(EsiError::InvalidStatusCode(resp.status().as_u16())); } let data: T = resp.json().await?; Ok(data) } /// Resolve an `operationId` to a URL path utilizing the Swagger spec. /// /// If the spec has not yet been retrieved when calling this function, /// an API call will be made to ESI to fetch that data (thus the /// async signature of this function). If you don't need that help (by /// explicitly making a call to `update_spec` prior) then you can use /// the `get_endpoint_for_op_id` function, which is synchronous. /// /// Note that when making use of this function along with `query`, you /// are responsible for resolving any/all URL parameters that the endpoint /// may contain. /// /// # Example /// ```rust,no_run /// # async fn run() { /// # use rfesi::EsiBuilder; /// # let mut esi = EsiBuilder::new() /// # .user_agent("some user agent") /// # .client_id("your_client_id") /// # .client_secret("your_client_secret") /// # .callback_url("your_callback_url") /// # .build() /// # .unwrap(); /// let endpoint = esi /// .try_get_endpoint_for_op_id("get_alliances_alliance_id_contacts_labels") /// .await /// .unwrap(); /// # } /// ``` pub async fn try_get_endpoint_for_op_id(&mut self, op_id: &str) -> EsiResult<String> { if self.spec.is_none() { debug!("Spec is `None`; must fetch before looking up op_id"); self.update_spec().await?; } self.get_endpoint_for_op_id(op_id) } /// Resolve an `operationId` to a URL path utilizing the Swagger spec. /// /// If the spec has not yet been retrieved when calling this function, /// this function will return an error. /// /// Note that when making use of this function along with `query`, you /// are responsible for resolving any/all URL parameters that the endpoint /// may contain. /// /// # Example /// ```rust,no_run /// # use rfesi::EsiBuilder; /// # let mut esi = EsiBuilder::new() /// # .user_agent("some user agent") /// # .client_id("your_client_id") /// # .client_secret("your_client_secret") /// # .callback_url("your_callback_url") /// # .build() /// # .unwrap(); /// let endpoint = esi.get_endpoint_for_op_id("get_alliances_alliance_id_contacts_labels").unwrap(); /// ``` pub fn get_endpoint_for_op_id(&self, op_id: &str) -> EsiResult<String> { let data = self .spec .as_ref() .ok_or_else(|| EsiError::FailedSpecParse("Unwrapping JSON Value".to_owned()))?; let paths = data["paths"] .as_object() .ok_or_else(|| EsiError::FailedSpecParse("Getting paths".to_owned()))?; for (path_str, path_obj) in paths.iter() { let path = path_obj .as_object() .ok_or_else(|| EsiError::FailedSpecParse("Parsing a path".to_owned()))?; for method in path.values() { let operation_id = match method["operationId"].as_str() { Some(o) => o, None => continue, }; if operation_id == op_id { // the paths contain a leading slash, so strip it return Ok(path_str.chars().skip(1).collect()); } } } Err(EsiError::UnknownOperationID(op_id.to_owned())) } /// Gets information on the currently-authenticated user. pub async fn get_whoami_info(&self) -> EsiResult<WhoAmIResponse> { self.query("GET", RequestType::Authenticated, "verify", None, None) .await } /// Call endpoints under the "alliance" group in ESI. pub fn group_alliance(&self) -> AllianceGroup { AllianceGroup { esi: self } } /// Call endpoints under the "Assets" group in ESI. pub fn group_assets(&self) -> AssetsGroup { AssetsGroup { esi: self } } /// Call endpoints under the "Bookmarks" group in ESI. pub fn group_bookmarks(&self) -> BookmarksGroup { BookmarksGroup { esi: self } } /// Call endpoints under the "Calendar" group in ESI. pub fn group_calendar(&self) -> CalendarGroup { CalendarGroup { esi: self } } /// Call endpoints under the "Character" group in ESI. pub fn group_character(&self) -> CharacterGroup { CharacterGroup { esi: self } } /// Call endpoints under the "Clones" group in ESI. pub fn group_clones(&self) -> ClonesGroup { ClonesGroup { esi: self } } /// Call endpoints under the "Contacts" group in ESI. pub fn group_contacts(&self) -> ContactsGroup { ContactsGroup { esi: self } } /// Call endpoints under the "Contracts" group in ESI. pub fn group_contracts(&self) -> ContractsGroup { ContractsGroup { esi: self } } /// Call endpoints under the "Corporation" group in ESI. pub fn group_corporation(&self) -> CorporationGroup { CorporationGroup { esi: self } } /// Call endpoints under the "Dogma" group in ESI. pub fn group_dogma(&self) -> DogmaGroup { DogmaGroup { esi: self } } /// Call endpoints under the "FactionWarfare" group in ESI. pub fn group_faction_warfare(&self) -> FactionWarfareGroup { FactionWarfareGroup { esi: self } } /// Call endpoints under the "Fittings" group in ESI. pub fn group_fittings(&self) -> FittingsGroup { FittingsGroup { esi: self } } /// Call endpoints under the "Fleets" group in ESI. pub fn group_fleets(&self) -> FleetsGroup { FleetsGroup { esi: self } } /// Call endpoints under the "Incursions" group in ESI. pub fn group_incursions(&self) -> IncursionsGroup { IncursionsGroup { esi: self } } /// Call endpoints under the "Industry" group in ESI. pub fn group_industry(&self) -> IndustryGroup { IndustryGroup { esi: self } } /// Call endpoints under the "Insurance" group in ESI. pub fn group_insurance(&self) -> InsuranceGroup { InsuranceGroup { esi: self } } /// Call endpoints under the "Killmails" group in ESI. pub fn group_killmails(&self) -> KillmailsGroup { KillmailsGroup { esi: self } } /// Call endpoints under the "Location" group in ESI. pub fn group_location(&self) -> LocationGroup { LocationGroup { esi: self } } /// Call endpoints under the "Loyalty" group in ESI. pub fn group_loyalty(&self) -> LoyaltyGroup { LoyaltyGroup { esi: self } } /// Call endpoints under the "Mail" group in ESI. pub fn group_mail(&self) -> MailGroup { MailGroup { esi: self } } /// Call endpoints under the "Market" group in ESI. pub fn group_market(&self) -> MarketGroup { MarketGroup { esi: self } } /// Call endpoints under the "Opportunities" group in ESI. pub fn group_opportunities(&self) -> OpportunitiesGroup { OpportunitiesGroup { esi: self } } /// Call endpoints under the "PlanetaryInteraction" group in ESI. pub fn group_planetary_interaction(&self) -> PlanetaryInteractionGroup { PlanetaryInteractionGroup { esi: self } } /// Call endpoints under the "Routes" group in ESI. pub fn group_routes(&self) -> RoutesGroup { RoutesGroup { esi: self } } /// Call endpoints under the "Search" group in ESI. pub fn group_search(&self) -> SearchGroup { SearchGroup { esi: self } } /// Call endpoints under the "Skills" group in ESI. pub fn group_skills(&self) -> SkillsGroup { SkillsGroup { esi: self } } /// Call endpoints under the "Sovereignty" group in ESI. pub fn group_sovereignty(&self) -> SovereigntyGroup { SovereigntyGroup { esi: self } } /// Call endpoints under the "Status" group in ESI. pub fn group_status(&self) -> StatusGroup { StatusGroup { esi: self } } /// Call endpoints under the "Universe" group in ESI. pub fn group_universe(&self) -> UniverseGroup { UniverseGroup { esi: self } } /// Call endpoints under the "UserInterface" group in ESI. pub fn group_user_interface(&self) -> UserInterfaceGroup { UserInterfaceGroup { esi: self } } /// Call endpoints under the "Wallet" group in ESI. pub fn group_wallet(&self) -> WalletGroup { WalletGroup { esi: self } } /// Call endpoints under the "Wars" group in ESI. pub fn group_wars(&self) -> WarsGroup { WarsGroup { esi: self } } } #[cfg(test)] mod tests { use super::AuthenticateResponse; #[test] fn test_authenticateresponse_deserialize() { let source = r#"{ "access_token": "abc", "token_type": "Bearer", "expires_in": 1000, "refresh_token": "def" }"#; let data: AuthenticateResponse = serde_json::from_str(source).unwrap(); assert_eq!(data.access_token, "abc"); assert_eq!(data.expires_in, 1000); assert_eq!(data.refresh_token, Some("def".to_owned())); } #[test] fn test_authenticateresponse_deserialize_no_refresh_token() { let source = r#"{ "access_token": "abc", "token_type": "Bearer", "expires_in": 1000, "refresh_token": null }"#; let data: AuthenticateResponse = serde_json::from_str(source).unwrap(); assert_eq!(data.access_token, "abc"); assert_eq!(data.expires_in, 1000); assert_eq!(data.refresh_token, None); } }