functions_framework 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a4d1e19c5565de4604964e48ff818b05460b2211ef2c8cfbd100bd572d802d7
-  data.tar.gz: 380d987acf157075cfe7fca5bf038404eb800f48b80614ce9781f44cbd6de764
+  metadata.gz: aefd222f82f6f3b6e54e5a9fc512e20f3cad4ff9ac5dfe3ee454efbc4bf88f70
+  data.tar.gz: ba675682be6f79c8c799336c92551955ed6d2f24bcfa5ee17373cf75151897c1
 SHA512:
-  metadata.gz: c76cb765863334411e7ab3bd448912fabc14c7725ae66465426ee996b05557d44653f64d47c98eb429d077f0df558b550b228a3fce014dd5aa9e02e4933cbc62
-  data.tar.gz: af8d74d419c75dc8f850fa989d48780a26e2639045ff945d4b0a1cd29fa0085d3a82d058db6e49ed9c9f2c2855b3bc495a44ab530e129a846b24c111c76f79f2
+  metadata.gz: 937e27e64ad65f0f4fd9888c6bc94fcace25a39e68834f37c04d9aecb407b8fa0dc5ef35f8ebc1d78e0134914241e42cc92714f9d4236dee77daae5259cd55f1
+  data.tar.gz: 9eb7d77db1a3faae5ff91cc3c365383b96a02bbc78b7e733e9a85a8752decaf5e97b93ec78665af936840f56d89de7f542439adedef9c4a0b73912c4cc9a5748

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### v0.10.0 / 2021-06-01
+
+* ADDED: Support raw pubsub events sent by the pubsub emulator
+* FIXED: Set proper response content-type charset when a function returns a string (plain text) or hash (JSON)
+* FIXED: Properly handle conversion of non-ascii characters in legacy event strings
+
 ### v0.9.0 / 2021-03-18
 
 * BREAKING CHANGE: Servers are configured as single-threaded in production by default, matching the current behavior of Google Cloud Functions.

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.9"
+gem "functions_framework", "~> 0.10"
 ```
 
 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.9"
+gem "functions_framework", "~> 0.10"
 ```
 
 Create a file called `app.rb` and include the following code. This defines a

data/docs/writing-functions.md

@@ -111,7 +111,7 @@ dependency on Sinatra in your `Gemfile`:
 
 ```ruby
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.9"
+gem "functions_framework", "~> 0.10"
 gem "sinatra", "~> 2.0"
 ```
 
@@ -470,7 +470,7 @@ Following is a typical layout for a Functions Framework based project.
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.9"
+gem "functions_framework", "~> 0.10"
 ```
 
 ```ruby

data/lib/functions_framework/legacy_event_converter.rb

@@ -27,10 +27,11 @@ module FunctionsFramework
     # @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"], default_charset: "utf-8"
       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
+      input = convert_raw_pubsub_event input, env if raw_pubsub_payload? input
       context = normalized_context input
       return nil unless context
       construct_cloud_event context, input["data"]
@@ -40,7 +41,7 @@ module FunctionsFramework
 
     def read_input_json input, charset
       input = input.read if input.respond_to? :read
-      input = input.encode charset if charset
+      input.force_encoding charset if charset
       content = ::JSON.parse input
       content = nil unless content.is_a? ::Hash
       content
@@ -48,6 +49,37 @@ module FunctionsFramework
       nil
     end
 
