Added tests for recognizing image from Bytes and Files (#44)

* Added tests for recognizing image from Bytes and Files

* Add ability to recognize image from bytes

Author: Denis-Averin

Makefile

@@ -8,10 +8,14 @@ check_git:
 	git fetch origin
 	git diff origin/main --exit-code
 
-.PHONY: clean
-clean:
+.PHONY: clean-git
+clean-git:
 	git clean -dfx --exclude='tests/configuration*.json'
 
+.PHONY: clean-pyc
+clean-pyc:
+	find . -type f -name '*.pyc' -delete
+
 .PHONY: dist
 dist:
 	python3 setup.py sdist bdist_wheel --universal
@@ -58,6 +62,10 @@ publish-docker: init-docker test-tox dist
 test:
 	python -Werror -m pytest --cov tests/
 
+.PHONY: unittest
+unittest:
+	python -Werror -m unittest discover -v
+
 .PHONY: test-example
 test-example:
 	python -Werror example.py

aspose_barcode_cloud/__init__.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# flake8: noqa
+# flake8: noqa: F401
 
 """
 
@@ -29,6 +29,8 @@
 
 from __future__ import absolute_import
 
+from aspose_barcode_cloud.rest import ApiException
+
 # import apis into sdk package
 from aspose_barcode_cloud.api.barcode_api import BarcodeApi
 from aspose_barcode_cloud.api.file_api import FileApi

aspose_barcode_cloud/api_client.py

@@ -26,8 +26,10 @@
 from __future__ import absolute_import, division
 
 import datetime
+import io
 import json
 import mimetypes
+from collections import namedtuple
 from multiprocessing.pool import ThreadPool
 import os
 import re
@@ -37,18 +39,23 @@
 import six
 from six.moves.urllib.parse import quote
 
+if not six.PY2:
+    from typing import Union
+    import pathlib
+
 from aspose_barcode_cloud.configuration import Configuration
 import aspose_barcode_cloud.models
-from aspose_barcode_cloud import rest
+from aspose_barcode_cloud.rest import RESTClientObject, ApiException
+
+FileFieldData = namedtuple("FileFieldData", ("file_name", "file_bytes", "mime_type"))
 
 
 class ApiClient(object):
     """Generic API client for Swagger client library builds.
 
-    Swagger generic API client. This client handles the client-
-    server communication, and is invariant across implementations. Specifics of
-    the methods and models for each application are generated from the Swagger
-    templates.
+    Swagger generic API client. This client handles the client-server communication,
+    and is invariant across implementations. Specifics of the methods and
+    models for each application are generated from the Swagger templates.
 
     NOTE: This class is auto generated by the swagger code generator program.
     Ref: https://github.com/swagger-api/swagger-codegen
@@ -81,7 +88,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, cook
 
         # Use the pool property to lazily initialize the ThreadPool.
         self._pool = None
-        self.rest_client = rest.RESTClientObject(configuration)
+        self.rest_client = RESTClientObject(configuration)
         self.default_headers = {
             "x-aspose-client": "python sdk",
             "x-aspose-client-version": "22.8.0",
@@ -485,7 +492,7 @@ def parameters_to_tuples(self, params, collection_formats):
         new_params = []
         if collection_formats is None:
             collection_formats = {}
-        for k, v in six.iteritems(params) if isinstance(params, dict) else params:  # noqa: E501
+        for k, v in six.iteritems(params) if isinstance(params, dict) else params:
             if k in collection_formats:
                 collection_format = collection_formats[k]
                 if collection_format == "multi":
@@ -504,29 +511,48 @@ def parameters_to_tuples(self, params, collection_formats):
                 new_params.append((k, v))
         return new_params
 
+    def is_not_ascii(self, string):
+        return any(ord(c) >= 128 for c in string)
+
+    def prepare_one_file(self, file_data):
+        # type: (Union[bytes, str, file, pathlib.Path, io.BytesIO]) -> FileFieldData # noqa: F821
+
+        # Python 2 has no difference between Bytes and Str
+        # So decide non-ascii string is Bytes
+        if isinstance(file_data, bytes) and (not six.PY2 or self.is_not_ascii(file_data)):
+            return FileFieldData("data.bin", file_data, "application/octet-stream")
+
+        if isinstance(file_data, str) or (not six.PY2 and isinstance(file_data, pathlib.PurePath)):
+            with open(file_data, "rb") as f:
+                fname = os.path.basename(f.name)
+                file_bytes = f.read()
+            mime_type = mimetypes.guess_type(fname)[0] or "application/octet-stream"
+            return FileFieldData(fname, file_bytes, mime_type)
+
+        if isinstance(file_data, io.BytesIO):
+            return FileFieldData("data.bin", file_data.read(), "application/octet-stream")
+
+        if isinstance(file_data, io.BufferedReader) or (six.PY2 and isinstance(file_data, file)):  # noqa: F821
+            return FileFieldData(os.path.basename(file_data.name), file_data.read(), "application/octet-stream")
+
+        raise ApiException(reason="Unknown type {type_name} for file parameter".format(type_name=type(file_data)))
+
     def prepare_post_parameters(self, post_params=None, files=None):
         """Builds form parameters.
 
         :param post_params: Normal form parameters.
         :param files: File parameters.
         :return: Form parameters with files.
         """
-        params = []
-
-        if post_params:
-            params = post_params
+        params = post_params or []
 
         if files:
-            for k, v in six.iteritems(files):
-                if not v:
+            for field_name, data in six.iteritems(files):
+                if not data:
                     continue
-                file_names = v if type(v) is list else [v]
-                for n in file_names:
-                    with open(n, "rb") as f:
-                        filename = os.path.basename(f.name)
-                        filedata = f.read()
-                        mimetype = mimetypes.guess_type(filename)[0] or "application/octet-stream"
-                        params.append(tuple([k, tuple([filename, filedata, mimetype])]))
+                file_names = data if type(data) is list else [data]
+                for file_data in file_names:
+                    params.append((field_name, self.prepare_one_file(file_data)))
 
         return params
 
@@ -642,7 +668,7 @@ def __deserialize_date(self, string):
         except ImportError:
             return string
         except ValueError:
-            raise rest.ApiException(status=0, reason="Failed to parse '{0}' as date object".format(string))
+            raise ApiException(reason="Failed to parse '{0}' as date object".format(string))
 
     def __deserialize_datetime(self, string):
         """Deserializes string to datetime.
@@ -659,7 +685,7 @@ def __deserialize_datetime(self, string):
         except ImportError:
             return string
         except ValueError:
-            raise rest.ApiException(status=0, reason=("Failed to parse '{0}' as datetime object".format(string)))
+            raise ApiException(reason=("Failed to parse '{0}' as datetime object".format(string)))
 
     def __hasattr(self, object, name):
         return name in object.__class__.__dict__

aspose_barcode_cloud/rest.py

@@ -229,15 +229,15 @@ def _request(
                     msg = """Cannot prepare a request message for provided
                              arguments. Please check that your arguments match
                              declared content type."""
-                    raise ApiException(status=0, reason=msg)
+                    raise ApiException(reason=msg)
             # For 'GET', 'HEAD'
             else:
                 r = self.pool_manager.request(
                     method, url, fields=query_params, preload_content=_preload_content, timeout=timeout, headers=headers
                 )
         except urllib3.exceptions.SSLError as e:
             msg = "{0}\n{1}".format(type(e).__name__, str(e))
-            raise ApiException(status=0, reason=msg)
+            raise ApiException(reason=msg)
 
         if _preload_content:
             r = RESTResponse(r)
@@ -375,7 +375,8 @@ def close(self):
 
 
 class ApiException(Exception):
-    def __init__(self, status=None, reason=None, http_resp=None):
+    def __init__(self, status=0, reason=None, http_resp=None):
+        # type: (int, str, RESTResponse) -> None
         if http_resp:
             self.status = http_resp.status
             self.reason = http_resp.reason

tests/test_auth.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from aspose_barcode_cloud import Configuration, ApiClient, BarcodeApi, EncodeBarcodeType
+from aspose_barcode_cloud import Configuration, ApiClient, BarcodeApi, EncodeBarcodeType, ApiException
 from .load_configuration import TEST_CONFIGURATION
 
 
@@ -37,7 +37,7 @@ def test_works_with_access_token(self):
     def test_unauthorized_raises(self):
         api = BarcodeApi(ApiClient(Configuration(access_token="incorrect token", host=TEST_CONFIGURATION.host)))
 
-        with self.assertRaises(Exception) as context:
+        with self.assertRaises(ApiException) as context:
             api.get_barcode_generate(EncodeBarcodeType.QR, "Testing")
 
         self.assertEqual(401, context.exception.status)

tests/test_barcode_api.py

@@ -26,10 +26,13 @@ class TestBarcodeApi(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        cls.test_filename = os.path.join("testdata", "pdf417Sample.png")
+        cls.test_filename = os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "..", "testdata", "pdf417Sample.png")
+        )
 
         cls.api_client = ApiClient(configuration=TEST_CONFIGURATION)
 
+        # noinspection PyUnresolvedReferences
         cls.api = BarcodeApi(api_client=cls.api_client)
         cls.temp_folder_path = "BarcodeTests/%s" % uuid.uuid4()
 
@@ -49,7 +52,9 @@ def test_get_barcode_recognize(self):
 
         Recognize barcode from a file on server.
         """
-        filename = self.upload_test_file("testdata/pdf417Sample.png")
+        filename = self.upload_test_file(
+            file_path=os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "testdata", "pdf417Sample.png"))
+        )
 
         response = self.api.get_barcode_recognize(
             filename, folder=self.temp_folder_path, preset=PresetType.HIGHPERFORMANCE
@@ -154,10 +159,11 @@ def test_put_generate_multiple(self):
         self.assertGreater(response.image_height, 0)
 
     def upload_test_file(self, file_path):
+        self.assertTrue(os.path.isfile(file_path))
         file_api = FileApi(self.api_client)
-        file_name = os.path.split(file_path)[-1]
+        fname = os.path.basename(file_path)
 
-        upload_result = file_api.upload_file(self.temp_folder_path + "/" + file_name, file_path)
+        upload_result = file_api.upload_file(path=self.temp_folder_path + "/" + fname, file=file_path)
 
         self.assertFalse(upload_result.errors, str(upload_result.errors))
         self.assertTrue(upload_result.uploaded)

tests/test_recognize_bytes.py

@@ -0,0 +1,52 @@
+import io
+import os
+import unittest
+
+from aspose_barcode_cloud import PresetType, ApiClient, BarcodeApi, DecodeBarcodeType
+from .load_configuration import TEST_CONFIGURATION
+
+
+class TestRecognizeBytes(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.test_filename = os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "..", "testdata", "pdf417Sample.png")
+        )
+
+        cls.api = BarcodeApi(api_client=ApiClient(configuration=TEST_CONFIGURATION))
+
+    def test_post_barcode_recognize_from_url_or_content_bytes(self):
+        """Test case for post_barcode_recognize_from_url_or_content
+
+        Recognize barcode from bytes.
+        """
+        with open(self.test_filename, "rb") as f:
+            image_bytes = f.read()
+
+        response = self.api.post_barcode_recognize_from_url_or_content(
+            preset=PresetType.HIGHPERFORMANCE,
+            image=image_bytes,
+        )
+
+        self.assertEqual(1, len(response.barcodes))
+        barcode = response.barcodes[0]
+        self.assertEqual(DecodeBarcodeType.PDF417, barcode.type)
+        self.assertEqual("Aspose.BarCode for Cloud Sample", barcode.barcode_value)
+
+    def test_post_barcode_recognize_from_url_or_content_BytesIO(self):
+        """Test case for post_barcode_recognize_from_url_or_content
+
+        Recognize barcode from BytesIO.
+        """
+        with open(self.test_filename, "rb") as f:
+            bytes_io = io.BytesIO(f.read())
+
+        response = self.api.post_barcode_recognize_from_url_or_content(
+            preset=PresetType.HIGHPERFORMANCE,
+            image=bytes_io,
+        )
+
+        self.assertEqual(1, len(response.barcodes))
+        barcode = response.barcodes[0]
+        self.assertEqual(DecodeBarcodeType.PDF417, barcode.type)
+        self.assertEqual("Aspose.BarCode for Cloud Sample", barcode.barcode_value)

