Added sample code to README.md

Signed-off-by: Curtis Mason <[email protected]>
cloudevents · grant · Jun 26, 2020 · Jun 24, 2020 · Jun 25, 2020 · Jun 25, 2020
commit b93ed54680d693fb0b30a9a94032b376e4295a27
diff --git a/README.md b/README.md
@@ -14,6 +14,55 @@ This SDK current supports the following versions of CloudEvents:
 
 Package **cloudevents** provides primitives to work with CloudEvents specification: https://github.com/cloudevents/spec.
 
+Creating minimal CloudEvents with data in version 1.0.0:
+
+### Binary HTTP CloudEvent
+
+```python
+from cloudevents.sdk.http_events import CloudEvent
+import requests
+
+
+# This data defines a binary cloudevent
+headers = {
+    "Content-Type": "application/json",
+    "ce-specversion": "1.0",
+    "ce-type": "README.sample.binary",
+    "ce-id": "binary-event",
+    "ce-time": "2018-10-23T12:28:22.4579346Z",
+    "ce-source": "README",
+}
+data = {"message": "Hello World!"}
+
+event = CloudEvent(data, headers=headers)
+headers, body = event.ToRequest()
+
+# POST
+requests.post("<some-url>", json=body, headers=headers)
+```
+
+### Structured HTTP CloudEvent
+
+```python
+from cloudevents.sdk.http_events import CloudEvent
+import requests
+
+
+# This data defines a structured cloudevent
+data = {
+    "specversion": "1.0",
+    "type": "README.sample.structured",
+    "id": "structured-event",
+    "source": "README",
+    "data": {"message": "Hello World!"}
+}
+event = CloudEvent(data)
+headers, body = event.ToRequest()
+
+# POST
+requests.post("<some-url>", json=structured_body, headers=structured_headers)
+```
+
 Parsing upstream structured Event from HTTP request:
 
 ```python
@@ -68,32 +117,6 @@ event = m.FromRequest(
 )
 ```
 
-Creating minimal CloudEvents with data in version 1.0.0:
-
-```python
-from cloudevents.sdk.http_events import CloudEvent
-
-data = {
-    "specversion": "1.0",
-    "type": "word.found.name",
-    "id": "96fb5f0b-001e-0108-6dfe-da6e2806f124",
-    "source": "<source-url>",
-    "data": {"message": "Hello World!"}
-}
-structured_event = CloudEvent(data)
-
-headers = {
-    "Content-Type": "application/cloudevents+json",         
-    "ce-specversion": "1.0",
-    "ce-type": "word.found.name",
-    "ce-id": "96fb5f0b-001e-0108-6dfe-da6e2806f124",
-    "ce-time": "2018-10-23T12:28:22.4579346Z",
-    "ce-source": "<source-url>",
-}
-data = {"message": "Hello World!"}
-binary_event = CloudEvent(data, headers=headers)
-```
-
 Creating HTTP request from CloudEvent:
 
 ```python

diff --git a/cloudevents/sdk/http_events.py b/cloudevents/sdk/http_events.py
@@ -34,14 +34,7 @@ def __init__(
             self,
             data: typing.Union[dict,None],
             headers: dict = {},
-            data_unmarshaller: typing.Callable = lambda x: json.loads(
-                x.read()
-                .decode('utf-8')
-            ),
-            data_marshaller: typing.Callable = lambda x: io.BytesIO(
-                json.dumps(x)
-                .encode()
-            )
+            data_unmarshaller= lambda x: x,
     ):
         """
         Event HTTP Constructor
@@ -63,8 +56,6 @@ def __init__(
         """
         self.required_attribute_values = {}
         self.optional_attribute_values = {}
-        self.data_unmarshaller = data_unmarshaller
-        self.data_marshaller = data_marshaller
         if data is None:
             data = {}
 
@@ -81,8 +72,8 @@ def __init__(
         self.__event = self.marshall.FromRequest(
             self.event_handler,
             headers,
-            self.data_marshaller(data),
-            self.data_unmarshaller
+            io.BytesIO(json.dumps(data).encode()),
+            data_unmarshaller
         )
 
         # headers validation for binary events
@@ -135,15 +126,19 @@ def __init__(
         }
 
 
-    def ToRequest(self):
+    def ToRequest(
+        self, 
+        data_unmarshaller: typing.Callable = lambda x: json.loads(x.read().decode('utf-8'))
+    ) -> (dict, dict):
         converter_type = converters.TypeBinary if self.isbinary else \
             converters.TypeStructured
 
-        return self.marshall.ToRequest(
+        headers, data = self.marshall.ToRequest(
             self.__event, 
             converter_type,
-            lambda x: x
+            data_unmarshaller
         )
+        return headers, (data if self.isbinary else data_unmarshaller(data)['data'])
 
     def __getitem__(self, key):
         return self.data if key == 'data' else self.headers[key]

diff --git a/cloudevents/tests/test_http_events.py b/cloudevents/tests/test_http_events.py
@@ -11,6 +11,8 @@
 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #    License for the specific language governing permissions and limitations
 #    under the License.
+import io
+
 import json
 
 import copy
@@ -217,11 +219,12 @@ def test_structured_ToRequest(specversion):
     }
     event = CloudEvent(data)
     headers, body = event.ToRequest()
-    decoded_body = event.data_unmarshaller(body)['data']
+    assert isinstance(body, dict)
+    print(body)
 
     assert headers['content-type'] == 'application/cloudevents+json'
     for key in data:
-        assert decoded_body[key] == data[key]
+        assert body[key] == data[key]
 
 
 @pytest.mark.parametrize("specversion", ['1.0', '0.3'])
@@ -237,6 +240,8 @@ def test_binary_ToRequest(specversion):
     }
     event = CloudEvent(data, headers=test_headers)
     headers, body = event.ToRequest()
+    assert isinstance(body, dict)
+    print("LOOK", body)
 
     for key in data:
         assert body[key] == data[key]