cloud_events 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c1658e90d1e5d2ba5fe59cd174faf0bf1a475e14f9d910fab5a5136b13417fd
-  data.tar.gz: 19dfdc7de4c50ea3e03cb7818ed526b9bff93173be68d378c512b4c466fc14ab
+  metadata.gz: 7449de71a0d20b1c7fa726bbb850080c977299ebb92c3c52ecc04c3acaa65a0c
+  data.tar.gz: 60c0bfa47f39b3c4a10d12122c57d2ee2b26e75f4a82bc0622033275a5866946
 SHA512:
-  metadata.gz: 1ff3c4b897ad25aafe2a13761d862d3bca6f28d2d9d57f611f3bf2c086161c6b559d30125888654b6e543ce30ffa7bedff99c42f115871507480855264354cea
-  data.tar.gz: 35024a3f6613d3d24a71f56fe50e3dc8a3e53a53c6b79468fd3a9f61b7311b940a1bff1d6dfb63000c37bd653e96ee9007c9f4d30e201060186f6b5766fd6515
+  metadata.gz: ba15c5d5fd8fd432b39a861297c57f04c659f0329783ad8a02f30c60f839836438df4371937d4d063f14bef326e45741140690be854dc2f8865c3defbb948074
+  data.tar.gz: 05cca16a9b8436a8cf7e7a23189d6873fbc322dbd177cd5d71886081a2a116d75ccb2215bc8c112a013976d769691ab0be96ab41b2d16e4acb57948c9aa7b8fc

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+### v0.3.1 / 2021-04-25
+
+* FIXED: Fixed exception when decoding from a rack source that uses InputWrapper 
+* FIXED: Fixed equality checking for V0 events 
+
+### v0.3.0 / 2021-03-02
+
+* ADDED: Require Ruby 2.5 or later
+* FIXED: Deep-duplicated event attributes in to_h to avoid returning frozen objects 
+
+### v0.2.0 / 2021-01-25
+
+* ADDED: Freeze event objects to make them Ractor-shareable
+* DOCS: Fix formatting of Apache license 
+
+### v0.1.2 / 2020-09-02
+
+* Fix: Convert extension attributes to strings, and ignore nils 
+* Documentation: Add code of conduct link to readme
+
+### v0.1.1 / 2020-07-20
+
+* Updated a few documentation links. No functional changes.
+
 ### v0.1.0 / 2020-07-08
 
 * Initial release of the Ruby SDK.

data/LICENSE.md

