cloud_events 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a711fe27eaab25a87e694f6436b2c34506b3a776457a77583c3f0f4bb0744ed
-  data.tar.gz: 01e81b176023ca2369999d2257c3157d4cef267ff0951e09a2df09f2848af0f5
+  metadata.gz: 716373fdabd76c9559f81defb7af5c8e8f460a1cb71d6b3ac51df1b2a90217e5
+  data.tar.gz: 3960c652157b7d9ee652112d840ae4c2ae5cf2e4f8490b8334b62578847007ad
 SHA512:
-  metadata.gz: 96e2b1892b58bd5944d506ffff3e30a899fcb1bc03c31018637788cc8772def582e258b31f35786ebad8d054f22bfcbf2fdbe98e573ff098c2f89e2d8da4e1a0
-  data.tar.gz: e058c5c54f57224d02d42c9f52d7a320ef319b72573aa0d162f2362e06a0294bdd1f81f7705d55f47b40d8eadf418de85efb09c68c797978fcf0e5b49c91c1f4
+  metadata.gz: 8053f2c1f19ca50cab810d6c5b80982e72e3ffcff3f578ac2a65243243255508739e1653c91e4b9caa7688fe552eec87479634c8fdaececf5855928eb12232e4
+  data.tar.gz: d30dc5cde096d2d8f0a4f439d576efcd73bcffb2ba880930bffd14ea4c118f55520cc3ffa98b6d0d1ece942ee0ecdbf0be9e1eb73c4a629858d086a6a24d4fe6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v0.9.0 / 2026-03-12
+
+* ADDED: Added an implementation of Kafka Binding
+
 ### v0.8.3 / 2026-01-15
 
 * FIXED: Fixed default charset behavior for various non-text/plain content types

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                  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]
+
+    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
+
+       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,
+    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/lib/cloud_events/errors.rb

@@ -51,6 +51,14 @@ module CloudEvents
   class AttributeError < CloudEventsError
   end
 
+  ##
+  # An error raised when a protocol binding that does not support batch
+  # content mode receives a batch. For example, the Kafka protocol binding
+  # does not support batches per the CloudEvents spec.
+  #
+  class BatchNotSupportedError < CloudEventsError
+  end
+
   ##
   # Alias of UnsupportedFormatError, for backward compatibility.
   #

data/lib/cloud_events/kafka_binding.rb

