#![deny(missing_docs, missing_debug_implementations)]

//! This crate wraps the Letterboxd API which provides easy and flexible
//! access to data on the Letterboxd.com website.
//!
//! The [client](struct.Client.html)'s API follows the following rules:
//!
//! * All Letterboxd API calls are asynchronous.
//! * A client is always created from API key and secret. If auth token,
//!   is provided, client calls will be authenticated. Client can be
//!   created from username/password. A token can be set after client was created.
//! * API key and secret can be created from default environment variables.
//! * Except GET calls all methods include a path parameter.
//!
//! Further, most of the [Client](struct.Client.html)'s methods take a request
//! struct, which is then serialized to url encoded parameters, and return a
//! response type, which is deserialized from JSON. However, some methods omit
//! the request or/and the response struct.
//!
//! Entities are identified in the API by Letterboxd ID (or LID), an
//! alpha-numeric string value that is returned where appropriate. For films,
//! lists and reviews, the LID can also be found through the Letterboxd website
//! as the path portion of the entity’s shareable boxd.it link.
//!
//! For more information, cf. API docs at <http://api-docs.letterboxd.com>.
//!
//! # Examples
//!
//! Client without authentication:
//!
//! ```rust,no_run
//! async fn list_films() -> letterboxd::Result<()> {
//!     let api_key_pair = letterboxd::ApiKeyPair::from_env().unwrap();
//!     let client = letterboxd::Client::new(api_key_pair);
//!
//!     let req = letterboxd::FilmsRequest {
//!         per_page: Some(1),
//!         ..Default::default()
//!     };
//!     let resp = client.films(&req).await?;
//!     println!("{:?}", resp);
//!
//!     Ok(())
//! }
//! ```
//!
//! Create and authenticate client with username/password:
//!
//! ```rust,no_run
//! async fn update_film_relationship() -> letterboxd::Result<()> {
//!     let api_key_pair = letterboxd::ApiKeyPair::from_env().unwrap();
//!     let username = std::env::var("LETTERBOXD_USERNAME").unwrap();
//!     let password = std::env::var("LETTERBOXD_PASSWORD").unwrap();
//!
//!     let client = letterboxd::Client::authenticate(api_key_pair, &username, &password).await?;
//!     // token can be retrieved after authentication for e.g. caching it on disk
//!     println!("{:?}", client.token().unwrap());
//!
//!     let req = letterboxd::FilmRelationshipUpdateRequest {
//!         watched: Some(true),
//!         ..Default::default()
//!     };
//!     client.update_film_relationship("2a9q", &req).await?; // Fight Club
//!
//!     Ok(())
//! }
//! ```

mod client;
mod defs;
mod error;

pub use client::{ApiKeyPair, Client};
pub use defs::*;
pub use error::{Error, Result};
