V1.1.0 dev (#114)

* 100% test-coverage rule added to tox (#109)

* version bump

Signed-off-by: Curtis Mason <[email protected]>

* adding tests for marshaller

Signed-off-by: Curtis Mason <[email protected]>

* marshaller 100% test-coverage

Signed-off-by: Curtis Mason <[email protected]>

* bricked some tests

Signed-off-by: Curtis Mason <[email protected]>

* additional error handling

Signed-off-by: Curtis Mason <[email protected]>

* 100% test-coverage

Signed-off-by: Curtis Mason <[email protected]>

* handles empty data and capitalized headers

Signed-off-by: Curtis Mason <[email protected]>

* 1.1.0 version bump

Signed-off-by: Curtis Mason <[email protected]>

* Removed _http suffix from http_methods (#108)

* Removed _http suffix from http_methods

to_binary_http renamed to_binary, and to_structured_http renamed
to_structured. These functions are inside of cloudevents.http thus the
_http part should be implicitly understood.

Signed-off-by: Curtis Mason <[email protected]>

* version bump

Signed-off-by: Curtis Mason <[email protected]>

* deprecated instead of removal

Signed-off-by: Curtis Mason <[email protected]>

* Update setup.py

Co-authored-by: Dustin Ingram <[email protected]>
Signed-off-by: Curtis Mason <[email protected]>

* 1.1.0 version bump

Signed-off-by: Curtis Mason <[email protected]>

Co-authored-by: Dustin Ingram <[email protected]>

* swapped args for from_http (#110)

Signed-off-by: Curtis Mason <[email protected]>

* exception names shortened (#111)

* exception names shortened

Signed-off-by: Curtis Mason <[email protected]>

* to_structured documentation

Signed-off-by: Curtis Mason <[email protected]>

* adjusted readme and changelog (#113)

* adjusted readme and changelog

Signed-off-by: Curtis Mason <[email protected]>

* readme adjustment

Signed-off-by: Curtis Mason <[email protected]>

* structured content mode

Signed-off-by: Curtis Mason <[email protected]>

Co-authored-by: Dustin Ingram <[email protected]>

Author: cumason123

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0]
+### Changed
+- Changed from_http to now expect headers argument before data ([#110])
+- Renamed exception names ([#111])
+
+### Deprecated
+- Renamed to_binary_http and to_structured_http. ([#108])
+
 ## [1.0.1]
 ### Added
 - CloudEvent exceptions and event type checking in http module ([#96])
@@ -93,4 +101,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#71]: https://github.com/cloudevents/sdk-python/pull/71
 [#72]: https://github.com/cloudevents/sdk-python/pull/72
 [#96]: https://github.com/cloudevents/sdk-python/pull/96
-[#98]: https://github.com/cloudevents/sdk-python/pull/98
+[#98]: https://github.com/cloudevents/sdk-python/pull/98
+[#108]: https://github.com/cloudevents/sdk-python/pull/108
+[#110]: https://github.com/cloudevents/sdk-python/pull/110
+[#111]: https://github.com/cloudevents/sdk-python/pull/111

README.md

@@ -24,19 +24,20 @@ Below we will provide samples on how to send cloudevents using the popular
 ### Binary HTTP CloudEvent
 
 ```python
-from cloudevents.http import CloudEvent, to_binary_http
+from cloudevents.http import CloudEvent, to_binary
 import requests
 
-
-# This data defines a binary cloudevent
+# Create a CloudEvent
+# - The CloudEvent "id" is generated if omitted. "specversion" defaults to "1.0".
 attributes = {
     "type": "com.example.sampletype1",
     "source": "https://example.com/event-producer",
 }
 data = {"message": "Hello World!"}
-
 event = CloudEvent(attributes, data)
-headers, body = to_binary_http(event)
+
+# Creates the HTTP request representation of the CloudEvent in binary content mode
+headers, body = to_binary(event)
 
 # POST
 requests.post("<some-url>", data=body, headers=headers)
@@ -45,18 +46,20 @@ requests.post("<some-url>", data=body, headers=headers)
 ### Structured HTTP CloudEvent
 
 ```python
-from cloudevents.http import CloudEvent, to_structured_http
+from cloudevents.http import CloudEvent, to_structured
 import requests
 
-
-# This data defines a structured cloudevent
+# Create a CloudEvent
+# - The CloudEvent "id" is generated if omitted. "specversion" defaults to "1.0".
 attributes = {
     "type": "com.example.sampletype2",
     "source": "https://example.com/event-producer",
 }
 data = {"message": "Hello World!"}
 event = CloudEvent(attributes, data)
-headers, body = to_structured_http(event)
+
+# Creates the HTTP request representation of the CloudEvent in structured content mode
+headers, body = to_structured(event)
 
 # POST
 requests.post("<some-url>", data=body, headers=headers)
@@ -81,7 +84,7 @@ app = Flask(__name__)
 @app.route("/", methods=["POST"])
 def home():
     # create a CloudEvent
-    event = from_http(request.get_data(), request.headers)
+    event = from_http(request.headers, request.get_data())
 
     # you can access cloudevent fields as seen below
     print(

cloudevents/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.1"
+__version__ = "1.1.0"

cloudevents/exceptions.py

@@ -11,9 +11,17 @@
 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #    License for the specific language governing permissions and limitations
 #    under the License.
-class CloudEventMissingRequiredFields(Exception):
+class MissingRequiredFields(Exception):
     pass
 
 
-class CloudEventTypeErrorRequiredFields(Exception):
+class InvalidRequiredFields(Exception):
+    pass
+
+
+class InvalidStructuredJSON(Exception):
+    pass
+
+
+class InvalidHeadersFormat(Exception):
     pass

cloudevents/http/__init__.py

@@ -18,7 +18,9 @@
 from cloudevents.http.event_type import is_binary, is_structured
 from cloudevents.http.http_methods import (
     from_http,
+    to_binary,
     to_binary_http,
+    to_structured,
     to_structured_http,
 )
 from cloudevents.http.json_methods import from_json, to_json

cloudevents/http/event.py

@@ -58,15 +58,15 @@ def __init__(
             ).isoformat()
 
         if self._attributes["specversion"] not in _required_by_version:
-            raise cloud_exceptions.CloudEventMissingRequiredFields(
-                f"Invalid specversion: {self._attributes['specversion']}"
+            raise cloud_exceptions.MissingRequiredFields(
+                f"Invalid specversion: {self._attributes['specversion']}. "
             )
         # There is no good way to default 'source' and 'type', so this
         # checks for those (or any new required attributes).
         required_set = _required_by_version[self._attributes["specversion"]]
         if not required_set <= self._attributes.keys():
-            raise cloud_exceptions.CloudEventMissingRequiredFields(
-                f"Missing required keys: {required_set - attributes.keys()}"
+            raise cloud_exceptions.MissingRequiredFields(
+                f"Missing required keys: {required_set - self._attributes.keys()}. "
             )
 
     def __eq__(self, other):

cloudevents/http/http_methods.py

@@ -1,6 +1,8 @@
 import json
 import typing
 
+from deprecation import deprecated
+
 import cloudevents.exceptions as cloud_exceptions
 from cloudevents.http.event import CloudEvent
 from cloudevents.http.event_type import is_binary, is_structured
@@ -10,20 +12,30 @@
 
 
 def from_http(
-    data: typing.Union[str, bytes],
     headers: typing.Dict[str, str],
+    data: typing.Union[str, bytes, None],
     data_unmarshaller: types.UnmarshallerType = None,
 ):
     """
     Unwrap a CloudEvent (binary or structured) from an HTTP request.
-    :param data: the HTTP request body
-    :type data: typing.IO
     :param headers: the HTTP headers
     :type headers: typing.Dict[str, str]
+    :param data: the HTTP request body
+    :type data: typing.IO
     :param data_unmarshaller: Callable function to map data to a python object
         e.g. lambda x: x or lambda x: json.loads(x)
     :type data_unmarshaller: types.UnmarshallerType
     """
+    if data is None:
+        data = ""
+
+    if not isinstance(data, (str, bytes, bytearray)):
+        raise cloud_exceptions.InvalidStructuredJSON(
+            "Expected json of type (str, bytes, bytearray), "
+            f"but instead found {type(data)}. "
+        )
+
+    headers = {key.lower(): value for key, value in headers.items()}
     if data_unmarshaller is None:
         data_unmarshaller = _json_or_string
 
@@ -32,19 +44,25 @@ def from_http(
     if is_binary(headers):
         specversion = headers.get("ce-specversion", None)
     else:
-        raw_ce = json.loads(data)
+        try:
+            raw_ce = json.loads(data)
+        except json.decoder.JSONDecodeError:
+            raise cloud_exceptions.InvalidStructuredJSON(
+                "Failed to read fields from structured event. "
+                f"The following can not be parsed as json: {data}. "
+            )
         specversion = raw_ce.get("specversion", None)
 
     if specversion is None:
-        raise cloud_exceptions.CloudEventMissingRequiredFields(
-            "could not find specversion in HTTP request"
+        raise cloud_exceptions.MissingRequiredFields(
+            "Failed to find specversion in HTTP request. "
         )
 
     event_handler = _obj_by_version.get(specversion, None)
 
     if event_handler is None:
-        raise cloud_exceptions.CloudEventTypeErrorRequiredFields(
-            f"found invalid specversion {specversion}"
+        raise cloud_exceptions.InvalidRequiredFields(
+            f"Found invalid specversion {specversion}. "
         )
 
     event = marshall.FromRequest(
@@ -77,8 +95,8 @@ def _to_http(
         data_marshaller = _marshaller_by_format[format]
 
     if event._attributes["specversion"] not in _obj_by_version:
-        raise cloud_exceptions.CloudEventTypeErrorRequiredFields(
-            f"Unsupported specversion: {event._attributes['specversion']}"
+        raise cloud_exceptions.InvalidRequiredFields(
+            f"Unsupported specversion: {event._attributes['specversion']}. "
         )
 
     event_handler = _obj_by_version[event._attributes["specversion"]]()
@@ -91,11 +109,13 @@ def _to_http(
     )
 
 
-def to_structured_http(
+def to_structured(
     event: CloudEvent, data_marshaller: types.MarshallerType = None,
 ) -> (dict, typing.Union[bytes, str]):
     """
-    Returns a tuple of HTTP headers/body dicts representing this cloudevent
+    Returns a tuple of HTTP headers/body dicts representing this cloudevent. If
+    event.data is a byte object, body will have a data_base64 field instead of
+    data.
 
     :param event: CloudEvent to cast into http data
     :type event: CloudEvent
@@ -107,7 +127,7 @@ def to_structured_http(
     return _to_http(event=event, data_marshaller=data_marshaller)
 
 
-def to_binary_http(
+def to_binary(
     event: CloudEvent, data_marshaller: types.MarshallerType = None,
 ) -> (dict, typing.Union[bytes, str]):
     """
@@ -125,3 +145,17 @@ def to_binary_http(
         format=converters.TypeBinary,
         data_marshaller=data_marshaller,
     )
+
+
+@deprecated(deprecated_in="1.0.2", details="Use to_binary function instead")
+def to_binary_http(
+    event: CloudEvent, data_marshaller: types.MarshallerType = None,
+) -> (dict, typing.Union[bytes, str]):
+    return to_binary(event, data_marshaller)
+
+
+@deprecated(deprecated_in="1.0.2", details="Use to_structured function instead")
+def to_structured_http(
+    event: CloudEvent, data_marshaller: types.MarshallerType = None,
+) -> (dict, typing.Union[bytes, str]):
+    return to_structured(event, data_marshaller)

cloudevents/http/json_methods.py

@@ -1,7 +1,7 @@
 import typing
 
 from cloudevents.http.event import CloudEvent
-from cloudevents.http.http_methods import from_http, to_structured_http
+from cloudevents.http.http_methods import from_http, to_structured
 from cloudevents.sdk import types
 
 
@@ -17,7 +17,7 @@ def to_json(
     :type data_marshaller: typing.Callable
     :returns: json object representing the given event
     """
-    return to_structured_http(event, data_marshaller=data_marshaller)[1]
+    return to_structured(event, data_marshaller=data_marshaller)[1]
 
 
 def from_json(
@@ -33,4 +33,4 @@ def from_json(
     :type data_unmarshaller: typing.Callable
     :returns: CloudEvent representing given cloudevent json object
     """
-    return from_http(data=data, headers={}, data_unmarshaller=data_unmarshaller)
+    return from_http(headers={}, data=data, data_unmarshaller=data_unmarshaller)

cloudevents/http/util.py

@@ -12,7 +12,7 @@ def default_marshaller(content: any):
 
 
 def _json_or_string(content: typing.Union[str, bytes]):
-    if len(content) == 0:
+    if content is None or len(content) == 0:
         return None
     try:
         return json.loads(content)

cloudevents/sdk/event/base.py

@@ -22,7 +22,7 @@
 # TODO(slinkydeveloper) is this really needed?
 
 
-class EventGetterSetter(object):
+class EventGetterSetter(object):  # pragma: no cover
 
     # ce-specversion
     def CloudEventVersion(self) -> str:
@@ -220,7 +220,7 @@ def UnmarshalJSON(
 
         missing_fields = self._ce_required_fields - raw_ce.keys()
         if len(missing_fields) > 0:
-            raise cloud_exceptions.CloudEventMissingRequiredFields(
+            raise cloud_exceptions.MissingRequiredFields(
                 f"Missing required attributes: {missing_fields}"
             )
 
@@ -246,7 +246,7 @@ def UnmarshalBinary(
         missing_fields = required_binary_fields - headers.keys()
 
         if len(missing_fields) > 0:
-            raise cloud_exceptions.CloudEventMissingRequiredFields(
+            raise cloud_exceptions.MissingRequiredFields(
                 f"Missing required attributes: {missing_fields}"
             )