#59: Give ability to override worksection project hash

.github/workflows/master.yml

@@ -58,8 +58,10 @@ jobs:
         env:
           WS_URL_ALL_USERS: ${{ secrets.WS_URL_ALL_USERS }}
           WS_URL_POST_COMMENT: ${{ secrets.WS_URL_POST_COMMENT }}
-          WS_EMAIL: ${{ secrets.WS_EMAIL }}
+          WS_ADMIN_EMAIL: ${{ secrets.WS_EMAIL }}
           WS_ADMIN_USER_ID: ${{ secrets.WS_ADMIN_USER_ID }}
+          WS_PRJ_223728_HASH: ${{ secrets.WS_PRJ_223728_HASH }}
+          WS_PRJ_1010_HASH: ${{ secrets.WS_PRJ_1010_HASH }}
       - name: "Upload coverage to Codecov"
         uses: codecov/[email protected]
         # with:
@@ -85,7 +87,7 @@ jobs:
         env:
           WS_URL_ALL_USERS: ${{ secrets.WS_URL_ALL_USERS }}
           WS_URL_POST_COMMENT: ${{ secrets.WS_URL_POST_COMMENT }}
-          WS_EMAIL: ${{ secrets.WS_EMAIL }}
+          WS_ADMIN_EMAIL: ${{ secrets.WS_EMAIL }}
           WS_ADMIN_USER_ID: ${{ secrets.WS_ADMIN_USER_ID }}
           WS_INT_TESTS_DISABLED: true
 
@@ -111,7 +113,7 @@ jobs:
         env:
           WS_URL_ALL_USERS: ${{ secrets.WS_URL_ALL_USERS }}
           WS_URL_POST_COMMENT: ${{ secrets.WS_URL_POST_COMMENT }}
-          WS_EMAIL: ${{ secrets.WS_EMAIL }}
+          WS_ADMIN_EMAIL: ${{ secrets.WS_EMAIL }}
           WS_ADMIN_USER_ID: ${{ secrets.WS_ADMIN_USER_ID }}
           WS_INT_TESTS_DISABLED: true
 

docker-compose.yml

@@ -6,11 +6,13 @@ services:
     environment:
       WS_URL_ALL_USERS: "https://xxx.worksection.com/xxxx"
       WS_URL_POST_COMMENT: "https://xxx.worksection.com/xxxx"
-      WS_EMAIL: "[email protected]"
+      WS_ADMIN_EMAIL: "[email protected]"
       WS_ADMIN_USER_ID: "370080"
+      WS_PRJ_223728_HASH: "xxx"
     build:
       dockerfile: Containerfile
       context: .
+    entrypoint: g2w --log=DEBUG
     ports:
       - "8080:8080"
     restart: always

g2w/__init__.py

@@ -1,4 +1,5 @@
 from .push import Push
 from .ws import Ws
+from .api import LoggableRoute
 
-__all__ = ["Push", "Ws"]
+__all__ = ["Push", "Ws", "LoggableRoute"]

g2w/__main__.py

@@ -6,8 +6,9 @@
 
 import uvicorn  # pragma: no cover
 from fastapi import FastAPI
+from fastapi.routing import APIRouter
 
-from g2w import Push, Ws
+from g2w import Push, Ws, LoggableRoute
 
 
 # @todo #/DEV Add support of command line parser for program arguments
@@ -30,13 +31,15 @@ def main() -> None:  # pragma: no cover
 
 ws = Ws()
 app = FastAPI()
+router = APIRouter(route_class=LoggableRoute)
 
 
 # @todo #/DEV add logging framework and remove `print` statement everywhere
 
 
-@app.post("/gitlab/push/{project_id}")
+@router.post("/gitlab/push/{project_id}")
 def push(event: Push, project_id: int) -> dict:
+
     author = ws.find_user(event.user_email)
     msg = event.comment(author)
     comments = []
