Merge lp:~ntoll/fom/requests-branch-978804 into lp:fom

[Nicholas Tollervey]

This branch introduces the following changes:

* All reference httplib2 is removed.
* The requests library is used instead to make calls to Fluidinfo.
* Changes in the test suite to take into account the above.

Also, given that requests simplifies the HTTP connectivity with Fluidinfo there is opportunity to simplify the whole db.py module in a later ticket. (The focus of this branch is to simply move from httplib2->requests).

[Nicholas Tollervey (ntoll)]

By the way, once reviewed and merged I'll push to pypi.python.org.

N.

[PA Parent (paparent)]

+1 LGTM, all tests pass!

review: Approve

[lp:~ntoll/fom/requests-branch-978804]

160. By Nicholas Tollervey on 2012-04-11

Fixed mention of httplib2 in build.bu

=== modified file 'build.bu'
--- build.bu	2010-09-18 01:23:10 +0000
+++ build.bu	2012-04-11 13:45:33 +0000
@@ -10,7 +10,7 @@
 ve.install deps=ve.new:
     {{ pip }} sphinx
     {{ pip }} sphinx-pypi-upload
-    {{ pip }} httplib2
+    {{ pip }} requests 
     {{ pip }} py
     {{ pip }} pytest-xdist
     {{ pip }} --no-deps -U .

=== modified file 'fom/db.py'
--- fom/db.py	2011-12-03 13:11:07 +0000
+++ fom/db.py	2012-04-11 13:45:33 +0000
@@ -32,7 +32,7 @@
 import types
 import urllib
 
-import httplib2
+import requests
 
 try:
     import json
@@ -107,7 +107,7 @@
     These are generally created by the API, and returned, and there is little
     use to create them manually.
 
-    :param response: An httplib2 response instance, which is a dict with an
+    :param response: A response instance, which is a dict with an
         additional status attribute.
     :param content: The body of the HTTP response.
     :param is_value: A boolean flag to indicate whether the response is from a
@@ -139,7 +139,7 @@
     """
 
     def __init__(self, response, content, is_value):
-        self.content_type = response['content-type']
+        self.content_type = response.headers['content-type']
         if ((is_value and self.content_type == PRIMITIVE_CONTENT_TYPE) or
             (self.content_type in DESERIALIZABLE_CONTENT_TYPES)):
             try:
@@ -148,11 +148,11 @@
                 self.value = content
         else:
             self.value = content
-        self.status = response.status
+        self.status = response.status_code
         self.response = response
         self.content = content
-        self.request_id = self.response.get('x-fluiddb-request-id')
-        self.error = self.response.get('x-fluiddb-error-class')
+        self.request_id = self.response.headers.get('x-fluiddb-request-id')
+        self.error = self.response.headers.get('x-fluiddb-error-class')
         if self.status >= 400:
             raise_error(self)
 
@@ -184,11 +184,11 @@
             raise ValueError('The domain for FluidDB must *not* end with'\
                              ' "/". Correct example:'\
                              ' https://fluiddb.fluidinfo.com')
-        self._http = httplib2.Http()
         self.base_url = base_url
         self.headers = {
             'User-agent': 'fom/%s' % version,
         }
+        self.session = requests.session(headers=self.headers)
         # XXX Backwards compat
         self.client = self
 
@@ -212,20 +212,16 @@
             `application/vnd.fluiddb.value+json` even if they are of a
             deserializable content type such as `application/json`
         """
-        req, params = self._build_request(method, path, payload, urlargs,
-                                          content_type)
-        fom_request_sent.send(self, request=params)
-        response, content = req(*params)
-        fom_response_received.send(self, response=(response.status,
-                                   content, response.copy()))
-        return FluidResponse(response, content, is_value)
-
-    def _build_request(self, method, path, payload, urlargs, content_type):
         payload, content_type = _get_body_and_type(payload, content_type)
         urlargs = urlargs or {}
         headers = self._get_headers(content_type)
         url = self._get_url(path, urlargs)
-        return self._http.request, (url, method, payload, headers)
+        fom_request_sent.send(self, request=(url, method, payload, headers))
+        response = self.session.request(method, url, data=payload,
+            headers=headers)
+        fom_response_received.send(self, response=(response.status_code,
+                                   response.text, None))
+        return FluidResponse(response, response.text, is_value)
 
     def _get_headers(self, content_type):
         headers = self.headers.copy()

