Merge pull request #177 from lumapps/MP-824/get-article

feat(get-article): add generated api and models

Author: thibaud-lumapps

Makefile

@@ -8,10 +8,12 @@ PYTHON ?= python3.7
 PIP = .venv/bin/pip
 POETRY ?= .venv/bin/poetry
 
+pytest_args?=-xv
+
 check: check-docs check-code-quality check-types  ## Check it all!
 
 check-code-quality:  ## Check the code quality.
-	@$(POETRY) run failprint -t "Checking code quality" -- flake8 --config=config/flake8.ini $(PY_SRC)
+	@$(POETRY) run failprint -t "Checking code quality" -- flake8 --config config/flake8.ini $(PY_SRC)
 
 check-docs:  ## Check if the documentation builds correctly.
 	@$(POETRY) run failprint -t "Building documentation" -- mkdocs build -s
@@ -58,7 +60,7 @@ setup: .venv  ## Setup the development environment (install dependencies).
 	$(POETRY) run pre-commit install --hook-type commit-msg
 
 test:  ## Run the test suite and report coverage. 2>/dev/null
-	@$(POETRY) run pytest -c config/pytest.ini
+	@$(POETRY) run pytest ${pytest_args} -c config/pytest.ini
 	@$(POETRY) run coverage html --rcfile=config/coverage.ini
 
 .venv:  ## Install the virtual env directory

config/coverage.ini

@@ -11,6 +11,7 @@ source =
 parallel = true
 omit = 
   lumapps/api/authlib_helpers.py
+  lumapps/latest/api/swagger/**
   **/__init__.py
   examples/**
   tests/*

config/flake8.ini

@@ -1,5 +1,6 @@
 [flake8]
 max-line-length = 88
+exclude = swagger
 ignore =
   W291  ;trailing whitespace
   W293  ;blank line contains whitespace
@@ -11,4 +12,4 @@ ignore =
 ban-relative-imports = true
 docstring-convention = google
 max-complexity = 18
-select = B,C,E,F,W,T4,B901
+select = B,C,E,F,W,T4,B901

config/mypy.ini

@@ -3,3 +3,6 @@ ignore_missing_imports = true
 
 [mypy-lumapps.api.client]
 ignore_errors = true
+
+[mypy-lumapps.latest.api.swagger.*]
+ignore_errors = true

lumapps/latest/api/__init__.py

@@ -0,0 +1,20 @@
+from lumapps.latest.client import IClient
+from lumapps.latest.entities.article import Article
+
+from .swagger.contribution_v1 import ContributionV1GW
+
+
+class ArticleApi:
+
+    def __init__(self, client: IClient) -> None:
+        self.gateway = ContributionV1GW(client)
+
+    def get_article(self, article_id: str) -> Article:
+        model = self.gateway.get_article(article_id)
+        return Article(
+            model.id,
+            model.author.user_id,
+            model.created_at,
+            model.structured_content.title.translations,
+            model.structured_content.intro.translations,
+        )

lumapps/latest/api/article.py

@@ -0,0 +1,2 @@
+class ApiException(Exception):
+    pass

lumapps/latest/api/exceptions.py

@@ -0,0 +1 @@
+from .gateway import ContributionV1GW

lumapps/latest/api/swagger/__init__.py

@@ -0,0 +1,27 @@
+from lumapps.latest.client import IClient, Request
+
+from lumapps.latest.api.exceptions import ApiException
+
+from . import models
+from ..serialization import Serialization
+
+class ContributionV1GW(object):
+
+    def __init__(self, client: IClient) -> None:
+        self.client = client
+
+    def get_article(self, article_id: str) -> models.Article:
+        request = Request(
+            method="GET",
+            url=f"/articles/{article_id}",
+        )
+        response = self.client.request(request)
+        if response.status_code == 200:
+            return Serialization(models).deserialize(response.json, models.Article)
+        else:
+            raise ApiException(
+                Serialization(models).deserialize(
+                    response.json["errors"][0],
+                    models.Error
+                ).detail,
+            )