Added Support for region in config

Author: mshaileshr@gmail.com

contentstack/__init__.py

@@ -1,4 +1,5 @@
 """ contentstack python sdk. """
+import warnings
 
 __author__ = 'Shailesh Mishra'
 __status__ = 'debug'
@@ -10,17 +11,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

@@ -15,29 +15,53 @@
  *
  * 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
  * SOFTWARE.
 
 """
 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")
 
-        # It initialises the Config with the default endpoint
-        self.default = dict(protocol="https", region="us", host="cdn.contentstack.io", port=443, 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)
+
+        """
+
+        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 +110,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

@@ -24,7 +24,6 @@
 
 
 class Error:
-
     """
     contentstack.error
     ~~~~~~~~~~~~~~~~~~
@@ -34,7 +33,6 @@ class Error:
     """
 
     def __init__(self):
-
         """
 
         """
@@ -44,7 +42,6 @@ def __init__(self):
         self.__cause_err = str
 
     def config(self, result: dict):
-
         """
 
         :param result:
@@ -61,7 +58,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 +70,6 @@ def error_code(self):
 
     @property
     def error_message(self):
-
         """
         Returns error_message from the stack response
         :return: error_message
@@ -88,7 +83,6 @@ def error_message(self):
 
     @property
     def error(self):
-
         """
         This returns error code and error_message in dict formats
         :return: error dict
@@ -101,7 +95,6 @@ def error(self):
 
     @property
     def error_info(self) -> dict:
-
         """
         error information
         :return: error information
@@ -162,3 +155,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

contentstack/http_connection.py

@@ -3,7 +3,7 @@
 from urllib import parse
 from contentstack import Error
 from json import JSONDecodeError
-from requests.exceptions import Timeout
+from requests.exceptions import Timeout, HTTPError
 
 
 class HTTPConnection(object):
@@ -19,11 +19,12 @@ def __init__(self, url: str, query: dict, headers: dict):
     def get_result(self, url: str, query: dict, headers: dict):
 
         """
-        get Results is helpful to make HTTP methods
-        :param url:
-        :param query:
-        :param headers:
-        :return:
+        get Results is helpful to make HTTP request
+        :param url: Request url
+        :param query: query parameters
+        :param headers: headers parameters
+        :return: response
+
         """
 
         if None not in (url, query, headers):
@@ -49,11 +50,18 @@ def get_result(self, url: str, query: dict, headers: dict):
                 if err is not None:
                     return Error().config(err)
         except Timeout:
+            # If a request times out, a Timeout exception will be raised.
             raise TimeoutError('The request timed out')
         except ConnectionError:
+            # If there is a network problem like a DNS failure, or refused connection the Requests library will raise
+            # a ConnectionError exception.
             raise ConnectionError('Connection error occurred')
         except JSONDecodeError:
+            # Invalid json format response received
             raise JSONDecodeError('Invalid JSON in request')
+        except HTTPError:
+            # With invalid HTTP responses, Requests will also raise an HTTPError exception, but these are rare.
+            raise HTTPError('Http Error Occurred')
 
     def __parse_dict(self, response):
         # This is the private method to parse the response to their respective type

requirements.txt

@@ -0,0 +1 @@
+requests==2.22.0