@@ -1,192 +1,191 @@
-Apache License
-==============
-
-* Version 2.0, January 2004
-* https://www.apache.org/licenses/
-
-### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. **Definitions.**
-
-    "License" shall mean the terms and conditions for use, reproduction,
-    and distribution as defined by Sections 1 through 9 of this document.
-
-    "Licensor" shall mean the copyright owner or entity authorized by
-    the copyright owner that is granting the License.
-
-    "Legal Entity" shall mean the union of the acting entity and all
-    other entities that control, are controlled by, or are under common
-    control with that entity. For the purposes of this definition,
-    "control" means (i) the power, direct or indirect, to cause the
-    direction or management of such entity, whether by contract or
-    otherwise, or (ii) ownership of fifty percent (50%) or more of the
-    outstanding shares, or (iii) beneficial ownership of such entity.
-
-    "You" (or "Your") shall mean an individual or Legal Entity
-    exercising permissions granted by this License.
-
-    "Source" form shall mean the preferred form for making modifications,
-    including but not limited to software source code, documentation
-    source, and configuration files.
-
-    "Object" form shall mean any form resulting from mechanical
-    transformation or translation of a Source form, including but
-    not limited to compiled object code, generated documentation,
-    and conversions to other media types.
-
-    "Work" shall mean the work of authorship, whether in Source or
-    Object form, made available under the License, as indicated by a
-    copyright notice that is included in or attached to the work
-    (an example is provided in the Appendix below).
-
-    "Derivative Works" shall mean any work, whether in Source or Object
-    form, that is based on (or derived from) the Work and for which the
-    editorial revisions, annotations, elaborations, or other modifications
-    represent, as a whole, an original work of authorship. For the purposes
-    of this License, Derivative Works shall not include works that remain
-    separable from, or merely link (or bind by name) to the interfaces of,
-    the Work and Derivative Works thereof.
-
-    "Contribution" shall mean any work of authorship, including
-    the original version of the Work and any modifications or additions
-    to that Work or Derivative Works thereof, that is intentionally
-    submitted to Licensor for inclusion in the Work by the copyright owner
-    or by an individual or Legal Entity authorized to submit on behalf of
-    the copyright owner. For the purposes of this definition, "submitted"
-    means any form of electronic, verbal, or written communication sent
-    to the Licensor or its representatives, including but not limited to
-    communication on electronic mailing lists, source code control systems,
-    and issue tracking systems that are managed by, or on behalf of, the
-    Licensor for the purpose of discussing and improving the Work, but
-    excluding communication that is conspicuously marked or otherwise
-    designated in writing by the copyright owner as "Not a Contribution."
-
-    "Contributor" shall mean Licensor and any individual or Legal Entity
-    on behalf of whom a Contribution has been received by Licensor and
-    subsequently incorporated within the Work.
-
- 2. **Grant of Copyright License.** Subject to the terms and conditions of
-    this License, each Contributor hereby grants to You a perpetual,
-    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-    copyright license to reproduce, prepare Derivative Works of,
-    publicly display, publicly perform, sublicense, and distribute the
-    Work and such Derivative Works in Source or Object form.
-
- 3. **Grant of Patent License.** Subject to the terms and conditions of
-    this License, each Contributor hereby grants to You a perpetual,
-    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-    (except as stated in this section) patent license to make, have made,
-    use, offer to sell, sell, import, and otherwise transfer the Work,
-    where such license applies only to those patent claims licensable
-    by such Contributor that are necessarily infringed by their
-    Contribution(s) alone or by combination of their Contribution(s)
-    with the Work to which such Contribution(s) was submitted. If You
-    institute patent litigation against any entity (including a
-    cross-claim or counterclaim in a lawsuit) alleging that the Work
-    or a Contribution incorporated within the Work constitutes direct
-    or contributory patent infringement, then any patent licenses
-    granted to You under this License for that Work shall terminate
-    as of the date such litigation is filed.
-
- 4. **Redistribution.** You may reproduce and distribute copies of the
-    Work or Derivative Works thereof in any medium, with or without
-    modifications, and in Source or Object form, provided that You
-    meet the following conditions:
-
-     *  **(a)** You must give any other recipients of the Work or
-        Derivative Works a copy of this License; and
-
-     *  **(b)** You must cause any modified files to carry prominent notices
-        stating that You changed the files; and
-
-     *  **(c)** You must retain, in the Source form of any Derivative Works
-        that You distribute, all copyright, patent, trademark, and
-        attribution notices from the Source form of the Work,
-        excluding those notices that do not pertain to any part of
-        the Derivative Works; and
-
-     *  **(d)** If the Work includes a "NOTICE" text file as part of its
-        distribution, then any Derivative Works that You distribute must
-        include a readable copy of the attribution notices contained
-        within such NOTICE file, excluding those notices that do not
-        pertain to any part of the Derivative Works, in at least one
-        of the following places: within a NOTICE text file distributed
-        as part of the Derivative Works; within the Source form or
-        documentation, if provided along with the Derivative Works; or,
-        within a display generated by the Derivative Works, if and
-        wherever such third-party notices normally appear. The contents
-        of the NOTICE file are for informational purposes only and
-        do not modify the License. You may add Your own attribution
-        notices within Derivative Works that You distribute, alongside
-        or as an addendum to the NOTICE text from the Work, provided
-        that such additional attribution notices cannot be construed
-        as modifying the License.
-
-    You may add Your own copyright statement to Your modifications and
-    may provide additional or different license terms and conditions
-    for use, reproduction, or distribution of Your modifications, or
-    for any such Derivative Works as a whole, provided Your use,
-    reproduction, and distribution of the Work otherwise complies with
-    the conditions stated in this License.
-
- 5. **Submission of Contributions.** Unless You explicitly state otherwise,
-    any Contribution intentionally submitted for inclusion in the Work
-    by You to the Licensor shall be under the terms and conditions of
-    this License, without any additional terms or conditions.
-    Notwithstanding the above, nothing herein shall supersede or modify
-    the terms of any separate license agreement you may have executed
-    with Licensor regarding such Contributions.
-
- 6. **Trademarks.** This License does not grant permission to use the trade
-    names, trademarks, service marks, or product names of the Licensor,
-    except as required for reasonable and customary use in describing the
-    origin of the Work and reproducing the content of the NOTICE file.
-
- 7. **Disclaimer of Warranty.** Unless required by applicable law or
-    agreed to in writing, Licensor provides the Work (and each
-    Contributor provides its Contributions) on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-    implied, including, without limitation, any warranties or conditions
-    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-    PARTICULAR PURPOSE. You are solely responsible for determining the
-    appropriateness of using or redistributing the Work and assume any
-    risks associated with Your exercise of permissions under this License.
-
- 8. **Limitation of Liability.** In no event and under no legal theory,
-    whether in tort (including negligence), contract, or otherwise,
-    unless required by applicable law (such as deliberate and grossly
-    negligent acts) or agreed to in writing, shall any Contributor be
-    liable to You for damages, including any direct, indirect, special,
-    incidental, or consequential damages of any character arising as a
-    result of this License or out of the use or inability to use the
-    Work (including but not limited to damages for loss of goodwill,
-    work stoppage, computer failure or malfunction, or any and all
-    other commercial damages or losses), even if such Contributor
-    has been advised of the possibility of such damages.
-
- 9. **Accepting Warranty or Additional Liability.** While redistributing
-    the Work or Derivative Works thereof, You may choose to offer,
-    and charge a fee for, acceptance of support, warranty, indemnity,
-    or other liability obligations and/or rights consistent with this
-    License. However, in accepting such obligations, You may act only
-    on Your own behalf and on Your sole responsibility, not on behalf
-    of any other Contributor, and only if You agree to indemnify,
-    defend, and hold each Contributor harmless for any liability
-    incurred by, or claims asserted against, such Contributor by reason
-    of your accepting any such warranty or additional liability.
-
-_END OF TERMS AND CONDITIONS_
-
-### APPENDIX: How to apply the Apache License to your work.
-
-To apply the Apache License to your work, attach the following
-boilerplate notice, with the fields enclosed by brackets "`[]`"
-replaced with your own identifying information. (Don't include
-the brackets!)  The text should be enclosed in the appropriate
-comment syntax for the file format. We also recommend that a
-file or class name and description of purpose be included on the
-same "printed page" as the copyright notice for easier
-identification within third-party archives.
+
+                                  Apache License
+                            Version 2.0, January 2004
+                         http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+       "License" shall mean the terms and conditions for use, reproduction,
+       and distribution as defined by Sections 1 through 9 of this document.
+
+       "Licensor" shall mean the copyright owner or entity authorized by
+       the copyright owner that is granting the License.
+
+       "Legal Entity" shall mean the union of the acting entity and all
+       other entities that control, are controlled by, or are under common
+       control with that entity. For the purposes of this definition,
+       "control" means (i) the power, direct or indirect, to cause the
+       direction or management of such entity, whether by contract or
+       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+       outstanding shares, or (iii) beneficial ownership of such entity.
+
+       "You" (or "Your") shall mean an individual or Legal Entity
+       exercising permissions granted by this License.
+
+       "Source" form shall mean the preferred form for making modifications,
+       including but not limited to software source code, documentation
+       source, and configuration files.
+
+       "Object" form shall mean any form resulting from mechanical
+       transformation or translation of a Source form, including but
+       not limited to compiled object code, generated documentation,
+       and conversions to other media types.
+
+       "Work" shall mean the work of authorship, whether in Source or
+       Object form, made available under the License, as indicated by a
+       copyright notice that is included in or attached to the work
+       (an example is provided in the Appendix below).
+
+       "Derivative Works" shall mean any work, whether in Source or Object
+       form, that is based on (or derived from) the Work and for which the
+       editorial revisions, annotations, elaborations, or other modifications
+       represent, as a whole, an original work of authorship. For the purposes
+       of this License, Derivative Works shall not include works that remain
+       separable from, or merely link (or bind by name) to the interfaces of,
+       the Work and Derivative Works thereof.
+
+       "Contribution" shall mean any work of authorship, including
+       the original version of the Work and any modifications or additions
+       to that Work or Derivative Works thereof, that is intentionally
+       submitted to Licensor for inclusion in the Work by the copyright owner
+       or by an individual or Legal Entity authorized to submit on behalf of
+       the copyright owner. For the purposes of this definition, "submitted"
+       means any form of electronic, verbal, or written communication sent
+       to the Licensor or its representatives, including but not limited to
+       communication on electronic mailing lists, source code control systems,
+       and issue tracking systems that are managed by, or on behalf of, the
+       Licensor for the purpose of discussing and improving the Work, but
+       excluding communication that is conspicuously marked or otherwise
+       designated in writing by the copyright owner as "Not a Contribution."
+
+       "Contributor" shall mean Licensor and any individual or Legal Entity
+       on behalf of whom a Contribution has been received by Licensor and
+       subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       copyright license to reproduce, prepare Derivative Works of,
+       publicly display, publicly perform, sublicense, and distribute the
+       Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       (except as stated in this section) patent license to make, have made,
+       use, offer to sell, sell, import, and otherwise transfer the Work,
+       where such license applies only to those patent claims licensable
+       by such Contributor that are necessarily infringed by their
+       Contribution(s) alone or by combination of their Contribution(s)
+       with the Work to which such Contribution(s) was submitted. If You
+       institute patent litigation against any entity (including a
+       cross-claim or counterclaim in a lawsuit) alleging that the Work
+       or a Contribution incorporated within the Work constitutes direct
+       or contributory patent infringement, then any patent licenses
+       granted to You under this License for that Work shall terminate
+       as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+       Work or Derivative Works thereof in any medium, with or without
+       modifications, and in Source or Object form, provided that You
+       meet the following conditions:
+
+       (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+       (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+       (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+       (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+       You may add Your own copyright statement to Your modifications and
+       may provide additional or different license terms and conditions
+       for use, reproduction, or distribution of Your modifications, or
+       for any such Derivative Works as a whole, provided Your use,
+       reproduction, and distribution of the Work otherwise complies with
+       the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+       any Contribution intentionally submitted for inclusion in the Work
+       by You to the Licensor shall be under the terms and conditions of
+       this License, without any additional terms or conditions.
+       Notwithstanding the above, nothing herein shall supersede or modify
+       the terms of any separate license agreement you may have executed
+       with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+       names, trademarks, service marks, or product names of the Licensor,
+       except as required for reasonable and customary use in describing the
+       origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+       agreed to in writing, Licensor provides the Work (and each
+       Contributor provides its Contributions) on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+       implied, including, without limitation, any warranties or conditions
+       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+       PARTICULAR PURPOSE. You are solely responsible for determining the
+       appropriateness of using or redistributing the Work and assume any
+       risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+       whether in tort (including negligence), contract, or otherwise,
+       unless required by applicable law (such as deliberate and grossly
+       negligent acts) or agreed to in writing, shall any Contributor be
+       liable to You for damages, including any direct, indirect, special,
+       incidental, or consequential damages of any character arising as a
+       result of this License or out of the use or inability to use the
+       Work (including but not limited to damages for loss of goodwill,
+       work stoppage, computer failure or malfunction, or any and all
+       other commercial damages or losses), even if such Contributor
+       has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+       the Work or Derivative Works thereof, You may choose to offer,
+       and charge a fee for, acceptance of support, warranty, indemnity,
+       or other liability obligations and/or rights consistent with this
+       License. However, in accepting such obligations, You may act only
+       on Your own behalf and on Your sole responsibility, not on behalf
+       of any other Contributor, and only if You agree to indemnify,
+       defend, and hold each Contributor harmless for any liability
+       incurred by, or claims asserted against, such Contributor by reason
+       of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+       To apply the Apache License to your work, attach the following
+       boilerplate notice, with the fields enclosed by brackets "[]"
+       replaced with your own identifying information. (Don't include
+       the brackets!)  The text should be enclosed in the appropriate
+       comment syntax for the file format. We also recommend that a
+       file or class name and description of purpose be included on the
+       same "printed page" as the copyright notice for easier
+       identification within third-party archives.
 
     Copyright [yyyy] [name of copyright owner]
 
@@ -194,7 +193,7 @@ identification within third-party archives.
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at
 
-        https://www.apache.org/licenses/LICENSE-2.0
+       http://www.apache.org/licenses/LICENSE-2.0
 
     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,

data/README.md

@@ -17,7 +17,7 @@ Features:
     specifications.
  *  Extensible to additional formats and protocol bindings, and future
     specification versions.
- *  Compatible with Ruby 2.4 or later, or JRuby 9.2.x or later. No runtime gem
+ *  Compatible with Ruby 2.5 or later, or JRuby 9.2.x or later. No runtime gem
     dependencies.
 
 ## Quickstart
@@ -35,7 +35,7 @@ A simple [Sinatra](https://sinatrarb.com) app that receives CloudEvents:
 ```ruby
 # examples/server/Gemfile
 source "https://rubygems.org"
-gem "cloud_events", "~> 0.1"
+gem "cloud_events", "~> 0.2"
 gem "sinatra", "~> 2.0"
 ```
 
@@ -59,7 +59,7 @@ A simple Ruby script that sends a CloudEvent:
 ```ruby
 # examples/client/Gemfile
 source "https://rubygems.org"
-gem "cloud_events", "~> 0.1"
+gem "cloud_events", "~> 0.2"
 ```
 
 ```ruby
@@ -106,7 +106,7 @@ Hit `CTRL+C` to stop the server.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cloudevents/ruby-sdk.
+Bug reports and pull requests are welcome on GitHub at https://github.com/cloudevents/sdk-ruby.
 
 ### Development
 
@@ -163,7 +163,7 @@ toys rubocop
 That said, we are not style sticklers, and if a break is necessary for code
 readability or practicality, Rubocop rules can be selectively disabled.
 
-### Pull Requests
+### Pull requests
 
 We welcome contributions from the community! Please take some time to become
 acquainted with the process before submitting a pull request. There are just a
@@ -188,33 +188,30 @@ Releases can be performed only by users with write access to the repository.
 
 To perform a release:
 
- 1. Update `lib/cloud_events/version.rb` with the new release version.
+ 1. Go to the GitHub Actions tab, and launch the "Request Release" workflow.
+    You can leave the input field blank.
 
- 2. Add an entry to `CHANGELOG.md`. The changelog entry _must_ be headed by
-    the version and release date, and _must_ be consistent with the format of
-    previous entries.
+ 2. The workflow will analyze the commit messages since the last release, and
+    open a pull request with a new version and a changelog entry. You can
+    optionally edit this pull request to modify the changelog or change the
+    version released.
 
- 3. Ensure the above changes are pushed to the GitHub master branch at
-    https://github.com/cloudevents/ruby-sdk.
+ 3. Merge the pull request (keeping the `release: pending` label set.) Once the
+    CI tests have run successfully, a job will run automatically to perform the
+    release, including tagging the commit in git, building and releasing a gem,
+    and building and pushing documentation.
 
- 4. Execute
+These tasks can also be performed manually by running the appropriate scripts
+locally. See `toys release request --help` and `toys release perform --help`
+for more information.
 
-    ```sh
-    toys release trigger $VERSION
-    ```
+If a release fails, you may need to delete the release tag before retrying.
 
-    where `$VERSION` is the version number (e.g. `0.1.0`). This script will
-    verify the version and changelog and will not proceed unless they are
-    correctly formatted and the master branch is up to date. It will also check
-    that all GitHub checks against the current commit have succeeded. If these
-    checks pass, the script will create and push a release tag.
+### For more information
 
- 5. A GitHub action will then perform the release within a few minutes. You can
-    check the [GitHub Actions dashboard](https://github.com/dazuma/toys/actions)
-    for status information on the release.
-
-    If the release workflow fails, fix the problem, and then you will need to
-    delete the release tag manually before triggering the release again.
+ *  Library documentation: https://cloudevents.github.io/sdk-ruby
+ *  Issue tracker: https://github.com/cloudevents/sdk-ruby/issues
+ *  Changelog: https://cloudevents.github.io/sdk-ruby/latest/file.CHANGELOG.html
 
 ## Community
 
@@ -233,6 +230,17 @@ To perform a release:
 
  *  For additional information, contact Daniel Azuma (`@dazuma` on Slack).
 
+Each SDK may have its own unique processes, tooling and guidelines, common
+governance related material can be found in the
+[CloudEvents `community`](https://github.com/cloudevents/spec/tree/master/community)
+directory. In particular, in there you will find information concerning
+how SDK projects are
+[managed](https://github.com/cloudevents/spec/blob/master/community/SDK-GOVERNANCE.md),
+[guidelines](https://github.com/cloudevents/spec/blob/master/community/SDK-maintainer-guidelines.md)
+for how PR reviews and approval, and our
+[Code of Conduct](https://github.com/cloudevents/spec/blob/master/community/GOVERNANCE.md#additional-information)
+information.
+
 ## Licensing
 
     Copyright 2020 Google LLC and the CloudEvents Ruby SDK Contributors

data/lib/cloud_events/content_type.rb

@@ -14,6 +14,8 @@ module CloudEvents
   # can, and fill the rest with defaults as recommended in RFC 2045 sec 5.2.
   # In case of a parsing error, the {#error_message} field will be set.
   #
+  # This object is immutable, and Ractor-shareable on Ruby 3.
+  #
   class ContentType
     ##
     # Parse the given header value.
@@ -31,6 +33,7 @@ module CloudEvents
       parse consume_comments string.strip
       @canonical_string = "#{@media_type}/#{@subtype}" +
                           @params.map { |k, v| "; #{k}=#{maybe_quote v}" }.join
+      full_freeze
     end
 
     ##
@@ -137,7 +140,7 @@ module CloudEvents
     end
 
     def consume_token str, downcase: false, error_message: nil
-      match = /^([\w!#\$%&'\*\+\.\^`\{\|\}-]+)(.*)$/.match str
+      match = /^([\w!#$%&'*+.\^`{|}-]+)(.*)$/.match str
       raise ParseError, error_message || "Expected token" unless match
       token = match[1]
       token.downcase! if downcase
@@ -200,9 +203,21 @@ module CloudEvents
     end
 
     def maybe_quote str
-      return str if /^[\w!#\$%&'\*\+\.\^`\{\|\}-]+$/ =~ str
+      return str if /^[\w!#$%&'*+.\^`{|}-]+$/ =~ str
       str = str.gsub("\\", "\\\\\\\\").gsub("\"", "\\\\\"")
       "\"#{str}\""
     end
+
+    def full_freeze
+      instance_variables.each do |iv|
+        instance_variable_get(iv).freeze
+      end
+      @params.each do |name_val|
+        name_val[0].freeze
+        name_val[1].freeze
+        name_val.freeze
+      end
+      freeze
+    end
   end
 end

data/lib/cloud_events/event.rb

@@ -15,9 +15,9 @@ module CloudEvents
   #  *  Event classes are defined within this module. For example, events
   #     conforming to the CloudEvents 1.0 specification are of type
   #     {CloudEvents::Event::V1}.
-  #  *  All event classes include this module, so you can use
+  #  *  All event classes include this module itself, so you can use
   #     `is_a? CloudEvents::Event` to test whether an object is an event.
-  #  *  All event objects are immutable. Data and atribute values can be
+  #  *  All event objects are immutable. Data and attribute values can be
   #     retrieved but not modified. To "modify" an event, make a copy with
   #     the desired changes. Generally, event classes will provide a helper
   #     method for this purpose.
@@ -50,6 +50,11 @@ module CloudEvents
       # `spec_version`, the remaining keyword arguments will be passed
       # through to the {CloudEvents::Event::V1} constructor.
       #
+      # Note that argument objects passed in may get deep-frozen if they are
+      # used in the final event object. This is particularly important for the
+      # `:data` field, for example if you pass a structured hash. If this is an
+      # issue, make a deep copy of objects before passing them to this method.
+      #
       # @param spec_version [String] The required `specversion` field.
       # @param kwargs [keywords] Additional parameters for the event.
       #

data/lib/cloud_events/event/field_interpreter.rb

@@ -1,22 +1,25 @@
 # frozen_string_literal: true
 
+require "cloud_events/event/utils"
+
 module CloudEvents
   module Event
     ##
     # A helper that extracts and interprets event fields from an input hash.
-    #
     # @private
     #
     class FieldInterpreter
       def initialize args
-        @args = keys_to_strings args
+        @args = Utils.keys_to_strings args
         @attributes = {}
       end
 
       def finish_attributes
-        @attributes.merge! @args
+        @args.each do |key, value|
+          @attributes[key.freeze] = value.to_s.freeze unless value.nil?
+        end
         @args = {}
-        @attributes
+        @attributes.freeze
       end
 
       def string keys, required: false
@@ -24,6 +27,7 @@ module CloudEvents
           case value
           when ::String
             raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
+            value.freeze
             [value, value]
           else
             raise AttributeError, "Illegal type for #{keys.first}:" \
@@ -38,12 +42,12 @@ module CloudEvents
           when ::String
             raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
             begin
-              [::URI.parse(value), value]
+              [Utils.deep_freeze(::URI.parse(value)), value.freeze]
             rescue ::URI::InvalidURIError => e
               raise AttributeError, "Illegal format for #{keys.first}: #{e.message}"
             end
           when ::URI::Generic
-            [value, value.to_s]
+            [Utils.deep_freeze(value), value.to_s.freeze]
           else
             raise AttributeError, "Illegal type for #{keys.first}:" \
                                   " String or URI expected but #{value.class} found"
@@ -56,15 +60,15 @@ module CloudEvents
           case value
           when ::String
             begin
-              [::DateTime.rfc3339(value), value]
+              [Utils.deep_freeze(::DateTime.rfc3339(value)), value.freeze]
             rescue ::Date::Error => e
               raise AttributeError, "Illegal format for #{keys.first}: #{e.message}"
             end
           when ::DateTime
-            [value, value.rfc3339]
+            [Utils.deep_freeze(value), value.rfc3339.freeze]
           when ::Time
             value = value.to_datetime
-            [value, value.rfc3339]
+            [Utils.deep_freeze(value), value.rfc3339.freeze]
           else
             raise AttributeError, "Illegal type for #{keys.first}:" \
                                   " String, Time, or DateTime expected but #{value.class} found"
@@ -77,7 +81,7 @@ module CloudEvents
           case value
           when ::String
             raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
-            [ContentType.new(value), value]
+            [ContentType.new(value), value.freeze]
           when ContentType
             [value, value.to_s]
           else
@@ -92,6 +96,7 @@ module CloudEvents
           case value
           when ::String
             raise SpecVersionError, "Unrecognized specversion: #{value}" unless accept =~ value
+            value.freeze
             [value, value]
           else
             raise AttributeError, "Illegal type for #{keys.first}:" \
@@ -100,7 +105,16 @@ module CloudEvents
         end
       end
 
-      UNDEFINED = ::Object.new
+      def data_object keys, required: false
+        object keys, required: required, allow_nil: true do |value|
+          Utils.deep_freeze value
+          [value, value]
+        end
+      end
+
+      UNDEFINED = ::Object.new.freeze
+
+      private
 
       def object keys, required: false, allow_nil: false
         value = UNDEFINED
@@ -113,24 +127,10 @@ module CloudEvents
           raise AttributeError, "The #{keys.first} field is required" if required
           return nil
         end
-        if block_given?
-          converted, raw = yield value
-        else
-          converted = raw = value
-        end
-        @attributes[keys.first] = raw
+        converted, raw = yield value
+        @attributes[keys.first.freeze] = raw
         converted
       end
-
-      private
-
-      def keys_to_strings hash
-        result = {}
-        hash.each do |key, val|
-          result[key.to_s] = val
-        end
-        result
-      end
     end
   end
 end

data/lib/cloud_events/event/utils.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CloudEvents
+  module Event
+    ##
+    # A variety of helper methods.
+    # @private
+    #
+    module Utils
+      class << self
+        def deep_freeze obj
+          case obj
+          when ::Hash
+            obj.each do |key, val|
+              deep_freeze key
+              deep_freeze val
+            end
+          when ::Array
+            obj.each do |val|
+              deep_freeze val
+            end
+          else
+            obj.instance_variables.each do |iv|
+              deep_freeze obj.instance_variable_get iv
+            end
+          end
+          obj.freeze
+        end
+
+        def deep_dup obj
+          case obj
+          when ::Hash
+            obj.each_with_object({}) { |(key, val), hash| hash[deep_dup key] = deep_dup val }
+          when ::Array
+            obj.map { |val| deep_dup val }
+          else
+            obj.dup
+          end
+        end
+
+        def keys_to_strings hash
+          result = {}
+          hash.each do |key, val|
+            result[key.to_s] = val
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/cloud_events/event/v0.rb

@@ -3,6 +3,9 @@
 require "date"
 require "uri"
 
+require "cloud_events/event/field_interpreter"
+require "cloud_events/event/utils"
+
 module CloudEvents
   module Event
     ##
@@ -16,9 +19,10 @@ module CloudEvents
     # their own accessor methods that may return typed objects (such as
     # `DateTime` for the `time` attribute).
     #
-    # This object is immutable. The data and attribute values can be
-    # retrieved but not modified. To obtain an event with modifications, use
-    # the {#with} method to create a copy with the desired changes.
+    # This object is immutable, and Ractor-shareable on Ruby 3. The data and
+    # attribute values can be retrieved but not modified. To obtain an event
+    # with modifications, use the {#with} method to create a copy with the
+    # desired changes.
     #
     # See https://github.com/cloudevents/spec/blob/v0.3/spec.md for
     # descriptions of the standard attributes.
@@ -42,7 +46,7 @@ module CloudEvents
       #     field.
       #  *  **:type** [`String`] - _required_ - The event `type` field.
       #  *  **:data** [`Object`] - _optional_ - The data associated with the
-      #     event (i.e. the `data` field.)
+      #     event (i.e. the `data` field).
       #  *  **:data_content_encoding** (or **:datacontentencoding**)
       #     [`String`] - _optional_ - The content-encoding for the data (i.e.
       #     the `datacontentencoding` field.)
@@ -59,6 +63,11 @@ module CloudEvents
       # They are not available as separate methods, but can be accessed via
       # the {Event::V1#[]} operator.
       #
+      # Note that attribute objects passed in may get deep-frozen if they are
+      # used in the final event object. This is particularly important for the
+      # `:data` field, for example if you pass a structured hash. If this is an
+      # issue, make a deep copy of objects before passing to this constructor.
+      #
       # @param attributes [Hash] The data and attributes, as a hash.
       # @param args [keywords] The data and attributes, as keyword arguments.
       #
@@ -68,13 +77,14 @@ module CloudEvents
         @id = interpreter.string ["id"], required: true
         @source = interpreter.uri ["source"], required: true
         @type = interpreter.string ["type"], required: true
-        @data = interpreter.object ["data"], allow_nil: true
+        @data = interpreter.data_object ["data"]
         @data_content_encoding = interpreter.string ["datacontentencoding", "data_content_encoding"]
         @data_content_type = interpreter.content_type ["datacontenttype", "data_content_type"]
         @schema_url = interpreter.uri ["schemaurl", "schema_url"]
         @subject = interpreter.string ["subject"]
         @time = interpreter.rfc3339_date_time ["time"]
         @attributes = interpreter.finish_attributes
+        freeze
       end
 
       ##
@@ -105,6 +115,8 @@ module CloudEvents
       #     event["time"]     # => String rfc3339 representation
       #     event.time        # => DateTime object
       #
+      # Results are also always frozen and cannot be modified in place.
+      #
       # @param key [String,Symbol] The attribute name.
       # @return [String,nil]
       #
@@ -113,12 +125,13 @@ module CloudEvents
       end
 
       ##
-      # Return a hash representation of this event.
+      # Return a hash representation of this event. The returned hash is an
+      # unfrozen deep copy. Modifications do not affect the original event.
       #
       # @return [Hash]
       #
       def to_h
-        @attributes.dup
+        Utils.deep_dup @attributes
       end
 
       ##
@@ -208,13 +221,13 @@ module CloudEvents
 
       ## @private
       def == other
-        other.is_a?(V1) && @attributes == other.instance_variable_get(:@attributes)
+        other.is_a?(V0) && @attributes == other.instance_variable_get(:@attributes)
       end
       alias eql? ==
 
       ## @private
       def hash
-        @hash ||= @attributes.hash
+        @attributes.hash
       end
     end
   end

data/lib/cloud_events/event/v1.rb

@@ -3,6 +3,9 @@
 require "date"
 require "uri"
 
+require "cloud_events/event/field_interpreter"
+require "cloud_events/event/utils"
+
 module CloudEvents
   module Event
     ##
@@ -16,9 +19,10 @@ module CloudEvents
     # their own accessor methods that may return typed objects (such as
     # `DateTime` for the `time` attribute).
     #
-    # This object is immutable. The data and attribute values can be
-    # retrieved but not modified. To obtain an event with modifications, use
-    # the {#with} method to create a copy with the desired changes.
+    # This object is immutable, and Ractor-shareable on Ruby 3. The data and
+    # attribute values can be retrieved but not modified. To obtain an event
+    # with modifications, use the {#with} method to create a copy with the
+    # desired changes.
     #
     # See https://github.com/cloudevents/spec/blob/v1.0/spec.md for
     # descriptions of the standard attributes.
@@ -42,7 +46,7 @@ module CloudEvents
       #     field.
       #  *  **:type** [`String`] - _required_ - The event `type` field.
       #  *  **:data** [`Object`] - _optional_ - The data associated with the
-      #     event (i.e. the `data` field.)
+      #     event (i.e. the `data` field).
       #  *  **:data_content_type** (or **:datacontenttype**) [`String`,
       #     {ContentType}] - _optional_ - The content-type for the data, if
       #     the data is a string (i.e. the event `datacontenttype` field.)
@@ -56,6 +60,11 @@ module CloudEvents
       # They are not available as separate methods, but can be accessed via
       # the {Event::V1#[]} operator.
       #
+      # Note that attribute objects passed in may get deep-frozen if they are
+      # used in the final event object. This is particularly important for the
+      # `:data` field, for example if you pass a structured hash. If this is an
+      # issue, make a deep copy of objects before passing to this constructor.
+      #
       # @param attributes [Hash] The data and attributes, as a hash.
       # @param args [keywords] The data and attributes, as keyword arguments.
       #
@@ -65,12 +74,13 @@ module CloudEvents
         @id = interpreter.string ["id"], required: true
         @source = interpreter.uri ["source"], required: true
         @type = interpreter.string ["type"], required: true
-        @data = interpreter.object ["data"], allow_nil: true
+        @data = interpreter.data_object ["data"]
         @data_content_type = interpreter.content_type ["datacontenttype", "data_content_type"]
         @data_schema = interpreter.uri ["dataschema", "data_schema"]
         @subject = interpreter.string ["subject"]
         @time = interpreter.rfc3339_date_time ["time"]
         @attributes = interpreter.finish_attributes
+        freeze
       end
 
       ##
@@ -101,6 +111,8 @@ module CloudEvents
       #     event["time"]     # => String rfc3339 representation
       #     event.time        # => DateTime object
       #
+      # Results are also always frozen and cannot be modified in place.
+      #
       # @param key [String,Symbol] The attribute name.
       # @return [String,nil]
       #
@@ -109,12 +121,13 @@ module CloudEvents
       end
 
       ##
-      # Return a hash representation of this event.
+      # Return a hash representation of this event. The returned hash is an
+      # unfrozen deep copy. Modifications do not affect the original event.
       #
       # @return [Hash]
       #
       def to_h
-        @attributes.dup
+        Utils.deep_dup @attributes
       end
 
       ##
@@ -201,7 +214,7 @@ module CloudEvents
 
       ## @private
       def hash
-        @hash ||= @attributes.hash
+        @attributes.hash
       end
     end
   end

data/lib/cloud_events/http_binding.rb

@@ -89,11 +89,11 @@ module CloudEvents
       if input && content_type&.media_type == "application"
         case content_type.subtype_base
         when "cloudevents"
-          input.set_encoding content_type.charset if content_type.charset
-          return decode_structured_content input.read, content_type.subtype_format, **format_args
+          content = read_with_charset input, content_type.charset
+          return decode_structured_content content, content_type.subtype_format, **format_args
         when "cloudevents-batch"
-          input.set_encoding content_type.charset if content_type.charset
-          return decode_batched_content input.read, content_type.subtype_format, **format_args
+          content = read_with_charset input, content_type.charset
+          return decode_batched_content content, content_type.subtype_format, **format_args
         end
       end
       decode_binary_content env, content_type
@@ -152,10 +152,7 @@ module CloudEvents
       return nil if spec_version.nil?
       raise SpecVersionError, "Unrecognized specversion: #{spec_version}" unless spec_version == "1.0"
       input = env["rack.input"]
-      data = if input
-               input.set_encoding content_type.charset if content_type&.charset
-               input.read
-             end
+      data = read_with_charset input, content_type&.charset if input
       attributes = { "spec_version" => spec_version, "data" => data }
       attributes["data_content_type"] = content_type if content_type
       omit_names = ["specversion", "spec_version", "data", "datacontenttype", "data_content_type"]
@@ -228,21 +225,19 @@ module CloudEvents
       headers = {}
       body = nil
       event.to_h.each do |key, value|
-        if key == "data"
+        case key
+        when "data"
           body = value
-        elsif key == "datacontenttype"
+        when "datacontenttype"
           headers["Content-Type"] = value
         else
           headers["CE-#{key}"] = percent_encode value
         end
       end
-      if body.is_a? ::String
-        headers["Content-Type"] ||= if body.encoding == ::Encoding.ASCII_8BIT
-                                      "application/octet-stream"
-                                    else
-                                      "text/plain; charset=#{body.encoding.name.downcase}"
-                                    end
-      elsif body.nil?
+      case body
+      when ::String
+        headers["Content-Type"] ||= string_content_type body
+      when nil
         headers.delete "Content-Type"
       else
         body = ::JSON.dump body
@@ -288,5 +283,27 @@ module CloudEvents
       end
       arr.pack "C*"
     end
+
+    private
+
+    def read_with_charset io, charset
+      str = io.read
+      if charset
+        begin
+          str.force_encoding charset
+        rescue ::ArgumentError
+          # Do nothing for now if the charset is unrecognized
+        end
+      end
+      str
+    end
+
+    def string_content_type str
+      if str.encoding == ::Encoding.ASCII_8BIT
+        "application/octet-stream"
+      else
+        "text/plain; charset=#{str.encoding.name.downcase}"
+      end
+    end
   end
 end

data/lib/cloud_events/json_format.rb

@@ -137,10 +137,9 @@ module CloudEvents
       structure = event.to_h
       data = event.data
       content_type = event.data_content_type
-      if data.is_a?(::String) && !content_type.nil?
-        if content_type.subtype == "json" || content_type.subtype_format == "json"
-          structure["data"] = ::JSON.parse data rescue data
-        end
+      if data.is_a?(::String) && !content_type.nil? &&
+         (content_type.subtype == "json" || content_type.subtype_format == "json")
+        structure["data"] = ::JSON.parse data rescue data
       end
       structure
     end

data/lib/cloud_events/version.rb

@@ -5,5 +5,5 @@ module CloudEvents
   # Version of the Ruby CloudEvents SDK
   # @return [String]
   #
-  VERSION = "0.1.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud_events
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2021-04-25 00:00:00.000000000 Z
 dependencies: []
 description: The official Ruby implementation of the CloudEvents Specification. Provides
   data types for events, and HTTP/JSON bindings for marshalling and unmarshalling
@@ -28,6 +28,7 @@ files:
 - lib/cloud_events/errors.rb
 - lib/cloud_events/event.rb
 - lib/cloud_events/event/field_interpreter.rb
+- lib/cloud_events/event/utils.rb
 - lib/cloud_events/event/v0.rb
 - lib/cloud_events/event/v1.rb
 - lib/cloud_events/http_binding.rb
@@ -37,10 +38,10 @@ homepage: https://github.com/cloudevents/sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://github.com/cloudevents/sdk-ruby/blob/master/CHANGELOG.md
+  changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.3.1/file.CHANGELOG.html
   source_code_uri: https://github.com/cloudevents/sdk-ruby
   bug_tracker_uri: https://github.com/cloudevents/sdk-ruby/issues
-  documentation_uri: https://rubydoc.info/gems/cloud_events/0.1.0
+  documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.3.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -49,14 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for CloudEvents