introduce return_raw_response engine attribute

Author: maxtepkeev

CHANGELOG.rst

@@ -47,6 +47,8 @@ Changelog
   registry, to which, all resources that inherit from any Python-Redmine resource are being automatically added
 - Removed ``container_many`` in favor of ``container_filter``, ``container_create`` and ``container_update``
   attributes on ``Resource`` object to allow more fine-grained resource setup
+- ``return_raw`` parameter on ``engine.request()`` and ``engine.process_response()`` methods has been removed
+  in favor of ``return_raw_response`` attribute on engine object
 
 **Bugfixes**:
 

redminelib/__init__.py

@@ -30,6 +30,7 @@ def __init__(self, url, **kwargs):
         :param raise_attr_exception: (optional). Control over resource attribute access exception raising.
         :type raise_attr_exception: bool or tuple
         :param cls engine: (optional). Engine that will be used to make requests to Redmine.
+        :param bool return_raw_response (optional). Whether engine should return raw or json encoded responses.
         """
         self.url = url.rstrip('/')
         self.ver = kwargs.get('version', None)
@@ -123,7 +124,8 @@ def download(self, url, savepath=None, filename=None, params=None):
         :param string filename: (optional). Name that will be used for the file.
         :param dict params: (optional). Params to send in the query string.
         """
-        response = self.engine.request('get', url, params=dict(params or {}, **{'stream': True}), return_raw=True)
+        with self.session(return_raw_response=True):
+            response = self.engine.request('get', url, params=dict(params or {}, **{'stream': True}))
 
         # If a savepath wasn't provided we return a response directly
         # so a user can have maximum control over response data

redminelib/engines/base.py

@@ -17,7 +17,9 @@ def __init__(self, **options):
         :param string password: (optional). Password used for authentication.
         :param dict requests: (optional). Connection options.
         :param string impersonate: (optional). Username to impersonate.
+        :param bool return_raw_response (optional). Whether to return raw or json encoded responses.
         """
+        self.return_raw_response = options.pop('return_raw_response', False)
         self.requests = dict(dict(headers={}, params={}, data={}), **options.get('requests', {}))
 
         if options.get('impersonate') is not None:
@@ -59,7 +61,7 @@ def construct_request_kwargs(method, headers, params, data):
 
         return kwargs
 
-    def request(self, method, url, headers=None, params=None, data=None, return_raw=False):
+    def request(self, method, url, headers=None, params=None, data=None):
         """
         Makes a single request to Redmine and returns processed response.
 
@@ -69,10 +71,9 @@ def request(self, method, url, headers=None, params=None, data=None, return_raw=
         :param dict params: (optional). Params to send in the query string.
         :param data: (optional). Data to send in the body of the request.
         :type data: dict, bytes or file-like object
-        :param bool return_raw: (optional). Whether to return raw or json encoded response.
         """
         kwargs = self.construct_request_kwargs(method, headers, params, data)
-        return self.process_response(self.session.request(method, url, **kwargs), return_raw)
+        return self.process_response(self.session.request(method, url, **kwargs))
 
     def bulk_request(self, method, url, container, **params):
         """
@@ -125,13 +126,11 @@ def process_bulk_request(self, method, url, container, bulk_params):
         """
         raise NotImplementedError
 
-    @staticmethod
-    def process_response(response, return_raw=False):
+    def process_response(self, response):
         """
         Processes response received from Redmine.
 
         :param obj response: (required). Response object with response details.
-        :param bool return_raw: (optional). Whether to return raw or json encoded response.
         """
         if response.history:
             r = response.history[0]
@@ -141,7 +140,7 @@ def process_response(response, return_raw=False):
         status_code = response.status_code
 
         if status_code in (200, 201, 204):
-            if return_raw:
+            if self.return_raw_response:
                 return response
             elif not response.content.strip():
                 return True