integrations: Add ClickUp integration.

Creates an incoming webhook integration for ClickUp. The main
use case is getting notifications when new ClickUp items such as task, list, folder, space, goals are created, updated or deleted.

Fixes zulip#26529.

Author: PieterCK

static/images/integrations/bot_avatars/clickup.png

@@ -8,7 +8,6 @@
 from django.utils.translation import gettext_lazy
 from django_stubs_ext import StrPromise
 from typing_extensions import TypeAlias
-
 from zerver.lib.storage import static_path
 
 """This module declares all of the (documented) integrations available
@@ -375,6 +374,7 @@ def __init__(self, name: str, *args: Any, **kwargs: Any) -> None:
     WebhookIntegration("buildbot", ["continuous-integration"], display_name="Buildbot"),
     WebhookIntegration("canarytoken", ["monitoring"], display_name="Thinkst Canarytokens"),
     WebhookIntegration("circleci", ["continuous-integration"], display_name="CircleCI"),
+    WebhookIntegration("clickup", ["project-management"], display_name="ClickUp"),
     WebhookIntegration("clubhouse", ["project-management"]),
     WebhookIntegration("codeship", ["continuous-integration", "deployment"]),
     WebhookIntegration("crashlytics", ["monitoring"]),
@@ -735,6 +735,7 @@ def __init__(self, name: str, *args: Any, **kwargs: Any) -> None:
         ScreenshotConfig("bitbucket_job_completed.json", image_name="001.png"),
         ScreenshotConfig("github_job_completed.json", image_name="002.png"),
     ],
+    "clickup": [ScreenshotConfig("task_created.json")],
     "clubhouse": [ScreenshotConfig("story_create.json")],
     "codeship": [ScreenshotConfig("error_build.json")],
     "crashlytics": [ScreenshotConfig("issue_message.json")],

static/images/integrations/clickup/001.png

@@ -0,0 +1,68 @@
+from typing import Any, Dict
+
+import requests
+from urllib.parse import urljoin
+from zerver.lib.outgoing_http import OutgoingSession
+
+
+class Error(Exception):
+    pass
+
+
+class APIUnavailableError(Error):
+    pass
+
+
+class BadRequestError(Error):
+    pass
+
+
+class ClickUpSession(OutgoingSession):
+    def __init__(self, **kwargs: Any) -> None:
+        super().__init__(role="clickup", timeout=5, **kwargs)
+
+
+def make_clickup_request(path: str, api_key: str) -> Dict[str, Any]:
+    headers: Dict[str, str] = {
+        "Content-Type": "application/json",
+        "Authorization": api_key,
+    }
+
+    try:
+        base_url = "https://api.clickup.com/api/v2/"
+        api_endpoint = urljoin(base_url, path)
+        response = ClickUpSession(headers=headers).get(
+            api_endpoint,
+        )
+        response.raise_for_status()
+    except (requests.ConnectionError, requests.Timeout) as e:
+        raise APIUnavailableError from e
+    except requests.HTTPError as e:
+        raise BadRequestError from e
+
+    return response.json()
+
+
+def get_list(api_key: str, list_id: str) -> Dict[str, Any]:
+    data = make_clickup_request(f"list/{list_id}", api_key)
+    return data
+
+
+def get_task(api_key: str, task_id: str) -> Dict[str, Any]:
+    data = make_clickup_request(f"task/{task_id}", api_key)
+    return data
+
+
+def get_folder(api_key: str, folder_id: str) -> Dict[str, Any]:
+    data = make_clickup_request(f"folder/{folder_id}", api_key)
+    return data
+
+
+def get_goal(api_key: str, goal_id: str) -> Dict[str, Any]:
+    data = make_clickup_request(f"goal/{goal_id}", api_key)
+    return data
+
+
+def get_space(api_key: str, space_id: str) -> Dict[str, Any]:
+    data = make_clickup_request(f"space/{space_id}", api_key)
+    return data

static/images/integrations/logos/clickup.svg

@@ -0,0 +1,14 @@
+{
+"id": "457",
+"name": "Lord Foldemort",
+"orderindex": 0,
+"override_statuses": false,
+"hidden": false,
+"space": {
+    "id": "789",
+    "name": "Space Name",
+    "access": true
+},
+"task_count": "0",
+"lists": []
+}

zerver/lib/integrations.py

@@ -0,0 +1,33 @@
+{
+    "goal": {
+      "id": "e53a033c-900e-462d-a849-4a216b06d930",
+      "name": "hat-trick",
+      "team_id": "512",
+      "date_created": "1568044355026",
+      "start_date": null,
+      "due_date": "1568036964079",
+      "description": "Updated Goal Description",
+      "private": false,
+      "archived": false,
+      "creator": 183,
+      "color": "#32a852",
+      "pretty_id": "6",
+      "multiple_owners": true,
+      "folder_id": null,
+      "members": [],
+      "owners": [
+        {
+          "id": 182,
+          "username": "Pieter CK",
+          "email": "[email protected]",
+          "color": "#7b68ee",
+          "initials": "PK",
+          "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
+        }
+      ],
+      "key_results": [],
+      "percent_completed": 0,
+      "history": [],
+      "pretty_url": "https://app.clickup.com/512/goals/6"
+    }
+  }

zerver/webhooks/clickup/__init__.py

@@ -0,0 +1,49 @@
+{
+    "id": "124",
+    "name": "List-an al Gaib",
+    "orderindex": 1,
+    "content": "Updated List Content",
+    "status": {
+      "status": "red",
+      "color": "#e50000",
+      "hide_label": true
+    },
+    "priority": {
+      "priority": "high",
+      "color": "#f50000"
+    },
+    "assignee": null,
+    "due_date": "1567780450202",
+    "due_date_time": true,
+    "start_date": null,
+    "start_date_time": null,
+    "folder": {
+      "id": "456",
+      "name": "Folder Name",
+      "hidden": false,
+      "access": true
+    },
+    "space": {
+      "id": "789",
+      "name": "Space Name",
+      "access": true
+    },
+    "inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
+    "archived": false,
+    "override_statuses": false,
+    "statuses": [
+      {
+        "status": "to do",
+        "orderindex": 0,
+        "color": "#d3d3d3",
+        "type": "open"
+      },
+      {
+        "status": "complete",
+        "orderindex": 1,
+        "color": "#6bc950",
+        "type": "closed"
+      }
+    ],
+    "permission_level": "create"
+  }

zerver/webhooks/clickup/api_endpoints.py

@@ -0,0 +1,52 @@
+{
+    "id": "790",
+    "name": "the Milky Way",
+    "private": false,
+    "statuses": [
+      {
+        "status": "to do",
+        "type": "open",
+        "orderindex": 0,
+        "color": "#d3d3d3"
+      },
+      {
+        "status": "complete",
+        "type": "closed",
+        "orderindex": 1,
+        "color": "#6bc950"
+      }
+    ],
+    "multiple_assignees": false,
+    "features": {
+      "due_dates": {
+        "enabled": false,
+        "start_date": false,
+        "remap_due_dates": false,
+        "remap_closed_due_date": false
+      },
+      "time_tracking": {
+        "enabled": false
+      },
+      "tags": {
+        "enabled": false
+      },
+      "time_estimates": {
+        "enabled": false
+      },
+      "checklists": {
+        "enabled": true
+      },
+      "custom_fields": {
+        "enabled": true
+      },
+      "remap_dependencies": {
+        "enabled": false
+      },
+      "dependency_warning": {
+        "enabled": false
+      },
+      "portfolios": {
+        "enabled": false
+      }
+    }
+  }