@@ -46,5 +49,7 @@ def push(event: Push, project_id: int) -> dict:
     return {"comments": comments}
 
 
+app.include_router(router)
+
 if __name__ == "__main__":  # pragma: no cover
     main()

g2w/api.py

@@ -0,0 +1,35 @@
+import logging
+import time
+from typing import Callable
+
+from fastapi import Request, Response
+from fastapi.routing import APIRoute
+
+# @todo #/DEV Extract timings to a separate route.
+"""
+Interceptor that logs all for incoming requests/responses.
+"""
+
+
+class LoggableRoute(APIRoute):
+    def get_route_handler(self) -> Callable:
+        original_route_handler = super().get_route_handler()
+
+        async def custom_route_handler(req: Request) -> Response:
+            before = time.time()
+            resp: Response = await original_route_handler(req)
+            duration = time.time() - before
+            resp.headers["X-Response-Time"] = str(duration)
+            # @todo #58/DEV Ensure that logging is enabled for HTTP traffic and
+            #  could be used.
+            logging.debug("req duration: {0}", duration)
+            logging.debug(
+                "req: %s, duration: %s, resp: %s, resp. headers: %s",
+                req,
+                duration,
+                resp,
+                resp.headers,
+            )
+            return resp
+
+        return custom_route_handler

g2w/ws.py

@@ -1,17 +1,42 @@
+import logging  # pragma: no cover
 import os  # pragma: no cover
 from typing import List
 
 import requests  # pragma: no cover
 
-"""
-Worksection client that allows manipulation with
-"""
+
+def get_hash(prj) -> str:
+    """
+    Fetch project hash from environment variable.
+    The naming format is 'WS_PRJ_0000_HASH', where '0000' is project id:
+      WS_PRJ_0001_HASH: 12fjasdfsdfhk34hsdf
+      WS_PRJ_0002_HASH: asf324i324jdfi23hfd
+      ...
+    """
+    val = os.getenv(f"WS_PRJ_{prj}_HASH")
+    if val is None:
+        logging.error("g2w-003: No hash found for project id '%'", prj)
+        raise ValueError("g2w-003: No hash found for project id '%'", prj)
+    return val
+
+
+def post(req) -> dict:
+    """
+    Send POST request to Worksection API.
+    """
+    resp = requests.post(req).json()
+    # @todo #58/DEV Ensure that logging is enabled for this method as well.
+    logging.debug("WS req: '%s', resp: '%s'", req, resp)
+    return resp
 
 
 class Ws:
