cloud_events 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c1658e90d1e5d2ba5fe59cd174faf0bf1a475e14f9d910fab5a5136b13417fd
+  data.tar.gz: 19dfdc7de4c50ea3e03cb7818ed526b9bff93173be68d378c512b4c466fc14ab
+SHA512:
+  metadata.gz: 1ff3c4b897ad25aafe2a13761d862d3bca6f28d2d9d57f611f3bf2c086161c6b559d30125888654b6e543ce30ffa7bedff99c42f115871507480855264354cea
+  data.tar.gz: 35024a3f6613d3d24a71f56fe50e3dc8a3e53a53c6b79468fd3a9f61b7311b940a1bff1d6dfb63000c37bd653e96ee9007c9f4d30e201060186f6b5766fd6515

data/.yardopts

@@ -0,0 +1,11 @@
+--no-private
+--title=CloudEvents SDK
+--markup markdown
+--markup-provider redcarpet
+--main=README.md
+./lib/cloud_events/**/*.rb
+./lib/cloud_events.rb
+-
+README.md
+CHANGELOG.md
+LICENSE.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### v0.1.0 / 2020-07-08
+
+* Initial release of the Ruby SDK.

data/LICENSE.md

@@ -0,0 +1,203 @@
+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.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    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
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/README.md

@@ -0,0 +1,250 @@
+# Ruby SDK for [CloudEvents](https://github.com/cloudevents/spec)
+
+## CloudEvents Ruby SDK
+
+A [Ruby](https://ruby-lang.org) language implementation of the
+[CloudEvents specification](https://github.com/cloudevents/spec).
+
+Features:
+
+ *  Ruby classes for representing CloudEvents, including support for standard
+    and extension attributes.
+ *  Support for serializing and deserializing from JSON Structure Format and
+    JSON Batch Format.
+ *  Support for sending and receiving CloudEvents via HTTP Bindings.
+ *  Supports the [CloudEvent 0.3](https://github.com/cloudevents/spec/tree/v0.3)
+    and [CloudEvents 1.0](https://github.com/cloudevents/spec/tree/v1.0)
+    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
+    dependencies.
+
+## Quickstart
+
+Install the `cloud_events` gem or add it to your bundle.
+
+```sh
+gem install cloud_events
+```
+
+### Receiving a CloudEvent in a Sinatra app
+
+A simple [Sinatra](https://sinatrarb.com) app that receives CloudEvents:
+
+```ruby
+# examples/server/Gemfile
+source "https://rubygems.org"
+gem "cloud_events", "~> 0.1"
+gem "sinatra", "~> 2.0"
+```
+
+```ruby
+# examples/server/app.rb
+require "sinatra"
+require "cloud_events"
+
+cloud_events_http = CloudEvents::HttpBinding.default
+
+post "/" do
+  event = cloud_events_http.decode_rack_env request.env
+  logger.info "Received CloudEvent: #{event.to_h}"
+end
+```
+
+### Sending a CloudEvent
+
+A simple Ruby script that sends a CloudEvent:
+
+```ruby
+# examples/client/Gemfile
+source "https://rubygems.org"
+gem "cloud_events", "~> 0.1"
+```
+
+```ruby
+# examples/client/send.rb
+require "cloud_events"
+require "net/http"
+require "uri"
+
+data = { message: "Hello, CloudEvents!" }
+event = CloudEvents::Event.create spec_version: "1.0",
+                                  id:           "1234-1234-1234",
+                                  source:       "/mycontext",
+                                  type:         "com.example.someevent",
+                                  data:         data
+
+cloud_events_http = CloudEvents::HttpBinding.default
+headers, body = cloud_events_http.encode_binary_content event
+Net::HTTP.post URI("http://localhost:4567"), body, headers
+```
+
+### Putting it together
+
+Start the server on localhost:
+
+```sh
+cd server
+bundle install
+bundle exec ruby app.rb
+```
+
+This will run the server in the foreground and start logging to the console.
+
+In a separate terminal shell, send it an event from the client:
+
+```sh
+cd client
+bundle install
+bundle exec ruby send.rb
+```
+
+The event should be logged in the server logs.
+
+Hit `CTRL+C` to stop the server.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cloudevents/ruby-sdk.
+
+### Development
+
+After cloning the repo locally, install the bundle, and install the `toys` gem
+if you do not already have it.
+
+```sh
+bundle install
+gem install toys
+```
+
+A variety of Toys scripts are provided for running tests and builds. For
+example:
+
+```sh
+# Run the unit tests
+toys test
+
+# Run CI locally, including unit tests, doc tests, and rubocop
+toys ci
+
+# Build and install the gem locally
+toys install
+
+# Clean temporary and build files
+toys clean
+
+# List all available scripts
+toys
+
+# Show online help for the "test" script
+toys test --help
+```
+
+### Code style
+
+Ruby code in this library generally follows the
+[Google Ruby Style Guide](https://github.com/googleapis/ruby-style), which is
+based on "Seattle Style" Ruby.
+
+Style is enforced by Rubocop rules. You can run rubocop directly using the
+`rubocop` binary:
+
+```sh
+bundle exec rubocop
+```
+
+or via Toys:
+
+```sh
+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
+
+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
+few things to keep in mind.
+
+ *  **Typically a pull request should relate to an existing issue.** If you
+    have found a bug, want to add an improvement, or suggest an API change,
+    please create an issue before proceeding with a pull request. For very
+    minor changes such as typos in the documentation this isn't necessary.
+ *  **Use Conventional Commit messages.** All commit messages should follow the
+    [Conventional Commits Specification](https://conventionalcommits.org) to
+    make it clear how your change should appear in release notes.
+ *  **Sign your work.** Each PR must be signed. Be sure your git `user.name`
+    and `user.email` are configured then use the `--signoff` flag for your
+    commits. e.g. `git commit --signoff`.
+ *  **Make sure CI passes.** Invoke `toys ci` to run the tests locally before
+    opening a pull request. This will include code style checks.
+
+### Releasing
+
+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.
+
+ 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.
+
+ 3. Ensure the above changes are pushed to the GitHub master branch at
+    https://github.com/cloudevents/ruby-sdk.
+
+ 4. Execute
+
+    ```sh
+    toys release trigger $VERSION
+    ```
+
+    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.
+
+ 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.
+
+## Community
+
+ *  **Weekly meetings:** There are bi-weekly calls immediately following the
+    [Serverless/CloudEvents call](https://github.com/cloudevents/spec#meeting-time)
+    at 9am PT (US Pacific). Which means they will typically start at 10am PT,
+    but if the other call ends early then the SDK call will start early as
+    well. See the
+    [CloudEvents meeting minutes](https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit)
+    to determine which week will have the call.
+
+ *  **Slack:** The `#cloudeventssdk` channel under
+    [CNCF's Slack workspace](https://slack.cncf.io/).
+
+ *  **Email:** https://lists.cncf.io/g/cncf-cloudevents-sdk
+
+ *  For additional information, contact Daniel Azuma (`@dazuma` on Slack).
+
+## Licensing
+
+    Copyright 2020 Google LLC and the CloudEvents Ruby SDK Contributors
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this software except in compliance with the License.
+    You may obtain a copy of the License at
+
+        https://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,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.