Skip to content

Commit 763838c

Browse files
authored
chore: Update examples to use latest sdk changes (#282)
* This updates all the examples to use the latest module version(3.0.0) Signed-off-by: Lucas Holmquist <[email protected]>
1 parent 3fab5f2 commit 763838c

File tree

14 files changed

+37
-27
lines changed

14 files changed

+37
-27
lines changed

examples/express-ex/README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ curl -X POST \
6767
-H'ce-source:https://github.com/cloudevents/spec/pull/123' \
6868
-H'ce-id:45c83279-c8a1-4db6-a703-b3768db93887' \
6969
-H'ce-time:2019-11-06T11:17:00Z' \
70-
-H'ce-my-extension:extension value' \
70+
-H'ce-myextension:extension value' \
7171
http://localhost:3000/
7272
```
7373

@@ -110,6 +110,17 @@ curl -X POST \
110110
http://localhost:3000/
111111
```
112112

113+
__A Structured One with Base64 Event Data__
114+
115+
> Payload [example](../payload/v03/structured-event-2.json)
116+
117+
```bash
118+
curl -X POST \
119+
-d'@../payload/v03/structured-event-2.json' \
120+
-H'Content-Type:application/cloudevents+json' \
121+
http://localhost:3000/
122+
```
123+
113124
__A Binary One__
114125

115126
```bash
@@ -135,7 +146,7 @@ curl -X POST \
135146
-H'ce-source:https://github.com/cloudevents/spec/pull/123' \
136147
-H'ce-id:45c83279-c8a1-4db6-a703-b3768db93887' \
137148
-H'ce-time:2019-06-21T17:31:00Z' \
138-
-H'ce-my-extension:extension value' \
149+
-H'ce-myextension:extension value' \
139150
http://localhost:3000/
140151
```
141152

examples/express-ex/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/* eslint-disable no-console */
22

33
const express = require("express");
4-
const { Receiver } = require("cloudevents-sdk");
4+
const { Receiver } = require("cloudevents");
55

66
const app = express();
77
const receiver = new Receiver();
@@ -25,7 +25,7 @@ app.post("/", function (req, res) {
2525
console.log("BODY", req.body);
2626

2727
try {
28-
const event = receiver.accept(req.headers, req.body);
28+
const event = Receiver.accept(req.headers, req.body);
2929
console.log(`Accepted event: ${event}`);
3030
res.status(201).json(event);
3131
} catch (err) {

examples/express-ex/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"author": "[email protected]",
1515
"license": "Apache-2.0",
1616
"dependencies": {
17-
"cloudevents-sdk": "~2.0.2",
17+
"cloudevents": "~3.0.0",
1818
"express": "^4.17.1"
1919
}
2020
}

examples/payload/v03/structured-event-1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"data":{
99
"much":"wow"
1010
},
11-
"my-extension" : {
11+
"myextension" : {
1212
"some" : "thing"
1313
}
1414
}

examples/payload/v03/structured-event-2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"datacontenttype":"application/json",
88
"datacontentencoding":"base64",
99
"data":"eyJtdWNoIjoid293In0=",
10-
"my-extension" : {
10+
"myextension" : {
1111
"some" : "thing"
1212
}
1313
}

examples/payload/v1/structured-event-1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
"data":{
99
"much":"wow"
1010
},
11-
"my-extension" : "something"
11+
"myextension" : "something"
1212
}

examples/payload/v1/structured-event-2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
"time":"2019-11-06T11:08:00Z",
77
"datacontenttype":"application/json",
88
"data_base64":"eyJtdWNoIjoid293In0=",
9-
"my-extension" : "something"
9+
"myextension" : "something"
1010
}

examples/typescript-ex/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@
2424
},
2525
"devDependencies": {
2626
"@types/node": "^8.9.0",
27-
"cloudevents-sdk": "~2.0.2",
2827
"gts": "^1.1.0",
2928
"typescript": "~3.9.5"
29+
},
30+
"dependencies": {
31+
"cloudevents": "~3.0.1"
3032
}
3133
}

examples/typescript-ex/src/index.ts

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
import { CloudEvent, CloudEventV1, Receiver } from "cloudevents-sdk";
2-
3-
export function doSomeStuff() {
4-
const receiver = new Receiver();
1+
import { CloudEvent, CloudEventV1, Receiver } from "cloudevents";
52

3+
export function doSomeStuff(): void {
64
const myevent: CloudEventV1 = new CloudEvent({
75
source: "/source",
86
type: "type",
97
datacontenttype: "text/plain",
108
dataschema: "https://d.schema.com/my.json",
119
subject: "cha.json",
1210
data: "my-data",
11+
extension1: "some extension data"
1312
});
14-
myevent.extension1 = "some extension data";
1513

1614
console.log("My structured event:", myevent);
1715

@@ -23,7 +21,7 @@ export function doSomeStuff() {
2321

2422
// Typically used with an incoming HTTP request where myevent.format() is the actual
2523
// body of the HTTP
26-
console.log("Received structured event:", receiver.accept(headers, myevent));
24+
console.log("Received structured event:", Receiver.accept(headers, myevent));
2725

2826
// ------ receiver binary
2927
const data = {
@@ -40,10 +38,9 @@ export function doSomeStuff() {
4038
"ce-extension1": "extension1",
4139
};
4240

43-
console.log("My binary event:", receiver.accept(attributes, data));
44-
console.log("My binary event extensions:", receiver.accept(attributes, data));
41+
console.log("My binary event:", Receiver.accept(attributes, data));
42+
console.log("My binary event extensions:", Receiver.accept(attributes, data));
4543

46-
return true;
4744
}
4845

4946
doSomeStuff();

examples/websocket/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ responds with a CloudEvent containing the body of the Weather API response as th
2424
event data.
2525

2626
You will need to change one line in the `server.js` file and provide your Open
27-
Weather API key.
27+
Weather API key. You can also create a environment variable `OPEN_WEATHER_API_KEY` and store your key there.
2828

2929
To start the server, run `node server.js`.
3030

0 commit comments

Comments
 (0)