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

[Jason Gerard DeRose]

For details, see this bug:

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

Changes include:

 * Replaces `microfiber.random_id()` with `dbase32.random_id()`

 * Updates all tests for D-Base32 encoding

 * Drops the `ssl.OP_NO_COMPRESSION` monkey-patch for Python 3.2 (`dbase32` requires Python 3.3 or newer so we can use the modern Unicode API in the C extension)

 * setup.py now enforces Python >= 3.3

 * Updates debian/control to require Python >= 3.3, Build-Depend and Depend on `python3-dbase32`

 * Removes the "microfiber-crashdb.conf" file as we're only supporting Apport 2.5 and newer now, so we can use the modern way of specifying the same inside the source_microfiber.py hook

[xzcvczx (xzcvczx)]

Looking good.

review: Approve

=== modified file 'debian/control'
--- debian/control	2012-11-22 00:02:31 +0000
+++ debian/control	2013-02-12 09:46:22 +0000
@@ -3,16 +3,17 @@
 Priority: optional
 Maintainer: Jason Gerard DeRose <[e-mail]>
 Build-Depends: debhelper (>= 9),
-    python3-all (>= 3.2),
+    python3-all (>= 3.3),
     python3-sphinx,
-    python3-usercouch (>= 12.11), 
+    python3-dbase32,
+    python3-usercouch (>= 13.02), 
 Standards-Version: 3.9.3
-X-Python3-Version: >= 3.2
+X-Python3-Version: >= 3.3
 Homepage: https://launchpad.net/microfiber
 
 Package: python3-microfiber
 Architecture: all
-Depends: ${python3:Depends}, ${misc:Depends}
+Depends: ${python3:Depends}, ${misc:Depends}, python3-dbase32
 Suggests: python3-usercouch, python3-microfiber-doc
 Description: fabric for a lightweight Couch
  Microfiber is an abstract adapter for making HTTP requests to an arbitrary JSON
 
=== removed file 'debian/microfiber-crashdb.conf'
--- debian/microfiber-crashdb.conf	2012-09-05 05:19:07 +0000
+++ debian/microfiber-crashdb.conf	1970-01-01 00:00:00 +0000
@@ -1,4 +0,0 @@
-microfiber = {
-    'impl': 'launchpad',
-    'project': 'microfiber',
-}
 
=== modified file 'debian/python3-microfiber.install'
--- debian/python3-microfiber.install	2012-09-05 07:51:05 +0000
+++ debian/python3-microfiber.install	2013-02-12 09:46:22 +0000
@@ -1,2 +1,1 @@
-debian/microfiber-crashdb.conf etc/apport/crashdb.conf.d/
 debian/source_microfiber.py usr/share/apport/package-hooks/
 
=== modified file 'debian/source_microfiber.py'
--- debian/source_microfiber.py	2012-09-05 07:51:05 +0000
+++ debian/source_microfiber.py	2013-02-12 09:46:22 +0000
@@ -1,9 +1,10 @@
-'''apport package hook for microfiber.
+"""
+Apport package hook for microfiber (requires Apport 2.5 or newer).
 
 (c) 2012 Novacut Inc
 Author: Jason Gerard DeRose <[e-mail]>
-'''
+"""
 
 def add_info(report):
-    report['CrashDB'] = 'microfiber'
+    report['CrashDB'] = "{'impl': 'launchpad', 'project': 'microfiber'}"
 
 
=== modified file 'microfiber.py'
--- microfiber.py	2013-01-28 13:38:33 +0000
+++ microfiber.py	2013-02-12 09:46:22 +0000
@@ -43,9 +43,8 @@
     https://launchpad.net/microfiber
 """
 
-from os import urandom
 from io import BufferedReader, TextIOWrapper
-from base64 import b32encode, b64encode
+from base64 import b64encode
 import json
 from gzip import GzipFile
 import time
@@ -60,9 +59,7 @@
 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'):
-    ssl.OP_NO_COMPRESSION = 131072  
+from dbase32 import random_id, RANDOM_BITS, RANDOM_BYTES, RANDOM_B32LEN
 
 
 __all__ = (
@@ -95,10 +92,6 @@
 DC3_CMD = ('/usr/bin/dc3', 'GetEnv')
 DMEDIA_CMD = ('/usr/bin/dmedia-cli', 'GetEnv')
 
-RANDOM_BITS = 120
-RANDOM_BYTES = RANDOM_BITS // 8
-RANDOM_B32LEN = RANDOM_BITS // 5
-
 HTTP_IPv4_URL = 'http://127.0.0.1:5984/'
 HTTPS_IPv4_URL = 'https://127.0.0.1:6984/'
 HTTP_IPv6_URL = 'http://[::1]:5984/'
@@ -213,21 +206,6 @@
 }
 
 
-def random_id(numbytes=RANDOM_BYTES):
-    """
-    Returns a 120-bit base32-encoded random ID.
-
-    The ID will be 24-characters long, URL and filesystem safe.  For example:
-
-    >>> random_id()  #doctest: +SKIP
-    'OVRHK3TUOUQCWIDMNFXGC4TP'
-
-    This is how dmedia/Novacut random IDs are created, so this is "Jason
-    approved", for what that's worth.
-    """
-    return b32encode(urandom(numbytes)).decode('utf-8')
-
-
 def random_id2():
     """
     Returns a random ID with timestamp + 80 bits of base32-encoded random data.
@@ -238,11 +216,7 @@
     '1313567384.67DFPERIOU66CT56'
 
     """
-    return '-'.join([
-        str(int(time.time())),
-        b32encode(urandom(10)).decode('utf-8')
-    ])
-
+    return '-'.join([str(int(time.time())), random_id(10)])
 
 
 def dc3_env():
@@ -392,7 +366,7 @@
 def _oauth_header(oauth, method, baseurl, query, testing=None):
     if testing is None:
         timestamp = str(int(time.time()))
-        nonce = b32encode(urandom(10)).decode('utf-8')
+        nonce = random_id()
     else:
         (timestamp, nonce) = testing
     o = {
 
=== modified file 'setup.py'
--- setup.py	2013-01-16 09:12:55 +0000
+++ setup.py	2013-02-12 09:46:22 +0000
@@ -30,8 +30,8 @@
 """
 
 import sys
-if sys.version_info < (3, 2):
-    sys.exit('Microfiber requires Python 3.2 or newer')
+if sys.version_info < (3, 3):
+    sys.exit('Microfiber requires Python 3.3 or newer')
 
 from distutils.core import setup
 from distutils.cmd import Command
 
=== modified file 'test_microfiber.py'
--- test_microfiber.py	2012-12-20 10:28:47 +0000
+++ test_microfiber.py	2013-02-12 09:46:22 +0000
@@ -31,7 +31,7 @@
 from unittest import TestCase
 import os
 from os import path
-from base64 import b64encode, b64decode, b32encode, b32decode
+from base64 import b64encode, b64decode
 from copy import deepcopy
 import json
 import gzip
@@ -45,16 +45,15 @@
 import ssl
 import threading
 from random import SystemRandom
+
 from usercouch.misc import TempCouch, TempPKI
+from dbase32 import db32dec, isdb32, random_id
 
 import microfiber
-from microfiber import random_id
 from microfiber import NotFound, MethodNotAllowed, Conflict, PreconditionFailed
 
 
 random = SystemRandom()
-B32ALPHABET = frozenset('234567ABCDEFGHIJKLMNOPQRSTUVWXYZ')
-
 
 # OAuth 1.0a test vector from http://oauth.net/core/1.0a/#anchor46
 
@@ -101,25 +100,21 @@
 
 def test_id():
     """
-    So we can tell our random test IDs from the ones microfiber.random_id()
+    So we can tell our random test IDs from the ones random_id()
     makes, we use 160-bit IDs instead of 120-bit.
     """
-    return b32encode(os.urandom(20)).decode('ascii')
+    return random_id(20)
 
 
 def is_microfiber_id(_id):
-    assert isinstance(_id, str)
-    return (
-        len(_id) == microfiber.RANDOM_B32LEN
-        and set(_id).issubset(B32ALPHABET)
-    )
+    return len(_id) == microfiber.RANDOM_B32LEN and isdb32(_id)
 
-assert is_microfiber_id(microfiber.random_id())
+assert is_microfiber_id(random_id())
 assert not is_microfiber_id(test_id())
 
 
 def random_dbname():
-    return 'db-' + microfiber.random_id().lower()
+    return 'db-' + random_id().lower()
 
 
 def random_oauth():
@@ -147,14 +142,13 @@
 
 
 class TestFunctions(TestCase):
-
     def test_random_id(self):
         _id = microfiber.random_id()
         self.assertIsInstance(_id, str)
         self.assertEqual(len(_id), 24)
-        b = b32decode(_id.encode('ascii'))
+        b = db32dec(_id)
         self.assertIsInstance(b, bytes)
-        self.assertEqual(len(b) * 8, 120)
+        self.assertEqual(len(b), 15)
 
     def test_random_id2(self):
         _id = microfiber.random_id2()
@@ -164,9 +158,9 @@
         self.assertEqual(len(t), 10)
         self.assertTrue(int(t) > 1234567890)
         self.assertEqual(len(r), 16)
-        b = b32decode(r.encode('ascii'))
+        b = db32dec(r)
         self.assertIsInstance(b, bytes)
-        self.assertEqual(len(b) * 8, 80)
+        self.assertEqual(len(b), 10)
 
     def test_json(self):
         """
@@ -1029,7 +1023,7 @@
         url = '/restful?and=awesome'
         for (status, klass) in microfiber.errors.items():
             self.assertTrue(klass.__doc__.startswith('{} '.format(status)))
-            reason = b32encode(os.urandom(10))
+            reason = random_id(10)
             data = os.urandom(20)
             r = FakeResponse(status, reason, data)
             inst = klass(r, method, url)