Add Unix Socket support

- Add new consul.adapters.UnixSocketRequest
- Refactor to make scheme configurable
- Update tests to reflect change
- Remove simplejson usage due to API differences

consulate/__init__.py

@@ -21,28 +21,43 @@ def emit(self, record):
 
 from consulate import adapters
 from consulate import api
+from consulate import utils
 
 DEFAULT_HOST = 'localhost'
 DEFAULT_PORT = 8500
-SCHEME = 'http'
+DEFAULT_SCHEME = 'http'
 VERSION = 'v1'
 
 
 class Consul(object):
-    """Access the Consul HTTP API via Python
+    """Access the Consul HTTP API via Python.
+
+    The default values connect to Consul via ``localhost:8500`` via http. If
+    you want to connect to Consul via a local UNIX socket, you'll need to
+    override both the ``scheme``, ``port`` and the ``adapter`` like so:
+
+    .. code:: python
+
+        consul = consulate.Consul('localhost', None, scheme='http+unix',
+                                  adapters=consulate.adapters.UnixSocketRequest)
+        services = consul.agent.services()
 
     :param str host: The host name to connect to (Default: localhost)
     :param int port: The port to connect on (Default: 8500)
     :param str datacenter: Specify a specific data center
     :param str token: Specify a ACL token to use
+    :param str scheme: Specify the scheme (Default: http)
+    :param class adapter: Specify to override the request adapter
+        (Default: :py:class:`consulate.adapters.Request`)
 
     """
     def __init__(self, host=DEFAULT_HOST, port=DEFAULT_PORT,
-                 datacenter=None, token=None, adapter=None):
+                 datacenter=None, token=None,
+                 scheme=DEFAULT_SCHEME, adapter=None):
         """Create a new instance of the Consul class"""
-        base_uri = self._base_uri(host, port)
+        base_uri = self._base_uri(scheme, host, port)
         if adapter:
-            self._adapter = adapter
+            self._adapter = adapter()
         else:
             self._adapter = adapters.Request()
         self._acl = api.ACL(base_uri, self._adapter, datacenter, token)
@@ -135,15 +150,19 @@ def status(self):
         return self._status
 
     @staticmethod
-    def _base_uri(host, port):
-        """Return the base URI to use for API requests
+    def _base_uri(scheme, host, port):
+        """Return the base URI to use for API requests. Set ``port`` to None
+        when creating a UNIX Socket URL.
 
+        :param str scheme: The scheme to use (Default: http)
         :param str host: The host name to connect to (Default: localhost)
-        :param int port: The port to connect on (Default: 8500)
+        :param int|None port: The port to connect on (Default: 8500)
         :rtype: str
 
         """
-        return '{0}://{1}:{2}/{3}'.format(SCHEME, host, port, VERSION)
+        if port:
+            return '{0}://{1}:{2}/{3}'.format(scheme, host, port, VERSION)
+        return '{0}://{1}/{2}'.format(scheme, utils.quote(host, ''), VERSION)
 
 
 # Backwards compatibility with 0.3.0

consulate/adapters.py

@@ -2,13 +2,11 @@
 HTTP Client Library Adapters
 
 """
+import json
 import logging
-import requests
 
-try:
-    import simplejson as json
-except ImportError:
-    import json
+import requests
+import requests_unixsocket
 
 from consulate import api
 from consulate import utils
@@ -52,7 +50,7 @@ def __init__(self, timeout=None):
             to consul.
         """
         self.session = requests.Session()
-        self._timeout = timeout
+        self.timeout = timeout
 
     def delete(self, uri):
         """Perform a HTTP delete
@@ -62,7 +60,7 @@ def delete(self, uri):
 
         """
         LOGGER.debug("DELETE %s", uri)
-        response = self.session.delete(uri, timeout=self._timeout)
+        response = self.session.delete(uri, timeout=self.timeout)
         return api.Response(response.status_code,
                             response.content,
                             response.headers)
@@ -75,7 +73,7 @@ def get(self, uri):
 
         """
         LOGGER.debug("GET %s", uri)
-        response = self.session.get(uri, timeout=self._timeout)
+        response = self.session.get(uri, timeout=self.timeout)
         return api.Response(response.status_code,
                             response.content,
                             response.headers)
@@ -96,9 +94,15 @@ def put(self, uri, data=None):
             headers = {'Content-Type': CONTENT_JSON}
         if not utils.PYTHON3 and data:
             data = data.encode('utf-8')
-        response = self.session.put(
-            uri, data=data, headers=headers, timeout=self._timeout
-        )
+        response = self.session.put(uri, data=data, headers=headers,
+                                    timeout=self.timeout)
         return api.Response(response.status_code,
                             response.content,
                             response.headers)
+
+
+class UnixSocketRequest(Request):
+    """Use to communicate with Consul over a Unix socket"""
+    def __init__(self, timeout=None):
+        self.session = requests_unixsocket.Session()
+        self.timeout = timeout

consulate/utils.py

@@ -3,6 +3,10 @@
 
 """
 import sys
+try:
+    from urllib.parse import quote
+except ImportError:
+    from urllib import quote
 
 PYTHON3 = True if sys.version_info > (3, 0, 0) else False
 

dev-requirements.txt

@@ -3,6 +3,5 @@ coverage==3.7.1
 httmock==1.2.2
 mock==1.0.1
 nose==1.3.4
-simplejson==3.6.5
 sphinx==1.3
 tornado>=3.0.0,<=4.2

requirements.txt

@@ -1 +1,2 @@
 requests>=2.0.0,<3.0.0
+requests-unixsocket>=0.1.4,<=1.0.0

tests/api-tests.py

@@ -17,7 +17,7 @@
 
 CONSUL_CONFIG = json.load(open('consul-test.json', 'r'))
 
-SCHEME = consulate.SCHEME
+SCHEME = consulate.DEFAULT_SCHEME
 VERSION = consulate.VERSION
 
 
@@ -55,9 +55,17 @@ def setUp(self, status, session, event, acl, health, kv, catalog,
                                        self.token)
 
     def test_base_uri(self):
-        self.assertEquals(self.consul._base_uri(self.host, self.port),
+        self.assertEquals(self.consul._base_uri(SCHEME, self.host, self.port),
                           self.base_uri)
 
+    def test_unix_socket_base_uri(self):
+        expectation = 'http+unix://%2Fvar%2Flib%2Fconsul%2Fconsul.sock/v1'
+        self.assertEquals(self.consul._base_uri('http+unix',
+                                                '/var/lib/consul/consul.sock',
+                                                None),
+                          expectation)
+
+
     def test_acl_initialization(self):
         self.assertTrue(self.acl.called_once_with(self.base_uri,
                                                   self.adapter, self.dc,

tests/kv-tests.py

@@ -14,7 +14,7 @@
 from consulate import adapters
 from consulate import api
 
-SCHEME = consulate.SCHEME
+SCHEME = consulate.DEFAULT_SCHEME
 VERSION = consulate.VERSION
 
 ALL_DATA = ('[{"CreateIndex":643,"ModifyIndex":643,"LockIndex":0,"Key":"bar",'

tests/utils-tests.py

@@ -0,0 +1,12 @@
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+from consulate import utils
+
+
+class TestQuote(unittest.TestCase):
+
+    def urlencode_test(self):
+        self.assertEqual("%2Ffoo%40bar", utils.quote("/foo@bar", ""))