cloud_events 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e92a0db6d57da2784f958e81f3416ade3c4c6c1e5e7830571be444c84a1001a0
-  data.tar.gz: e48bad4cf6cf8797c6f5a16817f6951a1c3b2138778fa2e6779b58fd49f28f21
+  metadata.gz: aac5d146b0b5adbac5c05de9af2e135046f0178baea94dea90005b22934c5b49
+  data.tar.gz: efce8edc6fcc07014e0183c87d955ea16ff5a44a5fac197e45a30f730981c939
 SHA512:
-  metadata.gz: 4429473d95e6150514f796a907f74a96741ab9378e2c833ed6945fbe4f5d85fe654d0bb6502960900c349721b167f90fc62994a2525a3fd372bc7ea9468c66f6
-  data.tar.gz: 91f22bf6c0b20357326166d896e0036dd90ae32f66b7c233a63cb3e060abac51827b2a9d560f6324830db2b5240e436d0f942c99a41bf8a1c711a48fe6af8d80
+  metadata.gz: 03c3c93e3ca7e49a67a8366c29f502466848a6e28f418c1ab9621f3dcc3dc050556148bab50e27109337f7bba70dc5c7ddb17e08729e79bbedd599b19f0be11c
+  data.tar.gz: d0fa89577d80fd1be5ab8d48689371a033da8b19439c24b1750b5ddc0c4d115e642bc19cc2b04f34ccca82b519f186e41f52e94a885c05a50a2387873ae1d4fb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### v0.8.2 / 2025-11-30
+
+* DOCS: Fixed a few typos in documentation and error messages
+
+### v0.8.1 / 2025-11-10
+
+* DOCS: Some minor updates and corrections to the README and examples
+
 ### v0.8.0 / 2025-11-04
 
 * BREAKING CHANGE: Raise AttributeError if an illegal attribute name is used

data/README.md

@@ -13,11 +13,11 @@ Features:
     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.1)
+    and [CloudEvents 1.0](https://github.com/cloudevents/spec/tree/v1.0.2)
     specifications.
  *  Extensible to additional formats and protocol bindings, and future
     specification versions.
- *  Compatible with Ruby 2.5 or later, or JRuby 9.2.x or later. No runtime gem
+ *  Compatible with Ruby 2.7 or later, or JRuby 9.2.x or later. No runtime gem
     dependencies.
 
 ## Quickstart
@@ -35,8 +35,10 @@ A simple [Sinatra](https://sinatrarb.com) app that receives CloudEvents:
 ```ruby
 # examples/server/Gemfile
 source "https://rubygems.org"
-gem "cloud_events", "~> 0.6"
-gem "sinatra", "~> 2.0"
+gem "cloud_events", "~> 0.8"
+gem "sinatra", "~> 4.0"
+gem "rackup"
+gem "puma"
 ```
 
 ```ruby
@@ -46,9 +48,9 @@ require "cloud_events"
 
 cloud_events_http = CloudEvents::HttpBinding.default
 
-post "/" do
-  event = cloud_events_http.decode_event request.env
-  logger.info "Received CloudEvent: #{event.to_h}"
+post("/") do
+  event = cloud_events_http.decode_event(request.env)
+  logger.info("Received CloudEvent: #{event.to_h}")
 end
 ```
 
@@ -59,7 +61,7 @@ A simple Ruby script that sends a CloudEvent:
 ```ruby
 # examples/client/Gemfile
 source "https://rubygems.org"
-gem "cloud_events", "~> 0.6"
+gem "cloud_events", "~> 0.8"
 ```
 
 ```ruby
@@ -69,17 +71,18 @@ require "net/http"
 require "uri"
 
 data = { message: "Hello, CloudEvents!" }
-event = CloudEvents::Event.create \
+event = CloudEvents::Event.create(
   spec_version:      "1.0",
   id:                "1234-1234-1234",
   source:            "/mycontext",
   type:              "com.example.someevent",
   data_content_type: "application/json",
   data:              data
+)
 
 cloud_events_http = CloudEvents::HttpBinding.default
-headers, body = cloud_events_http.encode_event event
-Net::HTTP.post URI("http://localhost:4567"), body, headers
+headers, body = cloud_events_http.encode_event(event)
+Net::HTTP.post(URI("http://localhost:4567"), body, headers)
 ```
 
 ### Putting it together
@@ -108,7 +111,8 @@ Hit `CTRL+C` to stop the server.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cloudevents/sdk-ruby.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/cloudevents/sdk-ruby.
 
 ### Development
 
@@ -145,11 +149,15 @@ 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.
+Ruby code style is enforced by Rubocop rules. We've left the configuration
+largely on the Rubocop defaults, with a few exceptions, notably:
 
-Style is enforced by Rubocop rules. You can run rubocop directly using the
+* We prefer double-quoted strings rather than single-quoted strings.
+* We prefer trailing commas in multi-line array and hash literals.
+* Line length limit is 120
+* We've loosened a few additional checks that we felt were not helpful.
+
+You can run rubocop directly using the
 `rubocop` binary:
 
 ```sh

data/RELEASING.md

@@ -22,4 +22,3 @@ locally. See `toys release request --help` and `toys release perform --help`
 for more information.
 
 If a release fails, you may need to delete the release tag before retrying.
-

data/lib/cloud_events/content_type.rb

@@ -131,7 +131,7 @@ module CloudEvents
       @subtype_base, @subtype_format = @subtype.split("+", 2)
       until str.empty?
         str = consume_special(str, ";")
-        name, str = consume_token(str, downcase: true, error_message: "Faled to parse attribute name")
+        name, str = consume_token(str, downcase: true, error_message: "Failed to parse attribute name")
         str = consume_special(str, "=", error_message: "Failed to find value for attribute #{name}")
         val, str = consume_token_or_quoted(str, error_message: "Failed to parse value for attribute #{name}")
         @params << [name, val]

data/lib/cloud_events/event/opaque.rb

@@ -8,7 +8,7 @@ module CloudEvents
     # single event or a batch of events.
     #
     # The event data is retained in a form that can be reserialized (in a
-    # structured cotent mode in the same format) but cannot otherwise be
+    # structured content mode in the same format) but cannot otherwise be
     # inspected.
     #
     # This object is immutable, and Ractor-shareable on Ruby 3.

data/lib/cloud_events/format.rb

@@ -30,7 +30,7 @@ module CloudEvents
   #
   # Both the keyword arguments recognized and the returned hash members may
   # vary from formatter to formatter; similarly, the keyword arguments provided
-  # and the resturned hash members recognized may also vary for different
+  # and the returned hash members recognized may also vary for different
   # callers. This interface will define a set of common argument and result key
   # names, but both callers and formatters must gracefully handle the case of
   # missing or extra information. For example, if a formatter expects a certain

data/lib/cloud_events/text_format.rb

@@ -37,7 +37,7 @@ module CloudEvents
     end
 
     ##
-    # Trivially an event data object using text format.
+    # Trivially encode an event data object using text format.
     # See {CloudEvents::Format#encode_data} for a general description.
     #
     # Expects `:data` and `:content_type` arguments, and will decline the

data/lib/cloud_events/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_events
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Daniel Azuma
@@ -42,10 +42,10 @@ homepage: https://github.com/cloudevents/sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.8.0/file.CHANGELOG.html
+  changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.8.2/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://cloudevents.github.io/sdk-ruby/v0.8.0
+  documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.8.2
 rdoc_options: []
 require_paths:
 - lib