functions_framework 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdf75f322fe9e9e78b5e65bfcc9682097606deffb46137d85b6b1cfde68d3ab8
-  data.tar.gz: 54f8e668875607738141963c70b1960da6c06df69083a7ef4357f66889e1a328
+  metadata.gz: 817129c1773079fed039152996a18e91a054241940b8d6e3437cb66e10046304
+  data.tar.gz: ff3f61597726b60241e8b528ef520641fa3f08ddb7adcdfb32f9413fcb125f45
 SHA512:
-  metadata.gz: 3d6fd59bc3730333e91a049d03089169720390f5f9300420449480924800d97da118a87cdae33224644c3550fe78dfee4a07b18e32e534d9bb7645340fbdf4c9
-  data.tar.gz: 897cef8cc366475123250d4c9a7cea0ccd07989c9ebdc0d88d358d996c5fa727aa9bcc5eb46be286d38e72a9d2512adfbaed743975d0300502516db9e3a5fde2
+  metadata.gz: 7396117d6e94bec87c70c697c7364b9256c7575f61c7259eb25df65694e9627b6c33a93e0caaea5d9d7955707e731eaddc27b90d4595f0029d181fc6cc18bfdf
+  data.tar.gz: 8eb929ace2a49ae764f5de0fef6dd7e0d668c80864368ad2379d0e52a89a44c7a3514e92dc02802d940374808a271a89f3076f1c8f3d0a532204118615e0c1af

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+### v0.4.1 / 2020-07-08
+
+* Fixed unsupported signal error on Windows.
+* Fixed several edge case errors in legacy event conversion.
+* Generated Content-Type headers now properly quote param values if needed.
+* Minor documentation updates.
+
 ### v0.4.0 / 2020-06-29
 
 * Dropped the legacy and largely unsupported `:event` function type. All event functions should be of type `:cloud_event`.

data/docs/deploying-functions.md

@@ -105,6 +105,12 @@ to adapt it if you have an Anthos installation.
 
 ### Building an image for your function
 
+Before you can deploy to Cloud Run, make sure your bundle, and in
+particular your `Gemfile.lock` file, is up to date. The easiest way to do this
+is to `bundle install` or `bundle update` and run your local tests prior to
+deploying. The configuration used in the Dockerfile below will not accept your
+function unless an up-to-date `Gemfile.lock` is present.
+
 First, build a Docker image containing your function. Following is a simple
 Dockerfile that you can use as a starting point. Feel free to adjust it to the
 needs of your project:
@@ -165,7 +171,7 @@ deployed function.
 
 Note that our Dockerfile's entrypoint did not pass any source file or target
 name to the Functions Framework. If these are not specified, the Framework will
-use the source `.app.rb` and the target `function` by default. To use different
+use the source `./app.rb` and the target `function` by default. To use different
 values, you need to set the appropriate environment variables when deploying, as
 illustrated above with the `FUNCTION_SOURCE` and `FUNCTION_TARGET` variables.
 

data/lib/functions_framework/cloud_events/content_type.rb

@@ -43,7 +43,7 @@ module FunctionsFramework
         @error_message = nil
         parse consume_comments string.strip
         @canonical_string = "#{@media_type}/#{@subtype}" +
-                            @params.map { |k, v| "; #{k}=#{v}" }.join
+                            @params.map { |k, v| "; #{k}=#{maybe_quote v}" }.join
       end
 
       ##
@@ -211,6 +211,12 @@ module FunctionsFramework
         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

data/lib/functions_framework/legacy_event_converter.rb

@@ -32,10 +32,9 @@ module FunctionsFramework
       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
-      raw_context = input["context"] || input
-      context = normalized_context raw_context
+      context = normalized_context input
       return nil unless context
-      construct_cloud_event context, input["data"]
+      construct_cloud_event context, input["data"], content_type.charset
     end
 
     private
@@ -50,27 +49,27 @@ module FunctionsFramework
       nil
     end
 
-    def normalized_context raw_context
-      id = raw_context["eventId"]
-      return nil unless id
-      timestamp = raw_context["timestamp"]
-      return nil unless timestamp
-      type = raw_context["eventType"]
-      return nil unless type
-      service, resource = analyze_resource raw_context["resource"], type
-      return nil unless service && resource
+    def normalized_context input
+      raw_context = input["context"]
+      id = raw_context&.[]("eventId") || input["eventId"]
+      timestamp = raw_context&.[]("timestamp") || input["timestamp"]
+      type = raw_context&.[]("eventType") || input["eventType"]
+      service, resource = analyze_resource raw_context&.[]("resource") || input["resource"]
+      service ||= service_from_type type
+      return nil unless id && timestamp && type && service && resource
       { id: id, timestamp: timestamp, type: type, service: service, resource: resource }
     end
 
-    def analyze_resource raw_resource, type
+    def analyze_resource raw_resource
+      service = resource = nil
       case raw_resource
       when ::Hash
-        [raw_resource["service"], raw_resource["name"]]
+        service = raw_resource["service"]
+        resource = raw_resource["name"]
       when ::String
-        [service_from_type(type), raw_resource]
-      else
-        [nil, nil]
+        resource = raw_resource
       end
+      [service, resource]
     end
 
     def service_from_type type
@@ -80,16 +79,17 @@ module FunctionsFramework
       nil
     end
 
-    def construct_cloud_event context, data
+    def construct_cloud_event context, data, charset
       source, subject = convert_source context[:service], context[:resource]
       type = LEGACY_TYPE_TO_CE_TYPE[context[:type]]
       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: "application/json",
+                             data_content_type: content_type,
                              data:              ce_data,
                              subject:           subject,
                              time:              context[:timestamp]

data/lib/functions_framework/server.rb

@@ -149,8 +149,12 @@ module FunctionsFramework
         ::Signal.trap "SIGINT" do
           Server.signal_enqueue "SIGINT", @config.logger, @server
         end
-        ::Signal.trap "SIGHUP" do
-          Server.signal_enqueue "SIGHUP", @config.logger, @server
+        begin
+          ::Signal.trap "SIGHUP" do
+            Server.signal_enqueue "SIGHUP", @config.logger, @server
+          end
+        rescue ::ArgumentError # rubocop:disable Lint/HandleExceptions
+          # Not available on all systems
         end
         @signals_installed = true
       end

data/lib/functions_framework/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -38,104 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: google-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.24.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.24.0
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.13'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: toys
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.24
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.24
 description: The Functions Framework implementation for Ruby.
 email:
 - dazuma@google.com
@@ -176,7 +78,11 @@ files:
 homepage: https://github.com/GoogleCloudPlatform/functions-framework-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+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
 post_install_message: 
 rdoc_options: []
 require_paths: