functions_framework 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 817129c1773079fed039152996a18e91a054241940b8d6e3437cb66e10046304
-  data.tar.gz: ff3f61597726b60241e8b528ef520641fa3f08ddb7adcdfb32f9413fcb125f45
+  metadata.gz: 370556a72cd31e4d24499b0715ca7f96a0598cb856fb28fed3d3eaabee0a80ae
+  data.tar.gz: 04a24cf1e2f205fe124eb0bda891f647177b93c43ba1c2286ed52ffbad18cb1d
 SHA512:
-  metadata.gz: 7396117d6e94bec87c70c697c7364b9256c7575f61c7259eb25df65694e9627b6c33a93e0caaea5d9d7955707e731eaddc27b90d4595f0029d181fc6cc18bfdf
-  data.tar.gz: 8eb929ace2a49ae764f5de0fef6dd7e0d668c80864368ad2379d0e52a89a44c7a3514e92dc02802d940374808a271a89f3076f1c8f3d0a532204118615e0c1af
+  metadata.gz: 34d91fa0417632a253ddba1db7aa85f54697eb645caaaf96c9253a36fca241bca80bf17a40796dd5c8521d2c7bbe04ff23353764491d28b5e4335e0ee022f05a
+  data.tar.gz: 0d8d59ef3e45d3980136d7015e8066052bffe3942c442f715368dcf6ac5dd98b0cb282c313fa1a387ac70514747701e75c879c549faa9802444fe6b4d56115c7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v0.5.0 / 2020-07-09
+
+* Removed embedded CloudEvents classes and added the official CloudEvents SDK as a dependency. A `FunctionsFramework::CloudEvents` alias provides backward compatibility.
+
 ### v0.4.1 / 2020-07-08
 
 * Fixed unsupported signal error on Windows.

data/README.md

@@ -60,7 +60,7 @@ Create a `Gemfile` listing the Functions Framework as a dependency:
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.4"
+gem "functions_framework", "~> 0.5"
 ```
 
 Create a file called `app.rb` and include the following code. This defines a

data/docs/overview.md

@@ -64,7 +64,7 @@ Create a `Gemfile` listing the Functions Framework as a dependency:
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.4"
+gem "functions_framework", "~> 0.5"
 ```
 
 Create a file called `app.rb` and include the following code. This defines a

data/docs/writing-functions.md

@@ -112,7 +112,7 @@ dependency on Sinatra in your `Gemfile`:
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.4"
+gem "functions_framework", "~> 0.5"
 gem "sinatra", "~> 2.0"
 ```
 
@@ -158,9 +158,9 @@ end
 ```
 
 The event parameter will be either a