+    def raw_pubsub_payload? input
+      return false if input.include?("context") || !input.include?("subscription")
+      message = input["message"]
+      message.is_a?(::Hash) && message.include?("data") && message.include?("messageId")
+    end
+
+    def convert_raw_pubsub_event input, env
+      message = input["message"]
+      path = "#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
+      path_match = %r{projects/[^/?]+/topics/[^/?]+}.match path
+      topic = path_match ? path_match[0] : "UNKNOWN_PUBSUB_TOPIC"
+      timestamp = message["publishTime"] || ::Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%6NZ")
+      {
+        "context" => {
+          "eventId" => message["messageId"],
+          "timestamp" => timestamp,
+          "eventType" => "google.pubsub.topic.publish",
+          "resource" => {
+            "service" => "pubsub.googleapis.com",
+            "type" => "type.googleapis.com/google.pubsub.v1.PubsubMessage",
+            "name" => topic
+          }
+        },
+        "data" => {
+          "@type" => "type.googleapis.com/google.pubsub.v1.PubsubMessage",
+          "data" => message["data"],
+          "attributes" => message["attributes"]
+        }
+      }
+    end
+
     def normalized_context input
       id = normalized_context_field input, "eventId"
       timestamp = normalized_context_field input, "timestamp"

data/lib/functions_framework/server.rb

@@ -346,9 +346,9 @@ module FunctionsFramework
         when ::Rack::Response
           response.finish
         when ::String
-          string_response response, "text/plain", 200
+          string_response response, 200
         when ::Hash
-          string_response ::JSON.dump(response), "application/json", 200
+          string_response ::JSON.dump(response), 200, content_type: "application/json"
         when ::CloudEvents::CloudEventsError
           cloud_events_error_response response
         when ::StandardError
@@ -359,10 +359,17 @@ module FunctionsFramework
       end
 
       def notfound_response
-        string_response "Not found", "text/plain", 404
+        string_response "Not found", 404
       end
 
-      def string_response string, content_type, status
+      def string_response string, status, content_type: nil
+        string.force_encoding ::Encoding::ASCII_8BIT unless string.valid_encoding?
+        if string.encoding == ::Encoding::ASCII_8BIT
+          content_type ||= "application/octet-stream"
+        else
+          content_type ||= "text/plain"
+          content_type = "#{content_type}; charset=#{string.encoding.name.downcase}"
+        end
         headers = {
           "Content-Type"   => content_type,
           "Content-Length" => string.bytesize
@@ -372,13 +379,13 @@ module FunctionsFramework
 
       def cloud_events_error_response error
         @config.logger.warn error
-        string_response "#{error.class}: #{error.message}", "text/plain", 400
+        string_response "#{error.class}: #{error.message}", 400
       end
 
       def error_response message
         @config.logger.error message
         message = "Unexpected internal error" unless @config.show_error_details?
-        string_response message, "text/plain", 500
+        string_response message, 500
       end
     end
 

data/lib/functions_framework/testing.rb

@@ -330,20 +330,27 @@ module FunctionsFramework
         when ::Array
           ::Rack::Response.new response[2], response[0], response[1]
         when ::String
-          string_response response, "text/plain", 200
+          string_response response, 200
         when ::Hash
           json = ::JSON.dump response
-          string_response json, "application/json", 200
+          string_response json, 200, content_type: "application/json"
         when ::StandardError
           message = "#{response.class}: #{response.message}\n#{response.backtrace}\n"
-          string_response message, "text/plain", 500
+          string_response message, 500
         else
           raise "Unexpected response type: #{response.inspect}"
         end
       end
 
       ## @private
-      def string_response string, content_type, status
+      def string_response string, status, content_type: nil
+        string.force_encoding ::Encoding::ASCII_8BIT unless string.valid_encoding?
+        if string.encoding == ::Encoding::ASCII_8BIT
+          content_type ||= "application/octet-stream"
+        else
+          content_type ||= "text/plain"
+          content_type = "#{content_type}; charset=#{string.encoding.name.downcase}"
+        end
         headers = {
           "Content-Type"   => content_type,
           "Content-Length" => string.bytesize

data/lib/functions_framework/version.rb

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

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-06-01 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.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 6.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 6.a
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -87,10 +99,10 @@ homepage: https://github.com/GoogleCloudPlatform/functions-framework-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v0.9.0/file.CHANGELOG.html
+  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v0.10.0/file.CHANGELOG.html
   source_code_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby
   bug_tracker_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby/issues
-  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v0.9.0
+  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v0.10.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -106,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Functions Framework for Ruby