Add accessors for read-only properties of a server-side object.

Addresses part of #313.

Author: tseaver

gcloud/storage/key.py

@@ -15,6 +15,19 @@ class Key(_PropertyMixin):
 
     CUSTOM_PROPERTY_ACCESSORS = {
         'acl': 'get_acl()',
+        'componentCount': 'component_count',
+        'etag': 'etag',
+        'generation': 'generation',
+        'id': 'id',
+        'mediaLink': 'media_link',
+        'metageneration': 'metageneration',
+        'name': 'name',
+        'owner': 'owner',
+        'selfLink': 'self_link',
+        'size': 'size',
+        'storageClass': 'storage_class',
+        'timeDeleted': 'time_deleted',
+        'updated': 'updated',
     }
     """Map field name -> accessor for fields w/ custom accessors."""
 
@@ -359,6 +372,133 @@ def make_public(self):
         self.acl.save()
         return self
 
+    @property
+    def component_count(self):
+        """Number of underlying components that make up this object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: integer
+        """
+        return self.properties['componentCount']
+
+    @property
+    def etag(self):
+        """Retrieve the ETag for the object.
+
+        See: http://tools.ietf.org/html/rfc2616#section-3.11 and
+             https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: string
+        """
+        return self.properties['etag']
+
+    @property
+    def generation(self):
+        """Retrieve the generation for the object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: integer
+        """
+        return self.properties['generation']
+
+    @property
+    def id(self):
+        """Retrieve the ID for the object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: string
+        """
+        return self.properties['id']
+
+    @property
+    def media_link(self):
+        """Retrieve the media download URI for the object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: string
+        """
+        return self.properties['selfLink']
+
+    @property
+    def metageneration(self):
+        """Retrieve the metageneration for the object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: integer
+        """
+        return self.properties['metageneration']
+
+    @property
+    def owner(self):
+        """Retrieve info about the owner of the object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: dict
+        :returns: mapping of owner's role/ID.
+        """
+        return self.properties['owner'].copy()
+
+    @property
+    def self_link(self):
+        """Retrieve the URI for the object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: string
+        """
+        return self.properties['selfLink']
+
+    @property
+    def size(self):
+        """Size of the object,  in bytes.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: integer
+        """
+        return self.properties['size']
+
+    @property
+    def storage_class(self):
+        """Retrieve the storage class for the object.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects and
+        https://cloud.google.com/storage/docs/durable-reduced-availability#_DRA_Bucket
+
+        :rtype: string
+        :returns: Currently one of "STANDARD", "DURABLE_REDUCED_AVAILABILITY"
+        """
+        return self.properties['storageClass']
+
+    @property
+    def time_deleted(self):
+        """Retrieve the timestamp at which the object was deleted.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: string or None
+        :returns: timestamp in RFC 3339 format, or None if the object
+                  has a "live" version.
+        """
+        return self.properties.get('timeDeleted')
+
+    @property
+    def updated(self):
+        """Retrieve the timestamp at which the object was updated.
+
+        See: https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: string
+        :returns: timestamp in RFC 3339 format.
+        """
+        return self.properties['updated']
+
 
 class _KeyIterator(Iterator):
     """An iterator listing keys.

gcloud/storage/test_key.py

@@ -344,6 +344,116 @@ def test_make_public(self):
         self.assertEqual(kw[0]['data'], {'acl': permissive})
         self.assertEqual(kw[0]['query_params'], {'projection': 'full'})
 
+    def test_component_count(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        COMPONENT_COUNT = 42
+        properties = {'componentCount': COMPONENT_COUNT}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.component_count, COMPONENT_COUNT)
+
+    def test_etag(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        ETAG = 'ETAG'
+        properties = {'etag': ETAG}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.etag, ETAG)
+
+    def test_generation(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        GENERATION = 42
+        properties = {'generation': GENERATION}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.generation, GENERATION)
+
+    def test_id(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        ID = 'ID'
+        properties = {'id': ID}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.id, ID)
+
+    def test_media_link(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        MEDIA_LINK = 'http://example.com/media/'
+        properties = {'selfLink': MEDIA_LINK}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.media_link, MEDIA_LINK)
+
+    def test_metageneration(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        METAGENERATION = 42
+        properties = {'metageneration': METAGENERATION}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.metageneration, METAGENERATION)
+
+    def test_owner(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        OWNER = {'entity': 'project-owner-12345', 'entityId': '23456'}
+        properties = {'owner': OWNER}
+        key = self._makeOne(bucket, KEY, properties)
+        owner = key.owner
+        self.assertEqual(owner['entity'], 'project-owner-12345')
+        self.assertEqual(owner['entityId'], '23456')
+
+    def test_self_link(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        SELF_LINK = 'http://example.com/self/'
+        properties = {'selfLink': SELF_LINK}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.self_link, SELF_LINK)
+
+    def test_size(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        SIZE = 42
+        properties = {'size': SIZE}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.size, SIZE)
+
+    def test_storage_class(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        STORAGE_CLASS = 'http://example.com/self/'
+        properties = {'storageClass': STORAGE_CLASS}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.storage_class, STORAGE_CLASS)
+
+    def test_time_deleted(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        TIME_DELETED = '2014-11-05T20:34:37Z'
+        properties = {'timeDeleted': TIME_DELETED}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.time_deleted, TIME_DELETED)
+
+    def test_updated(self):
+        KEY = 'key'
+        connection = _Connection()
+        bucket = _Bucket(connection)
+        UPDATED = '2014-11-05T20:34:37Z'
+        properties = {'updated': UPDATED}
+        key = self._makeOne(bucket, KEY, properties)
+        self.assertEqual(key.updated, UPDATED)
+
 
 class Test__KeyIterator(unittest2.TestCase):