swapped args for from_http (cloudevents#110)

cumason123 · web-flow · commit be802470da9e · 2020-08-17T17:38:35.000-04:00
Signed-off-by: Curtis Mason &lt;cumason@bu.edu&gt;
diff --git a/README.md b/README.md
@@ -81,7 +81,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(
diff --git a/cloudevents/http/http_methods.py b/cloudevents/http/http_methods.py
@@ -12,16 +12,16 @@
 
 
 def from_http(
-    data: typing.Union[str, bytes, None],
     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
diff --git a/cloudevents/http/json_methods.py b/cloudevents/http/json_methods.py
@@ -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)
diff --git a/cloudevents/tests/test_event_extensions.py b/cloudevents/tests/test_event_extensions.py
@@ -51,7 +51,7 @@ def test_from_binary_extensions(specversion):
         "ce-ext2": "test2",
     }
     body = json.dumps({"data-key": "val"})
-    event = from_http(body, headers)
+    event = from_http(headers, body)
 
     assert headers["ce-ext1"] == event["ext1"]
     assert headers["ce-ext2"] == event["ext2"]
@@ -81,7 +81,7 @@ def test_from_structured_extensions(specversion):
     }
 
     data = json.dumps(body)
-    event = from_http(data, headers)
+    event = from_http(headers, data)
 
     assert body["ext1"] == event["ext1"]
     assert body["ext2"] == event["ext2"]
diff --git a/cloudevents/tests/test_http_events.py b/cloudevents/tests/test_http_events.py
@@ -78,7 +78,7 @@ async def echo(request):
     if "binary-payload" in request.headers:
         decoder = lambda x: x
     event = from_http(
-        request.body, headers=dict(request.headers), data_unmarshaller=decoder
+        dict(request.headers), request.body, data_unmarshaller=decoder
     )
     data = (
         event.data
@@ -96,8 +96,7 @@ def test_missing_required_fields_structured(body):
         # implemented. In this instance one of the required keys should have
         # prefix e-id instead of ce-id therefore it should throw
         _ = from_http(
-            json.dumps(body),
-            headers={"Content-Type": "application/cloudevents+json"},
+            {"Content-Type": "application/cloudevents+json"}, json.dumps(body),
         )
 
 
@@ -108,7 +107,7 @@ def test_missing_required_fields_binary(headers):
         # and NotImplementedError because structured calls aren't
         # implemented. In this instance one of the required keys should have
         # prefix e-id instead of ce-id therefore it should throw
-        _ = from_http(json.dumps(test_data), headers=headers)
+        _ = from_http(headers, json.dumps(test_data))
 
 
 @pytest.mark.parametrize("specversion", ["1.0", "0.3"])
@@ -208,7 +207,7 @@ def test_missing_ce_prefix_binary_event(specversion):
             # and NotImplementedError because structured calls aren't
             # implemented. In this instance one of the required keys should have
             # prefix e-id instead of ce-id therefore it should throw
-            _ = from_http(json.dumps(test_data), headers=prefixed_headers)
+            _ = from_http(prefixed_headers, json.dumps(test_data))
 
 
 @pytest.mark.parametrize("specversion", ["1.0", "0.3"])
@@ -225,7 +224,7 @@ def test_valid_binary_events(specversion):
             "ce-specversion": specversion,
         }
         data = {"payload": f"payload-{i}"}
-        events_queue.append(from_http(json.dumps(data), headers=headers))
+        events_queue.append(from_http(headers, json.dumps(data)))
 
     for i, event in enumerate(events_queue):
         data = event.data
@@ -288,7 +287,7 @@ def test_empty_data_structured_event(specversion):
     }
 
     _ = from_http(
-        json.dumps(attributes), {"content-type": "application/cloudevents+json"}
+        {"content-type": "application/cloudevents+json"}, json.dumps(attributes)
     )
 
 
@@ -303,7 +302,7 @@ def test_empty_data_binary_event(specversion):
         "ce-time": "2018-10-23T12:28:22.4579346Z",
         "ce-source": "<source-url>",
     }
-    _ = from_http("", headers)
+    _ = from_http(headers, "")
 
 
 @pytest.mark.parametrize("specversion", ["1.0", "0.3"])
@@ -321,8 +320,8 @@ def test_valid_structured_events(specversion):
         }
         events_queue.append(
             from_http(
-                json.dumps(event),
                 {"content-type": "application/cloudevents+json"},
+                json.dumps(event),
             )
         )
 
@@ -343,7 +342,7 @@ def test_structured_no_content_type(specversion):
         "specversion": specversion,
         "data": test_data,
     }
-    event = from_http(json.dumps(data), {},)
+    event = from_http({}, json.dumps(data))
 
     assert event["id"] == "id"
     assert event["source"] == "source.com.test"
@@ -381,7 +380,7 @@ def test_cloudevent_repr(specversion):
         "ce-time": "2018-10-23T12:28:22.4579346Z",
         "ce-source": "<source-url>",
     }
-    event = from_http("", headers)
+    event = from_http(headers, "")
     # Testing to make sure event is printable. I could runevent. __repr__() but
     # we had issues in the past where event.__repr__() could run but
     # print(event) would fail.
@@ -412,15 +411,15 @@ def test_wrong_specversion():
         }
     )
     with pytest.raises(cloud_exceptions.CloudEventTypeErrorRequiredFields) as e:
