Uses subclasses of BaseVertical rather than the Vertical enum to identify a vertical (#66)

Closes #61 

So any time we were using `Vertical.SubVerticalName` we now use
`SubVerticalName`, where `SubVerticalName` is a subclass of
`BaseVertical`. Note that I do mean subclass and not instance of a
subclass since we're using the classes themselves as identifiers of
verticals. In the future, methods will be returning instances of those
same subclasses.

I also adjusted the names of the vertical fetching methods to follow the
structure: `fetch_<vertical_name>_vertical` for consistency and to avoid
having to keep track of the plural names like before.

### Misc
Anywhere where an argument `arg` to a function/method could have one or
more items, like in the constructor of the exception classes, I make
these into a `*arg` instead so we don't have to special case passing in
different number of arguments.

Author: aborem

src/pardner/exceptions.py

@@ -3,15 +3,19 @@
 
 class InsufficientScopeException(Exception):
     def __init__(self, *unsupported_verticals: Vertical, service_name: str) -> None:
-        combined_verticals = ', '.join(unsupported_verticals)
+        combined_verticals = ', '.join(
+            [str(vertical) for vertical in unsupported_verticals]
+        )
         super().__init__(
             f'Cannot add {combined_verticals} to {service_name} with current scope.'
         )
 
 
 class UnsupportedVerticalException(Exception):
     def __init__(self, *unsupported_verticals: Vertical, service_name: str) -> None:
-        combined_verticals = ', '.join(unsupported_verticals)
+        combined_verticals = ', '.join(
+            [str(vertical) for vertical in unsupported_verticals]
+        )
         is_more_than_one_vertical = len(unsupported_verticals) > 1
         super().__init__(
             f'Cannot fetch {combined_verticals} from {service_name} because '

src/pardner/services/base.py

@@ -263,5 +263,5 @@ def fetch(
                 vertical, service_name=self._service_name
             )
 
-        method_name = f'fetch_{vertical.plural}'
+        method_name = f'fetch_{vertical.vertical_name}_vertical'
         getattr(self, method_name)(request_params=request_params, **params)

src/pardner/services/groupme.py

@@ -8,7 +8,13 @@
 
 from pardner.exceptions import UnsupportedRequestException
 from pardner.services import BaseTransferService
-from pardner.verticals import Vertical
+from pardner.verticals import (
+    BlockedUserVertical,
+    ChatBotVertical,
+    ConversationDirectVertical,
+    ConversationGroupVertical,
+    Vertical,
+)
 
 
 class GroupMeTransferService(BaseTransferService):
@@ -35,10 +41,10 @@ def __init__(
             client_id=client_id,
             redirect_uri=redirect_uri,
             supported_verticals={
-                Vertical.BlockedUser,
-                Vertical.ChatBot,
-                Vertical.ConversationDirect,
-                Vertical.ConversationGroup,
+                BlockedUserVertical,
+                ChatBotVertical,
+                ConversationDirectVertical,
+                ConversationGroupVertical,
             },
             verticals=verticals,
         )
@@ -129,7 +135,7 @@ def fetch_user_data(self, request_params: dict[str, Any] = {}) -> Any:
         self._user_id = user_data['id']
         return user_data
 
-    def fetch_blocked_users(self, request_params: dict[str, Any] = {}) -> Any:
+    def fetch_blocked_user_vertical(self, request_params: dict[str, Any] = {}) -> Any:
         """
         Sends a GET request to fetch the users blocked by the authenticated user.
 
@@ -144,15 +150,15 @@ def fetch_blocked_users(self, request_params: dict[str, Any] = {}) -> Any:
 
         return blocked_users['blocks']
 
-    def fetch_chat_bots(self, request_params: dict[str, Any] = {}) -> Any:
+    def fetch_chat_bot_vertical(self, request_params: dict[str, Any] = {}) -> Any:
         """
         Sends a GET request to fetch the chat bots created by the authenticated user.
 
         :returns: a JSON object with the result of the request.
         """
         return self._fetch_resource_common('bots', request_params)
 
-    def fetch_conversations_direct(
+    def fetch_conversation_direct_vertical(
         self, request_params: dict[str, Any] = {}, count: int = 10
     ) -> Any:
         """
@@ -174,7 +180,7 @@ def fetch_conversations_direct(
             'can only make a request for at most 10 direct conversations at a time.',
         )
 
-    def fetch_conversations_group(
+    def fetch_conversation_group_vertical(
         self, request_params: dict[str, Any] = {}, count: int = 10
     ) -> Any:
         """

src/pardner/services/strava.py

@@ -3,7 +3,7 @@
 from pardner.exceptions import UnsupportedRequestException, UnsupportedVerticalException
 from pardner.services import BaseTransferService
 from pardner.services.utils import scope_as_set, scope_as_string
-from pardner.verticals import Vertical
+from pardner.verticals import PhysicalActivityVertical, Vertical
 
 
 class StravaTransferService(BaseTransferService):
@@ -31,7 +31,7 @@ def __init__(
             client_secret=client_secret,
             redirect_uri=redirect_uri,
             state=state,
-            supported_verticals={Vertical.PhysicalActivity},
+            supported_verticals={PhysicalActivityVertical},
             verticals=verticals,
         )
 
@@ -60,11 +60,11 @@ def scope_for_verticals(self, verticals: Iterable[Vertical]) -> set[str]:
                 raise UnsupportedVerticalException(
                     vertical, service_name=self._service_name
                 )
-            if vertical == Vertical.PhysicalActivity:
+            if vertical == PhysicalActivityVertical:
                 sub_scopes.update(['activity:read', 'profile:read_all'])
         return sub_scopes
 
-    def fetch_physical_activities(
+    def fetch_physical_activity_vertical(
         self, request_params: dict[str, Any] = {}, count: int = 30
     ) -> list[Any]:
         """

src/pardner/services/tumblr.py

@@ -2,7 +2,7 @@
 
 from pardner.exceptions import UnsupportedRequestException
 from pardner.services import BaseTransferService
-from pardner.verticals import Vertical
+from pardner.verticals import SocialPostingVertical, Vertical
 
 
 class TumblrTransferService(BaseTransferService):
@@ -30,7 +30,7 @@ def __init__(
             client_secret=client_secret,
             redirect_uri=redirect_uri,
             state=state,
-            supported_verticals={Vertical.FeedPost},
+            supported_verticals={SocialPostingVertical},
             verticals=verticals,
         )
 
@@ -48,7 +48,7 @@ def fetch_token(
     ) -> dict[str, Any]:
         return super().fetch_token(code, authorization_response, include_client_id)
 
-    def fetch_feed_posts(
+    def fetch_social_posting_vertical(
         self,
         request_params: dict[str, Any] = {},
         count: int = 20,

src/pardner/verticals/__init__.py

@@ -4,6 +4,12 @@
 from pardner.verticals.blocked_user import BlockedUserVertical as BlockedUserVertical
 from pardner.verticals.chat_bot import ChatBotVertical as ChatBotVertical
 from pardner.verticals.conversation import ConversationVertical as ConversationVertical
+from pardner.verticals.conversation_direct import (
+    ConversationDirectVertical as ConversationDirectVertical,
+)
+from pardner.verticals.conversation_group import (
+    ConversationGroupVertical as ConversationGroupVertical,
+)
 from pardner.verticals.message import MessageVertical as MessageVertical
 from pardner.verticals.physical_activity import (
     PhysicalActivityVertical as PhysicalActivityVertical,

src/pardner/verticals/base.py

@@ -1,34 +1,10 @@
 from abc import ABC
 from datetime import datetime
-from enum import StrEnum
-from typing import Optional
+from typing import Type
 
 from pydantic import AnyHttpUrl, BaseModel, Field
 
 
-class Vertical(StrEnum):
-    """
-    Represents the verticals, or categories of data, that are supported by this library.
-    Not all verticals are supported by every transfer service.
-    """
-
-    BlockedUser = 'blocked_user'
-    ChatBot = 'chat_bot'
-    ConversationDirect = 'conversation_direct', 'conversations_direct'
-    ConversationGroup = 'conversation_group', 'conversations_group'
-    ConversationMessage = 'conversation_message'
-    FeedPost = 'feed_post'
-    PhysicalActivity = 'physical_activity', 'physical_activities'
-
-    plural: str
-
-    def __new__(cls, singular: str, plural: Optional[str] = None) -> 'Vertical':
-        vertical_obj = str.__new__(cls, singular)
-        vertical_obj._value_ = singular
-        vertical_obj.plural = plural if plural else f'{singular}s'
-        return vertical_obj
-
-
 class BaseVertical(BaseModel, ABC):
     """
     Base class for all verticals, except sub-verticals. Represents the verticals, or
@@ -45,3 +21,9 @@ class BaseVertical(BaseModel, ABC):
 
     created_at: datetime | None = None
     url: AnyHttpUrl | None = None
+
+    def __str__(self):
+        return self.vertical_name
+
+
+Vertical = Type[BaseVertical]

src/pardner/verticals/conversation_direct.py

@@ -0,0 +1,11 @@
+from pardner.verticals.conversation import ConversationVertical
+
+
+class ConversationDirectVertical(ConversationVertical):
+    """
+    The metadata related to a conversation where messages are exchanged between one
+    or more people.
+    """
+
+    vertical_name: str = 'conversation_direct'
+    is_group_conversation: bool = False

src/pardner/verticals/conversation_group.py

@@ -0,0 +1,11 @@
+from pardner.verticals.conversation import ConversationVertical
+
+
+class ConversationGroupVertical(ConversationVertical):
+    """
+    The metadata related to a conversation where messages are exchanged between one
+    or more people.
+    """
+
+    vertical_name: str = 'conversation_group'
+    is_group_conversation: bool = True

tests/test_transfer_services/conftest.py

@@ -7,7 +7,24 @@
     StravaTransferService,
     TumblrTransferService,
 )
-from pardner.verticals import Vertical
+from pardner.verticals import (
+    BlockedUserVertical,
+    ConversationDirectVertical,
+    PhysicalActivityVertical,
+    SocialPostingVertical,
+)
+from pardner.verticals.base import BaseVertical
+
+# CLASSES
+
+
+class NewVertical(BaseVertical):
+    vertical_name: str = 'new_vertical'
+
+
+class ExtraScopeVertical(BaseVertical):
+    vertical_name: str = 'extra_scope_vertical'
+
 
 # FIXTURES
 
@@ -37,28 +54,22 @@ def mock_oauth2_session_response(mocker):
 
 
 @pytest.fixture
-def mock_vertical():
-    Vertical.NEW_VERTICAL = 'new_vertical'
-    Vertical.NEW_VERTICAL_EXTRA_SCOPE = 'new_vertical_unsupported'
-
-
-@pytest.fixture
-def mock_tumblr_transfer_service(verticals=[Vertical.FeedPost]):
+def mock_tumblr_transfer_service(verticals=[SocialPostingVertical]):
     return TumblrTransferService(
         'fake_client_id', 'fake_client_secret', 'https://redirect_uri', None, verticals
     )
 
 
 @pytest.fixture
-def mock_strava_transfer_service(verticals=[Vertical.PhysicalActivity]):
+def mock_strava_transfer_service(verticals=[PhysicalActivityVertical]):
     return StravaTransferService(
         'fake_client_id', 'fake_client_secret', 'https://redirect_uri', None, verticals
     )
 
 
 @pytest.fixture
 def mock_groupme_transfer_service(
-    verticals=[Vertical.BlockedUser, Vertical.ConversationDirect],
+    verticals=[BlockedUserVertical, ConversationDirectVertical],
 ):
     groupme = GroupMeTransferService(
         client_id='fake_client_id',