Add functionality to work with profiles API.

Author: headcr4sh

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Functionality to work with Gravatar profiles has been added.
+
 ## [0.3.0] - 2024-09-01
 
 ### Changed

src/lib.rs

@@ -5,3 +5,4 @@ extern crate url;
 
 pub mod avatars;
 mod common;
+pub mod profiles;

src/profiles/format.rs

@@ -0,0 +1,54 @@
+use std::fmt;
+
+/// The data format to be used when retrieving profiles.
+///
+/// See <https://docs.gravatar.com/api/profiles/#data-formats>.
+#[derive(Clone, Debug)]
+pub enum Format {
+    /// JSON
+    /// See <https://docs.gravatar.com/api/profiles/json/>.
+    Json,
+
+    /// XML
+    /// See <https://docs.gravatar.com/api/profiles/xml/>.
+    Xml,
+
+    /// PHP
+    /// See <https://docs.gravatar.com/api/profiles/php/>.
+    Php,
+
+    /// VCF/vCard
+    /// See <https://docs.gravatar.com/api/profiles/vcf-vcard/>.
+    Vcard,
+
+    // QR code image in PNG format
+    // See <https://docs.gravatar.com/api/profiles/qr-codes/>
+    QrCode,
+}
+
+impl std::fmt::Display for Format {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let val = match self {
+            Format::Json => "json",
+            Format::Xml => "xml",
+            Format::Php => "php",
+            Format::Vcard => "vcf",
+            Format::QrCode => "qr",
+        };
+        f.write_str(val)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_to_string() {
+        assert_eq!(Format::Json.to_string(), "json");
+        assert_eq!(Format::Xml.to_string(), "xml");
+        assert_eq!(Format::Php.to_string(), "php");
+        assert_eq!(Format::Vcard.to_string(), "vcf");
+        assert_eq!(Format::QrCode.to_string(), "qr");
+    }
+}

src/profiles/mod.rs

@@ -1 +1,70 @@
 const BASE_URL: &str = "https://gravatar.com/";
+
+use url::Url;
+
+use crate::common::email_hash;
+
+mod format;
+
+pub use format::Format;
+
+/// Representation of a single Gravatar profile URL.
+#[derive(Clone, Debug)]
+pub struct Profile {
+    email: String,
+}
+
+impl Profile {
+    pub fn builder(email: &str) -> ProfileBuilder {
+        ProfileBuilder::new(email)
+    }
+
+    /// Returns the URL of the Gravatar image.
+    pub fn profile_url(self: &Self, format: Format) -> Url {
+        let str = format!(
+            "{}{}.{}",
+            BASE_URL,
+            email_hash(&self.email),
+            format.to_string()
+        );
+        Url::parse(&str).unwrap()
+    }
+}
+
+// Builder for Profile instances.
+#[derive(core::default::Default)]
+pub struct ProfileBuilder {
+    email: String,
+}
+
+impl ProfileBuilder {
+    pub fn new(email: &str) -> ProfileBuilder {
+        ProfileBuilder {
+            email: email.to_string(),
+            ..core::default::Default::default()
+        }
+    }
+    /// Builds the Profile instance.
+    pub fn build(self) -> Profile {
+        Profile { email: self.email }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_profile_builder() {
+        let email = "[email protected]";
+
+        let builder = Profile::builder(email);
+        let profile = builder.build();
+        assert_eq!(email, profile.email);
+        assert_eq!("https://gravatar.com/f807b5609eae64257bf4877652ea49fee40ac2451c152c12fa596ffeda647157.json", profile.profile_url(Format::Json).to_string());
+        assert_eq!("https://gravatar.com/f807b5609eae64257bf4877652ea49fee40ac2451c152c12fa596ffeda647157.xml", profile.profile_url(Format::Xml).to_string());
+        assert_eq!("https://gravatar.com/f807b5609eae64257bf4877652ea49fee40ac2451c152c12fa596ffeda647157.php", profile.profile_url(Format::Php).to_string());
+        assert_eq!("https://gravatar.com/f807b5609eae64257bf4877652ea49fee40ac2451c152c12fa596ffeda647157.vcf", profile.profile_url(Format::Vcard).to_string());
+        assert_eq!("https://gravatar.com/f807b5609eae64257bf4877652ea49fee40ac2451c152c12fa596ffeda647157.qr", profile.profile_url(Format::QrCode).to_string());
+    }
+}