Merge pull request #67 from vgupta-mickey/feature-OBJREQ-524-allow-X-EMC-Header-to-add

Allow X-EMC-Override header to add into API calls.

Author: padthaitofuhot

README.rst

@@ -70,7 +70,9 @@ arguments:
 +-----------------------+------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
 | ``cache_token``       | No         | True                   | Whether to cache the token, by default this is true you should only switch this to false when you want to directly fetch a token for a user   |
 +-----------------------+------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-
+| ``override_header``   | No         | None                   | Add X-EMC-Override header with the header value in API request only if it is not None
+  |
++-----------------------+------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
 This is how you can instantiate the ``Client`` class and use the library.
 
 .. code-block:: python
@@ -120,6 +122,20 @@ to obtain a new token on the next call. To do so, you can remove the cached toke
 
     client.remove_cached_token()
 
+Add X-EMC-Override: "true" header
+~~~~~~~~~~~~~~
+You can pass override_header to the client which means the user wants to add custom 
+X-EMC-Override header into API request
+
+.. code-block:: python
+
+    client = Client('3',
+                    username='someone',
+                    password='password',
+                    token_endpoint='https://192.168.1.146:4443/login',
+                    ecs_endpoint='https://192.168.1.146:4443',
+                    override_header='true')
+
 
 Supported endpoints
 -------------------

ecsclient/baseclient.py

@@ -23,7 +23,7 @@ class Client(object):
     def __init__(self, username=None, password=None, token=None,
                  ecs_endpoint=None, token_endpoint=None, verify_ssl=False,
                  token_path='/tmp/ecsclient.tkn',
-                 request_timeout=15.0, cache_token=True):
+                 request_timeout=15.0, cache_token=True, override_header=None):
         """
         Creates the ECSClient class that the client will directly work with
 
@@ -39,6 +39,7 @@ def __init__(self, username=None, password=None, token=None,
         :param cache_token: Whether to cache the token, by default this is true
         you should only switch this to false when you want to directly fetch
         a token for a user
+        :param override_header: X-EMC-Override header value into API calls
         """
         if not ecs_endpoint:
             raise ECSClientException("Missing 'ecs_endpoint'")
@@ -53,6 +54,7 @@ def __init__(self, username=None, password=None, token=None,
             if not (token or os.path.isfile(token_path)):
                 raise ECSClientException("'token_endpoint' not provided and missing 'token'|'token_path'")
 
+        self.override_header = override_header 
         self.username = username
         self.password = password
         self.token = token
@@ -104,9 +106,12 @@ def remove_cached_token(self):
 
     def _fetch_headers(self):
         token = self.token if self.token else self._token_request.get_token()
-        return {'Accept': 'application/json',
-                'Content-Type': 'application/json',
-                'x-sds-auth-token': token}
+        headers = {'Accept': 'application/json',
+                   'Content-Type': 'application/json',
+                   'x-sds-auth-token': token}
+        if self.override_header != None:
+            headers['X-EMC-Override'] = self.override_header
+        return headers
 
     def _construct_url(self, path):
         url = '{0}/{1}'.format(self.ecs_endpoint, path)