functions_framework 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f82e8f7fb76005b4b61225b3ca02e31e52caecb2742604b88b6b60ced2945d84
-  data.tar.gz: 5f274cc6bdd13c7367d55212d1fb39f26432d8d00a6d607c09543e3818637c49
+  metadata.gz: d09fadc9facfc650793e4c6c30f8dab5f2e5909d0d068d18e0da0bd8a748115d
+  data.tar.gz: 7b99ab480e94f1ed4eae784121030a07106451cdc1ddd0de5e5b1d7edabbe41f
 SHA512:
-  metadata.gz: 6470be9c192f2231a610830bf51563638ce27e4330f071dd28b41a8fc15811704ace7025cede45ea54a13b4862d86153401360523d6bb479735793e1ed1e00c4
-  data.tar.gz: c7fd524f8c7c4819a6cb6a95d7e7ec0aa371e4211c8b521efe42d63ab3ca794dbfad490613633660c89aaa01479cbfe4d5e98683454e6bd4cdc382f1978da396
+  metadata.gz: b4cc30e0acb40f3de6e9a412b240c2f910a539d9b9e76085bcb701d605f657b5239b4bbeabf9a7f5e78c220ff4931ae34c7f21d028d4e472874308c91d26d997
+  data.tar.gz: d059a1fc586dfb12bbd06a757abf46227f0dcfc54c8653365198b596045a0c34d3fd4d00fcddc331a19d5bb028f5e52f5684aa022136b1258ce59a31ec195bd2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### v0.3.1 / 2020-06-27
+
+* Fixed crash when using "return" directly in a function block.
+* Added a more flexible request generation helper in the testing module.
+* Fixed several typos in the documentation.
+
 ### v0.3.0 / 2020-06-26
 
 * Updated the CloudEvent data format for converted pubsub events to conform to Cloud Run's conversion.

data/README.md

@@ -88,7 +88,7 @@ bundle exec functions-framework-ruby --target hello
 In a separate shell, you can send requests to this function using curl:
 
 ```sh
-curl https://localhost:8080
+curl http://localhost:8080
 # Output: Hello, world!
 ```
 

data/docs/overview.md

@@ -92,7 +92,7 @@ bundle exec functions-framework-ruby --target hello
 In a separate shell, you can send requests to this function using curl:
 
 ```sh
-curl https://localhost:8080
+curl http://localhost:8080
 # Output: Hello, world!
 ```
 

data/docs/writing-functions.md

@@ -43,7 +43,7 @@ now cover these in a bit more detail.
 
 An HTTP function is passed a request, which is an object of type
 [Rack::Request](https://rubydoc.info/gems/rack/Rack/Request). This object
-provides methods methods for obtaining request information such as the method,
+provides methods for obtaining request information such as the method,
 path, query parameters, body content, and headers. You can also obtain the raw
 Rack environment using the `env` method. The following example includes some
 request information in the response:

data/lib/functions_framework/function.rb

@@ -30,7 +30,9 @@ module FunctionsFramework
     def initialize name, type, &block
       @name = name
       @type = type
-      @block = block
+      @execution_context_class = Class.new do
+        define_method :call, &block
+      end
     end
 
     ##
@@ -43,11 +45,6 @@ module FunctionsFramework
     #
     attr_reader :type
 
-    ##
-    # @return [Proc] The function code as a proc
-    #
-    attr_reader :block
-
     ##
     # Call the function. You must pass an argument appropriate to the type
     # of function.
@@ -62,11 +59,12 @@ module FunctionsFramework
     # @return [Object]
     #
     def call argument
+      execution_context = @execution_context_class.new
       case type
       when :event
-        block.call argument.data, argument
+        execution_context.call argument.data, argument
       else
-        block.call argument
+        execution_context.call argument
       end
     end
   end

data/lib/functions_framework/testing.rb

@@ -116,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
 
     ##
@@ -245,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.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma