Merge pull request #5 from contentstack/dev

Dev

Author: ishaileshmishra

CHANGELOGS.md

@@ -1,3 +1,3 @@
 
-## v 0.0.1
+##v0.0.1
 Initial release of the python Content Delivery API SDK.

LICENSE

@@ -14,7 +14,7 @@ copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

contentstack/__init__.py

@@ -1,5 +1,11 @@
-""" contentstack python sdk. """
 
+#  __init__
+#  contentstack
+#
+#  Created by Shailesh Mishra on 22/06/19.
+#  Copyright © 2019 Contentstack. All rights reserved.
+
+import warnings
 __author__ = 'Shailesh Mishra'
 __status__ = 'debug'
 __version__ = '1.0.0'
@@ -10,17 +16,15 @@
 from .asset import Asset
 from .config import Config
 from .content_type import ContentType
-from .errors import Error, ConfigError
+from .errors import Error, ConfigError, FileModeWarning
 from .http_connection import HTTPConnection
 
 # Set a default logger to prevent "No handler found" warnings
+# Set default logging handler to avoid "No handler found" warnings.
 import logging
-
-try:
-    from logging import NullHandler
-except ImportError:
-    class NullHandler(logging.Handler):
-        def emit(self, record):
-            pass
+from logging import NullHandler
 
 logging.getLogger(__name__).addHandler(NullHandler())
+
+# FileModeWarnings go off per the default.
+warnings.simplefilter('default', FileModeWarning, append=True)

contentstack/config.py

@@ -1,43 +1,49 @@
-"""
- * MIT License
- *
- * Copyright (c) 2012 - 2019 Contentstack
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
-
-"""
+#  Config
+#  contentstack
+#
+#  Created by Shailesh Mishra on 22/06/19.
+#  Copyright © 2019 Contentstack. All rights reserved.
+
 import logging
+from enum import Enum
 
 logging.basicConfig(filename='cs.log', format='%(asctime)s - %(message)s', level=logging.INFO)
 logging.getLogger("Config")
 
 
+class ContentstackRegion(Enum):
+    US = 'us'
+    EU = 'eu'
+
+
 class Config(object):
+
     """
     All API paths are relative to this base URL, for example, /users actually means <scheme>://<host>/<basePath>/users.
-
     """
 
     def __init__(self):
+        self.default = dict(protocol="https", region=ContentstackRegion.US, host="cdn.contentstack.io", version="v3")
+
+    def region(self, region=ContentstackRegion.US):
+
+        """
+        The base URL for Content Delivery API is cdn.contentstack.io.
+        default region is for ContentstackRegion is US
+
+        :param region: ContentstackRegion
+        :return: self
+
+        Example:
+            >>> config  = Config().region(region=ContentstackRegion.US)
+
+        """
 
-        # It initialises the Config with the default endpoint
-        self.default = dict(protocol="https", region="us", host="cdn.contentstack.io", port=443, version="v3")
+        if region is not None and isinstance(region, ContentstackRegion):
+            self.default['region'] = region
+        else:
+            raise ValueError('Kindly provide a valid argument')
+        return self
 
     def host(self, host):
 
@@ -86,5 +92,19 @@ def version(self, version=None):
 
     @property
     def endpoint(self):
-        url = "{0}://{1}/{2}".format(self.default["protocol"], self.default["host"], self.default["version"])
-        return url
+        return self.__get_url()
+
+    def __get_url(self):
+        host = self.default["host"]
+        if self.default['region'] is not ContentstackRegion.US:
+
+            if self.default["host"] == 'cdn.contentstack.io':
+                # update the host to .com
+                self.default["host"] = 'cdn.contentstack.com'
+            else:
+                # Find the regional value
+                regional_host = str(self.default['region'].value)
+                # Attach region to the host
+                host = '{}-{}'.format(regional_host, self.default["host"])
+
+        return "{0}://{1}/{2}".format(self.default["protocol"], host, self.default["version"])

contentstack/errors.py

@@ -1,30 +1,11 @@
-"""
- * MIT License
- * Copyright (c) 2012 - 2019 Contentstack
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
-"""
+#  Error
+#  contentstack
+#
+#  Created by Shailesh Mishra on 22/06/19.
+#  Copyright © 2019 Contentstack. All rights reserved.
 
 
 class Error:
-
     """
     contentstack.error
     ~~~~~~~~~~~~~~~~~~
@@ -34,7 +15,6 @@ class Error:
     """
 
     def __init__(self):
-
         """
 
         """
@@ -44,7 +24,6 @@ def __init__(self):
         self.__cause_err = str
 
     def config(self, result: dict):
-
         """
 
         :param result:
@@ -61,7 +40,6 @@ def config(self, result: dict):
 
     @property
     def error_code(self):
-
         """
         It returns error code from the stack response
         :return: error_code as int
@@ -74,7 +52,6 @@ def error_code(self):
 
     @property
     def error_message(self):
-
         """
         Returns error_message from the stack response
         :return: error_message
@@ -88,7 +65,6 @@ def error_message(self):
 
     @property
     def error(self):
-
         """
         This returns error code and error_message in dict formats
         :return: error dict
@@ -101,7 +77,6 @@ def error(self):
 
     @property
     def error_info(self) -> dict:
-
         """
         error information
         :return: error information
@@ -162,3 +137,13 @@ class ContentstackError(Exception):
 
 class NotSupportedException(Exception):
     pass
+
+
+class RequestsWarning(Warning):
+    """Base warning for Requests."""
+    pass
+
+
+class FileModeWarning(RequestsWarning, DeprecationWarning):
+    """A file was opened in text mode, but Requests determined its binary length."""
+    pass