v0.4.0

Author: joejoinerr

.gitignore

@@ -1,3 +1,5 @@
 .idea
 __pycache__
 Pipfile.lock
+tests/
+.python-version

Pipfile

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Any, Dict, Literal, Optional
 
 import requests
 
@@ -12,7 +12,6 @@ def __init__(self, api_key: str) -> None:
         self._session = requests.Session()
 
         # Interface for interacting with people, including creating new people.
-        # To get an individual person, use `ForecastClient.person()`
         self.people = forecast.models.PeopleHelper(self)
 
         # Interface frore interacting with tasks
@@ -32,24 +31,20 @@ def __init__(self, api_key: str) -> None:
 
     def request(self,
                 path: str,
-                request_type: Optional[str] = 'GET',
-                params: Optional[dict] = None,
-                headers: Optional[dict] = None,
-                data: Optional[dict] = None) -> dict:
-        if not isinstance(request_type, str):
-            raise TypeError('`request_type` should be string.')
+                request_type: Literal['GET', 'POST', 'PUT', 'DELETE'] = 'GET',
+                params: Optional[Dict[str, Any]] = None,
+                headers: Optional[Dict[str, str]] = None,
+                data: Optional[Dict[str, Any]] = None) -> dict:
         request_type = request_type.upper()
-        valid_types = {'GET', 'POST', 'PUT', 'DELETE'}
-        if request_type not in valid_types:
-            raise ValueError(f'`request_type` should be one of: {", ".join(valid_types)}.')
 
         final_headers = {
             'x-forecast-api-key': self.api_key,
         }
         if isinstance(headers, dict):
             final_headers.update(headers)
 
