Merge pull request #10 from ggravlingen/add-retry

Add retry

pytradfri/__init__.py

@@ -1,9 +1,10 @@
 """Implement an API wrapper around Ikea Tradfri."""
 
+from .api import retry_timeout
 from .coap_cli import api_factory as cli_api_factory
 from .error import (
     PyTradFriError, RequestError, ClientError, ServerError, RequestTimeout)
 from .gateway import Gateway
 
 __all__ = ['Gateway', 'cli_api_factory', 'PyTradFriError', 'RequestError',
-           'ClientError', 'ServerError', 'RequestTimeout']
+           'ClientError', 'ServerError', 'RequestTimeout', 'retry_timeout']

pytradfri/api.py

@@ -0,0 +1,17 @@
+"""API utilities."""
+
+from .error import RequestTimeout
+
+
+def retry_timeout(api, retries=3):
+    """Retry API call when a timeout occurs."""
+    def retry_api(*args, **kwargs):
+        """Retrying API."""
+        for i in range(1, retries + 1):
+            try:
+                return api(*args, **kwargs)
+            except RequestTimeout:
+                if i == retries:
+                    raise
+
+    return retry_api

pytradfri/coap_cli.py

@@ -14,7 +14,7 @@
 
 def api_factory(host, security_code):
     """Generate a request method."""
-    def request(method, path, data=None, *, parse_json=True):
+    def request(method, path, data=None, *, parse_json=True, timeout=10):
         """Make a request."""
 
         path = '/'.join(str(v) for v in path)
@@ -34,7 +34,7 @@ def request(method, path, data=None, *, parse_json=True):
         ]
 
         kwargs = {
-            'timeout': 10,
+            'timeout': timeout,
             'stderr': subprocess.STDOUT,
         }
 

tests/test_api.py

@@ -0,0 +1,56 @@
+"""Test API utilities."""
+import pytest
+
+from pytradfri import retry_timeout, RequestTimeout
+
+
+def test_retry_timeout_passes_args():
+    """Test passing args."""
+    calls = []
+
+    def api(*args, **kwargs):
+        """Mock api"""
+        calls.append((args, kwargs))
+
+    retry_api = retry_timeout(api)
+
+    retry_api(1, 2, hello='world')
+    assert len(calls) == 1
+    args, kwargs = calls[0]
+    assert args == (1, 2)
+    assert kwargs == {'hello': 'world'}
+
+
+def test_retry_timeout_retries_timeouts():
+    """Test retrying timeout."""
+    calls = []
+
+    def api(*args, **kwargs):
+        """Mock api"""
+        calls.append((args, kwargs))
+
+        if len(calls) == 1:
+            raise RequestTimeout()
+
+    retry_api = retry_timeout(api, retries=2)
+
+    retry_api(1, 2, hello='world')
+    assert len(calls) == 2
+
+
+def test_retry_timeout_raises_after_max_retries():
+    """Test retrying timeout."""
+    calls = []
+
+    def api(*args, **kwargs):
+        """Mock api"""
+        calls.append((args, kwargs))
+
+        raise RequestTimeout()
+
+    retry_api = retry_timeout(api, retries=5)
+
+    with pytest.raises(RequestTimeout):
+        retry_api(1, 2, hello='world')
+
+    assert len(calls) == 5