1
Fork 0
gravatar-rs/source/lib.rs

120 lines
3.1 KiB
Rust

//! # gravatar-rs
//!
//! This crate provides an API for creating [Gravatar image URLs], and by
//! extension, [Ivatar/Libravatar image URLs].
//!
//! [Gravatar image URLs]: https://gravatar.com/site/implement/images/
//! [Ivatar/Libravatar image URLs]: https://wiki.libravatar.org/api/
//!
//! The default [`Generator::base_url`] is `www.gravatar.com`, if you want to
//! set a custom `base_url` use [`Generator::set_base_url`].
//!
//! ```rust
//! use gravatar_rs::Generator;
//!
//! let generator = Generator::default();
//!
//! let gravatar_url = generator.generate("helllo@holllo.cc");
//!
//! assert_eq!(
//! gravatar_url,
//! "https://www.gravatar.com/avatar/ebff9105dce4954b1bdb57fdab079ff3"
//! );
//! ```
/// A generator for Gravatar image URLs.
#[derive(Debug)]
pub struct Generator {
pub base_url: String,
pub image_size: Option<i32>,
}
impl Default for Generator {
fn default() -> Self {
Self {
base_url: "www.gravatar.com".to_string(),
image_size: None,
}
}
}
impl Generator {
/// Hashes an email with [`md5`] according to the [Gravatar hashing steps].
///
/// ```rust
/// use gravatar_rs::Generator;
///
/// let hash = Generator::hash_email("helllo@holllo.cc");
///
/// assert_eq!(
/// hash,
/// "ebff9105dce4954b1bdb57fdab079ff3"
/// );
/// ```
///
/// [Gravatar hashing steps]: https://en.gravatar.com/site/implement/hash/
pub fn hash_email(email: &str) -> String {
let hash = md5::compute(email.trim().to_lowercase());
format!("{hash:x}")
}
/// Generates a new Gravatar image URL using the Generator's configuration.
///
/// See the top-level module documentation for examples.
pub fn generate(&self, email: &str) -> String {
let base_url = &self.base_url;
let hash = Self::hash_email(email);
let query_parameters = self.query_parameters();
format!("https://{base_url}/avatar/{hash}{query_parameters}")
}
/// Returns all configurable options as a query parameter string.
pub fn query_parameters(&self) -> String {
fn encode<D: std::fmt::Display>(data: D) -> String {
urlencoding::encode(&data.to_string()).into_owned()
}
let mut query_parameters = vec![];
if let Some(image_size) = self.image_size {
query_parameters.push(format!("s={}", encode(image_size)));
}
if query_parameters.is_empty() {
String::new()
} else {
format!("?{}", query_parameters.join("&"))
}
}
/// Configures the Generator to use a custom base URL for generated URLs.
///
/// ```rust
/// use gravatar_rs::Generator;
///
/// // Use Libravatar instead of Gravatar.
/// Generator::default().set_base_url("cdn.libravatar.org");
/// ```
pub fn set_base_url(self, base_url: &str) -> Self {
Self {
base_url: base_url.to_string(),
..self
}
}
/// Configures the Generator to include a `s=<image size>` in the URL.
///
/// ```rust
/// use gravatar_rs::Generator;
///
/// // Get 128px images instead of the default 80px.
/// Generator::default().set_image_size(128);
/// ```
pub fn set_image_size(self, image_size: i32) -> Self {
Self {
image_size: Some(image_size),
..self
}
}
}