functions_framework 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d09328e219e183d857a5b0e5cbb4a9aac77dcb2b6deea96ecb4909729aac5e46
+  data.tar.gz: 2ffdd21b22c08193b64610ac42ee05f6b5627c25b99ee6d2d45eb52408438e33
+SHA512:
+  metadata.gz: 93cf161a26eee8349e99ec7012698374206e333099c94ecff07609bdefe9f7a33bf331aa3a0b305fd005e0a89ba9988bcc3ed3ce4c2c1edadd587975561b5fe8
+  data.tar.gz: 64eea2572a244dca261c090b6e51445b2f59ad2ad985edb29dc2a52aaa902fd9d9afa44e65e6ca51a6653c16d5532ace49cb9a6defd09c45195d9d81e9238707

data/.yardopts

@@ -0,0 +1,10 @@
+--no-private
+--title=Functions Framework
+--markup markdown
+--markup-provider redcarpet
+--main=README.md
+./lib/functions_framework/**/*.rb
+./lib/functions_framework.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### v0.1.0 / 2020-01-30
+
+* Initial release

data/LICENSE

@@ -0,0 +1,201 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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
+
+       http://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.

data/README.md

@@ -0,0 +1,218 @@
+# Functions Framework
+
+An open source framework for writing lightweight, portable Ruby functions that
+run in a serverless environment. Functions written to this Framework will run
+in many different environments, including:
+
+ *  [Google Cloud Functions](https://cloud.google.com/functions) *(coming soon)*
+ *  [Cloud Run or Cloud Run for Anthos](https://cloud.google.com/run)
+ *  Any other [Knative](https://github.com/knative)-based environment
+ *  Your local development machine
+
+The framework allows you to go from:
+
+```ruby
+FunctionsFramework.http do |request|
+  "Hello, world!\n"
+end
+```
+
+To:
+
+```sh
+curl http://my-url
+# Output: Hello, world!
+```
+
+All without needing to worry about writing an HTTP server or complicated
+request handling logic.
+
+For more information about the Functions Framework, see
+https://github.com/GoogleCloudPlatform/functions-framework
+
+## Features
+
+ *  Define named functions using normal Ruby constructs.
+ *  Invoke functions in response to requests.
+ *  Automatically unmarshal events conforming to the
+    [CloudEvents](https://cloudevents.io) spec.
+ *  Spin up a local development server for quick testing.
+ *  Integrate with standard Ruby libraries such as Rack and Minitest.
+ *  Portable between serverless platforms.
+
+## Installation
+
+Install the Functions Framework via Rubygems:
+
+```sh
+gem install functions_framework
+```
+
+Or add it to your Gemfile for installation using Bundler:
+
+```ruby
+# Gemfile
+gem "functions_framework", "~> 0.1"
+```
+
+### Supported Ruby versions
+
+This library is supported on Ruby 2.4+.
+
+Google provides official support for Ruby versions that are actively supported
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or
+in security maintenance, and not end of life. Currently, this means Ruby 2.4
+and later. Older versions of Ruby _may_ still work, but are unsupported and not
+recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
+about the Ruby support schedule.
+
+## Quickstart
+
+### Running Hello World on your local machine
+
+Create a `Gemfile` listing the Functions Framework as a dependency:
+
+```ruby
+# Gemfile
+source "https://rubygems.org"
+gem "functions_framework", "~> 0.1"
+```
+
+Create a file called `app.rb` and include the following code. This defines a
+simple function called "hello".
+
+```ruby
+# app.rb
+require "functions_framework"
+
+FunctionsFramework.http("hello") do |request|
+  "Hello, world!\n"
+end
+```
+
+Install the bundle, and start the framework. This spins up a local web server
+running your "hello" function:
+
+```sh
+bundle install
+# ...installs the functions_framework gem and other dependencies
+bundle exec functions-framework --target hello
+# ...starts the web server in the foreground
+```
+
+In a separate shell, you can send requests to this function using curl:
+
+```sh
+curl localhost:8080
+# Output: Hello, world!
+```
+
+Stop the web server with `CTRL+C`.
+
+### Deploying a function to Google Cloud Functions
+
+(Google Cloud Functions does not yet support the Ruby Function Framework)
+
+### Deploying a function to Cloud Run
+
+Create a `Dockerfile` for your function:
+
+```dockerfile
+# Dockerfile
+FROM ruby:2.6
+
+WORKDIR /app
+COPY . .
+RUN gem install --no-document bundler \
+    && bundle config --local frozen true \
+    && bundle install
+
+ENTRYPOINT ["bundle", "exec", "functions-framework"]
+CMD ["--target", "hello"]
+```
+
+Build your function into a Docker image:
+
+```sh
+gcloud builds submit --tag=gcr.io/[YOUR-PROJECT]/hello:build-1
+```
+
+Deploy to Cloud Run:
+
+```sh
+gcloud run deploy hello --image=gcr.io/[YOUR-PROJECT]/hello:build-1 \
+  --platform=managed --allow-unauthenticated --region=us-central1
+```
+
+You can use a similar approach to deploy to any other Knative-based serverless
+environment.
+
+### Responding to CloudEvents
+
+You can also define a function that response to
+[CloudEvents](https://cloudevents.io). The Functions Framework will handle
+unmarshalling of the event data.
+
+Change `app.rb` to read:
+
+```ruby
+# app.rb
+require "functions_framework"
+
+FunctionsFramework.event("my-handler") do |data, context|
+  FunctionsFramework.logger.info "I received #{data.inspect}"
+end
+```
+
+Start up the framework with this new function:
+
+```sh
+bundle install
+bundle exec functions-framework --target my-handler
+```
+
+In a separate shell, you can send a CloudEvent to this function using curl:
+
+```sh
+curl --header "Content-Type: text/plain; charset=utf-8" \
+     --header "CE-ID: 12345" \
+     --header "CE-Source: curl" \
+     --header "CE-Type: com.example.test" \
+     --header "CE-Specversion: 1.0" \
+     --data "Hello, world!" \
+     http://localhost:8080
+```
+
+CloudEvents functions do not return meaningful results, but you will see the
+log message from the web server.
+
+### Configuring the Functions Framework
+
+The Ruby Functions Framework recognizes the standard command line arguments to
+the `functions-framework` executable. Each argument also corresponds to an
+environment variable. If you specify both, the environment variable will be
+ignored.
+
+Command-line flag | Environment variable | Description
+----------------- | -------------------- | -----------
+`--port`          | `PORT`               | The port on which the Functions Framework listens for requests. Default: `8080`
+`--target`        | `FUNCTION_TARGET`    | The name of the exported function to be invoked in response to requests. Default: `function`
+`--source`        | `FUNCTION_SOURCE`    | The path to the file containing your function. Default: `app.rb` (in the current working directory)
+
+Note: the flag `--signature-type` and corresponding environment variable
+`FUNCTION_SIGNATURE_TYPE` are not used by the Ruby Function Framework, because
+you specify the signature type when defining the function in the source.
+
+The Ruby `functions-framework` executable also recognizes several additional
+flags that can be used to control logging verbosity, binding, and other
+parameters. For details, see the online help:
+
+```sh
+functions-framework --help
+```
+
+## For more information
+
+ *  See the `examples` directory for additional examples
+ *  Consult https://rubydoc.info/gems/functions_framework for full reference
+    documentation.

data/bin/functions-framework

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# 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 "functions_framework/cli"
+
+::FunctionsFramework::CLI.new.parse_args(::ARGV).run