feat: Adds endpoint for custom emoji (#107)

Author: db0

examples/emoji.py

@@ -0,0 +1,40 @@
+
+## python examples/emoji.py db0
+
+import os
+import argparse
+import json
+from pythorhead import Lemmy
+
+
+arg_parser = argparse.ArgumentParser()
+arg_parser.add_argument('username', action="store")
+arg_parser.add_argument('-d', '--lemmy_domain', action='store', required=False, type=str, help="the domain in which to look for this user")
+arg_parser.add_argument('-u', '--lemmy_username', action='store', required=False, type=str, help="Which user to authenticate as")
+arg_parser.add_argument('-p', '--lemmy_password', action='store', required=False, type=str, help="Which password to authenticate with")
+args = arg_parser.parse_args()
+
+
+
+lemmy_domain = args.lemmy_domain
+if not lemmy_domain:
+    lemmy_domain = os.getenv('LEMMY_DOMAIN', "lemmy.dbzer0.com")
+if not lemmy_domain:
+    raise Exception("You need to provide a lemmy domain via env var or arg")
+
+lemmy_username = args.lemmy_username
+if not lemmy_username:
+    lemmy_username = os.getenv("LEMMY_USERNAME")
+
+lemmy_password = args.lemmy_password
+if not lemmy_password:
+    lemmy_password = os.getenv("LEMMY_PASSWORD")
+
+lemmy = Lemmy(f"https://{lemmy_domain}", raise_exceptions=True)
+if lemmy_username and lemmy_password:
+    login = lemmy.log_in(lemmy_username, lemmy_password)
+emoji = lemmy.emoji.get()
+if emoji:
+    print(json.dumps(emoji, indent=4))
+else:
+    print("Retrieval of emoji information failed")

examples/site.py

@@ -1,5 +1,5 @@
 
-## python examples/user.py db0
+## python examples/site.py db0
 
 import os
 import argparse
@@ -35,6 +35,6 @@
     login = lemmy.log_in(lemmy_username, lemmy_password)
 site = lemmy.site.get()
 if site:
-    print(json.dumps(site["admins"], indent=4))
+    print(json.dumps(site, indent=4))
 else:
     print("Retrieval of site information failed")

pythorhead/emoji.py

@@ -0,0 +1,104 @@
+from typing import Any, List, Optional, Union
+
+from pythorhead.requestor import Request, Requestor
+from pythorhead.types import ListingType, LanguageType
+
+
+class Emoji:
+    def __init__(self, _requestor: Requestor):
+        self._requestor = _requestor
+
+    def get(
+        self,
+    ) -> Optional[dict]:
+        """
+        Get a list of all defined custom emoji
+
+        Returns:
+            dict: emoji view
+        """
+        return self._requestor.api(Request.GET, "/site")["custom_emojis"]
+    
+    # FIXME: untested
+    def edit(
+            self, 
+            emoji_id: int, 
+            category: str, 
+            image_url: str,
+            alt_text: str, 
+            keywords: str,
+        ) -> dict:
+        """
+        Admin/Mod Edit an existing custom emoji
+
+        Args:
+            emoji_id (int): The ID of the emoji to edit
+            category (str): The category of the emoji
+            image_url (str): The URL of the emoji image
+            alt_text (str): The alt text for the emoji
+            keywords (str): The keywords associated with the emoji
+
+        Returns:
+          dict: The edited emoji view
+        """
+        emoji_data = {
+          "id": emoji_id,
+          "category": category,
+          "image_url": image_url,
+          "alt_text": alt_text,
+          "keywords": keywords,
+        }
+
+        return self._requestor.api(Request.PUT, f"/custom_emoji", json=emoji_data)
+    
+    # FIXME: untested
+    def create(
+            self, 
+            emoji_id: int, 
+            category: str, 
+            image_url: str,
+            alt_text: str, 
+            keywords: str,
+        ) -> dict:
+        """
+        Admin/Mod Create a new custom emoji
+
+        Args:
+            if (int): The ID of the emoji to edit
+            category (str): The category of the emoji
+            image_url (str): The URL of the emoji image
+            alt_text (str): The alt text for the emoji
+            keywords (str): The keywords associated with the emoji
+
+        Returns:
+          dict: The edited emoji view
+        """
+        emoji_data = {
+          "id": emoji_id,
+          "category": category,
+          "image_url": image_url,
+          "alt_text": alt_text,
+          "keywords": keywords,
+        }
+
+        return self._requestor.api(Request.POST, f"/custom_emoji", json=emoji_data)
+    
+    # FIXME: untested
+    def delete(
+            self, 
+            emoji_id: int, 
+        ) -> bool:
+        """
+        Admin/Mod delete an existing custom emoji
+
+        Args:
+            emoji_id (int): The ID of the emoji to edit
+
+        Returns:
+          True if the emoji was deleted successfully. Else false.
+        """
+        emoji_data = {
+          "id": emoji_id,
+        }
+
+        return self._requestor.api(Request.POST, f"/custom_emoji/delete", json=emoji_data) == 'OK'

pythorhead/lemmy.py

@@ -14,6 +14,7 @@
 from pythorhead.types import FeatureType, ListingType, SortType, SearchType, SearchOption
 from pythorhead.user import User
 from pythorhead.admin import Admin
+from pythorhead.emoji import Emoji
 from pythorhead.classes.user import LemmyUser
 
 logger = logging.getLogger(__name__)
@@ -30,6 +31,7 @@ class Lemmy:
     image: Image
     mention: Mention
     admin: Admin
+    emoji: Emoji
 
     def __init__(self, api_base_url: str, raise_exceptions = False, request_timeout=3) -> None:
         self._requestor = Requestor(raise_exceptions, request_timeout)
@@ -43,6 +45,7 @@ def __init__(self, api_base_url: str, raise_exceptions = False, request_timeout=
         self.image = Image(self._requestor)
         self.mention = Mention(self._requestor)
         self.admin = Admin(self._requestor)
+        self.emoji = Emoji(self._requestor)
 
     @property
     def nodeinfo(self):