snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/beeminder/doc.md

@@ -0,0 +1,25 @@
+# Zulip Beeminder integration
+
+Get Beeminder notifications in Zulip whenever you're going
+to derail from your goal!
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. Go to your Beeminder **Reminders** settings.
+
+1. Set **URL for POST** to the URL generated above. Click
+   **Save Changes**.
+
+{end_tabs}
+
+{!congrats.md!}
+
+![](/static/images/integrations/beeminder/001.png)
+
+### Related documentation
+
+{!webhooks-url-specification.md!}

zerver/webhooks/beeminder/fixtures/derail.json

@@ -0,0 +1,137 @@
+{
+    "goal": {
+        "slug": "gainweight",
+        "title": "Have to get back to the shape I want!",
+        "description": null,
+        "goalval": 60,
+        "rate": null,
+        "goaldate": 1515258000,
+        "graph_url": "https://bmndr.s3.amazonaws.com/uploads/e5eec384-d736-4a96-a22c-724784598dd0.png",
+        "thumb_url": "https://bmndr.s3.amazonaws.com/uploads/e5eec384-d736-4a96-a22c-724784598dd0-thumb.png",
+        "goal_type": "gainer",
+        "autodata": null,
+        "healthkitmetric": "",
+        "losedate": 1517759100,
+        "deadline": -4500,
+        "leadtime": 0,
+        "alertstart": 81720,
+        "use_defaults": true,
+        "id": "5a47c445bfec034a59000d75",
+        "ephem": false,
+        "queued": false,
+        "panic": 54000,
+        "updated_at": 1514653620,
+        "burner": "frontburner",
+        "yaw": 1,
+        "lane": 666,
+        "lanewidth": 0,
+        "delta": 0.5,
+        "runits": "d",
+        "limsum": "+2 in 7 days (60)",
+        "frozen": false,
+        "lost": false,
+        "won": false,
+        "contract": {
+            "amount": 0,
+            "stepdown_at": null,
+            "pending_amount": null,
+            "pending_at": null
+        },
+        "delta_text": "✔ ✔ ✔",
+        "safebump": 60,
+        "limsumdate": "+2 due Sat by 22:45",
+        "limsumdays": "+2 due in 7 days",
+        "baremin": "+2",
+        "baremintotal": "60",
+        "roadstatuscolor": "green",
+        "lasttouch": "2017-12-30T16:53:18Z",
+        "safebuf": 7,
+        "sadbrink": false,
+        "coasting": false,
+        "fineprint": null,
+        "yaxis": "kilograms",
+        "nomercy": true,
+        "initday": 1514653200,
+        "initval": 57.5,
+        "curday": 1514653200,
+        "curval": 58,
+        "lastday": 1514653200,
+        "dir": 1,
+        "exprd": false,
+        "kyoom": false,
+        "odom": false,
+        "noisy": false,
+        "aggday": "max",
+        "plotall": false,
+        "steppy": false,
+        "rosy": true,
+        "movingav": true,
+        "aura": true,
+        "numpts": 2,
+        "road": [
+            [
+                1515258000,
+                null,
+                0
+            ]
+        ],
+        "roadall": [
+            [
+                1514653200,
+                57.5,
+                null
+            ],
+            [
+                1515258000,
+                null,
+                0
+            ],
+            [
+                1515258000,
+                60,
+                null
+            ]
+        ],
+        "fullroad": [
+            [
+                1514653200,
+                57.5,
+                0
+            ],
+            [
+                1515258000,
+                57.5,
+                0
+            ],
+            [
+                1515258000,
+                60,
+                0
+            ]
+        ],
+        "secret": false,
+        "pledge": 0,
+        "mathishard": [
+            1515258000,
+            60,
+            0
+        ],
+        "headsum": "Coasting on a currently flat yellow brick road",
+        "datapublic": false,
+        "graphsum": "58 on 2017.12.30 (1 datapoint in 1 day) targeting 60 on 2018.01.06 (7 more days). Yellow Brick Rd = +0 / day.",
+        "rah": 60,
+        "last_datapoint": {
+            "timestamp": 1514654099,
+            "value": 58,
+            "comment": "",
+            "id": "5a47c47ebfec034a4e0036b3",
+            "updated_at": 1514652798,
+            "requestid": null,
+            "canonical": "30 58",
+            "fulltext": "2017-Dec-30 entered at 22:23 via Beeminder Web",
+            "origin": "Beeminder Web",
+            "daystamp": "20171230"
+        },
+        "callback_url": null
+    }
+}

zerver/webhooks/beeminder/fixtures/derail_worried.json

