Merge pull request #78 from stealthrocket/example-gh-stats

doc: add github stats example

Author: Pryz

examples/github_stats/__init__.py

@@ -0,0 +1,63 @@
+"""Github repository stats example.
+
+This example demonstrates how to use async functions orchestrated by Dispatch.
+
+Make sure to follow the setup instructions at
+https://docs.stealthrocket.cloud/dispatch/stateful-functions/getting-started/
+
+Run with:
+
+uvicorn app:app
+
+
+Logs will show a pipeline of functions being called and their results.
+
+"""
+
+import httpx
+from fastapi import FastAPI
+
+from dispatch.fastapi import Dispatch
+
+app = FastAPI()
+
+dispatch = Dispatch(app)
+
+
+@dispatch.function
+async def get_repo_info(repo_owner: str, repo_name: str):
+    url = f"https://api.github.com/repos/{repo_owner}/{repo_name}"
+    api_response = httpx.get(url)
+    api_response.raise_for_status()
+    repo_info = api_response.json()
+    return repo_info
+
+
+@dispatch.function
+async def get_contributors(repo_info: dict):
+    contributors_url = repo_info["contributors_url"]
+    response = httpx.get(contributors_url)
+    response.raise_for_status()
+    contributors = response.json()
+    return contributors
+
+
+@dispatch.function
+async def main():
+    repo_info = await get_repo_info("stealthrocket", "coroutine")
+    print(
+        f"""Repository: {repo_info['full_name']}
+Stars: {repo_info['stargazers_count']}
+Watchers: {repo_info['watchers_count']}
+Forks: {repo_info['forks_count']}"""
+    )
+
+    contributors = await get_contributors(repo_info)
+    print(f"Contributors: {len(contributors)}")
+    return
+
+
+@app.get("/")
+def root():
+    main.dispatch()
+    return "OK"

examples/github_stats/app.py

@@ -0,0 +1,41 @@
+# This file is not part of the example. It is a test file to ensure the example
+# works as expected during the CI process.
+
+
+import os
+import unittest
+from unittest import mock
+
+from fastapi.testclient import TestClient
+
+from ... import function_service
+from ...test_client import ServerTest
+
+
+class TestGithubStats(unittest.TestCase):
+    @mock.patch.dict(
+        os.environ,
+        {
+            "DISPATCH_ENDPOINT_URL": "http://function-service",
+            "DISPATCH_API_KEY": "0000000000000000",
+        },
+    )
+    def test_foo(self):
+        from . import app
+
+        server = ServerTest()
+        servicer = server.servicer
+        app.dispatch._client = server.client
+        app.get_repo_info._client = server.client
+        app.get_contributors._client = server.client
+        app.main._client = server.client
+
+        http_client = TestClient(app.app, base_url="http://dispatch-service")
+        app_client = function_service.client(http_client)
+
+        response = http_client.get("/")
+        self.assertEqual(response.status_code, 200)
+
+        server.execute(app_client)
+
+        self.assertEqual(len(servicer.responses), 1)