refactor: add ProjectProjection

Pipfile

@@ -15,6 +15,7 @@ yoyo-migrations = "*"
 Flask = "*"
 Flask-WTF = "*"
 passlib = "*"
+orator = "*"
 
 [dev-packages]
 behave = "*"

pepy/application/query.py

@@ -5,7 +5,9 @@
 
 from pepy.domain.exception import ProjectNotFoundException
 from pepy.domain.model import ProjectName, Badge, Project, ProjectDownloads, Downloads
+from pepy.domain.read_model import ProjectProjection
 from pepy.domain.repository import ProjectRepository
+from pepy.domain.view import ProjectView
 
 
 class DownloadsNumberFormatter:
@@ -33,11 +35,12 @@ def generate_badge(self, project_name: ProjectName) -> Badge:
 
 
 class ProjectProvider:
-    def __init__(self, project_repository: ProjectRepository):
+    def __init__(self, project_repository: ProjectRepository, project_view: ProjectView):
         self._project_repository = project_repository
+        self._project_view = project_view
 
-    def find(self, project_name: ProjectName) -> Project:
-        project = self._project_repository.find(project_name)
+    def find(self, project_name: str) -> ProjectProjection:
+        project = self._project_view.find(project_name)
         if project is None:
             raise ProjectNotFoundException(project_name)
         return project

pepy/domain/exception.py

@@ -10,11 +10,11 @@ def message(self) -> str:
 
 
 class ProjectNotFoundException(DomainException):
-    def __init__(self, project_name: ProjectName):
+    def __init__(self, project_name: str):
         self.project_name = project_name
 
     def message(self) -> str:
-        return "Project with name {} does not exist".format(self.project_name.name)
+        return "Project with name {} does not exist".format(self.project_name)
 
 
 class ProjectNameLengthIsNotValidException(DomainException):

pepy/domain/read_model.py

@@ -0,0 +1,23 @@
+from datetime import date
+from typing import List
+
+from attr import attrs, attrib
+
+
+@attrs()
+class ProjectListProjection:
+    name: str = attrib()
+    total_downloads: int = attrib()
+
+
+@attrs()
+class DownloadProjection:
+    date: date = attrib()
+    downloads: int = attrib()
+
+
+@attrs()
+class ProjectProjection:
+    name: str = attrib()
+    total_downloads: int = attrib()
+    last_downloads: List[DownloadProjection] = attrib()  # the last 30 days downloads

pepy/domain/view.py

@@ -0,0 +1,10 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from pepy.domain.read_model import ProjectProjection
+
+
+class ProjectView(ABC):
+    @abstractmethod
+    def find(self, project_name: str) -> Optional[ProjectProjection]:
+        pass

pepy/infrastructure/container/_config/_dev.py

@@ -2,6 +2,9 @@
 SECRET_KEY = "1234"
 
 DATABASE = {"host": "pgsql", "user": "pepy", "password": "pepy", "database": "pepy"}
+DATABASE_ORATOR = {
+    "prope": {"driver": "postgres", "host": "pgsql", "user": "pepy", "password": "pepy", "database": "pepy"}
+}
 
 # password: pepyrocks
 ADMIN_PASSWORD = "$pbkdf2-sha256$29000$uXcOobS2FiIkJCSkFGJszQ$TwCkC7lAIvOTrPjWmVr3LGDVAAK68CjWW7niKoI6dzo"

pepy/infrastructure/container/_config/_prod.py

@@ -10,6 +10,16 @@
     "database": os.environ.get("PEPY_DATABASE_NAME"),
 }
 
+DATABASE_ORATOR = {
+    "prope": {
+        "driver": "postgres",
+        "host": os.environ.get("PEPY_DATABASE_HOST"),
+        "user": os.environ.get("PEPY_DATABASE_USER"),
+        "password":  os.environ.get("PEPY_DATABASE_PASSWORD"),
+        "database": os.environ.get("PEPY_DATABASE_NAME"),
+    }
+}
+
 ADMIN_PASSWORD = os.environ.get("PEPY_ADMIN_PASSWORD")
 BQ_CREDENTIALS_FILE = os.environ.get("PEPY_BIGQUERY_CREDENTIALS")
 LOGGING_FILE = os.environ.get("PEPY_LOGGING_FILE")

pepy/infrastructure/container/_config/_test.py

@@ -3,6 +3,9 @@
 DEBUG = True
 
 DATABASE = {"host": "pgsql", "user": "pepy", "password": "pepy", "database": "pepy_test"}
+DATABASE_ORATOR = {
+    "prope": {"driver": "postgres", "host": "pgsql", "user": "pepy", "password": "pepy", "database": "pepy_test"}
+}
 
 # password: pepyrocks
 ADMIN_PASSWORD = "$pbkdf2-sha256$29000$uXcOobS2FiIkJCSkFGJszQ$TwCkC7lAIvOTrPjWmVr3LGDVAAK68CjWW7niKoI6dzo"