functions_framework 0.1.1 → 0.4.0

data/lib/functions_framework/testing.rb

@@ -70,16 +70,9 @@ module FunctionsFramework
     #
     # @param path [String] File path to load
     #
-    def load_temporary path
-      registry = ::FunctionsFramework::Registry.new
-      old_registry = ::FunctionsFramework.global_registry
-      ::FunctionsFramework.global_registry = registry
-      begin
-        ::Kernel.load path
-        yield
-      ensure
-        ::FunctionsFramework.global_registry = old_registry
-      end
+    def load_temporary path, &block
+      path = ::File.expand_path path
+      Testing.load_for_testing path, &block
     end
 
     ##
@@ -94,7 +87,7 @@ module FunctionsFramework
       function = ::FunctionsFramework.global_registry[name]
       case function&.type
       when :http
-        Testing.interpret_response { function.call request }
+        Testing.interpret_response { function.new_call.call request }
       when nil
         raise "Unknown function name #{name}"
       else
@@ -104,7 +97,7 @@ module FunctionsFramework
 
     ##
     # Call the given event function for testing. The underlying function must
-    # be of type `:event` or `:cloud_event`.
+    # be of type :cloud_event`.
     #
     # @param name [String] The name of the function to call
     # @param event [FunctionsFramework::CloudEvets::Event] The event to send
@@ -113,8 +106,8 @@ module FunctionsFramework
     def call_event name, event
       function = ::FunctionsFramework.global_registry[name]
       case function&.type
-      when :event, :cloud_event
-        function.call event
+      when :cloud_event
+        function.new_call.call event
         nil
       when nil
         raise "Unknown function name #{name}"
@@ -123,30 +116,52 @@ module FunctionsFramework
       end
     end
 
+    ##
+    # Make a Rack request, for passing to a function test.
+    #
+    # @param url [URI,String] The URL to get, including query params.
+    # @param method [String] The HTTP method (defaults to "GET").
+    # @param body [String] The HTTP body, if any.
+    # @param headers [Array,Hash] HTTP headers. May be given as a hash (of
+    #     header names mapped to values), an array of strings (where each
+    #     string is of the form `Header-Name: Header value`), or an array of
+    #     two-element string arrays.
+    # @return [Rack::Request]
+    #
+    def make_request url, method: ::Rack::GET, body: nil, headers: []
+      env = Testing.build_standard_env URI(url), headers
+      env[::Rack::REQUEST_METHOD] = method
+      env[::Rack::RACK_INPUT] = ::StringIO.new body if body
+      ::Rack::Request.new env
+    end
+
     ##
     # Make a simple GET request, for passing to a function test.
     #
     # @param url [URI,String] The URL to get.
+    # @param headers [Array,Hash] HTTP headers. May be given as a hash (of
+    #     header names mapped to values), an array of strings (where each
+    #     string is of the form `Header-Name: Header value`), or an array of
+    #     two-element string arrays.
     # @return [Rack::Request]
     #
     def make_get_request url, headers = []
-      env = Testing.build_standard_env URI(url), headers
-      env[::Rack::REQUEST_METHOD] = ::Rack::GET
-      ::Rack::Request.new env
+      make_request url, headers: headers
     end
 
     ##
     # Make a simple POST request, for passing to a function test.
     #
     # @param url [URI,String] The URL to post to.
-    # @param data [String] The body to post.
+    # @param body [String] The body to post.
+    # @param headers [Array,Hash] HTTP headers. May be given as a hash (of
+    #     header names mapped to values), an array of strings (where each
+    #     string is of the form `Header-Name: Header value`), or an array of
+    #     two-element string arrays.
     # @return [Rack::Request]
     #
-    def make_post_request url, data, headers = []
-      env = Testing.build_standard_env URI(url), headers
-      env[::Rack::REQUEST_METHOD] = ::Rack::POST
-      env[::Rack::RACK_INPUT] = ::StringIO.new data
-      ::Rack::Request.new env
+    def make_post_request url, body, headers = []
+      make_request url, method: ::Rack::POST, body: body, headers: headers
     end
 
     ##
@@ -180,7 +195,28 @@ module FunctionsFramework
 
     extend self
 
+    @testing_registries = {}
+    @mutex = ::Mutex.new
+
     class << self
+      ## @private
+      def load_for_testing path
+        old_registry = ::FunctionsFramework.global_registry
+        @mutex.synchronize do
+          if @testing_registries.key? path
+            ::FunctionsFramework.global_registry = @testing_registries[path]
+          else
+            new_registry = ::FunctionsFramework::Registry.new
+            ::FunctionsFramework.global_registry = new_registry
+            ::Kernel.load path
+            @testing_registries[path] = new_registry
+          end
+        end
+        yield
+      ensure
+        ::FunctionsFramework.global_registry = old_registry
+      end
+
       ## @private
       def interpret_response
         response =
@@ -231,7 +267,11 @@ module FunctionsFramework
           ::Rack::RACK_ERRORS     => ::StringIO.new
         }
         headers.each do |header|
-          name, value = header.split ":"
+          if header.is_a? String
+            name, value = header.split ":"
+          elsif header.is_a? Array
+            name, value = header
+          end
           next unless name && value
           name = name.strip.upcase.tr "-", "_"
           name = "HTTP_#{name}" unless ["CONTENT_TYPE", "CONTENT_LENGTH"].include? name

data/lib/functions_framework/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -141,6 +141,7 @@ email:
 - dazuma@google.com
 executables:
 - functions-framework
+- functions-framework-ruby
 extensions: []
 extra_rdoc_files: []
 files:
@@ -149,14 +150,25 @@ files:
 - LICENSE
 - README.md
 - bin/functions-framework
+- bin/functions-framework-ruby
+- docs/deploying-functions.md
+- docs/overview.md
+- docs/running-a-functions-server.md
+- docs/testing-functions.md
+- docs/writing-functions.md
 - lib/functions_framework.rb
 - lib/functions_framework/cli.rb
 - lib/functions_framework/cloud_events.rb
-- lib/functions_framework/cloud_events/binary_content.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/json_structure.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
 - lib/functions_framework/server.rb
 - lib/functions_framework/testing.rb

data/lib/functions_framework/cloud_events/binary_content.rb

@@ -1,59 +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 content handler for the binary mode.
-    # See https://github.com/cloudevents/spec/blob/master/http-protocol-binding.md
-    #
-    module BinaryContent
-      class << self
-        ##
-        # Decode an event from the given Rack environment
-        #
-        # @param env [Hash] Rack environment hash
-        # @param content_type [FunctionsFramework::CloudEvents::ContentType]
-        #     the content type from the Rack environment
-        # @return [FunctionsFramework::CloudEvents::Event]
-        #
-        def decode_rack_env env, content_type
-          data = env["rack.input"]&.read
-          spec_version = interpret_header env, "HTTP_CE_SPECVERSION"
-          raise "Unrecognized specversion: #{spec_version}" unless spec_version == "1.0"
-          Event.new \
-            id:                interpret_header(env, "HTTP_CE_ID"),
-            source:            interpret_header(env, "HTTP_CE_SOURCE"),
-            type:              interpret_header(env, "HTTP_CE_TYPE"),
-            spec_version:      spec_version,
-            data:              data,
-            data_content_type: content_type,
-            data_schema:       interpret_header(env, "HTTP_CE_DATASCHEMA"),
-            subject:           interpret_header(env, "HTTP_CE_SUBJECT"),
-            time:              interpret_header(env, "HTTP_CE_TIME")
-        end
-
-        private
-
-        def interpret_header env, key
-          escaped_value = env[key]
-          return nil if escaped_value.nil?
-          escaped_value.gsub(/%([0-9a-fA-F]{2})/) do
-            [$1.to_i(16)].pack "C" # rubocop:disable Style/PerlBackrefs
-          end
-        end
-      end
-    end
-  end
-end

data/lib/functions_framework/cloud_events/json_structure.rb

@@ -1,88 +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 "base64"
-require "json"
-
-module FunctionsFramework
-  module CloudEvents
-    ##
-    # A content handler for the JSON structure and JSON batch format.
-    # See https://github.com/cloudevents/spec/blob/master/json-format.md
-    #
-    module JsonStructure
-      class << self
-        ##
-        # Decode an event from the given input string
-        #
-        # @param input [IO] An IO-like object providing a JSON-formatted string
-        # @param content_type [FunctionsFramework::CloudEvents::ContentType]
-        #     the content type
-        # @return [FunctionsFramework::CloudEvents::Event]
-        #
-        def decode_structured_content input, content_type
-          input = input.read if input.respond_to? :read
-          charset = content_type.charset
-          input = input.encode charset if charset
-          structure = ::JSON.parse input
-          decode_hash_structure structure
-        end
-
-        ##
-        # Decode a batch of events from the given input string
-        #
-        # @param input [IO] An IO-like object providing a JSON-formatted string
-        # @param content_type [FunctionsFramework::CloudEvents::ContentType]
-        #     the content type
-        # @return [Array<FunctionsFramework::CloudEvents::Event>]
-        #
-        def decode_batched_content input, content_type
-          input = input.read if input.respond_to? :read
-          charset = content_type.charset
-          input = input.encode charset if charset
-          structure_array = Array(::JSON.parse(input))
-          structure_array.map { |structure| decode_hash_structure structure }
-        end
-
-        ##
-        # Decode a single event from a hash data structure with keys and types
-        # conforming to the JSON event format
-        #
-        # @param structure [Hash] Input hash
-        # @return [FunctionsFramework::CloudEvents::Event]
-        #
-        def decode_hash_structure structure
-          data =
-            if structure.key? "data_base64"
-              ::Base64.decode64 structure["data_base64"]
-            else
-              structure["data"]
-            end
-          spec_version = structure["specversion"]
-          raise "Unrecognized specversion: #{spec_version}" unless spec_version == "1.0"
-          Event.new \
-            id:                structure["id"],
-            source:            structure["source"],
-            type:              structure["type"],
-            spec_version:      spec_version,
-            data:              data,
-            data_content_type: structure["datacontenttype"],
-            data_schema:       structure["dataschema"],
-            subject:           structure["subject"],
-            time:              structure["time"]
-        end
-      end
-    end
-  end
-end