Merge lp:~jderose/microfiber/att into lp:microfiber

[Jason Gerard DeRose]

For details and rational, see bug:

  https://bugs.launchpad.net/microfiber/+bug/1078656

Changes:

  * Adds `Attachment(content_type, data)` namedtuple

  * `CouchBase.get_att()` now returns an `Attachment` namedtuple rather than a vanilla tuple

  * Adds `encode_attachment(attachment)` function

  * Adds experimental `CouchBase.put_att2()` method to evaluate possible breaking `CouchBase.put_att()` API change

[David Jordan (dmj726)]

Looks good, approved.

review: Approve

=== modified file 'microfiber.py'
--- microfiber.py	2012-11-06 21:07:38 +0000
+++ microfiber.py	2012-11-14 10:46:21 +0000
@@ -58,6 +58,7 @@
 from queue import Queue
 import math
 import platform
+from collections import namedtuple
 
 # Monkey patch python3.2 to add ssl.OP_NO_COMPRESSION available in python3.3:
 if not hasattr(ssl, 'OP_NO_COMPRESSION'):
@@ -110,6 +111,8 @@
 )
 DEFAULT_URL = HTTP_IPv4_URL
 
+Attachment = namedtuple('Attachment', 'content_type data')
+
 
 class BulkConflict(Exception):
     """
@@ -307,6 +310,25 @@
     return dumps(obj).encode('utf-8')
 
 
+def encode_attachment(attachment):
+    """
+    Encode *attachment* for use in ``doc['_attachments']``.
+
+    For example:
+
+    >>> attachment = Attachment('image/png', b'PNG data')
+    >>> dumps(encode_attachment(attachment))
+    '{"content_type":"image/png","data":"UE5HIGRhdGE="}'
+
+    :param attachment: an `Attachment` namedtuple
+    """
+    assert isinstance(attachment, Attachment)    
+    return {
+        'content_type': attachment.content_type,
+        'data': b64encode(attachment.data).decode('utf-8'),        
+    }
+
+
 def _queryiter(options):
     """
     Return appropriately encoded (key, value) pairs sorted by key.
@@ -804,6 +826,17 @@
             {'Content-Type': mime}
         )
 
+    def put_att2(self, attachment, *parts, **options):
+        """
+        Experiment for possible CouchBase.put_att() API change.
+
+        WARNING: regardless how the experiment turns out, this method will be
+        removed!
+        """
+        return self.recv_json('PUT', parts, options, attachment.data,
+            {'Content-Type': attachment.content_type}
+        )
+
     def get_att(self, *parts, **options):
         """
         GET an attachment.
@@ -823,8 +856,9 @@
         :param options: optional keyword arguments to include in query
         """
         response = self.request('GET', parts, options)
+        content_type = response.getheader('Content-Type')
         data = response.read()
-        return (response.getheader('Content-Type'), data)
+        return Attachment(content_type, data)
 
 
 class Server(CouchBase):

=== modified file 'test_microfiber.py'
--- test_microfiber.py	2012-11-06 21:07:38 +0000
+++ test_microfiber.py	2012-11-14 10:46:21 +0000
@@ -250,6 +250,17 @@
         # Test when obj is pre-encoded bytes
         self.assertEqual(microfiber._json_body(json_bytes), json_bytes)
 
+    def test_encode_attachment(self):
+        data = os.urandom(1776)
+        att = microfiber.Attachment('image/jpeg', data)
+        self.assertEqual(
+            microfiber.encode_attachment(att),
+            {
+                'content_type': 'image/jpeg',
+                'data': b64encode(data).decode('utf-8'),
+            }
+        )
+
     def test_queryiter(self):
         f = microfiber._queryiter
         d = dict(foo=True, bar=False, baz=None, aye=10, zee=17.5, key='app')
@@ -1966,10 +1977,10 @@
         self.assertEqual(att['data'], b64encode(data).decode('utf-8'))
 
         # GET the attachment
-        self.assertEqual(
-            inst.get_att(self.db, 'doc1', 'att'),
-            (mime, data)
-        )
+        att = inst.get_att(self.db, 'doc1', 'att')
+        self.assertIsInstance(att, microfiber.Attachment)
+        self.assertEqual(att.content_type, mime)
+        self.assertEqual(att.data, data)
 
         # Create new doc with inline attachment:
         new = {
@@ -2005,11 +2016,48 @@
         )
 
         # GET the attachment:
+        att = inst.get_att(self.db, 'doc1', 'att')
+        self.assertIsInstance(att, microfiber.Attachment)
+        self.assertEqual(att.content_type, mime)
+        self.assertEqual(att.data, data)
+
+    def test_put_att2(self):
+        inst = microfiber.CouchBase(self.env)
+
+        # Create database
+        self.assertEqual(inst.put(None, 'foo'), {'ok': True})
+
+        data = os.urandom(1776)
+        att = microfiber.Attachment('image/png', data)
+        digest = b64encode(md5(data).digest()).decode('utf-8')
+
+        # PUT attachment
+        r = inst.put_att2(att, 'foo', 'bar', 'baz')
+        self.assertEqual(set(r), set(['id', 'rev', 'ok']))
+        self.assertEqual(r['id'], 'bar')
+        self.assertEqual(r['ok'], True)
+        self.assertTrue(r['rev'].startswith('1-'))
+
+        # GET the doc with attachments=true
+        doc = inst.get('foo', 'bar', attachments=True)
+        self.assertEqual(set(doc), set(['_id', '_rev', '_attachments']))
+        self.assertEqual(doc['_id'], 'bar')
+        self.assertEqual(doc['_rev'], r['rev'])
         self.assertEqual(
-            inst.get_att(self.db, 'doc2', 'att'),
-            (mime, data)
+            doc['_attachments'],
+            {
+                'baz': {
+                    'content_type': 'image/png',
+                    'data': b64encode(data).decode('ascii'),
+                    'revpos': 1,
+                    'digest': 'md5-{}'.format(digest),
+                },
+            }
         )
 
+        # Test the round-trip
+        self.assertEqual(inst.get_att('foo', 'bar', 'baz'), att)
+
     def test_put_post(self):
         inst = self.klass(self.env)