-        from_http(data, headers)
+        from_http(headers, data)
     assert "Found invalid specversion 0.2" in str(e.value)
 
 
 def test_invalid_data_format_structured_from_http():
     headers = {"Content-Type": "application/cloudevents+json"}
     data = 20
     with pytest.raises(cloud_exceptions.InvalidStructuredJSON) as e:
-        from_http(data, headers)
+        from_http(headers, data)
     assert "Expected json of type (str, bytes, bytearray)" in str(e.value)
 
 
@@ -452,7 +451,9 @@ def test_empty_json_structured():
     headers = {"Content-Type": "application/cloudevents+json"}
     data = ""
     with pytest.raises(cloud_exceptions.InvalidStructuredJSON) as e:
-        from_http(data, headers)
+        from_http(
+            headers, data,
+        )
     assert "Failed to read fields from structured event. " in str(e.value)
 
 
@@ -463,7 +464,7 @@ def test_uppercase_headers_with_none_data_binary():
         "Ce-Type": "cloudevent.event.type",
         "Ce-Specversion": "1.0",
     }
-    event = from_http(None, headers)
+    event = from_http(headers, None)
 
     for key in headers:
         assert event[key.lower()[3:]] == headers[key]
diff --git a/samples/http-image-cloudevents/image_sample_server.py b/samples/http-image-cloudevents/image_sample_server.py
@@ -26,8 +26,8 @@ def home():
     # Create a CloudEvent.
     # data_unmarshaller will cast event.data into an io.BytesIO object
     event = from_http(
-        request.get_data(),
         request.headers,
+        request.get_data(),
         data_unmarshaller=lambda x: io.BytesIO(x),
     )
 
diff --git a/samples/http-image-cloudevents/image_sample_test.py b/samples/http-image-cloudevents/image_sample_test.py
@@ -34,7 +34,7 @@ def test_create_binary_image():
 
     # Unmarshall CloudEvent and re-create image
     reconstruct_event = from_http(
-        body, headers, data_unmarshaller=lambda x: io.BytesIO(x)
+        headers, body, data_unmarshaller=lambda x: io.BytesIO(x)
     )
 
     # reconstruct_event.data is an io.BytesIO object due to data_unmarshaller
@@ -70,7 +70,7 @@ def test_create_structured_image():
 
     # Unmarshall CloudEvent and re-create image
     reconstruct_event = from_http(
-        body, headers, data_unmarshaller=lambda x: io.BytesIO(x)
+        headers, body, data_unmarshaller=lambda x: io.BytesIO(x)
     )
 
     # reconstruct_event.data is an io.BytesIO object due to data_unmarshaller
diff --git a/samples/http-json-cloudevents/json_sample_server.py b/samples/http-json-cloudevents/json_sample_server.py
@@ -22,7 +22,7 @@
 @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(

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ def test_from_binary_extensions(specversion):`
`51`	`51`	`"ce-ext2": "test2",`
`52`	`52`	`}`
`53`	`53`	`body = json.dumps({"data-key": "val"})`
`54`		`- event = from_http(body, headers)`
	`54`	`+ event = from_http(headers, body)`
`55`	`55`
`56`	`56`	`assert headers["ce-ext1"] == event["ext1"]`
`57`	`57`	`assert headers["ce-ext2"] == event["ext2"]`
`@@ -81,7 +81,7 @@ def test_from_structured_extensions(specversion):`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`data = json.dumps(body)`
`84`		`- event = from_http(data, headers)`
	`84`	`+ event = from_http(headers, data)`
`85`	`85`
`86`	`86`	`assert body["ext1"] == event["ext1"]`
`87`	`87`	`assert body["ext2"] == event["ext2"]`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@ def home():`
`26`	`26`	`# Create a CloudEvent.`
`27`	`27`	`# data_unmarshaller will cast event.data into an io.BytesIO object`
`28`	`28`	`event = from_http(`
`29`		`- request.get_data(),`
`30`	`29`	`request.headers,`
	`30`	`+ request.get_data(),`
`31`	`31`	`data_unmarshaller=lambda x: io.BytesIO(x),`
`32`	`32`	`)`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ def test_create_binary_image():`
`34`	`34`
`35`	`35`	`# Unmarshall CloudEvent and re-create image`
`36`	`36`	`reconstruct_event = from_http(`
`37`		`- body, headers, data_unmarshaller=lambda x: io.BytesIO(x)`
	`37`	`+ headers, body, data_unmarshaller=lambda x: io.BytesIO(x)`
`38`	`38`	`)`
`39`	`39`
`40`	`40`	`# reconstruct_event.data is an io.BytesIO object due to data_unmarshaller`
`@@ -70,7 +70,7 @@ def test_create_structured_image():`
`70`	`70`
`71`	`71`	`# Unmarshall CloudEvent and re-create image`
`72`	`72`	`reconstruct_event = from_http(`
`73`		`- body, headers, data_unmarshaller=lambda x: io.BytesIO(x)`
	`73`	`+ headers, body, data_unmarshaller=lambda x: io.BytesIO(x)`
`74`	`74`	`)`
`75`	`75`
`76`	`76`	`# reconstruct_event.data is an io.BytesIO object due to data_unmarshaller`