@@ -0,0 +1,137 @@
+{
+    "goal": {
+        "slug": "gainweight",
+        "title": "Have to get back to the shape I want!",
+        "description": null,
+        "goalval": 60,
+        "rate": null,
+        "goaldate": 1515258000,
+        "graph_url": "https://bmndr.s3.amazonaws.com/uploads/e5eec384-d736-4a96-a22c-724784598dd0.png",
+        "thumb_url": "https://bmndr.s3.amazonaws.com/uploads/e5eec384-d736-4a96-a22c-724784598dd0-thumb.png",
+        "goal_type": "gainer",
+        "autodata": null,
+        "healthkitmetric": "",
+        "losedate": 1517759100,
+        "deadline": -4500,
+        "leadtime": 0,
+        "alertstart": 81720,
+        "use_defaults": true,
+        "id": "5a47c445bfec034a59000d75",
+        "ephem": false,
+        "queued": false,
+        "panic": 54000,
+        "updated_at": 1514653620,
+        "burner": "frontburner",
+        "yaw": 1,
+        "lane": 666,
+        "lanewidth": 0,
+        "delta": 0.5,
+        "runits": "d",
+        "limsum": "+2 in 7 days (60)",
+        "frozen": false,
+        "lost": false,
+        "won": false,
+        "contract": {
+            "amount": 0,
+            "stepdown_at": null,
+            "pending_amount": null,
+            "pending_at": null
+        },
+        "delta_text": "✔ ✔ ✔",
+        "safebump": 60,
+        "limsumdate": "+2 due Sat by 22:45",
+        "limsumdays": "+2 due in 7 days",
+        "baremin": "+2",
+        "baremintotal": "60",
+        "roadstatuscolor": "green",
+        "lasttouch": "2017-12-30T16:53:18Z",
+        "safebuf": 7,
+        "sadbrink": false,
+        "coasting": false,
+        "fineprint": null,
+        "yaxis": "kilograms",
+        "nomercy": true,
+        "initday": 1514653200,
+        "initval": 57.5,
+        "curday": 1514653200,
+        "curval": 58,
+        "lastday": 1514653200,
+        "dir": 1,
+        "exprd": false,
+        "kyoom": false,
+        "odom": false,
+        "noisy": false,
+        "aggday": "max",
+        "plotall": false,
+        "steppy": false,
+        "rosy": true,
+        "movingav": true,
+        "aura": true,
+        "numpts": 2,
+        "road": [
+            [
+                1515258000,
+                null,
+                0
+            ]
+        ],
+        "roadall": [
+            [
+                1514653200,
+                57.5,
+                null
+            ],
+            [
+                1515258000,
+                null,
+                0
+            ],
+            [
+                1515258000,
+                60,
+                null
+            ]
+        ],
+        "fullroad": [
+            [
+                1514653200,
+                57.5,
+                0
+            ],
+            [
+                1515258000,
+                57.5,
+                0
+            ],
+            [
+                1515258000,
+                60,
+                0
+            ]
+        ],
+        "secret": true,
+        "pledge": 5,
+        "mathishard": [
+            1515258000,
+            60,
+            0
+        ],
+        "headsum": "Coasting on a currently flat yellow brick road",
+        "datapublic": false,
+        "graphsum": "58 on 2017.12.30 (1 datapoint in 1 day) targeting 60 on 2018.01.06 (7 more days). Yellow Brick Rd = +0 / day.",
+        "rah": 60,
+        "last_datapoint": {
+            "timestamp": 1514654099,
+            "value": 58,
+            "comment": "",
+            "id": "5a47c47ebfec034a4e0036b3",
+            "updated_at": 1514652798,
+            "requestid": null,
+            "canonical": "30 58",
+            "fulltext": "2017-Dec-30 entered at 22:23 via Beeminder Web",
+            "origin": "Beeminder Web",
+            "daystamp": "20171230"
+        },
+        "callback_url": null
+    }
+}

zerver/webhooks/beeminder/tests.py

@@ -0,0 +1,34 @@
+from unittest.mock import MagicMock, patch
+
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class BeeminderHookTests(WebhookTestCase):
+    @patch("zerver.webhooks.beeminder.view.time.time")
+    def test_beeminder_derail(self, time: MagicMock) -> None:
+        time.return_value = 1517739100  # 5.6 hours from fixture value
+        expected_topic_name = "beekeeper"
+        expected_message = """
+You are going to derail from goal **gainweight** in **5.6 hours**. You need **+2 in 7 days (60)** to avoid derailing.
+* Pledge: **$0** :relieved:
+""".strip()
+
+        self.check_webhook(
+            "derail",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    @patch("zerver.webhooks.beeminder.view.time.time")
+    def test_beeminder_derail_worried(self, time: MagicMock) -> None:
+        time.return_value = 1517739100  # 5.6 hours from fixture value
+        expected_topic_name = "beekeeper"
+        expected_message = """
+You are going to derail from goal **gainweight** in **5.6 hours**. You need **+2 in 7 days (60)** to avoid derailing.
+* Pledge: **$5** :worried:
+""".strip()
+
+        self.check_webhook(
+            "derail_worried", expected_topic_name, expected_message, content_type="application/json"
+        )

zerver/webhooks/beeminder/view.py

@@ -0,0 +1,53 @@
+# Webhooks for external integrations.
+import time
+
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+from zerver.lib.response import json_success
+from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint
+from zerver.lib.validator import WildValue, check_float, check_int, check_string, check_union
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+MESSAGE_TEMPLATE = (
+    "You are going to derail from goal **{goal_name}** in **{time:0.1f} hours**. "
+    "You need **{limsum}** to avoid derailing.\n"
+    "* Pledge: **${pledge}** {expression}\n"
+)
+
+
+def get_time(payload: WildValue) -> float:
+    losedate = payload["goal"]["losedate"].tame(check_int)
+    time_remaining = (losedate - time.time()) / 3600
+    return time_remaining
+
+
+@webhook_view("Beeminder")
+@typed_endpoint
+def api_beeminder_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    goal_name = payload["goal"]["slug"].tame(check_string)
+    limsum = payload["goal"]["limsum"].tame(check_string)
+    pledge = payload["goal"]["pledge"].tame(check_union([check_int, check_float]))
+    time_remain = get_time(payload)  # time in hours
+    # To show user's probable reaction by looking at pledge amount
+    if pledge > 0:
+        expression = ":worried:"
+    else:
+        expression = ":relieved:"
+
+    topic_name = "beekeeper"
+    body = MESSAGE_TEMPLATE.format(
+        goal_name=goal_name,
+        time=time_remain,
+        limsum=limsum,
+        pledge=pledge,
+        expression=expression,
+    )
+    check_send_webhook_message(request, user_profile, topic_name, body)
+    return json_success(request)