From 1835bb7b53fdef84ca3689f8a427156d25d45dea Mon Sep 17 00:00:00 2001
From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>
Date: Sun, 21 Apr 2024 17:37:30 -0400
Subject: [PATCH] refactor: create common.py

---
 src/common.py          | 25 +++++++++++++++++++++++++
 src/discord_avatar.py  |  4 ++--
 src/discord_helpers.py | 24 ------------------------
 src/reddit_bot.py      | 27 ++++-----------------------
 4 files changed, 31 insertions(+), 49 deletions(-)
 create mode 100644 src/common.py

diff --git a/src/common.py b/src/common.py
new file mode 100644
index 0000000..b874ce6
--- /dev/null
+++ b/src/common.py
@@ -0,0 +1,25 @@
+# lib imports
+from libgravatar import Gravatar
+
+
+def get_bot_avatar(gravatar: str) -> str:
+    """
+    Get Gravatar image url.
+
+    Return the Gravatar image url of the given email address.
+
+    Parameters
+    ----------
+    gravatar : str
+        The Gravatar email address.
+
+    Returns
+    -------
+    str
+        Gravatar image url.
+    """
+
+    g = Gravatar(email=gravatar)
+    image_url = g.get_image()
+
+    return image_url
diff --git a/src/discord_avatar.py b/src/discord_avatar.py
index 040d030..1776f9c 100644
--- a/src/discord_avatar.py
+++ b/src/discord_avatar.py
@@ -6,10 +6,10 @@
 import requests
 
 # local imports
-from discord_helpers import get_bot_avatar
+import common
 
 # avatar
-avatar = get_bot_avatar(gravatar=os.environ['GRAVATAR_EMAIL'])
+avatar = common.get_bot_avatar(gravatar=os.environ['GRAVATAR_EMAIL'])
 
 avatar_response = requests.get(url=avatar)
 avatar_img = BytesIO(avatar_response.content).read()
diff --git a/src/discord_helpers.py b/src/discord_helpers.py
index 8dea361..ffe7f04 100644
--- a/src/discord_helpers.py
+++ b/src/discord_helpers.py
@@ -2,7 +2,6 @@
 from typing import Union
 
 # lib imports
-from libgravatar import Gravatar
 import requests
 
 # convert month number to igdb human-readable month
@@ -22,29 +21,6 @@
 }
 
 
-def get_bot_avatar(gravatar: str) -> str:
-    """
-    Get Gravatar image url.
-
-    Return the Gravatar image url of the given email address.
-
-    Parameters
-    ----------
-    gravatar : str
-        The Gravatar email address.
-
-    Returns
-    -------
-    str
-        Gravatar image url.
-    """
-
-    g = Gravatar(email=gravatar)
-    image_url = g.get_image()
-
-    return image_url
-
-
 def igdb_authorization(client_id: str, client_secret: str) -> dict:
     """
     Authorization for IGDB.
diff --git a/src/reddit_bot.py b/src/reddit_bot.py
index 0a97519..dc0c82a 100644
--- a/src/reddit_bot.py
+++ b/src/reddit_bot.py
@@ -11,11 +11,13 @@
 from typing import Optional
 
 # lib imports
-from libgravatar import Gravatar
 import praw
 from praw import models
 from praw.util.token_manager import FileTokenManager
 
+# local imports
+import common
+
 # modify as required
 APP = 'lizardbyte-bot'
 VERSION = 'v1'
@@ -142,27 +144,6 @@ def send_message(client: socket.socket, message: str):
     client.close()
 
 
-def get_bot_avatar(gravatar: str) -> str:
-    """
-    Get the gravatar of a given email.
-
-    Parameters
-    ----------
-    gravatar : str
-        The gravatar email.
-
-    Returns
-    -------
-    str
-        The gravatar image url.
-    """
-
-    g = Gravatar(email=gravatar)
-    image_url = g.get_image()
-
-    return image_url
-
-
 def process_submission(submission: models.Submission):
     """
     Process a reddit submission.
@@ -346,7 +327,7 @@ def init():
 
     # avatar
     global avatar
-    avatar = get_bot_avatar(gravatar=os.environ['GRAVATAR_EMAIL'])
+    avatar = common.get_bot_avatar(gravatar=os.environ['GRAVATAR_EMAIL'])
 
     # verify reddit refresh token or get new
     token = initialize_refresh_token_file()