=== modified file 'fom/tx.py'
--- fom/tx.py	2010-11-29 12:52:12 +0000
+++ fom/tx.py	2012-04-11 13:45:33 +0000
@@ -73,9 +73,10 @@
     """
 
     def __init__(self, response):
-        self.status = response.code
+        self.status_code = response.code
+        self.headers = {}
         for k, v in response.headers.getAllRawHeaders():
-            self[k.lower()] = v[0]
+            self.headers[k.lower()] = v[0]
 
 
 class TxFluidDB(FluidDB):

=== modified file 'fom/version.py'
--- fom/version.py	2011-12-12 11:38:16 +0000
+++ fom/version.py	2012-04-11 13:45:33 +0000
@@ -9,5 +9,5 @@
     :license: MIT, see LICENSE for more information.
 """
 
-version = '0.9.7'
+version = '0.9.8'
 

=== modified file 'setup.py'
--- setup.py	2012-03-05 16:51:35 +0000
+++ setup.py	2012-04-11 13:45:33 +0000
@@ -13,6 +13,6 @@
     url='http://packages.python.org/Fom/',
     packages=['fom'],
     scripts=['bin/fdbc'],
-    install_requires=['httplib2', 'blinker'],
+    install_requires=['requests', 'blinker'],
 )
 

=== modified file 'tests/_base.py'
--- tests/_base.py	2010-11-30 14:59:41 +0000
+++ tests/_base.py	2012-04-11 13:45:33 +0000
@@ -12,15 +12,17 @@
 from collections import deque
 
 
-from fom.db import FluidDB, _generate_endpoint_url
+from fom.db import FluidDB, _generate_endpoint_url, NO_CONTENT, FluidResponse
 
 
 class FakeHttpLibResponse(dict):
 
-    def __init__(self, status, content_type):
+    def __init__(self, status, content_type, content=None):
         # yeah, I know, blame httplib2 for this API
-        self.status = status
-        self['content-type'] = content_type
+        self.status_code = status
+        self.headers = {}
+        self.headers['content-type'] = content_type
+        self.text = content
 
 
 class FakeHttpLibRequest(object):
@@ -39,14 +41,14 @@
         FluidDB.__init__(self, 'http://testing')
         self.reqs = []
         self.resps = deque()
-        self.default_response = (
-            FakeHttpLibResponse(200, 'text/plain'), 'empty')
+        self.default_response = FakeHttpLibResponse(200, 'text/plain', 'empty')
 
     def add_resp(self, status, content_type, content):
-        hresp = FakeHttpLibResponse(status, content_type)
-        self.resps.append((hresp, content))
+        hresp = FakeHttpLibResponse(status, content_type, content)
+        self.resps.append(hresp)
 
-    def _build_request(self, method, path, payload, urlargs, content_type):
+    def __call__(self, method, path, payload=NO_CONTENT, urlargs=None,
+                       content_type=None, is_value=False):
         path = _generate_endpoint_url('', path, '')
         req = (method, path, payload, urlargs, content_type)
         self.reqs.append(req)
@@ -54,5 +56,4 @@
             resp = self.resps.popleft()
         except IndexError:
             resp = self.default_response
-        return FakeHttpLibRequest(resp), (method, path, payload, urlargs,
-            content_type)
+        return FluidResponse(resp, resp.text, is_value)

=== modified file 'tests/test_base.py'
--- tests/test_base.py	2010-12-24 15:30:04 +0000
+++ tests/test_base.py	2012-04-11 13:45:33 +0000
@@ -22,5 +22,5 @@
         payload = 'fluiddb'
         urlargs = {'ham': 'eggs'}
         content_type = 'text/plain'
-        fake._build_request(method, path, payload, urlargs, content_type)
+        fake(method, path, payload, urlargs, content_type)
         self.assertEqual('/foo%2Fbar/baz/qux', fake.reqs[0][1])

=== modified file 'tests/test_tx.py'
--- tests/test_tx.py	2011-01-19 10:26:21 +0000
+++ tests/test_tx.py	2012-04-11 13:45:33 +0000
@@ -8,7 +8,7 @@
 class TestTxFluidDB(unittest.TestCase):
 
     def setUp(self):
-        self.db = TxFluidDB('https://sandbox.fluidinfo.com')
+        self.db = TxFluidDB('http://sandbox.fluidinfo.com')
 
     @defer.inlineCallbacks
     def testRequest(self):