-[CloudEvents V0.3 Event](https://rubydoc.info/gems/functions_framework/FunctionsFramework/CloudEvents/Event/V0)
+[CloudEvents V0.3 Event](https://rubydoc.info/gems/cloud_events/CloudEvents/Event/V0)
 object ([see spec](https://github.com/cloudevents/spec/blob/v0.3/spec.md)) or a
-[CloudEvents V1.0 Event](https://rubydoc.info/gems/functions_framework/FunctionsFramework/CloudEvents/Event/V1)
+[CloudEvents V1.0 Event](https://rubydoc.info/gems/cloud_events/CloudEvents/Event/V1)
 object ([see spec](https://github.com/cloudevents/spec/blob/v1.0/spec.md)).
 
 Some Google Cloud services send events in a legacy event format that was defined
@@ -236,7 +236,7 @@ A simple project might look like this:
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.4"
+gem "functions_framework", "~> 0.5"
 ```
 
 ```ruby

data/lib/functions_framework.rb

@@ -14,7 +14,8 @@
 
 require "logger"
 
-require "functions_framework/cloud_events"
+require "cloud_events"
+
 require "functions_framework/function"
 require "functions_framework/legacy_event_converter"
 require "functions_framework/registry"
@@ -44,10 +45,6 @@ require "functions_framework/version"
 #
 # Here is a roadmap to the internal modules in the Ruby functions framework.
 #
-#  *  {FunctionsFramework::CloudEvents} provides an implementation of the
-#     [CloudEvents](https://cloudevents.io) specification. In particular, if
-#     you define an event function, you will receive the event as a
-#     {FunctionsFramework::CloudEvents::Event} object.
 #  *  {FunctionsFramework::CLI} is the implementation of the
 #     `functions-framework-ruby` executable. Most apps will not need to interact
 #     with this class directly.
@@ -94,6 +91,12 @@ module FunctionsFramework
   #
   DEFAULT_SOURCE = "./app.rb".freeze
 
+  ##
+  # The CloudEvents implementation was extracted to become the official
+  # CloudEvents SDK. This alias is left here for backward compatibility.
+  #
+  CloudEvents = ::CloudEvents
+
   class << self
     ##
     # The "global" registry that holds events defined by the
@@ -144,7 +147,8 @@ module FunctionsFramework
     #
     # You must provide a name for the function, and a block that implemets the
     # function. The block should take one argument: the event object of type
-    # {FunctionsFramework::CloudEvents::Event}. Any return value is ignored.
+    # [`CloudEvents::Event`](https://rubydoc.info/gems/cloud_events/CloudEvents/Event).
+    # Any return value is ignored.
     #
     # ## Example
     #

data/lib/functions_framework/function.rb

@@ -23,8 +23,9 @@ module FunctionsFramework
   # `Rack::Request` argument and returns one of various HTTP response types.
   # See {FunctionsFramework::Registry.add_http}. For a function of type
   # `:cloud_event`, the `call` method takes a single
-  # {FunctionsFramework::CloudEvents::Event CloudEvent} argument, and does not
-  # return a value. See {FunctionsFramework::Registry.add_cloud_event}.
+  # [CloudEvent](https://rubydoc.info/gems/cloud_events/CloudEvents/Event)
+  # argument, and does not return a value.
+  # See {FunctionsFramework::Registry.add_cloud_event}.
   #
   # If a callable object is provided directly, its `call` method is invoked for
   # every function execution. Note that this means it may be called multiple

data/lib/functions_framework/legacy_event_converter.rb

@@ -23,12 +23,11 @@ module FunctionsFramework
     # Decode an event from the given Rack environment hash.
     #
     # @param env [Hash] The Rack environment
-    # @return [FunctionsFramework::CloudEvents::Event] if the request could
-    #     be converted
+    # @return [::CloudEvents::Event] if the request could be converted
     # @return [nil] if the event format was not recognized.
     #
     def decode_rack_env env
-      content_type = CloudEvents::ContentType.new env["CONTENT_TYPE"]
+      content_type = ::CloudEvents::ContentType.new env["CONTENT_TYPE"]
       return nil unless content_type.media_type == "application" && content_type.subtype_base == "json"
       input = read_input_json env["rack.input"], content_type.charset
       return nil unless input
@@ -85,14 +84,14 @@ module FunctionsFramework
       return nil unless type && source
       ce_data = convert_data context[:service], data
       content_type = "application/json; charset=#{charset}"
-      CloudEvents::Event.new id:                context[:id],
-                             source:            source,
-                             type:              type,
-                             spec_version:      "1.0",
-                             data_content_type: content_type,
-                             data:              ce_data,
-                             subject:           subject,
-                             time:              context[:timestamp]
+      ::CloudEvents::Event.new id:                context[:id],
+                               source:            source,
+                               type:              type,
+                               spec_version:      "1.0",
+                               data_content_type: content_type,
+                               data:              ce_data,
+                               subject:           subject,
+                               time:              context[:timestamp]
     end
 
     def convert_source service, resource

data/lib/functions_framework/registry.rb

@@ -80,7 +80,8 @@ module FunctionsFramework
     #
     # You must provide a name for the function, and a block that implemets the
     # function. The block should take _one_ argument: the event object of type
-    # {FunctionsFramework::CloudEvents::Event}. Any return value is ignored.
+    # [`CloudEvents::Event`](https://rubydoc.info/gems/cloud_events/CloudEvents/Event).
+    # Any return value is ignored.
     #
     # @param name [String] The function name
     # @param block [Proc] The function code as a proc

data/lib/functions_framework/server.rb

@@ -344,7 +344,7 @@ module FunctionsFramework
           string_response response, "text/plain", 200
         when ::Hash
           string_response ::JSON.dump(response), "application/json", 200
-        when CloudEvents::CloudEventsError
+        when ::CloudEvents::CloudEventsError
           cloud_events_error_response response
         when ::StandardError
           error_response "#{response.class}: #{response.message}\n#{response.backtrace}\n"
@@ -405,7 +405,7 @@ module FunctionsFramework
       def initialize function, config
         super config
         @function = function
-        @cloud_events = CloudEvents::HttpBinding.default
+        @cloud_events = ::CloudEvents::HttpBinding.default
         @legacy_events = LegacyEventConverter.new
       end
 
@@ -415,11 +415,11 @@ module FunctionsFramework
         event = decode_event env
         response =
           case event
-          when CloudEvents::Event
+          when ::CloudEvents::Event
             handle_cloud_event event, logger
           when ::Array
-            CloudEvents::HttpContentError.new "Batched CloudEvents are not supported"
-          when CloudEvents::CloudEventsError
+            ::CloudEvents::HttpContentError.new "Batched CloudEvents are not supported"
+          when ::CloudEvents::CloudEventsError
             event
           else
             raise "Unexpected event type: #{event.class}"
@@ -432,8 +432,8 @@ module FunctionsFramework
       def decode_event env
         @cloud_events.decode_rack_env(env) ||
           @legacy_events.decode_rack_env(env) ||
-          raise(CloudEvents::HttpContentError, "Unrecognized event format")
-      rescue CloudEvents::CloudEventsError => e
+          raise(::CloudEvents::HttpContentError, "Unrecognized event format")
+      rescue ::CloudEvents::CloudEventsError => e
         e
       end
 

data/lib/functions_framework/testing.rb

@@ -100,7 +100,7 @@ module FunctionsFramework
     # be of type :cloud_event`.
     #
     # @param name [String] The name of the function to call
-    # @param event [FunctionsFramework::CloudEvets::Event] The event to send
+    # @param event [::CloudEvents::Event] The event to send
     # @return [nil]
     #
     def call_event name, event
@@ -174,23 +174,35 @@ module FunctionsFramework
     # @param source [String,URI] Event source (optional)
     # @param type [String] Event type (optional)
     # @param spec_version [String] Spec version (optional)
-    # @param data_content_type [String,FunctionsFramework::CloudEvents::ContentType]
+    # @param data_content_type [String,::CloudEvents::ContentType]
     #     Content type for the data (optional)
     # @param data_schema [String,URI] Data schema (optional)
     # @param subject [String] Subject (optional)
     # @param time [String,DateTime] Event timestamp (optional)
-    # @return [FunctionsFramework::CloudEvents::Event]
+    # @return [::CloudEvents::Event]
     #
     def make_cloud_event data,
-                         id: nil, source: nil, type: nil, spec_version: nil,
-                         data_content_type: nil, data_schema: nil, subject: nil, time: nil
+                         id: nil,
+                         source: nil,
+                         type: nil,
+                         spec_version: nil,
+                         data_content_type: nil,
+                         data_schema: nil,
+                         subject: nil,
+                         time: nil
       id ||= "random-id-#{rand 100_000_000}"
       source ||= "functions-framework-testing"
       type ||= "com.example.test"
       spec_version ||= "1.0"
-      CloudEvents::Event.new id: id, source: source, type: type, spec_version: spec_version,
-                             data_content_type: data_content_type, data_schema: data_schema,
-                             subject: subject, time: time, data: data
+      ::CloudEvents::Event.new id:                id,
+                               source:            source,
+                               type:              type,
+                               spec_version:      spec_version,
+                               data_content_type: data_content_type,
+                               data_schema:       data_schema,
+                               subject:           subject,
+                               time:              time,
+                               data:              data
     end
 
     extend self

data/lib/functions_framework/version.rb

@@ -17,5 +17,5 @@ module FunctionsFramework
   # Version of the Ruby Functions Framework
   # @return [String]
   #
-  VERSION = "0.4.1".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cloud_events
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -60,15 +74,6 @@ files:
 - docs/writing-functions.md
 - lib/functions_framework.rb
 - lib/functions_framework/cli.rb
-- lib/functions_framework/cloud_events.rb
-- lib/functions_framework/cloud_events/content_type.rb
-- lib/functions_framework/cloud_events/errors.rb
-- lib/functions_framework/cloud_events/event.rb
-- lib/functions_framework/cloud_events/event/field_interpreter.rb
-- lib/functions_framework/cloud_events/event/v0.rb
-- lib/functions_framework/cloud_events/event/v1.rb
-- lib/functions_framework/cloud_events/http_binding.rb
-- lib/functions_framework/cloud_events/json_format.rb
 - lib/functions_framework/function.rb
 - lib/functions_framework/legacy_event_converter.rb
 - lib/functions_framework/registry.rb
@@ -82,7 +87,7 @@ metadata:
   changelog_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby
   bug_tracker_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby/issues
-  documentation_uri: https://rubydoc.info/gems/functions_framework/0.4.1
+  documentation_uri: https://rubydoc.info/gems/functions_framework/0.5.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/functions_framework/cloud_events.rb

@@ -1,45 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# 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.
-
-require "functions_framework/cloud_events/content_type"
-require "functions_framework/cloud_events/errors"
-require "functions_framework/cloud_events/event"
-require "functions_framework/cloud_events/http_binding"
-require "functions_framework/cloud_events/json_format"
-
-module FunctionsFramework
-  ##
-  # CloudEvents implementation.
-  #
-  # This is a Ruby implementation of the [CloudEvents](https://cloudevents.io)
-  # specification. It supports both
-  # [CloudEvents 0.3](https://github.com/cloudevents/spec/blob/v0.3/spec.md) and
-  # [CloudEvents 1.0](https://github.com/cloudevents/spec/blob/v1.0/spec.md).
-  #
-  module CloudEvents
-    # @private
-    SUPPORTED_SPEC_VERSIONS = ["0.3", "1.0"].freeze
-
-    class << self
-      ##
-      # The spec versions supported by this implementation.
-      #
-      # @return [Array<String>]
-      #
-      def supported_spec_versions
-        SUPPORTED_SPEC_VERSIONS
-      end
-    end
-  end
-end

data/lib/functions_framework/cloud_events/content_type.rb

@@ -1,222 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# 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.
-
-module FunctionsFramework
-  module CloudEvents
-    ##
-    # A parsed content-type header.
-    #
-    # This object represents the information contained in a Content-Type,
-    # obtained by parsing the header according to RFC 2045.
-    #
-    # Case-insensitive fields, such as media_type and subtype, are normalized
-    # to lower case.
-    #
-    # If parsing fails, this class will try to get as much information as it
-    # can, and fill the rest with defaults as recommended in RFC 2045 sec 5.2.
-    # In case of a parsing error, the {#error_message} field will be set.
-    #
-    class ContentType
-      ##
-      # Parse the given header value.
-      #
-      # @param string [String] Content-Type header value in RFC 2045 format
-      #
-      def initialize string
-        @string = string
-        @media_type = "text"
-        @subtype_base = @subtype = "plain"
-        @subtype_format = nil
-        @params = []
-        @charset = "us-ascii"
-        @error_message = nil
-        parse consume_comments string.strip
-        @canonical_string = "#{@media_type}/#{@subtype}" +
-                            @params.map { |k, v| "; #{k}=#{maybe_quote v}" }.join
-      end
-
-      ##
-      # The original header content string.
-      # @return [String]
-      #
-      attr_reader :string
-      alias to_s string
-
-      ##
-      # A "canonical" header content string with spacing and capitalization
-      # normalized.
-      # @return [String]
-      #
-      attr_reader :canonical_string
-
-      ##
-      # The media type.
-      # @return [String]
-      #
-      attr_reader :media_type
-
-      ##
-      # The entire content subtype (which could include an extension delimited
-      # by a plus sign).
-      # @return [String]
-      #
-      attr_reader :subtype
-
-      ##
-      # The portion of the content subtype before any plus sign.
-      # @return [String]
-      #
-      attr_reader :subtype_base
-
-      ##
-      # The portion of the content subtype after any plus sign, or nil if there
-      # is no plus sign in the subtype.
-      # @return [String,nil]
-      #
-      attr_reader :subtype_format
-
-      ##
-      # An array of parameters, each element as a two-element array of the
-      # parameter name and value.
-      # @return [Array<Array(String,String)>]
-      #
-      attr_reader :params
-
-      ##
-      # The charset, defaulting to "us-ascii" if none is explicitly set.
-      # @return [String]
-      #
-      attr_reader :charset
-
-      ##
-      # The error message when parsing, or `nil` if there was no error message.
-      # @return [String,nil]
-      #
-      attr_reader :error_message
-
-      ##
-      # An array of values for the given parameter name
-      # @param key [String]
-      # @return [Array<String>]
-      #
-      def param_values key
-        key = key.downcase
-        @params.inject([]) { |a, (k, v)| key == k ? a << v : a }
-      end
-
-      ## @private
-      def == other
-        other.is_a?(ContentType) && canonical_string == other.canonical_string
-      end
-      alias eql? ==
-
-      ## @private
-      def hash
-        canonical_string.hash
-      end
-
-      ## @private
-      class ParseError < ::StandardError
-      end
-
-      private
-
-      def parse str
-        @media_type, str = consume_token str, downcase: true, error_message: "Failed to parse media type"
-        str = consume_special str, "/"
-        @subtype, str = consume_token str, downcase: true, error_message: "Failed to parse subtype"
-        @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"
-          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]
-          @charset = val if name == "charset"
-        end
-      rescue ParseError => e
-        @error_message = e.message
-      end
-
-      def consume_token str, downcase: false, error_message: nil
-        match = /^([\w!#\$%&'\*\+\.\^`\{\|\}-]+)(.*)$/.match str
-        raise ParseError, error_message || "Expected token" unless match
-        token = match[1]
-        token.downcase! if downcase
-        str = consume_comments match[2].strip
-        [token, str]
-      end
-
-      def consume_special str, expected, error_message: nil
-        raise ParseError, error_message || "Expected #{expected.inspect}" unless str.start_with? expected
-        consume_comments str[1..-1].strip
-      end
-
-      def consume_token_or_quoted str, error_message: nil
-        return consume_token str unless str.start_with? '"'
-        arr = []
-        index = 1
-        loop do
-          char = str[index]
-          case char
-          when nil
-            raise ParseError, error_message || "Quoted-string never finished"
-          when "\""
-            break
-          when "\\"
-            char = str[index + 1]
-            raise ParseError, error_message || "Quoted-string never finished" unless char
-            arr << char
-            index += 2
-          else
-            arr << char
-            index += 1
-          end
-        end
-        index += 1
-        str = consume_comments str[index..-1].strip
-        [arr.join, str]
-      end
-
-      def consume_comments str
-        return str unless str.start_with? "("
-        index = 1
-        loop do
-          char = str[index]
-          case char
-          when nil
-            raise ParseError, "Comment never finished"
-          when ")"
-            break
-          when "\\"
-            index += 2
-          when "("
-            str = consume_comments str[index..-1]
-            index = 0
-          else
-            index += 1
-          end
-        end
-        index += 1
-        consume_comments str[index..-1].strip
-      end
-
-      def maybe_quote str
-        return str if /^[\w!#\$%&'\*\+\.\^`\{\|\}-]+$/ =~ str
-        str = str.gsub("\\", "\\\\\\\\").gsub("\"", "\\\\\"")
-        "\"#{str}\""
-      end
-    end
-  end
-end