Add DBlista as a service

Author: Snazzah

README.md

@@ -114,6 +114,7 @@ See more examples [here](/examples).
  - [carbonitex.net](https://www.carbonitex.net/Discord/bots) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.Carbon))
  - [cloud-botlist.xyz](https://cloud-botlist.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.CloudBotList))
  - [cloudlist.xyz](https://cloudlist.xyz) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.CloudList))
+ - [dblista.pl](https://dblista.pl) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DBLista))
  - [discord.bots.gg](https://discord.bots.gg) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordBotsGG))
  - [discordapps.dev](https://discordapps.dev) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordAppsDev))
  - [discord.boats](https://discord.boats) ([docs](https://dbots.readthedocs.io/en/latest/api.html#dbots.DiscordBoats))

dbots/errors.py

@@ -55,4 +55,9 @@ class HTTPNotFound(HTTPException):
 class EndpointRequiresToken(DBotsException):
     """Exception that's thrown for when an endpoint is being used without a token."""
     def __init__(self):
-        super().__init__('This endpoint requires a token.')
+        super().__init__('This endpoint requires a token.')
+
+class PostingUnsupported(ServiceException):
+    """Exception that's thrown for services that cannot be posted to."""
+    def __init__(self):
+        super().__init__('This service does not support posting.')

dbots/service.py

@@ -1,6 +1,7 @@
 from .http import HTTPClient, HTTPResponse
-from .errors import EndpointRequiresToken, ServiceException
+from .errors import EndpointRequiresToken, ServiceException, PostingUnsupported
 from urllib.parse import urlencode as _encode_query
+from urllib.parse import quote as _encode_uri
 
 class Service:
     """
@@ -624,6 +625,172 @@ def get_bot_votes(self, bot_id: str) -> HTTPResponse:
             requires_token = True
         )
 
+class DBLista(Service):
+    """
+    Represents the DBLista service.
+    
+    .. seealso::
+        - `DBLista Website <https://dblista.pl/>`_
+        - `DBLista API Documentation <https://docs.dblista.pl/>`_
+    """
+
+    BASE_URL = 'https://www.cloudlist.xyz/api'
+
+    @staticmethod
+    def aliases() -> list:
+        return ['dblistapl', 'dblista.pl', 'dblista']
+
+    @staticmethod
+    def _post(
+        http_client: HTTPClient, bot_id: str, token: str
+    ) -> HTTPResponse:
+        raise PostingUnsupported()
+
+    def add_bot(self, data: dict) -> HTTPResponse:
+        """|httpres|\n
+        Updates the bot's listing with the data provided.
+
+        Parameters
+        -----------
+        data: :class:`dict`
+            The data being posted. This should include the ID of the bot.
+        """
+        return self._request(
+            method = 'POST',
+            path = '/bots',
+            json = data,
+            headers = { 'Authorization': self.token },
+            requires_token = True
+        )
+
+    def update_bot(self, data: dict) -> HTTPResponse:
+        """|httpres|\n
+        Updates the bot's listing with the data provided.
+
+        Parameters
+        -----------
+        data: :class:`dict`
+            The data being posted. This should include the ID of the bot.
+        """
+        return self._request(
+            method = 'PUT',
+            path = '/bots',
+            json = data,
+            headers = { 'Authorization': self.token },
+            requires_token = True
+        )
+
+    def get_bot(self, bot_id: str) -> HTTPResponse:
+        """|httpres|\n
+        Gets the bot's stats on this service.
+
+        Parameters
+        -----------
+        bot_id: :class:`str`
+            The bot's ID.
+        """
+        return self._request(
+            method = 'GET',
+            path = f'/bots/{bot_id}'
+        )
+
+    def get_bots(self, page: int = 0) -> HTTPResponse:
+        """|httpres|\n
+        Gets the bot's stats on this service.
+
+        Parameters
+        -----------
+        page: :class:`int`
+            The page you want to get.
+        """
+        return self._request(
+            method = 'GET',
+            path = f'/bots/list/{page}'
+        )
+
+    def get_unverified_bots(self) -> HTTPResponse:
+        """|httpres|\n
+        Gets a list of unverified bots on this service.
+        """
+        return self._request(
+            method = 'GET',
+            path = '/bots/list/unverified'
+        )
+
+    def get_rejected_bots(self) -> HTTPResponse:
+        """|httpres|\n
+        Gets a list of rejected bots on this service.
+        """
+        return self._request(
+            method = 'GET',
+            path = '/bots/list/rejected'
+        )
+
+    def rate_bot(self, bot_id: str, data: dict) -> HTTPResponse:
+        """|httpres|\n
+        Adds a rating to a bot on the service.
+
+        Parameters
+        -----------
+        bot_id: :class:`str`
+            The bot's ID.
+        data: :class:`dict`
+            The data being posted. This should include the ID of the bot.
+        """
+        return self._request(
+            method = 'POST',
+            path = f'/bots/{bot_id}/rate',
+            json = data,
+            headers = { 'Authorization': self.token },
+            requires_token = True
+        )
+
+    def remove_rating(self, bot_id: str) -> HTTPResponse:
+        """|httpres|\n
+        Removes a rating from a bot on the service.
+
+        Parameters
+        -----------
+        bot_id: :class:`str`
+            The bot's ID.
+        """
+        return self._request(
+            method = 'DELETE',
+            path = f'/bots/{bot_id}/rate',
+            headers = { 'Authorization': self.token },
+            requires_token = True
+        )
+
+    def remove_bot(self, bot_id: str) -> HTTPResponse:
+        """|httpres|\n
+        Removes a bot from the service.
+
+        Parameters
+        -----------
+        bot_id: :class:`str`
+            The bot's ID.
+        """
+        return self._request(
+            method = 'DELETE',
+            path = f'/bots/{bot_id}',
+            headers = { 'Authorization': self.token },
+            requires_token = True
+        )
+
+    def search(self, query: str) -> HTTPResponse:
+        """|httpres|\n
+        Searches for bots on the service.
+
+        Parameters
+        -----------
+        query: :class:`str`
+            The query to search for.
+        """
+        return self._request(
+            method = 'GET',
+            path = f'/bots/search/{_encode_uri(query, safe='~()*!.\'')}'
+        )
+
 class DiscordBotsGG(Service):
     """
     Represents the Discord Bots service.
@@ -1944,8 +2111,8 @@ def get_unverified_bots(self) -> HTTPResponse:
         )
 
 Service.SERVICES = [
-    Arcane, BotListSpace, BotsForDiscord, BotsOfDiscord, BotsOnDiscord,
-    Carbon, CloudBotList, CloudList, DiscordBotsGG, DiscordAppsDev, DiscordBoats,
+    Arcane, BotListSpace, BotsForDiscord, BotsOfDiscord, BotsOnDiscord, Carbon,
+    CloudBotList, CloudList, DBLista, DiscordBotsGG, DiscordAppsDev, DiscordBoats,
     DiscordBotList, DiscordBotWorld, DiscordExtremeList, DivineDiscordBots, GlennBotList,
     LBots, ListMyBots, MythicalBots, SpaceBotsList, TopGG, WonderBotList, YABL
 ]

docs/api.rst

@@ -70,6 +70,9 @@ Services
 .. autoclass:: CloudList
     :members:
 
+.. autoclass:: DBLista
+    :members:
+
 .. autoclass:: DiscordBotsGG
     :members: