Merge pull request #29 from soda480/0.3.4

Add Head method

README.md

@@ -91,6 +91,12 @@ The examples below show how RESTclient can be used to consume the GitHub REST AP
 >>> client.delete('/repos/soda480/test-repo1')
 ```
 
+`HEAD` request
+```python
+>>> response = client.head('/user/repos', raw_response=True)
+>>> response.headers
+```
+
 #### Retries
 Add support for retry using the `retrying` library: https://pypi.org/project/retrying/
 

src/main/python/rest3client/restclient.py

@@ -21,6 +21,7 @@
 import base64
 import requests
 from collections.abc import Iterable
+from functools import wraps
 
 from rest3client.ssladapter import SSLAdapter
 from retrying import retry
@@ -178,6 +179,7 @@ def get_response(self, response, **kwargs):
     def request_handler(function):
         """ decorator to process arguments and response for request method
         """
+        @wraps(function)
         def _request_handler(self, endpoint, **kwargs):
             """ decorator method to prepare and handle requests and responses
             """
@@ -188,7 +190,6 @@ def _request_handler(self, endpoint, **kwargs):
                 return
             response = function(self, endpoint, **arguments)
             return self.get_response(response, **kwargs)
-
         return _request_handler
 
     @request_handler
@@ -221,6 +222,12 @@ def patch(self, endpoint, **kwargs):
         """
         return self.session.request('patch', kwargs.pop('address'), **kwargs)
 
+    @request_handler
+    def head(self, endpoint, **kwargs):
+        """ helper method to submit head requests
+        """
+        return self.session.request('head', kwargs.pop('address'), **kwargs)
+
     def get_retry_methods(self):
         """ return list of retry_ methods found in self
         """

src/unittest/python/test_RESTclient.py

@@ -428,6 +428,19 @@ def test__patch_Should_CallRequestsPatch_When_Called(self, *patches):
             verify=client.cabundle)
         self.assertTrue(requests_patch_call in client.session.request.mock_calls)
 
+    @patch('rest3client.restclient.os.access')
+    @patch('rest3client.restclient.requests.Session')
+    def test__head_Should_CallRequestsHead_When_Called(self, *patches):
+        client = RESTclient('api.name.com')
+        client.head('/rest/endpoint')
+        requests_head_call = call(
+            'head',
+            'https://api.name.com/rest/endpoint',
+            headers={
+                'Content-Type': 'application/json'},
+            verify=client.cabundle)
+        self.assertTrue(requests_head_call in client.session.request.mock_calls)
+
     @patch('rest3client.restclient.os.access')
     @patch('rest3client.restclient.requests.Session')
     def test__delete_Should_CallRequestsDelete_When_Called(self, *patches):