moved waggle message stuff into minimal module

Author: seanshahkarami

.github/workflows/cicd.yaml

@@ -0,0 +1,54 @@
+name: CI/CD
+on: push
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set release version
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+        if: startsWith(github.ref, 'refs/tags/')
+      - name: Build wheel
+        run: python3 setup.py bdist_wheel
+      - name: Upload wheel
+        uses: actions/upload-artifact@v2
+        with:
+          name: dist
+          path: dist/*.whl
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    needs: build
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Download wheel
+        uses: actions/download-artifact@v2
+        with:
+          name: dist
+      - name: Install wheel
+        run: pip3 install *.whl
+      - name: Run tests
+        run: python3 -m unittest
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+      - name: Download wheel
+        uses: actions/download-artifact@v2
+        with:
+          name: dist
+      - name: Create release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            *.whl

.gitignore

@@ -0,0 +1,6 @@
+build/
+dist/
+*.egg-info/
+__pycache__/
+venv/
+.DS_Store

README.md

@@ -0,0 +1,23 @@
+# pywagglemsg
+
+Tiny Python library for (de)serializing Waggle messages. Although this is a public module, it's
+mostly geared towards building internal tools and services.
+
+## Example
+
+```python3
+import wagglemsg
+
+msg = wagglemsg.Message(
+    name='env.temperature.htu21d',
+    value=10,
+    timestamp=1602704769215113000,
+    meta={
+        "device": "bme280",
+    },
+)
+
+data = wagglemsg.dump(msg)
+
+# ... send data over the network ....
+```

setup.py

@@ -0,0 +1,13 @@
+from setuptools import setup
+from os import getenv
+
+setup(
+    name="wagglemsg",
+    version=getenv("RELEASE_VERSION", "0.0.0"),
+    description="Official Waggle Python message module",
+    url="https://github.com/waggle-sensor/pywagglemsg",
+    packages=[
+        "wagglemsg",
+    ],
+    python_requires=">=3.6",
+)

test.py

@@ -0,0 +1,44 @@
+import unittest
+import wagglemsg
+
+
+class TestMain(unittest.TestCase):
+
+    def test_fail(self):
+        test_cases = [
+            wagglemsg.Message(
+                name='env.temperature.htu21d',
+                value=10,
+                timestamp=1602704769215113000,
+                meta={},
+            ),
+            wagglemsg.Message(
+                name='env.temperature.htu21d',
+                value=21.2,
+                timestamp=1602704769215113000,
+                meta={},
+            ),
+            wagglemsg.Message(
+                name='env.temperature.htu21d',
+                value=b'some binary data',
+                timestamp=1602704769215113000,
+                meta={},
+            ),
+            wagglemsg.Message(
+                name='env.temperature.htu21d',
+                value='some string data',
+                timestamp=1602704769215113000,
+                meta={
+                    "id": "meta-test-id"
+                },
+            )
+        ]
+
+        for msg in test_cases:
+            out = wagglemsg.load(wagglemsg.dump(msg))
+            self.assertEqual(msg, out)
+
+
+
+if __name__ == "__main__":
+    unittest.main()

wagglemsg/__init__.py

@@ -0,0 +1,44 @@
+import base64
+import json
+from typing import NamedTuple, Any, Dict
+
+
+class Message(NamedTuple):
+    """Message contains message data."""
+    name: str
+    value: Any
+    timestamp: int
+    meta: Dict[str, str]
+
+
+def dump(msg: Message) -> bytes:
+    """dump serializes a Message object."""
+    payload = {
+        "name": msg.name,
+        "ts": msg.timestamp,
+        "meta": msg.meta,
+    }
+
+    # binary data is encoded to base64 by default. all other
+    # data is shipped as-is for now.
+    if isinstance(msg.value, (bytes, bytearray)):
+        payload["enc"] = "b64"
+        payload["val"] = base64.b64encode(msg.value).decode()
+    else:
+        payload["val"] = msg.value
+
+    return json.dumps(payload, separators=(",", ":"))
+
+
+def load(body: bytes) -> Message:
+    """dump deserializes a Message object."""
+    data = json.loads(body)
+
+    if data.get("enc") == "b64":
+        data["val"] = base64.b64decode(data["val"])
+
+    return Message(
+        name=data["name"],
+        value=data["val"],
+        timestamp=data["ts"],
+        meta=data["meta"])