Initial commit

Signed-off-by: Benjamin P. Jung <[email protected]>

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build
+        run: cargo build --verbose
+      - name: Run tests
+        run: cargo test --verbose

.gitignore

@@ -0,0 +1 @@
+/target

Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "gravatar_api"
+version = "0.1.0"
+authors = ["Benjamin P. Jung <[email protected]>"]
+description = "Access to the public Gravatar API"
+edition = "2021"
+license = "MIT"
+repository = "https://github.com/cathive/rust-gravatar-api"
+
+[dependencies]
+sha2 = "0.9.1"
+url = "2"

LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2013-2022 The rust-url developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,19 @@
+# Gravatar API Client for Rust
+
+## Example Usage
+
+```rust
+use gravatar_api::avatars;
+
+fn main() {
+    println!(
+        "{}",
+        avatars::Avatar::builder("[email protected]")
+            .size(512)
+            .default(avatars::Default::RoboHash)
+            .rating(avatars::Rating::G)
+            .build()
+            .image_url()
+    );
+}
+``

src/avatar/default.rs

@@ -0,0 +1,33 @@
+/// The default image to display if the user's email does not have a Gravatar.
+///
+/// See <https://en.gravatar.com/site/implement/images/#default-image>.
+#[derive(Clone, Debug)]
+pub enum Default {
+    /// The URL of an image file to display as the default.
+    ImageUrl(String),
+
+    /// Instead of loading an image, the Gravatar URL will return an HTTP 404 (File Not Found)
+    /// response if the email is not found.
+    Http404,
+
+    /// A transparent PNG image.
+    Blank,
+
+    /// A simple, cartoon-style silhouetted outline of a person that does not vary by email hash.
+    MysteryPerson,
+
+    /// A geometric pattern based on the email hash.
+    Identicon,
+
+    /// A "monster" with different colors, faces, etc. that are generated by the email hash.
+    MonsterId,
+
+    /// A face with different features and backgrounds, generated by the email hash.
+    Wavatar,
+
+    /// An 8-bit arcade-style pixelated face that is generated by the email hash.
+    Retro,
+
+    /// A generated robot with different colors, faces, etc.
+    RoboHash,
+}

src/avatar/rating.rs

@@ -0,0 +1,23 @@
+/// The maximum rating level for which Gravatar will show the user's image instead of the specified
+/// default.
+///
+/// See <https://en.gravatar.com/site/implement/images/#rating>.
+#[derive(Clone, Debug)]
+pub enum Rating {
+    /// Show "G"-rated images only,
+    /// suitable for display on all websites with any audience type.
+    G,
+
+    /// Show "PG"-rated images or lower only,
+    /// may contain rude gestures, provocatively dressed individuals, the lesser swear words,
+    /// or mild violence.
+    Pg,
+
+    /// Show "R"-rated images or lower only,
+    /// may contain such things as harsh profanity, intense violence, nudity, or hard drug use.
+    R,
+
+    /// Show all images, up to and including "X"-rated ones,
+    /// may contain sexual imagery or extremely disturbing violence.
+    X,
+}

src/avatars/default.rs

@@ -0,0 +1,76 @@
+use std::fmt;
+use url;
+
+/// The default image to display if the user's email does not have a Gravatar.
+///
+/// See <https://en.gravatar.com/site/implement/images/#default-image>.
+#[derive(Clone, Debug)]
+pub enum Default {
+    /// The URL of an image file to display as the default.
+    ImageUrl(String),
+
+    /// Instead of loading an image, the Gravatar URL will return an HTTP 404 (File Not Found)
+    /// response if the email is not found.
+    Http404,
+
+    /// A transparent PNG image.
+    Blank,
+
+    /// A simple, cartoon-style silhouetted outline of a person that does not vary by email hash.
+    MysteryPerson,
+
+    /// A geometric pattern based on the email hash.
+    Identicon,
+
+    /// A "monster" with different colors, faces, etc. that are generated by the email hash.
+    MonsterId,
+
+    /// A face with different features and backgrounds, generated by the email hash.
+    Wavatar,
+
+    /// An 8-bit arcade-style pixelated face that is generated by the email hash.
+    Retro,
+
+    /// A generated robot with different colors, faces, etc.
+    RoboHash,
+}
+
+impl std::fmt::Display for Default {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let val = match self {
+            Default::Http404 => "404",
+            Default::MysteryPerson => "mp",
+            Default::Identicon => "identicon",
+            Default::MonsterId => "monsterid",
+            Default::Wavatar => "wavatar",
+            Default::Retro => "retro",
+            Default::RoboHash => "robohash",
+            Default::Blank => "blank",
+            Default::ImageUrl(ref u) => {
+                &url::form_urlencoded::byte_serialize(u.as_bytes()).collect::<String>()
+            }
+        };
+        f.write_str(val)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_to_string() {
+        assert_eq!(Default::Http404.to_string(), "404");
+        assert_eq!(Default::MysteryPerson.to_string(), "mp");
+        assert_eq!(Default::Identicon.to_string(), "identicon");
+        assert_eq!(Default::MonsterId.to_string(), "monsterid");
+        assert_eq!(Default::Wavatar.to_string(), "wavatar");
+        assert_eq!(Default::Retro.to_string(), "retro");
+        assert_eq!(Default::RoboHash.to_string(), "robohash");
+        assert_eq!(Default::Blank.to_string(), "blank");
+        assert_eq!(
+            Default::ImageUrl("[email protected]".to_string()).to_string(),
+            "anonymous%40example.com"
+        );
+    }
+}