Version 1.0.23: Fix encoding issues with differences in Py2-Py3

* Jobs are now iterable

Author: Dario Varotto

pytest.ini

@@ -3,3 +3,7 @@
 # -s 	=> avoid capturing stdout: we want to see prints ;)
 # -n 4	=> runs in parallel
 addopts = -s
+
+log_format = %(asctime)s %(levelname)s %(message)s
+log_date_format = %Y-%m-%d %H:%M:%S
+

ravenpackapi/core.py

@@ -14,7 +14,7 @@
 from ravenpackapi.utils.constants import JSON_AVAILABLE_FIELDS, ENTITY_TYPES
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete')
-VERSION = '1.0.22'
+VERSION = '1.0.23'
 
 logger = logging.getLogger("ravenpack.core")
 
@@ -50,7 +50,6 @@ def request(self, endpoint, data=None, params=None, method='get', stream=False):
             'Method {used} not accepted. Please choose one of {valid_methods}'.format(
                 used=method, valid_methods=", ".join(_VALID_METHODS)
             )
-        logger.debug("Request to %s" % endpoint)
         requests_call = getattr(requests, method)
         logger.debug("Request {method} to {endpoint}".format(method=method,
                                                              endpoint=endpoint))

ravenpackapi/models/job.py

@@ -125,3 +125,8 @@ def iterate_results(self):
             for line in iterator:
                 fields = parse_csv_line(line)
                 yield fields
+
+    def __iter__(self):
+        # this will be yield from in Py3
+        for record in self.iterate_results():
+            yield record

ravenpackapi/tests/test_encoding.py

@@ -0,0 +1,42 @@
+from ravenpackapi import RPApi, Dataset
+
+
+class TestEncoding(object):
+    api = RPApi()
+
+    @classmethod
+    def setup_class(cls):
+        cls.ds = cls.api.create_dataset(
+            Dataset(
+                name='testing_encoding',
+                filters={
+                    "rp_entity_id": '9BFEB5'  # this entity has non-ascii name
+                },
+            )
+        )
+
+    params = dict(
+        start_date='2018-05-01 21:51',  # we have an event here
+        end_date='2018-05-01 21:52',
+    )
+
+    def test_json_iterate(self):
+        self.api.log_curl_commands = True
+
+        results = self.ds.json(
+            **self.params
+        )
+        assert results, 'We should have some result in the timerange'
+        for analytic_row in results:
+            print(analytic_row)
+
+    def test_dump_iterate(self):
+        results = self.ds.request_datafile(
+            **self.params
+        )
+        for analytic_row in results:
+            print(analytic_row)
+
+    @classmethod
+    def teardown_class(cls):
+        cls.ds.delete()

ravenpackapi/util.py

@@ -1,6 +1,7 @@
 import csv
 import sys
 
+import six
 from dateutil.relativedelta import relativedelta
 from dateutil.rrule import MO
 
@@ -90,10 +91,12 @@ def get_end(get_next_end):
 
 def parse_csv_line(line):
     """ Decode a line of CSV
-
         line is unicode
-        Python 2 wants utf-8, Python 3 wants "unicode" strings
     """
     if sys.version_info[0] < 3:
-        line = line.encode('utf-8')
+        if isinstance(line, six.text_type):
+            line = line.encode('utf-8')  # Python 2 wants utf8 bytes
+    else:
+        if not isinstance(line, six.text_type):
+            line = line.decode('utf-8')  # Python 3 wants strings
     return list(csv.reader((line,)))[0]

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = '1.0.22'
+VERSION = '1.0.23'
 
 with open('README.rst') as readme_file:
     readme = readme_file.read()