improved put request

Author: jlwalke2

CHANGELOG.md

@@ -1,9 +1,13 @@
 
 Unreleased
 ----------
+**Changes**
+ - `put` request will take an `item` parameter that's used to automatically populate headers for updates.  
+
 **Bugfixes**
  - Convert NaN values to null (None) when calling `microanalytic_score.execute_module_step`.
 
+
 v1.2.2 (2019-8-21)
 ------------------
 **Bugfixes**

src/sasctl/core.py

@@ -632,30 +632,115 @@ def is_uuid(id):
         return False
 
 
-def get(*args, **kwargs):
+def get(path, **kwargs):
+    """Send a GET request.
+
+    Parameters
+    ----------
+    path : str
+        The path portion of the URL.
+    kwargs : any
+        Passed to `request`.
+
+    Returns
+    -------
+    RestObj or None
+        The results or None if the resource was not found.
+
+    """
     try:
-        return request('get', *args, **kwargs)
+        return request('get', path, **kwargs)
     except HTTPError as e:
         if e.code == 404:
             return None  # Resource not found
         else:
             raise e
 
 
-def head(*args, **kwargs):
-    return request('head', *args, **kwargs)
+def head(path, **kwargs):
+    """Send a HEAD request.
+
+    Parameters
+    ----------
+    path : str
+        The path portion of the URL.
+    kwargs : any
+        Passed to `request`.
+
+    Returns
+    -------
+    RestObj
 
+    """
+    return request('head', path, **kwargs)
 
-def post(*args, **kwargs):
-    return request('post', *args, **kwargs)
 
+def post(path, **kwargs):
+    """Send a POST request.
 
-def put(*args, **kwargs):
-    return request('put', *args, **kwargs)
+    Parameters
+    ----------
+    path : str
+        The path portion of the URL.
+    kwargs : any
+        Passed to `request`.
 
+    Returns
+    -------
+    RestObj
 
-def delete(*args, **kwargs):
-    return request('delete', *args, **kwargs)
+    """
+    return request('post', path, **kwargs)
+
+
+def put(path, item=None, **kwargs):
+    """Send a PUT request.
+
+    Parameters
+    ----------
+    path : str
+        The path portion of the URL.
+    item : RestObj, optional
+        A existing object to PUT.  If provided, ETag and Content-Type headers
+        will automatically be specified.
+    kwargs : any
+        Passed to `request`.
+
+    Returns
+    -------
+    RestObj
+
+    """
+    # If call is in the format put(url, RestObj), automatically fill in header
+    # information
+    if item is not None and isinstance(item, RestObj):
+        get_headers = getattr(item, '_headers', None)
+        if get_headers is not None:
+            # Update the headers param if it was specified
+            headers = kwargs.pop('headers', {})
+            headers.setdefault('If-Match', get_headers.get('etag'))
+            headers.setdefault('Content-Type', get_headers.get('content-type'))
+            return request('put', path, json=item, headers=headers)
+
+    return request('put', path, **kwargs)
+
+
+def delete(path, **kwargs):
+    """Send a DELETE request.
+
+    Parameters
+    ----------
+    path : str
+        The path portion of the URL.
+    kwargs : any
+        Passed to `request`.
+
+    Returns
+    -------
+    RestObj
+
+    """
+    return request('delete', path, **kwargs)
 
 
 def request(verb, path, session=None, raw=False, **kwargs):

tests/unit/test_core.py

@@ -111,3 +111,53 @@ def test_update_item():
     assert ('put', '/widget/12345') == request.call_args[0]
     assert target == resp
 
+
+def test_put_restobj():
+    from sasctl.core import put, RestObj
+
+    url = "/jobDefinitions/definitions/717331fa-f650-4e31-b9e2-6e6d49f66bf9"
+    obj = RestObj({
+        '_headers': {'etag': 123, 'content-type': 'spam'}
+    })
+
+    # Base case
+    with mock.patch('sasctl.core.request') as req:
+        put(url, obj)
+
+    assert req.called
+    args = req.call_args[0]
+    kwargs = req.call_args[1]
+
+    assert args == ('put', url)
+    assert kwargs['json'] == obj
+    assert kwargs['headers']['If-Match'] == 123
+    assert kwargs['headers']['Content-Type'] == 'spam'
+
+    # Should merge with explicit headers
+    with mock.patch('sasctl.core.request') as req:
+        put(url, obj, headers={'encoding': 'spammy'})
+
+    assert req.called
+    args = req.call_args[0]
+    kwargs = req.call_args[1]
+
+    assert args == ('put', url)
+    assert kwargs['json'] == obj
+    assert kwargs['headers']['If-Match'] == 123
+    assert kwargs['headers']['Content-Type'] == 'spam'
+    assert kwargs['headers']['encoding'] == 'spammy'
+
+    # Should not overwrite explicit headers
+    with mock.patch('sasctl.core.request') as req:
+        put(url, obj, headers={'Content-Type': 'notspam',
+                               'encoding': 'spammy'})
+
+    assert req.called
+    args = req.call_args[0]
+    kwargs = req.call_args[1]
+
+    assert args == ('put', url)
+    assert kwargs['json'] == obj
+    assert kwargs['headers']['If-Match'] == 123
+    assert kwargs['headers']['Content-Type'] == 'notspam'
+    assert kwargs['headers']['encoding'] == 'spammy'