cloud_events 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 352989599792500818d6a7f57d28c131e88abd43f34eadda1a2533ef1407bf0c
-  data.tar.gz: edb587ea833390c5ecaeccf17dcf19c17cf5347d4928473deced3830a192433b
+  metadata.gz: 561f1577a53c99db91573da43e0caa899add4388169a8c4784910dbfb3ae94d7
+  data.tar.gz: eb936cd23fbbd2b2658ec8a5c52ad5857c50b8f81019e15f341bdeb89346d037
 SHA512:
-  metadata.gz: a45bae8560267d2f40212f193b2847c24302659699350a06def41c46d4d31a748e3459ef2073d66d9cbca5520598b834c2ddb020507cefd7db45c1b80ccb4ad9
-  data.tar.gz: cc19771ab81fed83130ca8114685251a3c9b814490a2232dd903cd6b1d9a4271be23258bdf174723cdeabe86df5c74cba05f511066d75ed92c9a1a19a7a1d72f
+  metadata.gz: 0c702c7b33d247b38c9ef8c46dc0d0ef3253d5ffe5d6e8ba7ba6043a0d0f597b748c40514bbe94f0836c150d5f7336e67005f550bbabe6ecfefd73b6f9925ff0
+  data.tar.gz: f765051aec3c216b36eafdd082f771701d8647d7c4cead2489a61370fb598390fb5d7f43b138a7ab0af91a039d4a88e36c9f4897e91d37650220b474260c9d3d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### 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

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

data/lib/cloud_events/content_type.rb

@@ -140,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
@@ -203,7 +203,7 @@ module CloudEvents
     end
 
     def maybe_quote str
-      return str if /^[\w!#\$%&'\*\+\.\^`\{\|\}-]+$/ =~ str
+      return str if /^[\w!#$%&'*+.\^`{|}-]+$/ =~ str
       str = str.gsub("\\", "\\\\\\\\").gsub("\"", "\\\\\"")
       "\"#{str}\""
     end

data/lib/cloud_events/event/field_interpreter.rb

@@ -1,15 +1,16 @@
 # 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
 
@@ -26,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}:" \
@@ -40,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"
@@ -58,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"
@@ -79,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
@@ -94,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}:" \
@@ -102,8 +105,17 @@ module CloudEvents
         end
       end
 
+      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
         keys.each do |key|
@@ -115,44 +127,10 @@ module CloudEvents
           raise AttributeError, "The #{keys.first} field is required" if required
           return nil
         end
-        if block_given?
-          converted, raw = yield value
-          deep_freeze converted
-        else
-          converted = raw = value
-        end
-        @attributes[keys.first.freeze] = raw.freeze
+        converted, raw = yield value
+        @attributes[keys.first.freeze] = raw
         converted
       end
-
-      private
-
-      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 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
     ##
@@ -43,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.)
@@ -74,7 +77,7 @@ 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"]
@@ -112,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]
       #
@@ -121,12 +126,12 @@ module CloudEvents
 
       ##
       # Return a hash representation of this event. The returned hash is an
-      # unfrozen copy. Modifications do not affect the original event.
+      # unfrozen deep copy. Modifications do not affect the original event.
       #
       # @return [Hash]
       #
       def to_h
-        @attributes.dup
+        Utils.deep_dup @attributes
       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
     ##
@@ -43,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.)
@@ -71,7 +74,7 @@ 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"]
@@ -108,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]
       #
@@ -117,12 +122,12 @@ module CloudEvents
 
       ##
       # Return a hash representation of this event. The returned hash is an
-      # unfrozen copy. Modifications do not affect the original event.
+      # unfrozen deep copy. Modifications do not affect the original event.
       #
       # @return [Hash]
       #
       def to_h
-        @attributes.dup
+        Utils.deep_dup @attributes
       end
 
       ##

data/lib/cloud_events/http_binding.rb

@@ -228,21 +228,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 +286,15 @@ module CloudEvents
       end
       arr.pack "C*"
     end
+
+    private
+
+    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.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud_events
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-02 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://cloudevents.github.io/sdk-ruby/v0.2.0/file.CHANGELOG.html
+  changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.3.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.2.0
+  documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.3.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -49,7 +50,7 @@ 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:
   - - ">="