cloud_events 0.1.0

data/lib/cloud_events/json_format.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+
+module CloudEvents
+  ##
+  # An implementation of JSON format and JSON batch format.
+  #
+  # Supports the CloudEvents 0.3 and CloudEvents 1.0 variants of this format.
+  # See https://github.com/cloudevents/spec/blob/v0.3/json-format.md and
+  # https://github.com/cloudevents/spec/blob/v1.0/json-format.md.
+  #
+  class JsonFormat
+    ##
+    # Decode an event from the given input JSON string.
+    #
+    # @param json [String] A JSON-formatted string
+    # @return [CloudEvents::Event]
+    #
+    def decode json, **_other_kwargs
+      structure = ::JSON.parse json
+      decode_hash_structure structure
+    end
+
+    ##
+    # Encode an event to a JSON string.
+    #
+    # @param event [CloudEvents::Event] An input event.
+    # @param sort [boolean] Whether to sort keys of the JSON output.
+    # @return [String] The JSON representation.
+    #
+    def encode event, sort: false, **_other_kwargs
+      structure = encode_hash_structure event
+      structure = sort_keys structure if sort
+      ::JSON.dump structure
+    end
+
+    ##
+    # Decode a batch of events from the given input string.
+    #
+    # @param json [String] A JSON-formatted string
+    # @return [Array<CloudEvents::Event>]
+    #
+    def decode_batch json, **_other_kwargs
+      structure_array = Array(::JSON.parse(json))
+      structure_array.map do |structure|
+        decode_hash_structure structure
+      end
+    end
+
+    ##
+    # Encode a batch of event to a JSON string.
+    #
+    # @param events [Array<CloudEvents::Event>] An array of input events.
+    # @param sort [boolean] Whether to sort keys of the JSON output.
+    # @return [String] The JSON representation.
+    #
+    def encode_batch events, sort: false, **_other_kwargs
+      structure_array = Array(events).map do |event|
+        structure = encode_hash_structure event
+        sort ? sort_keys(structure) : structure
+      end
+      ::JSON.dump structure_array
+    end
+
+    ##
+    # Decode a single event from a hash data structure with keys and types
+    # conforming to the JSON envelope.
+    #
+    # @param structure [Hash] An input hash.
+    # @return [CloudEvents::Event]
+    #
+    def decode_hash_structure structure
+      spec_version = structure["specversion"].to_s
+      case spec_version
+      when "0.3"
+        decode_hash_structure_v0 structure
+      when /^1(\.|$)/
+        decode_hash_structure_v1 structure
+      else
+        raise SpecVersionError, "Unrecognized specversion: #{spec_version}"
+      end
+    end
+
+    ##
+    # Encode a single event to a hash data structure with keys and types
+    # conforming to the JSON envelope.
+    #
+    # @param event [CloudEvents::Event] An input event.
+    # @return [String] The hash structure.
+    #
+    def encode_hash_structure event
+      case event
+      when Event::V0
+        encode_hash_structure_v0 event
+      when Event::V1
+        encode_hash_structure_v1 event
+      else
+        raise SpecVersionError, "Unrecognized specversion: #{event.spec_version}"
+      end
+    end
+
+    private
+
+    def sort_keys hash
+      result = {}
+      hash.keys.sort.each do |key|
+        result[key] = hash[key]
+      end
+      result
+    end
+
+    def decode_hash_structure_v0 structure
+      data = structure["data"]
+      content_type = structure["datacontenttype"]
+      if data.is_a?(::String) && content_type.is_a?(::String)
+        content_type = ContentType.new content_type
+        if content_type.subtype == "json" || content_type.subtype_format == "json"
+          structure = structure.dup
+          structure["data"] = ::JSON.parse data rescue data
+          structure["datacontenttype"] = content_type
+        end
+      end
+      Event::V0.new attributes: structure
+    end
+
+    def decode_hash_structure_v1 structure
+      if structure.key? "data_base64"
+        structure = structure.dup
+        structure["data"] = ::Base64.decode64 structure.delete "data_base64"
+      end
+      Event::V1.new attributes: structure
+    end
+
+    def encode_hash_structure_v0 event
+      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
+      end
+      structure
+    end
+
+    def encode_hash_structure_v1 event
+      structure = event.to_h
+      data = structure["data"]
+      if data.is_a?(::String) && data.encoding == ::Encoding::ASCII_8BIT
+        structure.delete "data"
+        structure["data_base64"] = ::Base64.encode64 data
+      end
+      structure
+    end
+  end
+end

data/lib/cloud_events/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CloudEvents
+  ##
+  # Version of the Ruby CloudEvents SDK
+  # @return [String]
+  #
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: cloud_events
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Azuma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-08 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
+  event data.
+email:
+- dazuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/cloud_events.rb
+- lib/cloud_events/content_type.rb
+- lib/cloud_events/errors.rb
+- lib/cloud_events/event.rb
+- lib/cloud_events/event/field_interpreter.rb
+- lib/cloud_events/event/v0.rb
+- lib/cloud_events/event/v1.rb
+- lib/cloud_events/http_binding.rb
+- lib/cloud_events/json_format.rb
+- lib/cloud_events/version.rb
+homepage: https://github.com/cloudevents/sdk-ruby
+licenses:
+- Apache-2.0
+metadata:
+  changelog_uri: https://github.com/cloudevents/sdk-ruby/blob/master/CHANGELOG.md
+  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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for CloudEvents
+test_files: []