functions_framework 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 921150d16d50802b1fa0e5f4f6fb5d3c71aee1dd87e8242ce2e0b63dc8c6320b
-  data.tar.gz: 9b2fd4967811fc1225319102a6aadb56497d90241f6678933843a88299ea926c
+  metadata.gz: f82e8f7fb76005b4b61225b3ca02e31e52caecb2742604b88b6b60ced2945d84
+  data.tar.gz: 5f274cc6bdd13c7367d55212d1fb39f26432d8d00a6d607c09543e3818637c49
 SHA512:
-  metadata.gz: 90ea5d1622b446eb02a84a79717c92b47fadc6b5420f153acd48d0b01716a44dd6dc6cbea6851f446fde70e5a53522569b95cde61c5807563dee5b0bc4a6b50c
-  data.tar.gz: 0dd19692bfaa5566c4da5151d78c9d233b9241089d186d5461ef13e83529ca9de7f04e8736fbae70fd361a1fc2b605c03947d23867d28c2c9f80995d9cf60d06
+  metadata.gz: 6470be9c192f2231a610830bf51563638ce27e4330f071dd28b41a8fc15811704ace7025cede45ea54a13b4862d86153401360523d6bb479735793e1ed1e00c4
+  data.tar.gz: c7fd524f8c7c4819a6cb6a95d7e7ec0aa371e4211c8b521efe42d63ab3ca794dbfad490613633660c89aaa01479cbfe4d5e98683454e6bd4cdc382f1978da396

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v0.3.0 / 2020-06-26
+
+* Updated the CloudEvent data format for converted pubsub events to conform to Cloud Run's conversion.
+
 ### v0.2.1 / 2020-06-25
 
 * The `--signature-type` check recognizes the legacy `event` type.

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

data/docs/deploying-functions.md

@@ -30,12 +30,21 @@ Google Cloud Functions is Google's scalable pay-as-you-go Functions-as-a-Service
 Functions Framework is designed especially for functions that can be hosted on
 Cloud Functions.
 
+You can run Ruby functions on Google Cloud Functions by selecting the `ruby26`
+runtime. This runtime uses a recent release of Ruby 2.6. Support for other
+versions of Ruby may be added in the future.
+
+> **Note:** Ruby support on Cloud Functions is currently in limited preview.
+> It is not yet suitable for production workloads, and support is best-effort
+> only. Access is currently limited to selected early-access users.
+
 ### Deploying and updating your function
 
 Before you can deploy to Cloud Functions, 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.
+deploying. Cloud Functions will not accept your function unless an up-to-date
+`Gemfile.lock` is present.
 
 Choose a name for your function. This function name is how it will appear in the
 cloud console, and will also be part of the function's URL. (It's different from
@@ -126,6 +135,10 @@ You must use your project ID, but you can choose an app name and build ID. The
 command may ask you for permission to enable the Cloud Build API for the project
 if it isn't already enabled.
 
+Because you provide your own Docker image when deploying to Cloud Run, you can
+use any version of Ruby supported by the Functions Framework, from 2.4 through
+2.7.
+
 ### Deploying an image to Cloud Run
 
 To deploy to Cloud Run, specify the same image URL that you built above. For

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

data/docs/writing-functions.md

@@ -156,7 +156,7 @@ the [CloudEvents 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
 prior to CloudEvents. The Functions Framework will convert these legacy events
 to an equivalent CloudEvents type, so your function will always receive a
-CloudEvent when it is sent an event from Google Cloud.
+CloudEvent object when it is sent an event from Google Cloud.
 
 ## Error handling
 
@@ -188,9 +188,10 @@ end
 
 A Functions Framework based "project" or "application" is a typical Ruby
 application. It should include a `Gemfile` that specifies the gem dependencies
-(including the `functions_framework` gem itself), and at least one Ruby source
-file that defines functions. It can also include additional Ruby files defining
-classes and methods that assist in the function implementation.
+(including the `functions_framework` gem itself), and any other dependencies
+needed by the function. It must include at least one Ruby source file that
+defines functions, and can also include additional Ruby files defining classes
+and methods that assist in the function implementation.
 
 The "entrypoint" to the project, also called the "source", is a Ruby file. It
 can define any number of functions (with distinct names), although it is often
@@ -221,7 +222,7 @@ A simple project might look like this:
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.2"
+gem "functions_framework", "~> 0.3"
 ```
 
 ```ruby

data/lib/functions_framework/legacy_event_converter.rb

@@ -84,12 +84,13 @@ module FunctionsFramework
       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
       CloudEvents::Event.new id:                context[:id],
                              source:            source,
                              type:              type,
                              spec_version:      "1.0",
                              data_content_type: "application/json",
-                             data:              data,
+                             data:              ce_data,
                              subject:           subject,
                              time:              context[:timestamp]
     end
@@ -104,6 +105,14 @@ module FunctionsFramework
       end
     end
 
+    def convert_data service, data
+      if service == "pubsub.googleapis.com"
+        { "message" => data, "subscription" => nil }
+      else
+        data
+      end
+    end
+
     LEGACY_TYPE_TO_SERVICE = {
       %r{^providers/cloud\.firestore/} => "firestore.googleapis.com",
       %r{^providers/cloud\.pubsub/}    => "pubsub.googleapis.com",

data/lib/functions_framework/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Azuma