Add missing GCF samples (other than tutorials) (#1614)

* Add GCP API call sample

Change-Id: I2362e4ee8031fd3ea6880ffcec5eb253615df5ba

* Add log retrieval sample + a few import tweaks

Change-Id: Ieb2b5b3421bd6821bc6d5626b7986c23e9d82350

* Move log retrieval sample

Change-Id: I0fb311114bf8c3554e2f052ca00f1dd9eef1cf69

* Add XML parsing sample

Change-Id: I5ed6d6dc3792e28b12162c47c7e6f5c974a7477f

* Add multipart sample

Change-Id: I1a17e1c72bea6e7a8d18b9ed5910db09bedb753d

* Add docstrings

Change-Id: I3d99531c68b5ca3272cb6208777f3ab9bde8f9bd

* Add signed URL sample

Change-Id: I06c2a5cb46fd2cb497af7ba9e02e43a4e97de972

* Fix nits

Change-Id: Ic20ff72602ea3b6b1fdc361d87aea7dfb742150f

* Add requirements.txt files

Change-Id: Ie8682514d99aa6f82786a76719535efd58a5c1bf

* Build fix: downgrade 'futures'

Change-Id: Ief7e96a43948af12de32627b20031c95953ade09

* Fix failing test + s/Exception/runtimeError/

Change-Id: Idc9854ba256271081078c15f7e62d3fd6bbec449

* Remove incorrect lint commits + actually fix lint

Change-Id: Ib1b6f8eb47511fe9b19ed6d773b4f9c6ef0dc8ed

* Shrink requirements.txt files

Change-Id: I8fe4f70869deeb3aac0f9c6016f5c5e45a172731

* Add missing package

Change-Id: Iba2165bd2af99306feb47b7e29640ebf7d8f3e95

* Remove add'l pkgs

Change-Id: I585f2a6a31cf5e23a54eb02fb366a8685601ea23

* Address Andrew's comments

Change-Id: Ibb5a518f60d06c7637cc39ab54e81a234ea188ec

* Fix minor python{2->3} bugs

Change-Id: If71dba3d86954e8e0bf7168638c5c73eb40fe599

Author: Ace Nassri

functions/http/main.py

@@ -0,0 +1,120 @@
+# Copyright 2018 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
+#
+#     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.
+
+# [START functions_http_signed_url]
+from datetime import datetime, timedelta
+# [END functions_http_signed_url]
+
+# [START functions_http_xml]
+import json
+# [END functions_http_xml]
+
+# [START functions_http_form_data]
+import os
+import tempfile
+# [END functions_http_form_data]
+
+# [START functions_http_signed_url]
+from flask import abort
+from google.cloud import storage
+# [END functions_http_signed_url]
+
+# [START functions_http_form_data]
+from werkzeug.utils import secure_filename
+# [END functions_http_form_data]
+
+# [START functions_http_xml]
+import xmltodict
+# [END functions_http_xml]
+
+
+# [START functions_http_xml]
+
+def parse_xml(request):
+    """ Parses a document of type 'text/xml'
+    Args:
+        request (flask.Request): The request object.
+    Returns:
+        The response text, or any set of values that can be turned into a
+         Response object using `make_response`
+        <http://flask.pocoo.org/docs/0.12/api/#flask.Flask.make_response>.
+    """
+    data = xmltodict.parse(request.data)
+    return json.dumps(data, indent=2)
+# [END functions_http_xml]
+
+
+# [START functions_http_form_data]
+
+# Helper function that computes the filepath to save files to
+def get_file_path(filename):
+    # Note: tempfile.gettempdir() points to an in-memory file system
+    # on GCF. Thus, any files in it must fit in the instance's memory.
+    file_name = secure_filename(filename)
+    return os.path.join(tempfile.gettempdir(), file_name)
+
+
+def parse_multipart(request):
+    """ Parses a 'multipart/form-data' upload request
+    Args:
+        request (flask.Request): The request object.
+    Returns:
+        The response text, or any set of values that can be turned into a
+         Response object using `make_response`
+        <http://flask.pocoo.org/docs/0.12/api/#flask.Flask.make_response>.
+    """
+
+    # This code will process each non-file field in the form
+    fields = {}
+    data = request.form.to_dict()
+    for field in data:
+        fields[field] = data[field]
+        print('Processed field: %s' % field)
+
+    # This code will process each file uploaded
+    files = request.files.to_dict()
+    for file_name, file in files.items():
+        file.save(get_file_path(file_name))
+        print('Processed file: %s' % file_name)
+
+    # Clear temporary directory
+    for file_name in files:
+        file_path = get_file_path(file_name)
+        os.remove(file_path)
+
+    return "Done!"
+# [END functions_http_form_data]
+
+
+# [START functions_http_signed_url]
+storage_client = storage.Client()
+
+
+def get_signed_url(request):
+    if request.method != 'POST':
+        return abort(405)
+
+    request_json = request.get_json()
+
+    # Get a reference to the destination file in GCS
+    file_name = request_json['filename']
+    file = storage_client.bucket('my-bucket').blob(file_name)
+
+    # Create a temporary upload URL
+    expires_at_ms = datetime.now() + timedelta(seconds=30)
+    url = file.generate_signed_url(expires_at_ms,
+                                   content_type=request_json['contentType'])
+
+    return url
+# [END functions_http_signed_url]

functions/http/requirements.txt

@@ -0,0 +1,2 @@
+google-cloud-storage==1.10.0
+xmltodict==0.11.0

functions/log/main.py

@@ -15,7 +15,18 @@
 # [START functions_log_helloworld]
 import logging
 
+# [END functions_log_helloworld]
+
+# [START functions_log_retrieve]
+import os
+# [END functions_log_retrieve]
+
+# [START functions_logs_retrieve]
+import google.cloud.logging as cloud_logging
+# [END functions_logs_retrieve]
+
 
+# [START functions_log_helloworld]
 def hello_world(data, context):
     """Background Cloud Function.
     Args:
@@ -25,3 +36,33 @@ def hello_world(data, context):
     print('Hello, stdout!')
     logging.warn('Hello, logging handler!')
 # [END functions_log_helloworld]
+
+
+# [START functions_log_retrieve]
+cloud_client = cloud_logging.Client()
+log_name = 'cloudfunctions.googleapis.com%2Fcloud-functions'
+cloud_logger = cloud_client.logger(log_name.format(os.getenv('GCP_PROJECT')))
+
+
+def get_log_entries(request):
+    """
+    HTTP Cloud Function that displays log entries from Cloud Functions.
+    Args:
+        request (flask.Request): The request object.
+    Returns:
+        The response text, or any set of values that can be turned into a
+        Response object using `make_response`
+        <http://flask.pocoo.org/docs/0.12/api/#flask.Flask.make_response>.
+    """
+    """"""
+
+    all_entries = cloud_logger.list_entries(page_size=10)
+    entries = next(all_entries.pages)
+
+    for entry in entries:
+        timestamp = entry.timestamp.isoformat()
+        print('* {}: {}'.format
+              (timestamp, entry.payload))
+
+    return 'Done!'
+# [END functions_log_retrieve]

functions/log/requirements.txt

@@ -0,0 +1 @@
+google-cloud-logging==1.6.0

functions/tips/README.md

@@ -2,10 +2,12 @@
 
 # Google Cloud Functions - Tips sample
 
+## Running locally
+Set the `GCP_PROJECT` variable to the ID of the GCP project to use.
+
+## More info
 See:
 
-* [Cloud Functions Tips tutorial][tutorial]
 * [Cloud Functions Tips sample source code][code]
 
-[tutorial]: https://cloud.google.com/functions/docs/bestpractices/tips
 [code]: main.py

functions/tips/main.py

@@ -14,11 +14,26 @@
 
 # [START functions_tips_infinite_retries]
 from datetime import datetime
+# [END functions_tips_infinite_retries]
+
+# [START functions_tips_gcp_apis]
+import os
+# [END functions_tips_gcp_apis]
 
+# [START functions_tips_infinite_retries]
 # The 'python-dateutil' package must be included in requirements.txt.
 from dateutil import parser
 
 # [END functions_tips_infinite_retries]
+
+# [START functions_tips_retry]
+from google.cloud import error_reporting
+# [END functions_tips_retry]
+
+# [START functions_tips_gcp_apis]
+from google.cloud import pubsub_v1
+# [END functions_tips_gcp_apis]
+
 # [START functions_tips_connection_pooling]
 import requests
 
@@ -89,6 +104,38 @@ def connection_pooling(request):
 # [END functions_tips_connection_pooling]
 
 
+# [START functions_tips_gcp_apis]
+
+# Create a global Pub/Sub client to avoid unneeded network activity
+pubsub = pubsub_v1.PublisherClient()
+
+
+def gcp_api_call(request):
+    """
+    HTTP Cloud Function that uses a cached client library instance to
+    reduce the number of connections required per function invocation.
+    Args:
+        request (flask.Request): The request object.
+    Returns:
+        The response text, or any set of values that can be turned into a
+        Response object using `make_response`
+        <http://flask.pocoo.org/docs/0.12/api/#flask.Flask.make_response>.
+    """
+
+    project = os.getenv('GCP_PROJECT')
+    request_json = request.get_json()
+
+    topic_name = request_json['topic']
+    topic_path = pubsub.topic_path(project, topic_name)
+
+    # Process the request
+    data = 'Test message'.encode('utf-8')
+    pubsub.publish(topic_path, data=data)
+
+    return '1 message published'
+# [END functions_tips_gcp_apis]
+
+
 # [START functions_tips_infinite_retries]
 def avoid_infinite_retries(data, context):
     """Background Cloud Function that only executes within a certain
@@ -119,6 +166,9 @@ def avoid_infinite_retries(data, context):
 
 
 # [START functions_tips_retry]
+error_client = error_reporting.Client()
+
+
 def retry_or_not(data, context):
     """Background Cloud Function that demonstrates how to toggle retries.
 
@@ -129,9 +179,6 @@ def retry_or_not(data, context):
         None; output is written to Stackdriver Logging
     """
 
-    from google import cloud
-    error_client = cloud.error_reporting.Client()
-
     if data.data.get('retry'):
         try_again = True
     else:

functions/tips/main_test.py

@@ -72,19 +72,15 @@ def test_avoid_infinite_retries(capsys):
 
 
 def test_retry_or_not():
-    with patch('google.cloud') as cloud_mock:
-
-        error_client = MagicMock()
-
-        cloud_mock.error_reporting = MagicMock(
-            Client=MagicMock(return_value=error_client))
+    with patch('main.error_client') as error_client_mock:
+        error_client_mock.report_exception = MagicMock()
 
         event = Mock(data={})
         main.retry_or_not(event, None)
-        assert error_client.report_exception.call_count == 1
+        assert error_client_mock.report_exception.call_count == 1
 
         event.data = {'retry': True}
         with pytest.raises(RuntimeError):
             main.retry_or_not(event, None)
 
-        assert error_client.report_exception.call_count == 2
+        assert error_client_mock.report_exception.call_count == 2

functions/tips/requirements.txt

@@ -1,2 +1,5 @@
 google-cloud-error-reporting==0.30.0
-python-dateutil==2.7.3
+google-cloud-pubsub==0.35.4
+python-dateutil==2.7.3
+requests==2.18.1
+xmltodict==0.11.0