cloud_events 0.1.2 → 0.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +41 -0
- data/LICENSE.md +189 -190
- data/README.md +26 -33
- data/lib/cloud_events.rb +1 -0
- data/lib/cloud_events/content_type.rb +22 -5
- data/lib/cloud_events/errors.rb +37 -5
- data/lib/cloud_events/event.rb +6 -1
- data/lib/cloud_events/event/field_interpreter.rb +25 -27
- data/lib/cloud_events/event/opaque.rb +80 -0
- data/lib/cloud_events/event/utils.rb +51 -0
- data/lib/cloud_events/event/v0.rb +22 -9
- data/lib/cloud_events/event/v1.rb +21 -8
- data/lib/cloud_events/format.rb +202 -0
- data/lib/cloud_events/http_binding.rb +319 -145
- data/lib/cloud_events/json_format.rb +162 -52
- data/lib/cloud_events/version.rb +1 -1
- metadata +9 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d44f430fb349c68608ecb791c8e0727c7c6cef018022a4f28c6dcb140b201d48
|
|
4
|
+
data.tar.gz: d4f1755b09f71fe1817d227666762c642de19172062a7fbdc29ec2a837a7b31e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c0f36a2c0cf43efafbda5b94a7392e5c52ff7974df002d0051013a4db1bd809d62721499c2f0c5f1712907f72dbbea6e2280532d1ac275a0aa33e96e4094eb19
|
|
7
|
+
data.tar.gz: c18abd09d34d4e7f51ac2f327d10ae99ab7541ee2f13afa2df46c67424e40bc2e99521f64341436858c686261cdab315945173940cd467fa55bc49ead4590096
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,46 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
### v0.5.1 / 2021-06-28
|
|
4
|
+
|
|
5
|
+
* ADDED: Add HttpBinding#probable_event?
|
|
6
|
+
* FIXED: Fixed a NoMethodError when a format declined to decode an http request
|
|
7
|
+
|
|
8
|
+
### v0.5.0 / 2021-06-28
|
|
9
|
+
|
|
10
|
+
This is a significant update that provides several important spec-related and usability fixes. Some of the behavioral changes are breaking, so to preserve compatibility, new methods were added and old methods deprecated, particularly in the HttpBinding class. Additionally, the formatter interface has been simplified and expanded to support payload formatting.
|
|
11
|
+
|
|
12
|
+
* CHANGED: Deprecated HttpBinding#decode_rack_env and replaced with HttpBinding#decode_event. (The old method remains for backward compatibility, but will be removed in version 1.0). The new decode_event method has the following differences:
|
|
13
|
+
* decode_event raises NotCloudEventError (rather than returning nil) if given an HTTP request that does not seem to have been intended as a CloudEvent.
|
|
14
|
+
* decode_event takes an allow_opaque argument that, when set to true, returns a CloudEvents::Event::Opaque (rather than raising an exception) if given a structured event with a format not known by the SDK. Opaque event objects cannot have their fields inspected, but can be reserialized for retransmission to another event handler.
|
|
15
|
+
* decode_event in binary content mode now parses JSON content-types and exposes the data attribute as a JSON value.
|
|
16
|
+
* CHANGED: Deprecated the HttpBinding encoding entrypoints (encode_structured_content, encode_batched_content, and encode_binary_content) and replaced with a single encode_event entrypoint that handles all cases via the structured_format argument. (The old methods remain for backward compatibility, but will be removed in version 1.0). In addition, the new encode_event method has the following differences:
|
|
17
|
+
* encode_event in binary content mode now interprets a string-valued data attribute as a JSON string and serializes it (i.e. wraps it in quotes) if the data_content_type has a JSON format. This is for compatibility with the behavior of the JSON structured mode which always treats the data attribute as a JSON value if the data_content_type indicates JSON.
|
|
18
|
+
* CHANGED: The JsonFormat class interface was reworked to be more generic, combine the structured and batched calls, and add calls to handle data payloads. A Format module has been added to specify the interface used by JsonFormat and future formatters. (Breaking change of internal interfaces)
|
|
19
|
+
* CHANGED: Renamed HttpContentError to UnsupportedFormatError to better reflect the specific issue being reported, and to eliminate the coupling to http. The old name remains aliased to the new name, but is deprecated and will be removed in version 1.0.
|
|
20
|
+
* CHANGED: If format-driven parsing (e.g. parsing a JSON document) fails, a FormatSyntaxError will be raised instead of, for example, a JSON-specific error. The lower-level parser error can still be accessed from the exception's "cause".
|
|
21
|
+
* FIXED: JsonFormat now sets the datacontenttype attribute explicitly to "application/json" if it isn't otherwise set.
|
|
22
|
+
|
|
23
|
+
### v0.4.0 / 2021-05-26
|
|
24
|
+
|
|
25
|
+
* ADDED: ContentType can take an optional default charset
|
|
26
|
+
* FIXED: Binary HTTP format parses quoted tokens according to RFC 7230 section 3.2.6
|
|
27
|
+
* FIXED: When encoding structured events for HTTP transport, the content-type now includes the charset
|
|
28
|
+
|
|
29
|
+
### v0.3.1 / 2021-04-25
|
|
30
|
+
|
|
31
|
+
* FIXED: Fixed exception when decoding from a rack source that uses InputWrapper
|
|
32
|
+
* FIXED: Fixed equality checking for V0 events
|
|
33
|
+
|
|
34
|
+
### v0.3.0 / 2021-03-02
|
|
35
|
+
|
|
36
|
+
* ADDED: Require Ruby 2.5 or later
|
|
37
|
+
* FIXED: Deep-duplicated event attributes in to_h to avoid returning frozen objects
|
|
38
|
+
|
|
39
|
+
### v0.2.0 / 2021-01-25
|
|
40
|
+
|
|
41
|
+
* ADDED: Freeze event objects to make them Ractor-shareable
|
|
42
|
+
* DOCS: Fix formatting of Apache license
|
|
43
|
+
|
|
3
44
|
### v0.1.2 / 2020-09-02
|
|
4
45
|
|
|
5
46
|
* Fix: Convert extension attributes to strings, and ignore nils
|
data/LICENSE.md
CHANGED
|
@@ -1,192 +1,191 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
the
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
identification within third-party archives.
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
190
189
|
|
|
191
190
|
Copyright [yyyy] [name of copyright owner]
|
|
192
191
|
|
|
@@ -194,7 +193,7 @@ identification within third-party archives.
|
|
|
194
193
|
you may not use this file except in compliance with the License.
|
|
195
194
|
You may obtain a copy of the License at
|
|
196
195
|
|
|
197
|
-
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
197
|
|
|
199
198
|
Unless required by applicable law or agreed to in writing, software
|
|
200
199
|
distributed under the License is distributed on an "AS IS" BASIS,
|
data/README.md
CHANGED
|
@@ -13,11 +13,11 @@ Features:
|
|
|
13
13
|
JSON Batch Format.
|
|
14
14
|
* Support for sending and receiving CloudEvents via HTTP Bindings.
|
|
15
15
|
* Supports the [CloudEvent 0.3](https://github.com/cloudevents/spec/tree/v0.3)
|
|
16
|
-
and [CloudEvents 1.0](https://github.com/cloudevents/spec/tree/v1.0)
|
|
16
|
+
and [CloudEvents 1.0](https://github.com/cloudevents/spec/tree/v1.0.1)
|
|
17
17
|
specifications.
|
|
18
18
|
* Extensible to additional formats and protocol bindings, and future
|
|
19
19
|
specification versions.
|
|
20
|
-
* Compatible with Ruby 2.
|
|
20
|
+
* Compatible with Ruby 2.5 or later, or JRuby 9.2.x or later. No runtime gem
|
|
21
21
|
dependencies.
|
|
22
22
|
|
|
23
23
|
## Quickstart
|
|
@@ -35,7 +35,7 @@ A simple [Sinatra](https://sinatrarb.com) app that receives CloudEvents:
|
|
|
35
35
|
```ruby
|
|
36
36
|
# examples/server/Gemfile
|
|
37
37
|
source "https://rubygems.org"
|
|
38
|
-
gem "cloud_events", "~> 0.
|
|
38
|
+
gem "cloud_events", "~> 0.5"
|
|
39
39
|
gem "sinatra", "~> 2.0"
|
|
40
40
|
```
|
|
41
41
|
|
|
@@ -59,7 +59,7 @@ A simple Ruby script that sends a CloudEvent:
|
|
|
59
59
|
```ruby
|
|
60
60
|
# examples/client/Gemfile
|
|
61
61
|
source "https://rubygems.org"
|
|
62
|
-
gem "cloud_events", "~> 0.
|
|
62
|
+
gem "cloud_events", "~> 0.5"
|
|
63
63
|
```
|
|
64
64
|
|
|
65
65
|
```ruby
|
|
@@ -69,14 +69,16 @@ require "net/http"
|
|
|
69
69
|
require "uri"
|
|
70
70
|
|
|
71
71
|
data = { message: "Hello, CloudEvents!" }
|
|
72
|
-
event = CloudEvents::Event.create
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
72
|
+
event = CloudEvents::Event.create \
|
|
73
|
+
spec_version: "1.0",
|
|
74
|
+
id: "1234-1234-1234",
|
|
75
|
+
source: "/mycontext",
|
|
76
|
+
type: "com.example.someevent",
|
|
77
|
+
data_content_type: "application/json",
|
|
78
|
+
data: data
|
|
77
79
|
|
|
78
80
|
cloud_events_http = CloudEvents::HttpBinding.default
|
|
79
|
-
headers, body = cloud_events_http.
|
|
81
|
+
headers, body = cloud_events_http.encode_event event
|
|
80
82
|
Net::HTTP.post URI("http://localhost:4567"), body, headers
|
|
81
83
|
```
|
|
82
84
|
|
|
@@ -188,33 +190,24 @@ Releases can be performed only by users with write access to the repository.
|
|
|
188
190
|
|
|
189
191
|
To perform a release:
|
|
190
192
|
|
|
191
|
-
1.
|
|
193
|
+
1. Go to the GitHub Actions tab, and launch the "Request Release" workflow.
|
|
194
|
+
You can leave the input field blank.
|
|
192
195
|
|
|
193
|
-
2.
|
|
194
|
-
|
|
195
|
-
|
|
196
|
+
2. The workflow will analyze the commit messages since the last release, and
|
|
197
|
+
open a pull request with a new version and a changelog entry. You can
|
|
198
|
+
optionally edit this pull request to modify the changelog or change the
|
|
199
|
+
version released.
|
|
196
200
|
|
|
197
|
-
3.
|
|
198
|
-
|
|
201
|
+
3. Merge the pull request (keeping the `release: pending` label set.) Once the
|
|
202
|
+
CI tests have run successfully, a job will run automatically to perform the
|
|
203
|
+
release, including tagging the commit in git, building and releasing a gem,
|
|
204
|
+
and building and pushing documentation.
|
|
199
205
|
|
|
200
|
-
|
|
206
|
+
These tasks can also be performed manually by running the appropriate scripts
|
|
207
|
+
locally. See `toys release request --help` and `toys release perform --help`
|
|
208
|
+
for more information.
|
|
201
209
|
|
|
202
|
-
|
|
203
|
-
toys release trigger $VERSION
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
where `$VERSION` is the version number (e.g. `0.1.0`). This script will
|
|
207
|
-
verify the version and changelog and will not proceed unless they are
|
|
208
|
-
correctly formatted and the master branch is up to date. It will also check
|
|
209
|
-
that all GitHub checks against the current commit have succeeded. If these
|
|
210
|
-
checks pass, the script will create and push a release tag.
|
|
211
|
-
|
|
212
|
-
5. A GitHub action will then perform the release within a few minutes. The
|
|
213
|
-
[GitHub actions dashboard](https://github.com/cloudevents/sdk-ruby/actions?query=workflow%3A%22CloudEvents+Release%22)
|
|
214
|
-
will provide status information on the release workflow.
|
|
215
|
-
|
|
216
|
-
If the release workflow fails, fix the problem, and then you will need to
|
|
217
|
-
delete the release tag manually before triggering the release again.
|
|
210
|
+
If a release fails, you may need to delete the release tag before retrying.
|
|
218
211
|
|
|
219
212
|
### For more information
|
|
220
213
|
|