tests/test_recognize_file.py

@@ -0,0 +1,72 @@
+import os
+import sys
+
+import six
+import unittest
+
+from aspose_barcode_cloud import PresetType, ApiClient, BarcodeApi, DecodeBarcodeType
+from .load_configuration import TEST_CONFIGURATION
+
+if not six.PY2:
+    import pathlib
+
+PY35orLess = sys.version_info[0:2] <= (3, 5)
+
+
+class TestRecognizeFile(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.test_filename = os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "..", "testdata", "pdf417Sample.png")
+        )
+
+        cls.api = BarcodeApi(api_client=ApiClient(configuration=TEST_CONFIGURATION))
+
+    def test_post_barcode_recognize_from_url_or_content_filename(self):
+        """Test case for post_barcode_recognize_from_url_or_content
+
+        Recognize barcode from a local file.
+        """
+
+        response = self.api.post_barcode_recognize_from_url_or_content(
+            preset=PresetType.HIGHPERFORMANCE,
+            image=self.test_filename,
+        )
+
+        self.assertEqual(1, len(response.barcodes))
+        barcode = response.barcodes[0]
+        self.assertEqual(DecodeBarcodeType.PDF417, barcode.type)
+        self.assertEqual("Aspose.BarCode for Cloud Sample", barcode.barcode_value)
+
+    @unittest.skipIf(PY35orLess, "No pathlib in Python2 and Python3.5 raises an error")
+    def test_post_barcode_recognize_from_url_or_content_pathlike(self):
+        """Test case for post_barcode_recognize_from_url_or_content
+
+        Recognize barcode from a local file by pathlike.
+        """
+
+        response = self.api.post_barcode_recognize_from_url_or_content(
+            preset=PresetType.HIGHPERFORMANCE,
+            image=pathlib.Path(self.test_filename),
+        )
+
+        self.assertEqual(1, len(response.barcodes))
+        barcode = response.barcodes[0]
+        self.assertEqual(DecodeBarcodeType.PDF417, barcode.type)
+        self.assertEqual("Aspose.BarCode for Cloud Sample", barcode.barcode_value)
+
+    def test_post_barcode_recognize_from_url_or_content_file_obj(self):
+        """Test case for post_barcode_recognize_from_url_or_content
+
+        Recognize barcode from a local file obj.
+        """
+        with open(self.test_filename, "rb") as file_obj:
+            response = self.api.post_barcode_recognize_from_url_or_content(
+                preset=PresetType.HIGHPERFORMANCE,
+                image=file_obj,
+            )
+
+        self.assertEqual(1, len(response.barcodes))
+        barcode = response.barcodes[0]
+        self.assertEqual(DecodeBarcodeType.PDF417, barcode.type)
+        self.assertEqual("Aspose.BarCode for Cloud Sample", barcode.barcode_value)