Add Key.rename from PR #99, with test.

tseaver · tseaver · commit d4fe9bf84727 · 2014-10-07T13:28:08.000-04:00
Manually applies patch from gsalgado: gsalgado@1c80d61 But changes semantics to return the new key instance, leaving the original key unchanged.
diff --git a/gcloud/storage/key.py b/gcloud/storage/key.py
@@ -134,6 +134,20 @@ def exists(self):
 
         return self.bucket.get_key(self.name) is not None
 
+    def rename(self, new_name):
+        """Renames this key.
+
+        Effectively, copies key to the same bucket with a new name, then
+        deletes the key.
+
+        :type new_name: string
+        :param new_name: The new name for this key.
+
+        :rtype: :class:`Key`
+        :returns: The newly-copied key.
+        """
+        return self.bucket.copy_key(self, self.bucket, new_name)
+
     def delete(self):
         """Deletes a key from Cloud Storage.
 
diff --git a/gcloud/storage/test_key.py b/gcloud/storage/test_key.py
@@ -95,6 +95,23 @@ def test_exists_hit(self):
         bucket._keys[KEY] = 1
         self.assertTrue(key.exists())
 
+    def test_rename(self):
+        KEY = 'key'
+        NEW_NAME = 'new-name'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        key = self._makeOne(bucket, KEY)
+        bucket._keys[KEY] = 1
+        orig_key_path = key.path
+        new_key = key.rename(NEW_NAME)
+        expected = [
+            ['POST', orig_key_path + '/copyTo/b/bucket/o/%s' % NEW_NAME, None],
+            ['DELETE', orig_key_path, None]]
+        self.assertEqual(key.name, KEY)
+        self.assertEqual(new_key.name, NEW_NAME)
+        self.assertFalse(KEY in bucket._keys)
+        self.assertTrue(NEW_NAME in bucket._keys)
+
     def test_delete(self):
         KEY = 'key'
         connection = _Connection()
@@ -594,5 +611,9 @@ def __init__(self, connection):
     def get_key(self, key):
         return self._keys.get(key)  # XXX s.b. 'key.name'?
 
+    def copy_key(self, key, destination_bucket, new_name):
+        destination_bucket._keys[new_name] = self._keys.pop(key.name)
+        return key.from_dict({'name': new_name}, bucket=destination_bucket)
+
     def delete_key(self, key):
         del self._keys[key.name]  # XXX s.b. 'key'?
