App Engine Cloud Storage Client Sample (#793)

* Added AppEngine Storage Client sample, renamed subfolders

* Fixed code review issues

* Updated storage api-client code to upload/delete objects - now testing works

* Changed BUCKET_NAME back to <your-bucket-name>

* Fixed code review issues

appengine/standard/storage/main.py → appengine/standard/storage/api-client/main.py

@@ -23,8 +23,10 @@
 """
 
 import json
+import StringIO
 
 from googleapiclient import discovery
+from googleapiclient import http
 from oauth2client.client import GoogleCredentials
 import webapp2
 
@@ -37,14 +39,33 @@
 
 
 class MainPage(webapp2.RequestHandler):
+    def upload_object(self, bucket, file_object):
+        body = {
+            'name': 'storage-api-client-sample-file.txt',
+        }
+        req = storage.objects().insert(
+            bucket=bucket, body=body, media_body=http.MediaIoBaseUpload(
+                file_object, 'application/octet-stream'))
+        resp = req.execute()
+        return resp
+
+    def delete_object(self, bucket, filename):
+        req = storage.objects().delete(bucket=bucket, object=filename)
+        resp = req.execute()
+        return resp
+
     def get(self):
-        response = storage.objects().list(bucket=BUCKET_NAME).execute()
+        string_io_file = StringIO.StringIO('Hello World!')
+        self.upload_object(BUCKET_NAME, string_io_file)
 
+        response = storage.objects().list(bucket=BUCKET_NAME).execute()
         self.response.write(
             '<h3>Objects.list raw response:</h3>'
             '<pre>{}</pre>'.format(
                 json.dumps(response, sort_keys=True, indent=2)))
 
+        self.delete_object(BUCKET_NAME, 'storage-api-client-sample-file.txt')
+
 
 app = webapp2.WSGIApplication([
     ('/', MainPage)

appengine/standard/storage/appengine-client/app.yaml

@@ -0,0 +1,12 @@
+runtime: python27
+api_version: 1
+threadsafe: yes
+
+env_variables:
+
+handlers:
+- url: /blobstore.*
+  script: blobstore.app
+
+- url: /.*
+  script: main.app

appengine/standard/storage/appengine-client/appengine_config.py

@@ -0,0 +1,4 @@
+from google.appengine.ext import vendor
+
+# Add any libraries installed in the "lib" folder.
+vendor.add('lib')

appengine/standard/storage/appengine-client/main.py

@@ -0,0 +1,167 @@
+#!/usr/bin/env python
+
+# Copyright 2017 Google Inc.
+#
+# 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 sample]
+"""A sample app that uses GCS client to operate on bucket and file."""
+
+# [START imports]
+import os
+
+import cloudstorage
+from google.appengine.api import app_identity
+
+import webapp2
+
+# [END imports]
+
+# [START retries]
+cloudstorage.set_default_retry_params(
+    cloudstorage.RetryParams(
+        initial_delay=0.2, max_delay=5.0, backoff_factor=2, max_retry_period=15
+        ))
+# [END retries]
+
+
+class MainPage(webapp2.RequestHandler):
+    """Main page for GCS demo application."""
+
+# [START get_default_bucket]
+    def get(self):
+        bucket_name = os.environ.get(
+            'BUCKET_NAME', app_identity.get_default_gcs_bucket_name())
+
+        self.response.headers['Content-Type'] = 'text/plain'
+        self.response.write(
+            'Demo GCS Application running from Version: {}\n'.format(
+                os.environ['CURRENT_VERSION_ID']))
+        self.response.write('Using bucket name: \n\n'.format(bucket_name))
+# [END get_default_bucket]
+
+        bucket = '/' + bucket_name
+        filename = bucket + '/demo-testfile'
+        self.tmp_filenames_to_clean_up = []
+
+        self.create_file(filename)
+        self.response.write('\n\n')
+
+        self.read_file(filename)
+        self.response.write('\n\n')
+
+        self.stat_file(filename)
+        self.response.write('\n\n')
+
+        self.create_files_for_list_bucket(bucket)
+        self.response.write('\n\n')
+
+        self.list_bucket(bucket)
+        self.response.write('\n\n')
+
+        self.list_bucket_directory_mode(bucket)
+        self.response.write('\n\n')
+
+        self.delete_files()
+        self.response.write('\n\nThe demo ran successfully!\n')
+
+# [START write]
+    def create_file(self, filename):
+        """Create a file."""
+
+        self.response.write('Creating file {}\n'.format(filename))
+
+        # The retry_params specified in the open call will override the default
+        # retry params for this particular file handle.
+        write_retry_params = cloudstorage.RetryParams(backoff_factor=1.1)
+        with cloudstorage.open(
+            filename, 'w', content_type='text/plain', options={
+                'x-goog-meta-foo': 'foo', 'x-goog-meta-bar': 'bar'},
+                retry_params=write_retry_params) as cloudstorage_file:
+                    cloudstorage_file.write('abcde\n')
+                    cloudstorage_file.write('f'*1024*4 + '\n')
+        self.tmp_filenames_to_clean_up.append(filename)
+# [END write]
+
+# [START read]
+    def read_file(self, filename):
+        self.response.write(
+            'Abbreviated file content (first line and last 1K):\n')
+
+        with cloudstorage.open(filename) as cloudstorage_file:
+            self.response.write(cloudstorage_file.readline())
+            cloudstorage_file.seek(-1024, os.SEEK_END)
+            self.response.write(cloudstorage_file.read())
+# [END read]
+
+    def stat_file(self, filename):
+        self.response.write('File stat:\n')
+
+        stat = cloudstorage.stat(filename)
+        self.response.write(repr(stat))
+
+    def create_files_for_list_bucket(self, bucket):
+        self.response.write('Creating more files for listbucket...\n')
+        filenames = [bucket + n for n in [
+            '/foo1', '/foo2', '/bar', '/bar/1', '/bar/2', '/boo/']]
+        for f in filenames:
+            self.create_file(f)
+
+# [START list_bucket]
+    def list_bucket(self, bucket):
+        """Create several files and paginate through them."""
+
+        self.response.write('Listbucket result:\n')
+
+        # Production apps should set page_size to a practical value.
+        page_size = 1
+        stats = cloudstorage.listbucket(bucket + '/foo', max_keys=page_size)
+        while True:
+            count = 0
+            for stat in stats:
+                count += 1
+                self.response.write(repr(stat))
+                self.response.write('\n')
+
+            if count != page_size or count == 0:
+                break
+            stats = cloudstorage.listbucket(
+                bucket + '/foo', max_keys=page_size, marker=stat.filename)
+# [END list_bucket]
+
+    def list_bucket_directory_mode(self, bucket):
+        self.response.write('Listbucket directory mode result:\n')
+        for stat in cloudstorage.listbucket(bucket + '/b', delimiter='/'):
+            self.response.write(stat)
+            self.response.write('\n')
+            if stat.is_dir:
+                for subdir_file in cloudstorage.listbucket(
+                        stat.filename, delimiter='/'):
+                    self.response.write('  {}'.format(subdir_file))
+                    self.response.write('\n')
+
+# [START delete_files]
+    def delete_files(self):
+        self.response.write('Deleting files...\n')
+        for filename in self.tmp_filenames_to_clean_up:
+            self.response.write('Deleting file {}\n'.format(filename))
+            try:
+                cloudstorage.delete(filename)
+            except cloudstorage.NotFoundError:
+                pass
+# [END delete_files]
+
+
+app = webapp2.WSGIApplication(
+    [('/', MainPage)], debug=True)
+# [END sample]

appengine/standard/storage/appengine-client/main_test.py

@@ -0,0 +1,27 @@
+# Copyright 2017 Google Inc. All rights reserved.
+#
+# 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.
+
+import webtest
+
+import main
+
+
+def test_get(testbed, cloud_config):
+    main.BUCKET_NAME = cloud_config.project
+    app = webtest.TestApp(main.app)
+
+    response = app.get('/')
+
+    assert response.status_int == 200
+    assert 'The demo ran successfully!' in response.body

appengine/standard/storage/appengine-client/requirements.txt

@@ -0,0 +1 @@
+GoogleAppEngineCloudStorageClient==1.9.22.1