Release 20.11 (#10)

Documentation and code samples updated

Author: Denis-Averin

README.md

@@ -1,7 +1,7 @@
 # Aspose.BarCode Cloud SDK for Python
 
 - API version: 3.0
-- Package version: 20.10.0
+- Package version: 20.11.0
 
 [Aspose.BarCode for Cloud](https://products.aspose.cloud/barcode/cloud) is a REST API for Linear, 2D and postal barcode generation and recognition in the cloud. API recognizes and generates barcode images in a variety of formats. Barcode REST API allows to specify barcode image attributes like image width, height, border style and output image format in order to customize the generation process. Developers can also specify the barcode type and text attributes such as text location and font styles in order to suit the application requirements.
 
@@ -12,15 +12,15 @@ Supported Python versions:
 - Python 2.7
 - Python 3.4+
 
-To use these SDKs, you will need App SID and App Key which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (free registration in Aspose Cloud is required for this).
+To use these SDKs, you will need Client Id and Client Secret which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/applications) (free registration in Aspose Cloud is required for this).
 
 ## How to use the SDK
 
 The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [from PyPi](https://pypi.org/project/aspose-barcode-cloud/) (recommended).
 
 ## Prerequisites
 
-To use Aspose.BarCode Cloud SDK for Python you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
+To use Aspose.BarCode Cloud SDK for Python you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create Client Secret and Client Id at [Cloud Dashboard](https://dashboard.aspose.cloud/applications). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
 
 ## Installation
 
@@ -52,8 +52,8 @@ from aspose_barcode_cloud.rest import ApiException
 
 # Configure OAuth2 access token for authorization: JWT
 configuration = aspose_barcode_cloud.Configuration(
-    app_sid="App SID from https://dashboard.aspose.cloud/#/apps",
-    app_key="App Key from https://dashboard.aspose.cloud/#/apps",
+    client_id="Client Id from https://dashboard.aspose.cloud/applications",
+    client_secret="Client Secret from https://dashboard.aspose.cloud/applications",
 )
 
 # create an instance of the API class

aspose_barcode_cloud/api_client.py

@@ -82,12 +82,12 @@ 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.default_headers = {"x-aspose-client": "python sdk", "x-aspose-client-version": "20.10.0"}
+        self.default_headers = {"x-aspose-client": "python sdk", "x-aspose-client-version": "20.11.0"}
         if header_name is not None:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = "Aspose-Barcode-SDK/20.10.0/python"
+        self.user_agent = "Aspose-Barcode-SDK/20.11.0/python"
 
     def __del__(self):
         if self._pool is not None:

aspose_barcode_cloud/configuration.py

@@ -50,8 +50,8 @@ class Configuration(object):
 
     def __init__(
         self,
-        app_sid=None,
-        app_key=None,
+        client_id=None,
+        client_secret=None,
         access_token=None,
         host=None,
         token_url="https://api.aspose.cloud/connect/token",
@@ -81,8 +81,8 @@ def __init__(
 
         # access token for OAuth
         self._access_token = access_token
-        self._app_sid = app_sid
-        self._app_key = app_key
+        self._client_id = client_id
+        self._client_secret = client_secret
         self._token_url = token_url
 
         # Logging Settings
@@ -131,11 +131,11 @@ def access_token(self):
         if self._access_token:
             return self._access_token
 
-        if self._app_sid and self._app_key and self._token_url:
-            self._access_token = self.fetch_token(self._app_sid, self._app_key, self._token_url)
+        if self._client_id and self._client_secret and self._token_url:
+            self._access_token = self.fetch_token(self._client_id, self._client_secret, self._token_url)
             return self._access_token
 
-        raise ValueError("No access_token or app_sid and app_key specified")
+        raise ValueError("No access_token or client_id and client_secret specified")
 
     @property
     def token_url(self):
@@ -285,16 +285,16 @@ def to_debug_report(self):
             "OS: {env}\n"
             "Python Version: {pyversion}\n"
             "Version of the API: 3.0\n"
-            "SDK Package Version: 20.10.0".format(env=sys.platform, pyversion=sys.version)
+            "SDK Package Version: 20.11.0".format(env=sys.platform, pyversion=sys.version)
         )
 
     @staticmethod
-    def fetch_token(app_sid, app_key, token_url):
-        client = RESTClientObject(Configuration(app_sid=app_sid, app_key=app_key, token_url=token_url))
+    def fetch_token(client_id, client_secret, token_url):
+        client = RESTClientObject(Configuration(client_id=client_id, client_secret=client_secret, token_url=token_url))
         response = client.POST(
             token_url,
             headers={"Content-Type": "application/x-www-form-urlencoded"},
-            post_params={"grant_type": "client_credentials", "client_id": app_sid, "client_secret": app_key},
+            post_params={"grant_type": "client_credentials", "client_id": client_id, "client_secret": client_secret},
         )
         js_data = json.loads(response.data)
         access_token = js_data["access_token"]

example.py

@@ -6,8 +6,8 @@
 from aspose_barcode_cloud import BarcodeApi, ApiClient, Configuration, EncodeBarcodeType, PresetType
 
 config = Configuration(
-    app_sid="App SID from https://dashboard.aspose.cloud/#/apps",
-    app_key="App Key from https://dashboard.aspose.cloud/#/apps",
+    client_id="Client Id from https://dashboard.aspose.cloud/applications",
+    client_secret="Client Secret from https://dashboard.aspose.cloud/applications",
     access_token=os.environ.get("TEST_ACCESS_TOKEN")  # Only for testing in CI, remove this line
 )
 

setup.py

@@ -29,7 +29,7 @@
 from setuptools import setup, find_packages
 
 NAME = "aspose-barcode-cloud"
-VERSION = "20.10.0"
+VERSION = "20.11.0"
 # To install the library, run the following
 #
 # python setup.py install

tests/configuration.example.json

@@ -1,7 +1,7 @@
 {
   "access_token": "JWT token",
-  "app_sid": "App SID from https://dashboard.aspose.cloud/#/apps",
-  "app_key": "App Key from https://dashboard.aspose.cloud/#/apps",
+  "client_id": "Client Id from https://dashboard.aspose.cloud/applications",
+  "client_secret": "Client Secret from https://dashboard.aspose.cloud/applications",
   "host": "https://api.aspose.cloud/v3.0",
   "token_url": "https://api.aspose.cloud/connect/token"
 }

tests/test_auth.py

@@ -6,7 +6,9 @@
 from .load_configuration import TEST_CONFIGURATION
 
 
-@unittest.skipUnless(TEST_CONFIGURATION._app_sid and TEST_CONFIGURATION._app_key, "No app_sid and app_key provided")
+@unittest.skipUnless(
+    TEST_CONFIGURATION._client_id and TEST_CONFIGURATION._client_secret, "No client_id and client_secret provided"
+)
 class TestAuth(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
@@ -23,7 +25,7 @@ def test_access_token_raises(self):
         with self.assertRaises(ValueError) as cm:
             _ = config.access_token
         the_exception = cm.exception
-        self.assertEqual("No access_token or app_sid and app_key specified", the_exception.args[0])
+        self.assertEqual("No access_token or client_id and client_secret specified", the_exception.args[0])
 
     def test_works_with_access_token(self):
         api = BarcodeApi(
@@ -33,7 +35,7 @@ def test_works_with_access_token(self):
         self.assertEqual(200, response.status)
 
     def test_unauthorized_raises(self):
-        api = BarcodeApi(ApiClient(Configuration(access_token="incorrect token")))
+        api = BarcodeApi(ApiClient(Configuration(access_token="incorrect token", host=TEST_CONFIGURATION.host)))
 
         with self.assertRaises(Exception) as context:
             api.get_barcode_generate(EncodeBarcodeType.QR, "Testing")

tests/test_headers.py

@@ -24,9 +24,9 @@ def test_default_headers(self):
 
         self.assertEqual(1, self.rest_client_mock.GET.call_count)
         headers = self.rest_client_mock.GET.call_args[1]["headers"]
-        self.assertEqual("Aspose-Barcode-SDK/20.10.0/python", headers["User-Agent"])
+        self.assertEqual("Aspose-Barcode-SDK/20.11.0/python", headers["User-Agent"])
         self.assertEqual("python sdk", headers["x-aspose-client"])
-        self.assertEqual("20.10.0", headers["x-aspose-client-version"])
+        self.assertEqual("20.11.0", headers["x-aspose-client-version"])
 
     def test_header_override(self):
         api_client = ApiClient(self.local_config, header_name="x-aspose-client", header_value="some custom sdk")