+    """
+    Worksection client that allows manipulation with
+    """
     def __init__(
         self,
-        email=os.getenv("WS_EMAIL"),
+        email=os.getenv("WS_ADMIN_EMAIL"),
         system_user_id=os.getenv("WS_ADMIN_USER_ID"),
         all_users=os.getenv("WS_URL_ALL_USERS"),
         post_comment=os.getenv("WS_URL_POST_COMMENT"),
@@ -24,17 +49,37 @@ def __init__(
     users: List[dict] = []
 
     def all_users(self) -> List[dict]:
+        """
+        Fetch all users from worksection space.
+        """
         if not self.users:
             # @todo #/DEV use memorize feature/approach instead of own caching.
             self.users.extend(requests.get(self.url_all_users).json()["data"])
         return self.users
 
-    def add_comment(self, prj: int, task_id: int, body: str) -> dict:
-        return requests.post(
-            self.url_post_comment.format(prj, task_id, self.system_email, body)
-        ).json()["data"]
+    def add_comment(self, prj: int, task: int, body: str) -> dict:
+        """
+        Add a comment to a particular worksection task id.
+        """
+        resp = post(self.post_comment_url(prj, task, body))
+        if resp["status"] == "ok":
+            return resp["data"]
+        else:
+            return resp
+
+    def post_comment_url(self, prj, task, body) -> str:
+        """
+        Construct URL for posting comments.
+        """
+        return self.url_post_comment.format(
+            prj, task, self.system_email, body, get_hash(prj)
+        )
 
     def find_user(self, email: str) -> dict:
+        """
+        Find user details in Worksection by email.
+        Return user or system account (if not found).
+        """
         user = next((u for u in self.all_users() if u["email"] == email), None)
         if user is not None:
             return user

readme.md

@@ -50,14 +50,15 @@ Please note, that `GitLab` commit messages must have the following format: `#WS-
     version: "3.9"
     services:
       g2ws:
-        image: dgroup/g2w:0.1.0
+        image: dgroup/g2w:0.2.0
         container_name: g2w
         environment:
           # Mandatory environment variables (docker, podman, etc.)
           WS_URL_ALL_USERS: "https://xxx.worksection.com/xxxx"    # https://worksection.com/faq/api-user.html#q1572
           WS_URL_POST_COMMENT: "https://xxx.worksection.com/xxxx" # https://worksection.com/faq/api-comments.html#q1575
-          WS_EMAIL: "[email protected]"               # plain worksection user email
+          WS_ADMIN_EMAIL: "[email protected]"         # plain worksection user email
           WS_ADMIN_USER_ID: "370080"                              # plain worksection user id
+          WS_PRJ_223728_HASH: "xxx"                               # HASH generated for a particular Worksection project
         build:
           dockerfile: Containerfile
           context: .
@@ -162,3 +163,6 @@ curl --request POST \
 ```bash
 pip install g2w
 ```
+
+## Materials & Links
+* http://www.md5.cz - generate WS hash

tests/test_app.py

@@ -20,7 +20,7 @@
 #  - https://setuptools.pypa.io/en/latest/pkg_resources.html
 
 
-@pytest.mark.skipif(os.getenv("WS_EMAIL") is None, reason="Email account for worksection is absent")
+@pytest.mark.skipif(os.getenv("WS_ADMIN_EMAIL") is None, reason="Environment variable 'WS_ADMIN_EMAIL' is absent")
 @pytest.mark.skipif(os.getenv("WS_URL_ALL_USERS") is None, reason="Environment variable 'WS_URL_ALL_USERS' is absent")
 @pytest.mark.skipif(os.getenv("WS_URL_POST_COMMENT") is None, reason="Environment variable 'WS_URL_POST_COMMENT' is absent")
 @pytest.mark.skipif(os.getenv("WS_INT_TESTS_DISABLED") is not None, reason="Integration tests are disabled")

tests/test_ws.py

@@ -19,7 +19,7 @@ def test_users():
 
 
 @pytest.mark.skipif(os.getenv("WS_INT_TESTS_DISABLED") is not None, reason="Integration tests are disabled")
-@pytest.mark.skipif(os.getenv("WS_EMAIL") is None, reason="Email account for worksection is absent")
+@pytest.mark.skipif(os.getenv("WS_ADMIN_EMAIL") is None, reason="WS_ADMIN_EMAIL variable 'WS_URL_POST_COMMENT' is absent")
 @pytest.mark.skipif(os.getenv("WS_URL_POST_COMMENT") is None, reason="Environment variable 'WS_URL_POST_COMMENT' is absent")
 def test_add_comment():
     assert (
@@ -30,3 +30,13 @@ def test_add_comment():
         )["id"]
         is not None
     )
+
+
+@pytest.mark.skipif(os.getenv("WS_PRJ_1010_HASH") is None, reason="Environment variable 'WS_PRJ_1010_HASH' is absent")
+def test_post_comment_url():
+    assert (
+        Ws(post_comment="https://test.ws.com/api/admin/v2/?action=post_comment&page=/project/{0}/{1}/&email_user_from={2}&text={3}&hash={4}", email="[email protected]").post_comment_url(
+            1010, 1234, "text"
+        )
+        == "https://test.ws.com/api/admin/v2/?action=post_comment&page=/project/1010/1234/&[email protected]&text=text&hash=1fsasdfj"
+    )