@@ -0,0 +1,364 @@
+# frozen_string_literal: true
+
+module CloudEvents
+  ##
+  # Kafka protocol binding for CloudEvents.
+  #
+  # This class implements the Kafka protocol binding, including decoding of
+  # events from Kafka message hashes, and encoding of events to Kafka message
+  # hashes. It supports binary (header-based) and structured (body-based)
+  # content modes that can delegate to formatters such as JSON.
+  #
+  # Supports CloudEvents 1.0 only.
+  # See https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/kafka-protocol-binding.md.
+  #
+  # Kafka messages are represented as plain Ruby Hashes with the keys:
+  # - `key:` [String, nil] — the Kafka record key
+  # - `value:` [String, nil] — the Kafka record value (body)
+  # - `headers:` [Hash] — String => String header pairs
+  #
+  class KafkaBinding
+    ##
+    # The name of the JSON decoder/encoder.
+    # @return [String]
+    #
+    JSON_FORMAT = "json"
+
+    ##
+    # The default key mapper for encoding.
+    # Returns the `partitionkey` extension attribute from the event.
+    # @return [Proc]
+    #
+    DEFAULT_KEY_MAPPER = ->(event) { event["partitionkey"] }
+
+    ##
+    # The default reverse key mapper for decoding.
+    # Sets the `partitionkey` extension attribute from the Kafka record key.
+    # Returns an empty hash if the key is nil.
+    # @return [Proc]
+    #
+    DEFAULT_REVERSE_KEY_MAPPER = ->(key) { key.nil? ? {} : { "partitionkey" => key } }
+
+    ##
+    # Returns a default Kafka binding, including support for JSON format.
+    #
+    # @return [KafkaBinding]
+    #
+    def self.default
+      @default ||= begin
+        kafka_binding = new
+        kafka_binding.register_formatter(JsonFormat.new, encoder_name: JSON_FORMAT)
+        kafka_binding.default_encoder_name = JSON_FORMAT
+        kafka_binding
+      end
+    end
+
+    ##
+    # Create an empty Kafka binding.
+    #
+    # @param key_mapper [Proc,nil] A callable `(event) -> String|nil` used
+    #     to derive the Kafka record key when encoding. Defaults to
+    #     {DEFAULT_KEY_MAPPER}. Set to `nil` to always produce a `nil` key.
+    # @param reverse_key_mapper [Proc,nil] A callable `(key) -> Hash` used
+    #     to derive attributes to merge into the event when decoding.
+    #     Defaults to {DEFAULT_REVERSE_KEY_MAPPER}. Set to `nil` to skip
+    #     key-to-attribute mapping.
+    #
+    def initialize(key_mapper: DEFAULT_KEY_MAPPER, reverse_key_mapper: DEFAULT_REVERSE_KEY_MAPPER)
+      @key_mapper = key_mapper
+      @reverse_key_mapper = reverse_key_mapper
+      @event_decoders = Format::Multi.new do |result|
+        result&.key?(:event) ? result : nil
+      end
+      @event_encoders = {}
+      @data_decoders = Format::Multi.new do |result|
+        result&.key?(:data) && result.key?(:content_type) ? result : nil
+      end
+      @data_encoders = Format::Multi.new do |result|
+        result&.key?(:content) && result.key?(:content_type) ? result : nil
+      end
+      text_format = TextFormat.new
+      @data_decoders.formats.replace([text_format, HttpBinding::DefaultDataFormat])
+      @data_encoders.formats.replace([text_format, HttpBinding::DefaultDataFormat])
+      @default_encoder_name = nil
+    end
+
+    ##
+    # Register a formatter for all operations it supports, based on which
+    # methods are implemented by the formatter object. See
+    # {CloudEvents::Format} for a list of possible methods.
+    #
+    # @param formatter [Object] The formatter.
+    # @param encoder_name [String] The encoder name under which this
+    #     formatter will register its encode operations. Optional. If not
+    #     specified, any event encoder will _not_ be registered.
+    # @return [self]
+    #
+    def register_formatter(formatter, encoder_name: nil)
+      encoder_name = encoder_name.to_s.strip.downcase if encoder_name
+      decode_event = formatter.respond_to?(:decode_event)
+      encode_event = encoder_name if formatter.respond_to?(:encode_event)
+      decode_data = formatter.respond_to?(:decode_data)
+      encode_data = formatter.respond_to?(:encode_data)
+      register_formatter_methods(formatter,
+                                 decode_event: decode_event,
+                                 encode_event: encode_event,
+                                 decode_data: decode_data,
+                                 encode_data: encode_data)
+      self
+    end
+
+    ##
+    # Registers the given formatter for the given operations. Some arguments
+    # are activated by passing `true`, whereas those that rely on a format
+    # name are activated by passing in a name string.
+    #
+    # @param formatter [Object] The formatter.
+    # @param decode_event [boolean] If true, register the formatter's
+    #     {CloudEvents::Format#decode_event} method.
+    # @param encode_event [String] If set to a string, use the formatter's
+    #     {CloudEvents::Format#encode_event} method when that name is
+    #     requested.
+    # @param decode_data [boolean] If true, register the formatter's
+    #     {CloudEvents::Format#decode_data} method.
+    # @param encode_data [boolean] If true, register the formatter's
+    #     {CloudEvents::Format#encode_data} method.
+    # @return [self]
+    #
+    def register_formatter_methods(formatter,
+                                   decode_event: false,
+                                   encode_event: nil,
+                                   decode_data: false,
+                                   encode_data: false)
+      @event_decoders.formats.unshift(formatter) if decode_event
+      if encode_event
+        encoders = @event_encoders[encode_event] ||= Format::Multi.new do |result|
+          result&.key?(:content) && result.key?(:content_type) ? result : nil
+        end
+        encoders.formats.unshift(formatter)
+      end
+      @data_decoders.formats.unshift(formatter) if decode_data
+      @data_encoders.formats.unshift(formatter) if encode_data
+      self
+    end
+
+    ##
+    # The name of the encoder to use if none is specified.
+    #
+    # @return [String,nil]
+    #
+    attr_accessor :default_encoder_name
+
+    ##
+    # Determine whether a Kafka message is likely a CloudEvent, by
+    # inspecting headers only (does not parse the value).
+    #
+    # @param message [Hash] The Kafka message hash.
+    # @return [boolean]
+    #
+    def probable_event?(message)
+      headers = message[:headers] || {}
+      return true if headers.key?("ce_specversion")
+      content_type_string = headers["content-type"]
+      return false unless content_type_string
+      content_type = ContentType.new(content_type_string)
+      content_type.media_type == "application" && content_type.subtype_base == "cloudevents"
+    end
+
+    ##
+    # Decode an event from a Kafka message hash.
+    #
+    # @param message [Hash] A hash with `:key`, `:value`, and `:headers` keys.
+    # @param allow_opaque [boolean] If true, returns {Event::Opaque} for
+    #     unrecognized structured formats. Default is false.
+    # @param reverse_key_mapper [Proc,nil,:NOT_SET] A callable
+    #     `(key) -> Hash`, or `nil` to skip key mapping. Defaults to the
+    #     instance's reverse_key_mapper.
+    # @param format_args [keywords] Extra args forwarded to formatters.
+    # @return [CloudEvents::Event] The decoded event.
+    # @raise [NotCloudEventError] if the message is not a CloudEvent.
+    # @raise [SpecVersionError] if the specversion is not supported.
+    # @raise [UnsupportedFormatError] if a structured format is not recognized.
+    # @raise [FormatSyntaxError] if the structured content is malformed.
+    #
+    def decode_event(message, allow_opaque: false, reverse_key_mapper: :NOT_SET, **format_args)
+      reverse_key_mapper = @reverse_key_mapper if reverse_key_mapper == :NOT_SET
+      headers = message[:headers] || {}
+      content_type_string = headers["content-type"]
+      content_type = ContentType.new(content_type_string) if content_type_string
+
+      event = decode_content(message, headers, content_type, content_type_string, allow_opaque, **format_args)
+      apply_reverse_key_mapper(event, message[:key], reverse_key_mapper)
+    end
+
+    ##
+    # Encode an event into a Kafka message hash.
+    #
+    # @param event [CloudEvents::Event,CloudEvents::Event::Opaque] The event.
+    # @param structured_format [boolean,String] If false (default), encodes
+    #     in binary content mode. If true or a format name string, encodes
+    #     in structured content mode.
+    # @param key_mapper [Proc,nil,:NOT_SET] A callable
+    #     `(event) -> String|nil`, or `nil` to always produce a `nil` key.
+    #     Defaults to the instance's key_mapper.
+    # @param format_args [keywords] Extra args forwarded to formatters.
+    # @return [Hash] A hash with `:key`, `:value`, and `:headers` keys.
+    #
+    def encode_event(event, structured_format: false, key_mapper: :NOT_SET, **format_args)
+      key_mapper = @key_mapper if key_mapper == :NOT_SET
+      if event.is_a?(Event::Opaque)
+        return encode_opaque_event(event)
+      end
+      unless event.respond_to?(:spec_version)
+        raise(SpecVersionError, "Unable to determine specversion")
+      end
+      unless event.spec_version.start_with?("1.")
+        raise(SpecVersionError, "Unrecognized specversion: #{event.spec_version}")
+      end
+      if structured_format
+        encode_structured_event(event, structured_format, key_mapper, **format_args)
+      else
+        encode_binary_event(event, key_mapper, **format_args)
+      end
+    end
+
+    # @private
+    OMIT_ATTR_NAMES = ["specversion", "spec_version", "data", "datacontenttype", "data_content_type"].freeze
+
+    private
+
+    # Detect content mode, reject batches, and dispatch to the appropriate
+    # binary or structured decoder. Raises if the message is not a CloudEvent.
+    def decode_content(message, headers, content_type, content_type_string, allow_opaque, **format_args)
+      if content_type&.media_type == "application" && content_type.subtype_base == "cloudevents-batch"
+        raise(BatchNotSupportedError, "Kafka protocol binding does not support batch content mode")
+      end
+      if content_type&.media_type == "application" && content_type.subtype_base == "cloudevents"
+        return decode_structured_content(message, content_type, allow_opaque, **format_args)
+      end
+      if headers.key?("ce_specversion")
+        return decode_binary_content(message, content_type, **format_args)
+      end
+      ct_desc = content_type_string ? content_type_string.inspect : "not present"
+      raise(NotCloudEventError, "content-type is #{ct_desc}, and ce_specversion header is not present")
+    end
+
+    # Decode a single event from binary content mode. Reads ce_* headers as
+    # attributes and the message value as event data.
+    def decode_binary_content(message, content_type, **format_args)
+      headers = message[:headers] || {}
+      spec_version = headers["ce_specversion"]
+      raise(SpecVersionError, "Unrecognized specversion: #{spec_version}") unless spec_version =~ /^1(\.|$)/
+      attributes = { "spec_version" => spec_version }
+      headers.each do |key, value|
+        next unless key.start_with?("ce_")
+        attr_name = key[3..].downcase
+        attributes[attr_name] = value unless OMIT_ATTR_NAMES.include?(attr_name)
+      end
+      value = message[:value]
+      unless value.nil?
+        content_type = populate_data_attributes(attributes, value, content_type, spec_version, format_args)
+      end
+      attributes["data_content_type"] = content_type if content_type
+      Event.create(spec_version: spec_version, set_attributes: attributes)
+    end
+
+    # Populate data-related attributes (data_encoded, data, data_content_type)
+    # by running the value through registered data decoders. Returns the
+    # (possibly updated) content_type.
+    def populate_data_attributes(attributes, value, content_type, spec_version, format_args)
+      attributes["data_encoded"] = value
+      result = @data_decoders.decode_data(spec_version: spec_version,
+                                          content: value,
+                                          content_type: content_type,
+                                          **format_args)
+      if result
+        attributes["data"] = result[:data]
+        content_type = result[:content_type]
+      end
+      content_type
+    end
+
+    # Decode a single event from structured content mode. Delegates to
+    # registered event decoders, falling back to Event::Opaque if allowed.
+    def decode_structured_content(message, content_type, allow_opaque, **format_args)
+      content = message[:value].to_s
+      result = @event_decoders.decode_event(content: content,
+                                            content_type: content_type,
+                                            data_decoder: @data_decoders,
+                                            **format_args)
+      if result
+        event = result[:event]
+        raise(SpecVersionError, "Unable to determine specversion") unless event.respond_to?(:spec_version)
+        unless event.spec_version.start_with?("1.")
+          raise(SpecVersionError, "Unrecognized specversion: #{event.spec_version}")
+        end
+        return event
+      end
+      return Event::Opaque.new(content, content_type) if allow_opaque
+      raise(UnsupportedFormatError, "Unknown cloudevents content type: #{content_type}")
+    end
+
+    # Apply the reverse_key_mapper to merge Kafka record key attributes into
+    # the decoded event. Returns the event unchanged if the mapper is nil or
+    # returns an empty hash.
+    def apply_reverse_key_mapper(event, key, reverse_key_mapper)
+      return event unless reverse_key_mapper
+      mapped_attrs = reverse_key_mapper.call(key)
+      return event if mapped_attrs.nil? || mapped_attrs.empty?
+      event.with(**mapped_attrs.transform_keys(&:to_sym))
+    end
+
+    # Encode an event in binary content mode. Writes attributes as ce_*
+    # headers and event data as the message value.
+    def encode_binary_event(event, key_mapper, **format_args)
+      key = key_mapper&.call(event)
+      headers = {}
+      event.to_h.each do |attr_key, value|
+        next if ["data", "data_encoded", "datacontenttype"].include?(attr_key)
+        headers["ce_#{attr_key}"] = value.to_s
+      end
+      body, content_type = extract_event_data(event, format_args)
+      headers["content-type"] = content_type.to_s if content_type
+      { key: key, value: body, headers: headers }
+    end
+
+    # Encode an event in structured content mode using a named format encoder.
+    # The entire event is serialized into the message value.
+    def encode_structured_event(event, structured_format, key_mapper, **format_args)
+      key = key_mapper&.call(event)
+      structured_format = default_encoder_name if structured_format == true
+      raise(::ArgumentError, "Format name not specified, and no default is set") unless structured_format
+      result = @event_encoders[structured_format]&.encode_event(event: event,
+                                                                data_encoder: @data_encoders,
+                                                                **format_args)
+      raise(::ArgumentError, "Unknown format name: #{structured_format.inspect}") unless result
+      { key: key, value: result[:content], headers: { "content-type" => result[:content_type].to_s } }
+    end
+
+    # Encode an opaque event by passing through its content and content_type
+    # directly, with a nil key.
+    def encode_opaque_event(event)
+      { key: nil, value: event.content, headers: { "content-type" => event.content_type.to_s } }
+    end
+
+    # Extract the event data and content type for binary mode encoding.
+    # Uses data_encoded if present, otherwise delegates to data encoders.
+    # Returns [body, content_type], where body is nil for tombstones.
+    def extract_event_data(event, format_args)
+      body = event.data_encoded
+      if body
+        [body, event.data_content_type]
+      elsif event.data?
+        result = @data_encoders.encode_data(spec_version: event.spec_version,
+                                            data: event.data,
+                                            content_type: event.data_content_type,
+                                            **format_args)
+        raise(UnsupportedFormatError, "Could not encode data content-type") unless result
+        [result[:content], result[:content_type]]
+      else
+        [nil, nil]
+      end
+    end
+  end
+end

data/lib/cloud_events/version.rb

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

data/lib/cloud_events.rb

@@ -5,6 +5,7 @@ require "cloud_events/errors"
 require "cloud_events/event"
 require "cloud_events/format"
 require "cloud_events/http_binding"
+require "cloud_events/kafka_binding"
 require "cloud_events/json_format"
 require "cloud_events/text_format"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_events
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Daniel Azuma
@@ -21,6 +21,7 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- LICENSE
 - MAINTAINERS.md
 - README.md
 - RELEASING.md
@@ -36,16 +37,17 @@ files:
 - lib/cloud_events/format.rb
 - lib/cloud_events/http_binding.rb
 - lib/cloud_events/json_format.rb
+- lib/cloud_events/kafka_binding.rb
 - lib/cloud_events/text_format.rb
 - lib/cloud_events/version.rb
 homepage: https://github.com/cloudevents/sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.8.3/file.CHANGELOG.html
+  changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.9.0/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.3
+  documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.9.0
 rdoc_options: []
 require_paths:
 - lib