-        req = requests.Request(request_type, f'https://api.forecast.it/api{path}',
+        req = requests.Request(request_type,
+                               f'https://api.forecast.it/api{path}',
                                params=params,
                                headers=final_headers,
                                json=data)
@@ -61,6 +56,7 @@ def request(self,
             res.raise_for_status()
         except requests.exceptions.HTTPError as e:
             message = json.get('message')
-            raise ForecastAPIError(f'Forecast API responded with status {res.status_code}: {message}') from e
+            raise ForecastAPIError(f'Forecast API responded with status '
+                                   f'{res.status_code}: {message}') from e
 
         return json

forecast/client.py

@@ -13,6 +13,7 @@
     'person_id': '/v1/persons/{id}',
     'persons': '/v1/persons',
     'project_id': '/v1/projects/{id}',
+    'project_team': '/v1/projects/{id}/team',
     'project_company_id': '/v1/projects/company_project_id/{id}',
     'projects': '/v1/projects',
     'role_id': '/v1/roles/{id}',

forecast/const.py

@@ -1,4 +1,4 @@
-from .people import Person
+from .people import Person, ProjectTeam
 from .roles import Role
 from .labels import Label
 from .tasks import Task

forecast/models/__init__.py

@@ -1,7 +1,27 @@
 import datetime
+from typing import TYPE_CHECKING, Any, Dict, Optional
+
+if TYPE_CHECKING:
+    import forecast
 
 
 class ForecastBase:
+    def __init__(self,
+                 _forecast: 'forecast.ForecastClient',
+                 _id: int,
+                 raw: Optional[Dict[str, Any]] = None):
+        self._forecast = _forecast
+        self._id = _id
+        self.raw = raw
+        self.path = None  # Must be set by children
+
+    def __getattribute__(self, item):
+        """ Lazy loads the API response"""
+        if item == 'raw' and not object.__getattribute__(self, 'raw'):
+            self.raw = object.__getattribute__(self, '_forecast')\
+                .request(self.path)
+        return object.__getattribute__(self, item)
+
     @property
     def id(self) -> int:
         return self._id

forecast/models/base.py

@@ -12,16 +12,9 @@ def __init__(self,
                  _forecast: 'forecast.ForecastClient',
                  _id: int,
                  raw: Optional[Dict[str, Any]] = None):
-        self._forecast = _forecast
-        self._id = _id
-        self.raw = raw
-
-    def __getattribute__(self, item):
-        # Lazy load the JSON response so that we can create a Label without it
-        if item == 'raw' and not object.__getattribute__(self, 'raw'):
-            path = API_PATH['label_id'].format(id=object.__getattribute__(self, '_id'))
-            self.raw = object.__getattribute__(self, '_forecast').request(path)
-        return object.__getattribute__(self, item)
+        super(Label, self).__init__(_forecast, _id, raw)
+        self.path = API_PATH['label_id'].format(
+            id=object.__getattribute__(self, '_id'))
 
     @property
     def name(self) -> str:
@@ -33,6 +26,7 @@ def color(self) -> str:
 
     def __repr__(self):
         if object.__getattribute__(self, 'raw'):
-            return f'<forecast.Label(id=\'{self.id}\', name=\'{self.name}\')>'
+            return (f'<forecast.{type(self).__name__}(id=\'{self.id}\', '
+                    f'name=\'{self.name}\')>')
         else:
-            return f'<forecast.Label(id=\'{self.id}\')>'
+            return f'<forecast.{type(self).__name__}(id=\'{self.id}\')>'

forecast/models/labels.py

@@ -1,30 +1,20 @@
 from typing import TYPE_CHECKING, Any, Optional, Dict
 
+from .base import ForecastBase
 from ..const import API_PATH
 
 if TYPE_CHECKING:
     import forecast
 
 
-class Person(object):
+class Person(ForecastBase, object):
     def __init__(self,
                  _forecast: 'forecast.ForecastClient',
                  _id: int,
                  raw: Optional[Dict[str, Any]] = None):
-        self._forecast = _forecast
-        self._id = _id
-        self.raw = raw
-
-    def __getattribute__(self, item):
-        # Lazy load the JSON response so that we can create a Person without it
-        if item == 'raw' and not object.__getattribute__(self, 'raw'):
-            path = API_PATH['person_id'].format(id=object.__getattribute__(self, '_id'))
-            self.raw = object.__getattribute__(self, '_forecast').request(path)
-        return object.__getattribute__(self, item)
-
-    @property
-    def id(self) -> int:
-        return self._id
+        super(Person, self).__init__(_forecast, _id, raw)
+        self.path = API_PATH['person_id'].format(
+            id=object.__getattribute__(self, '_id'))
 
     @property
     def name(self) -> str:
@@ -78,16 +68,55 @@ def start_date(self) -> Optional[str]:
     def end_date(self) -> Optional[str]:
         return self.raw.get('end_date')
 
-    @property
-    def created_at(self) -> str:
-        return self.raw['created_at']
+    def __repr__(self):
+        if object.__getattribute__(self, 'raw'):
+            return (f'<forecast.{type(self).__name__}(id=\'{self.id}\', '
+                    f'name=\'{self.name}\')>')
+        else:
+            return f'<forecast.{type(self).__name__}(id=\'{self.id}\')>'
+
+
+class ProjectTeam:
+    def __init__(self,
+                 _forecast: 'forecast.ForecastClient',
+                 project: 'forecast.models.Project',
+                 raw: Optional[Dict[str, Any]] = None):
+        self._forecast = _forecast
+        self.project = project
+        self.raw = raw
+
+    def __len__(self):
+        return len(self.members)
+
+    def __iter__(self):
+        return iter(self.members)
 
     @property
-    def updated_at(self) -> str:
-        return self.raw['updated_at']
+    def members(self):
+        return [ProjectTeamMember(self._forecast,
+                                  member['person_id'],
+                                  self.project,
+                                  member['project_role'],
+                                  member['project_contact'])
+                for member in self.raw]
 
     def __repr__(self):
         if object.__getattribute__(self, 'raw'):
-            return f'<forecast.Person(id=\'{self.id}\', name=\'{self.name}\')>'
+            return (f'<forecast.{type(self).__name__}(project=\'{self.project.id}\', '
+                    f'members=\'{len(self)}\')>')
         else:
-            return f'<forecast.Person(id=\'{self.id}\')>'
+            return f'<forecast.{type(self).__name__}(project=\'{self.project.id}\')>'
+
+
+class ProjectTeamMember(Person):
+    def __init__(self,
+                 _forecast: 'forecast.ForecastClient',
+                 _id: int,
+                 project: 'forecast.models.Project',
+                 _project_role: int,
+                 project_contact: bool):
+        super(ProjectTeamMember, self).__init__(_forecast, _id)
+        self.project = project
+        self._project_role = _project_role
+        self.project_contact = project_contact
+