Add VBMLClient.format() (#221)

This calls the https://vbml.vestaboard.com/format endpoint, which
formats a message string into rows of character codes.

Author: jparise

src/vesta/clients.py

@@ -416,3 +416,14 @@ def compose(
         r = self.http.post("/compose", json=data)
         r.raise_for_status()
         return r.json()
+
+    def format(self, message: str) -> Rows:
+        """Formats a message string into rows of character codes.
+
+        .. versionadded:: 0.13.0
+
+        :returns: Rows of character codes representing the formatted message
+        """
+        data = {"message": message}
+        r = self.http.post("/format", json=data)
+        return r.json()

tests/test_clients.py

@@ -325,3 +325,10 @@ def test_compose(self, vbml_client: VBMLClient, respx_mock: MockRouter):
     def test_component_no_components(self, vbml_client: VBMLClient):
         with pytest.raises(ValueError, match=r"expected at least one component"):
             vbml_client.compose([])
+
+    def test_format(self, vbml_client: VBMLClient, respx_mock: MockRouter):
+        chars = [[0] * COLS] * ROWS
+        respx_mock.post("https://vbml.vestaboard.com/format").respond(json=chars)
+
+        assert vbml_client.format("message") == chars
+        assert respx_mock.calls.called