Adding extra parameters for querying Cloud Storage keys.

Author: dhermes

gcloud/storage/iterator.py

@@ -38,11 +38,12 @@ class Iterator(object):
     :type path: string
     :param path: The path to query for the list of items.
     """
-    def __init__(self, connection, path):
+    def __init__(self, connection, path, extra_params=None):
         self.connection = connection
         self.path = path
         self.page_number = 0
         self.next_page_token = None
+        self.extra_params = extra_params
 
     def __iter__(self):
         """Iterate through the list of items."""
@@ -69,8 +70,13 @@ def get_query_params(self):
         :rtype: dict or None
         :returns: A dictionary of query parameters or None if there are none.
         """
+        result = None
         if self.next_page_token:
-            return {'pageToken': self.next_page_token}
+            result = {'pageToken': self.next_page_token}
+        if self.extra_params is not None:
+            result = result or {}
+            result.update(self.extra_params)
+        return result
 
     def get_next_page_response(self):
         """Requests the next page from the path provided.

gcloud/storage/key.py

@@ -298,9 +298,9 @@ def upload_from_string(self, data, content_type='text/plain'):
         """
         string_buffer = StringIO()
         string_buffer.write(data)
-        self.set_contents_from_file(file_obj=string_buffer, rewind=True,
-                                    size=string_buffer.len,
-                                    content_type=content_type)
+        self.upload_from_file(file_obj=string_buffer, rewind=True,
+                              size=string_buffer.len,
+                              content_type=content_type)
         return self
 
     # NOTE: Alias for boto-like API.
@@ -465,10 +465,11 @@ class _KeyIterator(Iterator):
     :type bucket: :class:`gcloud.storage.bucket.Bucket`
     :param bucket: The bucket from which to list keys.
     """
-    def __init__(self, bucket):
+    def __init__(self, bucket, extra_params=None):
         self.bucket = bucket
         super(_KeyIterator, self).__init__(
-            connection=bucket.connection, path=bucket.path + '/o')
+            connection=bucket.connection, path=bucket.path + '/o',
+            extra_params=extra_params)
 
     def get_items_from_response(self, response):
         """Factory method, yields :class:`.storage.key.Key` items from response.

gcloud/storage/test_bucket.py

@@ -334,8 +334,9 @@ def __init__(self, bucket, name):
                 self._bucket = bucket
                 self._name = name
 
-            def set_contents_from_filename(self, filename):
+            def upload_from_filename(self, filename):
                 _uploaded.append((self._bucket, self._name, filename))
+
         bucket = self._makeOne()
         with _Monkey(MUT, Key=_Key):
             bucket.upload_file(FILENAME)
@@ -354,8 +355,9 @@ def __init__(self, bucket, name):
                 self._bucket = bucket
                 self._name = name
 
-            def set_contents_from_filename(self, filename):
+            def upload_from_filename(self, filename):
                 _uploaded.append((self._bucket, self._name, filename))
+
         bucket = self._makeOne()
         with _Monkey(MUT, Key=_Key):
             bucket.upload_file(FILENAME, KEY)

gcloud/storage/test_iterator.py

@@ -75,6 +75,13 @@ def test_get_query_params_w_token(self):
         self.assertEqual(iterator.get_query_params(),
                          {'pageToken': TOKEN})
 
+    def test_get_query_params_extra_params(self):
+        connection = _Connection()
+        PATH = '/foo'
+        extra_params = {'key': 'val'}
+        iterator = self._makeOne(connection, PATH, extra_params=extra_params)
+        self.assertEqual(iterator.get_query_params(), extra_params)
+
     def test_get_next_page_response_new_no_token_in_response(self):
         PATH = '/foo'
         TOKEN = 'token'