cloud_events 0.1.1 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/LICENSE.md +189 -190
- data/README.md +29 -27
- data/lib/cloud_events/content_type.rb +21 -4
- data/lib/cloud_events/event.rb +5 -0
- data/lib/cloud_events/event/field_interpreter.rb +27 -27
- 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/http_binding.rb +54 -20
- data/lib/cloud_events/json_format.rb +3 -4
- data/lib/cloud_events/version.rb +1 -1
- metadata +7 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ae042efe6c2ccd066620bf2e4f548d6f0470fff3426e92442e5f403c8e06273a
|
|
4
|
+
data.tar.gz: f8d1fbbb00faa1d2b72db8c1e9ac016580951884e78cc6129eeec7fb8d844d5a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 06a156c8448d1c7b59ef683e90ecba1d22dfbe4564574a9355ee110c31f91240137295c437933ed6038fe8e1a9e9e5b19067ef82ee11affd38c6c2f41dac2b50
|
|
7
|
+
data.tar.gz: 9d8b7c3745261e6addd427b9b4d24b3873014f998f0f0844889315a6ea59ab3c11e44cbc25abfdffdb758357545c8c62eeca4f5d5138e6bd2179d700e1dd60c6
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
### v0.4.0 / 2021-05-26
|
|
4
|
+
|
|
5
|
+
* ADDED: ContentType can take an optional default charset
|
|
6
|
+
* FIXED: Binary HTTP format parses quoted tokens according to RFC 7230 section 3.2.6
|
|
7
|
+
* FIXED: When encoding structured events for HTTP transport, the content-type now includes the charset
|
|
8
|
+
|
|
9
|
+
### v0.3.1 / 2021-04-25
|
|
10
|
+
|
|
11
|
+
* FIXED: Fixed exception when decoding from a rack source that uses InputWrapper
|
|
12
|
+
* FIXED: Fixed equality checking for V0 events
|
|
13
|
+
|
|
14
|
+
### v0.3.0 / 2021-03-02
|
|
15
|
+
|
|
16
|
+
* ADDED: Require Ruby 2.5 or later
|
|
17
|
+
* FIXED: Deep-duplicated event attributes in to_h to avoid returning frozen objects
|
|
18
|
+
|
|
19
|
+
### v0.2.0 / 2021-01-25
|
|
20
|
+
|
|
21
|
+
* ADDED: Freeze event objects to make them Ractor-shareable
|
|
22
|
+
* DOCS: Fix formatting of Apache license
|
|
23
|
+
|
|
24
|
+
### v0.1.2 / 2020-09-02
|
|
25
|
+
|
|
26
|
+
* Fix: Convert extension attributes to strings, and ignore nils
|
|
27
|
+
* Documentation: Add code of conduct link to readme
|
|
28
|
+
|
|
3
29
|
### v0.1.1 / 2020-07-20
|
|
4
30
|
|
|
5
31
|
* Updated a few documentation links. No functional changes.
|
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
|
@@ -17,7 +17,7 @@ Features:
|
|
|
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.2"
|
|
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.2"
|
|
63
63
|
```
|
|
64
64
|
|
|
65
65
|
```ruby
|
|
@@ -106,7 +106,7 @@ Hit `CTRL+C` to stop the server.
|
|
|
106
106
|
|
|
107
107
|
## Contributing
|
|
108
108
|
|
|
109
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/cloudevents/ruby
|
|
109
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/cloudevents/sdk-ruby.
|
|
110
110
|
|
|
111
111
|
### Development
|
|
112
112
|
|
|
@@ -188,33 +188,24 @@ Releases can be performed only by users with write access to the repository.
|
|
|
188
188
|
|
|
189
189
|
To perform a release:
|
|
190
190
|
|
|
191
|
-
1.
|
|
191
|
+
1. Go to the GitHub Actions tab, and launch the "Request Release" workflow.
|
|
192
|
+
You can leave the input field blank.
|
|
192
193
|
|
|
193
|
-
2.
|
|
194
|
-
|
|
195
|
-
|
|
194
|
+
2. The workflow will analyze the commit messages since the last release, and
|
|
195
|
+
open a pull request with a new version and a changelog entry. You can
|
|
196
|
+
optionally edit this pull request to modify the changelog or change the
|
|
197
|
+
version released.
|
|
196
198
|
|
|
197
|
-
3.
|
|
198
|
-
|
|
199
|
+
3. Merge the pull request (keeping the `release: pending` label set.) Once the
|
|
200
|
+
CI tests have run successfully, a job will run automatically to perform the
|
|
201
|
+
release, including tagging the commit in git, building and releasing a gem,
|
|
202
|
+
and building and pushing documentation.
|
|
199
203
|
|
|
200
|
-
|
|
204
|
+
These tasks can also be performed manually by running the appropriate scripts
|
|
205
|
+
locally. See `toys release request --help` and `toys release perform --help`
|
|
206
|
+
for more information.
|
|
201
207
|
|
|
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.
|
|
208
|
+
If a release fails, you may need to delete the release tag before retrying.
|
|
218
209
|
|
|
219
210
|
### For more information
|
|
220
211
|
|
|
@@ -239,6 +230,17 @@ To perform a release:
|
|
|
239
230
|
|
|
240
231
|
* For additional information, contact Daniel Azuma (`@dazuma` on Slack).
|
|
241
232
|
|
|
233
|
+
Each SDK may have its own unique processes, tooling and guidelines, common
|
|
234
|
+
governance related material can be found in the
|
|
235
|
+
[CloudEvents `community`](https://github.com/cloudevents/spec/tree/master/community)
|
|
236
|
+
directory. In particular, in there you will find information concerning
|
|
237
|
+
how SDK projects are
|
|
238
|
+
[managed](https://github.com/cloudevents/spec/blob/master/community/SDK-GOVERNANCE.md),
|
|
239
|
+
[guidelines](https://github.com/cloudevents/spec/blob/master/community/SDK-maintainer-guidelines.md)
|
|
240
|
+
for how PR reviews and approval, and our
|
|
241
|
+
[Code of Conduct](https://github.com/cloudevents/spec/blob/master/community/GOVERNANCE.md#additional-information)
|
|
242
|
+
information.
|
|
243
|
+
|
|
242
244
|
## Licensing
|
|
243
245
|
|
|
244
246
|
Copyright 2020 Google LLC and the CloudEvents Ruby SDK Contributors
|
|
@@ -14,23 +14,28 @@ module CloudEvents
|
|
|
14
14
|
# can, and fill the rest with defaults as recommended in RFC 2045 sec 5.2.
|
|
15
15
|
# In case of a parsing error, the {#error_message} field will be set.
|
|
16
16
|
#
|
|
17
|
+
# This object is immutable, and Ractor-shareable on Ruby 3.
|
|
18
|
+
#
|
|
17
19
|
class ContentType
|
|
18
20
|
##
|
|
19
21
|
# Parse the given header value.
|
|
20
22
|
#
|
|
21
23
|
# @param string [String] Content-Type header value in RFC 2045 format
|
|
24
|
+
# @param default_charset [String] Optional. The charset to use if none is
|
|
25
|
+
# specified. Defaults to `us-ascii`.
|
|
22
26
|
#
|
|
23
|
-
def initialize string
|
|
27
|
+
def initialize string, default_charset: nil
|
|
24
28
|
@string = string
|
|
25
29
|
@media_type = "text"
|
|
26
30
|
@subtype_base = @subtype = "plain"
|
|
27
31
|
@subtype_format = nil
|
|
28
32
|
@params = []
|
|
29
|
-
@charset = "us-ascii"
|
|
33
|
+
@charset = default_charset || "us-ascii"
|
|
30
34
|
@error_message = nil
|
|
31
35
|
parse consume_comments string.strip
|
|
32
36
|
@canonical_string = "#{@media_type}/#{@subtype}" +
|
|
33
37
|
@params.map { |k, v| "; #{k}=#{maybe_quote v}" }.join
|
|
38
|
+
full_freeze
|
|
34
39
|
end
|
|
35
40
|
|
|
36
41
|
##
|
|
@@ -137,7 +142,7 @@ module CloudEvents
|
|
|
137
142
|
end
|
|
138
143
|
|
|
139
144
|
def consume_token str, downcase: false, error_message: nil
|
|
140
|
-
match = /^([\w
|
|
145
|
+
match = /^([\w!#$%&'*+.\^`{|}-]+)(.*)$/.match str
|
|
141
146
|
raise ParseError, error_message || "Expected token" unless match
|
|
142
147
|
token = match[1]
|
|
143
148
|
token.downcase! if downcase
|
|
@@ -200,9 +205,21 @@ module CloudEvents
|
|
|
200
205
|
end
|
|
201
206
|
|
|
202
207
|
def maybe_quote str
|
|
203
|
-
return str if /^[\w
|
|
208
|
+
return str if /^[\w!#$%&'*+.\^`{|}-]+$/ =~ str
|
|
204
209
|
str = str.gsub("\\", "\\\\\\\\").gsub("\"", "\\\\\"")
|
|
205
210
|
"\"#{str}\""
|
|
206
211
|
end
|
|
212
|
+
|
|
213
|
+
def full_freeze
|
|
214
|
+
instance_variables.each do |iv|
|
|
215
|
+
instance_variable_get(iv).freeze
|
|
216
|
+
end
|
|
217
|
+
@params.each do |name_val|
|
|
218
|
+
name_val[0].freeze
|
|
219
|
+
name_val[1].freeze
|
|
220
|
+
name_val.freeze
|
|
221
|
+
end
|
|
222
|
+
freeze
|
|
223
|
+
end
|
|
207
224
|
end
|
|
208
225
|
end
|
data/lib/cloud_events/event.rb
CHANGED
|
@@ -50,6 +50,11 @@ module CloudEvents
|
|
|
50
50
|
# `spec_version`, the remaining keyword arguments will be passed
|
|
51
51
|
# through to the {CloudEvents::Event::V1} constructor.
|
|
52
52
|
#
|
|
53
|
+
# Note that argument objects passed in may get deep-frozen if they are
|
|
54
|
+
# used in the final event object. This is particularly important for the
|
|
55
|
+
# `:data` field, for example if you pass a structured hash. If this is an
|
|
56
|
+
# issue, make a deep copy of objects before passing them to this method.
|
|
57
|
+
#
|
|
53
58
|
# @param spec_version [String] The required `specversion` field.
|
|
54
59
|
# @param kwargs [keywords] Additional parameters for the event.
|
|
55
60
|
#
|
|
@@ -1,22 +1,25 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require "cloud_events/event/utils"
|
|
4
|
+
|
|
3
5
|
module CloudEvents
|
|
4
6
|
module Event
|
|
5
7
|
##
|
|
6
8
|
# A helper that extracts and interprets event fields from an input hash.
|
|
7
|
-
#
|
|
8
9
|
# @private
|
|
9
10
|
#
|
|
10
11
|
class FieldInterpreter
|
|
11
12
|
def initialize args
|
|
12
|
-
@args = keys_to_strings args
|
|
13
|
+
@args = Utils.keys_to_strings args
|
|
13
14
|
@attributes = {}
|
|
14
15
|
end
|
|
15
16
|
|
|
16
17
|
def finish_attributes
|
|
17
|
-
@
|
|
18
|
+
@args.each do |key, value|
|
|
19
|
+
@attributes[key.freeze] = value.to_s.freeze unless value.nil?
|
|
20
|
+
end
|
|
18
21
|
@args = {}
|
|
19
|
-
@attributes
|
|
22
|
+
@attributes.freeze
|
|
20
23
|
end
|
|
21
24
|
|
|
22
25
|
def string keys, required: false
|
|
@@ -24,6 +27,7 @@ module CloudEvents
|
|
|
24
27
|
case value
|
|
25
28
|
when ::String
|
|
26
29
|
raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
|
|
30
|
+
value.freeze
|
|
27
31
|
[value, value]
|
|
28
32
|
else
|
|
29
33
|
raise AttributeError, "Illegal type for #{keys.first}:" \
|
|
@@ -38,12 +42,12 @@ module CloudEvents
|
|
|
38
42
|
when ::String
|
|
39
43
|
raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
|
|
40
44
|
begin
|
|
41
|
-
[::URI.parse(value), value]
|
|
45
|
+
[Utils.deep_freeze(::URI.parse(value)), value.freeze]
|
|
42
46
|
rescue ::URI::InvalidURIError => e
|
|
43
47
|
raise AttributeError, "Illegal format for #{keys.first}: #{e.message}"
|
|
44
48
|
end
|
|
45
49
|
when ::URI::Generic
|
|
46
|
-
[value, value.to_s]
|
|
50
|
+
[Utils.deep_freeze(value), value.to_s.freeze]
|
|
47
51
|
else
|
|
48
52
|
raise AttributeError, "Illegal type for #{keys.first}:" \
|
|
49
53
|
" String or URI expected but #{value.class} found"
|
|
@@ -56,15 +60,15 @@ module CloudEvents
|
|
|
56
60
|
case value
|
|
57
61
|
when ::String
|
|
58
62
|
begin
|
|
59
|
-
[::DateTime.rfc3339(value), value]
|
|
63
|
+
[Utils.deep_freeze(::DateTime.rfc3339(value)), value.freeze]
|
|
60
64
|
rescue ::Date::Error => e
|
|
61
65
|
raise AttributeError, "Illegal format for #{keys.first}: #{e.message}"
|
|
62
66
|
end
|
|
63
67
|
when ::DateTime
|
|
64
|
-
[value, value.rfc3339]
|
|
68
|
+
[Utils.deep_freeze(value), value.rfc3339.freeze]
|
|
65
69
|
when ::Time
|
|
66
70
|
value = value.to_datetime
|
|
67
|
-
[value, value.rfc3339]
|
|
71
|
+
[Utils.deep_freeze(value), value.rfc3339.freeze]
|
|
68
72
|
else
|
|
69
73
|
raise AttributeError, "Illegal type for #{keys.first}:" \
|
|
70
74
|
" String, Time, or DateTime expected but #{value.class} found"
|
|
@@ -77,7 +81,7 @@ module CloudEvents
|
|
|
77
81
|
case value
|
|
78
82
|
when ::String
|
|
79
83
|
raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
|
|
80
|
-
[ContentType.new(value), value]
|
|
84
|
+
[ContentType.new(value), value.freeze]
|
|
81
85
|
when ContentType
|
|
82
86
|
[value, value.to_s]
|
|
83
87
|
else
|
|
@@ -92,6 +96,7 @@ module CloudEvents
|
|
|
92
96
|
case value
|
|
93
97
|
when ::String
|
|
94
98
|
raise SpecVersionError, "Unrecognized specversion: #{value}" unless accept =~ value
|
|
99
|
+
value.freeze
|
|
95
100
|
[value, value]
|
|
96
101
|
else
|
|
97
102
|
raise AttributeError, "Illegal type for #{keys.first}:" \
|
|
@@ -100,7 +105,16 @@ module CloudEvents
|
|
|
100
105
|
end
|
|
101
106
|
end
|
|
102
107
|
|
|
103
|
-
|
|
108
|
+
def data_object keys, required: false
|
|
109
|
+
object keys, required: required, allow_nil: true do |value|
|
|
110
|
+
Utils.deep_freeze value
|
|
111
|
+
[value, value]
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
UNDEFINED = ::Object.new.freeze
|
|
116
|
+
|
|
117
|
+
private
|
|
104
118
|
|
|
105
119
|
def object keys, required: false, allow_nil: false
|
|
106
120
|
value = UNDEFINED
|
|
@@ -113,24 +127,10 @@ module CloudEvents
|
|
|
113
127
|
raise AttributeError, "The #{keys.first} field is required" if required
|
|
114
128
|
return nil
|
|
115
129
|
end
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
else
|
|
119
|
-
converted = raw = value
|
|
120
|
-
end
|
|
121
|
-
@attributes[keys.first] = raw
|
|
130
|
+
converted, raw = yield value
|
|
131
|
+
@attributes[keys.first.freeze] = raw
|
|
122
132
|
converted
|
|
123
133
|
end
|
|
124
|
-
|
|
125
|
-
private
|
|
126
|
-
|
|
127
|
-
def keys_to_strings hash
|
|
128
|
-
result = {}
|
|
129
|
-
hash.each do |key, val|
|
|
130
|
-
result[key.to_s] = val
|
|
131
|
-
end
|
|
132
|
-
result
|
|
133
|
-
end
|
|
134
134
|
end
|
|
135
135
|
end
|
|
136
136
|
end
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module CloudEvents
|
|
4
|
+
module Event
|
|
5
|
+
##
|
|
6
|
+
# A variety of helper methods.
|
|
7
|
+
# @private
|
|
8
|
+
#
|
|
9
|
+
module Utils
|
|
10
|
+
class << self
|
|
11
|
+
def deep_freeze obj
|
|
12
|
+
case obj
|
|
13
|
+
when ::Hash
|
|
14
|
+
obj.each do |key, val|
|
|
15
|
+
deep_freeze key
|
|
16
|
+
deep_freeze val
|
|
17
|
+
end
|
|
18
|
+
when ::Array
|
|
19
|
+
obj.each do |val|
|
|
20
|
+
deep_freeze val
|
|
21
|
+
end
|
|
22
|
+
else
|
|
23
|
+
obj.instance_variables.each do |iv|
|
|
24
|
+
deep_freeze obj.instance_variable_get iv
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
obj.freeze
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
def deep_dup obj
|
|
31
|
+
case obj
|
|
32
|
+
when ::Hash
|
|
33
|
+
obj.each_with_object({}) { |(key, val), hash| hash[deep_dup key] = deep_dup val }
|
|
34
|
+
when ::Array
|
|
35
|
+
obj.map { |val| deep_dup val }
|
|
36
|
+
else
|
|
37
|
+
obj.dup
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def keys_to_strings hash
|
|
42
|
+
result = {}
|
|
43
|
+
hash.each do |key, val|
|
|
44
|
+
result[key.to_s] = val
|
|
45
|
+
end
|
|
46
|
+
result
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
@@ -3,6 +3,9 @@
|
|
|
3
3
|
require "date"
|
|
4
4
|
require "uri"
|
|
5
5
|
|
|
6
|
+
require "cloud_events/event/field_interpreter"
|
|
7
|
+
require "cloud_events/event/utils"
|
|
8
|
+
|
|
6
9
|
module CloudEvents
|
|
7
10
|
module Event
|
|
8
11
|
##
|
|
@@ -16,9 +19,10 @@ module CloudEvents
|
|
|
16
19
|
# their own accessor methods that may return typed objects (such as
|
|
17
20
|
# `DateTime` for the `time` attribute).
|
|
18
21
|
#
|
|
19
|
-
# This object is immutable. The data and
|
|
20
|
-
# retrieved but not modified. To obtain an event
|
|
21
|
-
# the {#with} method to create a copy with the
|
|
22
|
+
# This object is immutable, and Ractor-shareable on Ruby 3. The data and
|
|
23
|
+
# attribute values can be retrieved but not modified. To obtain an event
|
|
24
|
+
# with modifications, use the {#with} method to create a copy with the
|
|
25
|
+
# desired changes.
|
|
22
26
|
#
|
|
23
27
|
# See https://github.com/cloudevents/spec/blob/v0.3/spec.md for
|
|
24
28
|
# descriptions of the standard attributes.
|
|
@@ -42,7 +46,7 @@ module CloudEvents
|
|
|
42
46
|
# field.
|
|
43
47
|
# * **:type** [`String`] - _required_ - The event `type` field.
|
|
44
48
|
# * **:data** [`Object`] - _optional_ - The data associated with the
|
|
45
|
-
# event (i.e. the `data` field.
|
|
49
|
+
# event (i.e. the `data` field).
|
|
46
50
|
# * **:data_content_encoding** (or **:datacontentencoding**)
|
|
47
51
|
# [`String`] - _optional_ - The content-encoding for the data (i.e.
|
|
48
52
|
# the `datacontentencoding` field.)
|
|
@@ -59,6 +63,11 @@ module CloudEvents
|
|
|
59
63
|
# They are not available as separate methods, but can be accessed via
|
|
60
64
|
# the {Event::V1#[]} operator.
|
|
61
65
|
#
|
|
66
|
+
# Note that attribute objects passed in may get deep-frozen if they are
|
|
67
|
+
# used in the final event object. This is particularly important for the
|
|
68
|
+
# `:data` field, for example if you pass a structured hash. If this is an
|
|
69
|
+
# issue, make a deep copy of objects before passing to this constructor.
|
|
70
|
+
#
|
|
62
71
|
# @param attributes [Hash] The data and attributes, as a hash.
|
|
63
72
|
# @param args [keywords] The data and attributes, as keyword arguments.
|
|
64
73
|
#
|
|
@@ -68,13 +77,14 @@ module CloudEvents
|
|
|
68
77
|
@id = interpreter.string ["id"], required: true
|
|
69
78
|
@source = interpreter.uri ["source"], required: true
|
|
70
79
|
@type = interpreter.string ["type"], required: true
|
|
71
|
-
@data = interpreter.
|
|
80
|
+
@data = interpreter.data_object ["data"]
|
|
72
81
|
@data_content_encoding = interpreter.string ["datacontentencoding", "data_content_encoding"]
|
|
73
82
|
@data_content_type = interpreter.content_type ["datacontenttype", "data_content_type"]
|
|
74
83
|
@schema_url = interpreter.uri ["schemaurl", "schema_url"]
|
|
75
84
|
@subject = interpreter.string ["subject"]
|
|
76
85
|
@time = interpreter.rfc3339_date_time ["time"]
|
|
77
86
|
@attributes = interpreter.finish_attributes
|
|
87
|
+
freeze
|
|
78
88
|
end
|
|
79
89
|
|
|
80
90
|
##
|
|
@@ -105,6 +115,8 @@ module CloudEvents
|
|
|
105
115
|
# event["time"] # => String rfc3339 representation
|
|
106
116
|
# event.time # => DateTime object
|
|
107
117
|
#
|
|
118
|
+
# Results are also always frozen and cannot be modified in place.
|
|
119
|
+
#
|
|
108
120
|
# @param key [String,Symbol] The attribute name.
|
|
109
121
|
# @return [String,nil]
|
|
110
122
|
#
|
|
@@ -113,12 +125,13 @@ module CloudEvents
|
|
|
113
125
|
end
|
|
114
126
|
|
|
115
127
|
##
|
|
116
|
-
# Return a hash representation of this event.
|
|
128
|
+
# Return a hash representation of this event. The returned hash is an
|
|
129
|
+
# unfrozen deep copy. Modifications do not affect the original event.
|
|
117
130
|
#
|
|
118
131
|
# @return [Hash]
|
|
119
132
|
#
|
|
120
133
|
def to_h
|
|
121
|
-
@attributes
|
|
134
|
+
Utils.deep_dup @attributes
|
|
122
135
|
end
|
|
123
136
|
|
|
124
137
|
##
|
|
@@ -208,13 +221,13 @@ module CloudEvents
|
|
|
208
221
|
|
|
209
222
|
## @private
|
|
210
223
|
def == other
|
|
211
|
-
other.is_a?(
|
|
224
|
+
other.is_a?(V0) && @attributes == other.instance_variable_get(:@attributes)
|
|
212
225
|
end
|
|
213
226
|
alias eql? ==
|
|
214
227
|
|
|
215
228
|
## @private
|
|
216
229
|
def hash
|
|
217
|
-
@
|
|
230
|
+
@attributes.hash
|
|
218
231
|
end
|
|
219
232
|
end
|
|
220
233
|
end
|
|
@@ -3,6 +3,9 @@
|
|
|
3
3
|
require "date"
|
|
4
4
|
require "uri"
|
|
5
5
|
|
|
6
|
+
require "cloud_events/event/field_interpreter"
|
|
7
|
+
require "cloud_events/event/utils"
|
|
8
|
+
|
|
6
9
|
module CloudEvents
|
|
7
10
|
module Event
|
|
8
11
|
##
|
|
@@ -16,9 +19,10 @@ module CloudEvents
|
|
|
16
19
|
# their own accessor methods that may return typed objects (such as
|
|
17
20
|
# `DateTime` for the `time` attribute).
|
|
18
21
|
#
|
|
19
|
-
# This object is immutable. The data and
|
|
20
|
-
# retrieved but not modified. To obtain an event
|
|
21
|
-
# the {#with} method to create a copy with the
|
|
22
|
+
# This object is immutable, and Ractor-shareable on Ruby 3. The data and
|
|
23
|
+
# attribute values can be retrieved but not modified. To obtain an event
|
|
24
|
+
# with modifications, use the {#with} method to create a copy with the
|
|
25
|
+
# desired changes.
|
|
22
26
|
#
|
|
23
27
|
# See https://github.com/cloudevents/spec/blob/v1.0/spec.md for
|
|
24
28
|
# descriptions of the standard attributes.
|
|
@@ -42,7 +46,7 @@ module CloudEvents
|
|
|
42
46
|
# field.
|
|
43
47
|
# * **:type** [`String`] - _required_ - The event `type` field.
|
|
44
48
|
# * **:data** [`Object`] - _optional_ - The data associated with the
|
|
45
|
-
# event (i.e. the `data` field.
|
|
49
|
+
# event (i.e. the `data` field).
|
|
46
50
|
# * **:data_content_type** (or **:datacontenttype**) [`String`,
|
|
47
51
|
# {ContentType}] - _optional_ - The content-type for the data, if
|
|
48
52
|
# the data is a string (i.e. the event `datacontenttype` field.)
|
|
@@ -56,6 +60,11 @@ module CloudEvents
|
|
|
56
60
|
# They are not available as separate methods, but can be accessed via
|
|
57
61
|
# the {Event::V1#[]} operator.
|
|
58
62
|
#
|
|
63
|
+
# Note that attribute objects passed in may get deep-frozen if they are
|
|
64
|
+
# used in the final event object. This is particularly important for the
|
|
65
|
+
# `:data` field, for example if you pass a structured hash. If this is an
|
|
66
|
+
# issue, make a deep copy of objects before passing to this constructor.
|
|
67
|
+
#
|
|
59
68
|
# @param attributes [Hash] The data and attributes, as a hash.
|
|
60
69
|
# @param args [keywords] The data and attributes, as keyword arguments.
|
|
61
70
|
#
|
|
@@ -65,12 +74,13 @@ module CloudEvents
|
|
|
65
74
|
@id = interpreter.string ["id"], required: true
|
|
66
75
|
@source = interpreter.uri ["source"], required: true
|
|
67
76
|
@type = interpreter.string ["type"], required: true
|
|
68
|
-
@data = interpreter.
|
|
77
|
+
@data = interpreter.data_object ["data"]
|
|
69
78
|
@data_content_type = interpreter.content_type ["datacontenttype", "data_content_type"]
|
|
70
79
|
@data_schema = interpreter.uri ["dataschema", "data_schema"]
|
|
71
80
|
@subject = interpreter.string ["subject"]
|
|
72
81
|
@time = interpreter.rfc3339_date_time ["time"]
|
|
73
82
|
@attributes = interpreter.finish_attributes
|
|
83
|
+
freeze
|
|
74
84
|
end
|
|
75
85
|
|
|
76
86
|
##
|
|
@@ -101,6 +111,8 @@ module CloudEvents
|
|
|
101
111
|
# event["time"] # => String rfc3339 representation
|
|
102
112
|
# event.time # => DateTime object
|
|
103
113
|
#
|
|
114
|
+
# Results are also always frozen and cannot be modified in place.
|
|
115
|
+
#
|
|
104
116
|
# @param key [String,Symbol] The attribute name.
|
|
105
117
|
# @return [String,nil]
|
|
106
118
|
#
|
|
@@ -109,12 +121,13 @@ module CloudEvents
|
|
|
109
121
|
end
|
|
110
122
|
|
|
111
123
|
##
|
|
112
|
-
# Return a hash representation of this event.
|
|
124
|
+
# Return a hash representation of this event. The returned hash is an
|
|
125
|
+
# unfrozen deep copy. Modifications do not affect the original event.
|
|
113
126
|
#
|
|
114
127
|
# @return [Hash]
|
|
115
128
|
#
|
|
116
129
|
def to_h
|
|
117
|
-
@attributes
|
|
130
|
+
Utils.deep_dup @attributes
|
|
118
131
|
end
|
|
119
132
|
|
|
120
133
|
##
|
|
@@ -201,7 +214,7 @@ module CloudEvents
|
|
|
201
214
|
|
|
202
215
|
## @private
|
|
203
216
|
def hash
|
|
204
|
-
@
|
|
217
|
+
@attributes.hash
|
|
205
218
|
end
|
|
206
219
|
end
|
|
207
220
|
end
|
|
@@ -89,11 +89,11 @@ module CloudEvents
|
|
|
89
89
|
if input && content_type&.media_type == "application"
|
|
90
90
|
case content_type.subtype_base
|
|
91
91
|
when "cloudevents"
|
|
92
|
-
|
|
93
|
-
return decode_structured_content
|
|
92
|
+
content = read_with_charset input, content_type.charset
|
|
93
|
+
return decode_structured_content content, content_type.subtype_format, **format_args
|
|
94
94
|
when "cloudevents-batch"
|
|
95
|
-
|
|
96
|
-
return decode_batched_content
|
|
95
|
+
content = read_with_charset input, content_type.charset
|
|
96
|
+
return decode_batched_content content, content_type.subtype_format, **format_args
|
|
97
97
|
end
|
|
98
98
|
end
|
|
99
99
|
decode_binary_content env, content_type
|
|
@@ -152,10 +152,7 @@ module CloudEvents
|
|
|
152
152
|
return nil if spec_version.nil?
|
|
153
153
|
raise SpecVersionError, "Unrecognized specversion: #{spec_version}" unless spec_version == "1.0"
|
|
154
154
|
input = env["rack.input"]
|
|
155
|
-
data = if input
|
|
156
|
-
input.set_encoding content_type.charset if content_type&.charset
|
|
157
|
-
input.read
|
|
158
|
-
end
|
|
155
|
+
data = read_with_charset input, content_type&.charset if input
|
|
159
156
|
attributes = { "spec_version" => spec_version, "data" => data }
|
|
160
157
|
attributes["data_content_type"] = content_type if content_type
|
|
161
158
|
omit_names = ["specversion", "spec_version", "data", "datacontenttype", "data_content_type"]
|
|
@@ -186,7 +183,10 @@ module CloudEvents
|
|
|
186
183
|
handlers = @structured_formatters[format] || []
|
|
187
184
|
handlers.reverse_each do |handler|
|
|
188
185
|
content = handler.encode event, **format_args
|
|
189
|
-
|
|
186
|
+
if content
|
|
187
|
+
content_type = "application/cloudevents+#{format}; charset=#{charset_of content}"
|
|
188
|
+
return [{ "Content-Type" => content_type }, content]
|
|
189
|
+
end
|
|
190
190
|
end
|
|
191
191
|
raise HttpContentError, "Unknown cloudevents format: #{format.inspect}"
|
|
192
192
|
end
|
|
@@ -209,7 +209,10 @@ module CloudEvents
|
|
|
209
209
|
handlers = @batched_formatters[format] || []
|
|
210
210
|
handlers.reverse_each do |handler|
|
|
211
211
|
content = handler.encode_batch events, **format_args
|
|
212
|
-
|
|
212
|
+
if content
|
|
213
|
+
content_type = "application/cloudevents-batch+#{format}; charset=#{charset_of content}"
|
|
214
|
+
return [{ "Content-Type" => content_type }, content]
|
|
215
|
+
end
|
|
213
216
|
end
|
|
214
217
|
raise HttpContentError, "Unknown cloudevents format: #{format.inspect}"
|
|
215
218
|
end
|
|
@@ -228,21 +231,19 @@ module CloudEvents
|
|
|
228
231
|
headers = {}
|
|
229
232
|
body = nil
|
|
230
233
|
event.to_h.each do |key, value|
|
|
231
|
-
|
|
234
|
+
case key
|
|
235
|
+
when "data"
|
|
232
236
|
body = value
|
|
233
|
-
|
|
237
|
+
when "datacontenttype"
|
|
234
238
|
headers["Content-Type"] = value
|
|
235
239
|
else
|
|
236
240
|
headers["CE-#{key}"] = percent_encode value
|
|
237
241
|
end
|
|
238
242
|
end
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
"text/plain; charset=#{body.encoding.name.downcase}"
|
|
244
|
-
end
|
|
245
|
-
elsif body.nil?
|
|
243
|
+
case body
|
|
244
|
+
when ::String
|
|
245
|
+
headers["Content-Type"] ||= string_content_type body
|
|
246
|
+
when nil
|
|
246
247
|
headers.delete "Content-Type"
|
|
247
248
|
else
|
|
248
249
|
body = ::JSON.dump body
|
|
@@ -259,6 +260,7 @@ module CloudEvents
|
|
|
259
260
|
# @return [String] Resulting decoded string in UTF-8.
|
|
260
261
|
#
|
|
261
262
|
def percent_decode str
|
|
263
|
+
str = str.gsub(/"((?:[^"\\]|\\.)*)"/) { ::Regexp.last_match(1).gsub(/\\(.)/, '\1') }
|
|
262
264
|
decoded_str = str.gsub(/%[0-9a-fA-F]{2}/) { |m| [m[1..-1].to_i(16)].pack "C" }
|
|
263
265
|
decoded_str.force_encoding ::Encoding::UTF_8
|
|
264
266
|
end
|
|
@@ -276,7 +278,7 @@ module CloudEvents
|
|
|
276
278
|
arr = []
|
|
277
279
|
utf_str = str.to_s.encode ::Encoding::UTF_8
|
|
278
280
|
utf_str.each_byte do |byte|
|
|
279
|
-
if byte >= 33 && byte <= 126 && byte != 37
|
|
281
|
+
if byte >= 33 && byte <= 126 && byte != 34 && byte != 37
|
|
280
282
|
arr << byte
|
|
281
283
|
else
|
|
282
284
|
hi = byte / 16
|
|
@@ -288,5 +290,37 @@ module CloudEvents
|
|
|
288
290
|
end
|
|
289
291
|
arr.pack "C*"
|
|
290
292
|
end
|
|
293
|
+
|
|
294
|
+
private
|
|
295
|
+
|
|
296
|
+
def read_with_charset io, charset
|
|
297
|
+
str = io.read
|
|
298
|
+
if charset
|
|
299
|
+
begin
|
|
300
|
+
str.force_encoding charset
|
|
301
|
+
rescue ::ArgumentError
|
|
302
|
+
# Use binary for now if the charset is unrecognized
|
|
303
|
+
str.force_encoding ::Encoding::ASCII_8BIT
|
|
304
|
+
end
|
|
305
|
+
end
|
|
306
|
+
str
|
|
307
|
+
end
|
|
308
|
+
|
|
309
|
+
def string_content_type str
|
|
310
|
+
if str.encoding == ::Encoding::ASCII_8BIT
|
|
311
|
+
"application/octet-stream"
|
|
312
|
+
else
|
|
313
|
+
"text/plain; charset=#{str.encoding.name.downcase}"
|
|
314
|
+
end
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
def charset_of str
|
|
318
|
+
encoding = str.encoding
|
|
319
|
+
if encoding == ::Encoding::ASCII_8BIT
|
|
320
|
+
"binary"
|
|
321
|
+
else
|
|
322
|
+
encoding.name.downcase
|
|
323
|
+
end
|
|
324
|
+
end
|
|
291
325
|
end
|
|
292
326
|
end
|
|
@@ -137,10 +137,9 @@ module CloudEvents
|
|
|
137
137
|
structure = event.to_h
|
|
138
138
|
data = event.data
|
|
139
139
|
content_type = event.data_content_type
|
|
140
|
-
if data.is_a?(::String) && !content_type.nil?
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
end
|
|
140
|
+
if data.is_a?(::String) && !content_type.nil? &&
|
|
141
|
+
(content_type.subtype == "json" || content_type.subtype_format == "json")
|
|
142
|
+
structure["data"] = ::JSON.parse data rescue data
|
|
144
143
|
end
|
|
145
144
|
structure
|
|
146
145
|
end
|
data/lib/cloud_events/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: cloud_events
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Daniel Azuma
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-05-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: The official Ruby implementation of the CloudEvents Specification. Provides
|
|
14
14
|
data types for events, and HTTP/JSON bindings for marshalling and unmarshalling
|
|
@@ -28,6 +28,7 @@ files:
|
|
|
28
28
|
- lib/cloud_events/errors.rb
|
|
29
29
|
- lib/cloud_events/event.rb
|
|
30
30
|
- lib/cloud_events/event/field_interpreter.rb
|
|
31
|
+
- lib/cloud_events/event/utils.rb
|
|
31
32
|
- lib/cloud_events/event/v0.rb
|
|
32
33
|
- lib/cloud_events/event/v1.rb
|
|
33
34
|
- lib/cloud_events/http_binding.rb
|
|
@@ -37,10 +38,10 @@ homepage: https://github.com/cloudevents/sdk-ruby
|
|
|
37
38
|
licenses:
|
|
38
39
|
- Apache-2.0
|
|
39
40
|
metadata:
|
|
40
|
-
changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.
|
|
41
|
+
changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.4.0/file.CHANGELOG.html
|
|
41
42
|
source_code_uri: https://github.com/cloudevents/sdk-ruby
|
|
42
43
|
bug_tracker_uri: https://github.com/cloudevents/sdk-ruby/issues
|
|
43
|
-
documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.
|
|
44
|
+
documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.4.0
|
|
44
45
|
post_install_message:
|
|
45
46
|
rdoc_options: []
|
|
46
47
|
require_paths:
|
|
@@ -49,14 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
49
50
|
requirements:
|
|
50
51
|
- - ">="
|
|
51
52
|
- !ruby/object:Gem::Version
|
|
52
|
-
version: 2.
|
|
53
|
+
version: '2.5'
|
|
53
54
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
54
55
|
requirements:
|
|
55
56
|
- - ">="
|
|
56
57
|
- !ruby/object:Gem::Version
|
|
57
58
|
version: '0'
|
|
58
59
|
requirements: []
|
|
59
|
-
rubygems_version: 3.1.
|
|
60
|
+
rubygems_version: 3.1.6
|
|
60
61
|
signing_key:
|
|
61
62
|
specification_version: 4
|
|
62
63
|
summary: Ruby SDK for CloudEvents
|