Merge pull request #10 from contentstack/v1.1.0

V1.1.0

Author: ishaileshmishra

.github/workflows/pythonpackage.yml

@@ -5,9 +5,9 @@ name: Python package
 
 on:
   push:
-    branches: [ master,  1.0.0 ]
+    branches: [ master,  v1.1.0 ]
   pull_request:
-    branches: [ master, 1.0.0 ]
+    branches: [ master, v1.1.0 ]
 
 jobs:
   build:

CHANGELOG.md

@@ -0,0 +1,45 @@
+# CHANGELOG
+
+Date: 10-Aug-2020 - include_reference issue fixed
+
+## _v1.1.0_
+
+EntryQueryable
+
+- updated include_reference function.
+
+-----------------------------
+
+Date: 17-Jun-2020 - initial release
+
+## _v1.0.0_
+
+Stack
+
+- Initialisation of stack has been modified
+- External config support moved to stack initialisation optional paramters
+- Added support for whereIn(String key) and whereNotIn(String key) methods in Query
+
+Assets
+
+- Changes incorporated in Asset class.
+
+Entry
+
+- Changes incorporated in the entry class.
+
+Query
+
+- Changes incorporated in the Query class.
+
+-----------------------------
+
+Date: 18-Nov-2019 - beta release
+
+## _v0.1.0_
+
+November-18, 2019 -beta release
+
+Initial release for the contentstack-python-sdk for Content Delivery API
+
+-----------------------------

CHANGELOGS.md

@@ -4,4 +4,4 @@ To install the package simply run the below command on your terminal:
    python setup.py install
 
 Don't forget to file bugs and let me know about them.
-Also, don't hasitate to ask for new features. Happy coding.
+Also, don't hesitate to ask for new features. Happy coding.

INSTALL

@@ -2,30 +2,38 @@
 CHANGELOG
 =========
 
-*Date: 17-Jun-2020 - initial release*
+Date: 10-Aug-2020 - include_reference issue fixed
 
-**v1.0.0**
+*v1.1.0*
 ============
 
-- **Stack**
-    - Initialisation of stack has been modified
-    - External config support moved to stack initialisation optional paramters
-    - Added support for whereIn(String key) and whereNotIn(String key) methods in Query
+EntryQueryable
+    - updated include_reference function.
 
-- **Asset**
+============
+
+Date: 17-Jun-2020 - initial release
+
+*v1.0.0*
+============
+
+Stack
+    - Initialization of the stack has been modified
+    - External config support moved to stack initialization optional parameters
+
+Asset
     - changes incorporated in Asset class.
 
-- **Entry**
+Entry
     - changes incorporated in the entry class.
 
-- **Query**
+Query
     - Changes incorporated in the Query class.
 
-
 -----------------------------
 
-*Date: 18-Nov-2019 - beta release*
+Date: 18-Nov-2019 - beta release
 
-**v0.0.1**
+*v0.0.1*
 ============
 - Beta release for the contentstack-python SDK for Content Delivery API

changelog.rst

@@ -1,3 +1,13 @@
+"""
+The __init__.py files are required to make Python treat the directories as containing
+packages; this is done to prevent directories with a common name, such as string,
+from unintentionally hiding valid modules that occur later on the module search path
+
+Used: Safety checks your installed dependencies for known security vulnerabilities
+file __init__.py contains package information like
+__author__, __status__, __version__, __endpoint__ and __email__
+
+"""
 from .entry import Entry
 from .asset import Asset
 from .contenttype import ContentType
@@ -6,8 +16,9 @@
 from .utility import Utils
 # from contentstack import *
 
+__title__ = 'contentstack-python'
 __author__ = 'Contentstack'
 __status__ = 'debug'
-__version__ = '1.0.0'
+__version__ = '1.1.0'
 __endpoint__ = 'cdn.contentstack.io'
-__email__ = 'mshaileshr@gmail.com'
+__email__ = 'shailesh.mishra@contentstack.com'

contentstack/__init__.py

@@ -9,6 +9,7 @@
 # Your code has been rated at 10.00/10 by pylint
 
 from urllib import parse
+
 from contentstack.entry import Entry
 from contentstack.query import Query
 
@@ -44,7 +45,7 @@ def entry(self, entry_uid: str):
         """
         if self.__content_type_uid is None:
             raise PermissionError('Please provide valid content_type_uid')
-        elif entry_uid is None:
+        if entry_uid is None:
             raise PermissionError('Please provide valid entry uid')
         entry = Entry(self.http_instance, self.__content_type_uid, entry_uid=entry_uid)
         return entry

contentstack/contenttype.py

@@ -1,25 +1,14 @@
-import enum
-
-
-class Include(enum.Enum):
-    """
-    Include is enum that Provides Options to perform operation to query the result.
-
-    Available Options for QueryOperation are below.
-    DEFAULT, ONLY, EXCEPT
-
-    Arguments:
-        enum {Include} -- Type of IncludeReference
-    """
-    EXCEPT = 'except'
-    ONLY = 'only'
-    DEFAULT = ''
+"""
+EntryQueryable class contains common functions
+that is used as parents class for the query and entry classes
+"""
 
 
 class EntryQueryable:
     """
     This class is base class for the Entry and Query class that shares common functions
     """
+
     def __init__(self):
         self.entry_queryable_param = {}
 
@@ -53,7 +42,7 @@ def locale(self, locale: str):
         self.entry_queryable_param['locale'] = locale
         return self
 
-    def only(self, field_uid):
+    def only(self, field_uid: str):
         """
         Specifies an array of only keys in BASE object that would be included in the response.
         It refers to the top-level fields of the schema
@@ -62,57 +51,61 @@ def only(self, field_uid):
             self -- so you can chain this call.
         """
         if field_uid is not None:
-            self.entry_queryable_param['only[BASE][]'] = field_uid
-            return self
+            if isinstance(field_uid, str):
+                self.entry_queryable_param['only[BASE][]'] = field_uid
+            else:
+                raise KeyError("Invalid field_uid provided")
+        return self
 
-    def excepts(self, field_uid):
+    def excepts(self, field_uid: str):
         """
         Specifies list of field_uid that would be excluded from the response.
         It refers to the top-level fields of the schema
         :param field_uid: to be excluded from the response.
         :return: self -- so you can chain this call.
         """
         if field_uid is not None:
-            self.entry_queryable_param['except[BASE][]'] = field_uid
-            return self
+            if isinstance(field_uid, str):
+                self.entry_queryable_param['except[BASE][]'] = field_uid
+            else:
+                raise KeyError("Invalid field_uid provided")
+        return self
 
-    def include_reference(self, include_reference_type:  Include, reference_field_uid: str, field_uid=None):
+    def include_reference(self, field_uid):
         """
         **Include Reference:**
         When you fetch an entry of a content type that has a reference field,
         by default, the content of the referred entry is not fetched.
         It only fetches the UID of the referred entry, along with the content of
         the specified entry.
 
+        Note: The maximum reference depth limit to which a multiple content type
+        referencing Reference field works is three levels deep
+
         Arguments:
-        reference_field_uid {str} -- Key who has reference to some other class object.
         Array of the only reference keys to be included in response
-        include_type {Include} -- Provides three options, none, only and except
-        i.e accepts list of field_uid
-        field_uid {list} -- list of field_uid on which include operation to perform
+        field_uid {str or list of str} -- [str/list of str] of field_uid on
+        which include operation to perform
 
         Returns:
             self -- So you can chain this call.
+
+            >>> import contentstack
+            >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
+            >>> entry = stack.content_type('content_type')
+            >>> entry("entry_uid").include_reference(["categories", "brand"])
+            >>> result = entry.fetch()
         """
-        container = {}
-        if reference_field_uid is None:
-            raise KeyError("reference_field_uid can't be None")
-        if include_reference_type.name == 'DEFAULT':
-            self.entry_queryable_param["include[]"] = reference_field_uid
-        else:
-            container[reference_field_uid] = field_uid
-            self.entry_queryable_param["include[]"] = {include_reference_type.value: container}
+        if field_uid is not None and isinstance(field_uid, (str, list)):
+            self.entry_queryable_param["include[]"] = field_uid
         return self
 
     def include_content_type(self):
         """
         This method also includes the ContentType in the entry
         :return: self: so you can chain this call.
-
         -------------------------------
-
         [Example: for Entry]
-
             >>> import contentstack
             >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
             >>> content_type = stack.content_type('content_type_uid')

contentstack/entryqueryable.py

@@ -1,20 +1,16 @@
 """
-# -*- coding: utf-8 -*-
-requests.api
-~~~~~~~~~~~~
-
 This module implements the Requests API.
 """
 
 # ************* Module https_connection.py **************
 # Your code has been rated at 10.00/10  by pylint
 
-from json import JSONDecodeError
-import json
-import urllib.parse as urlparse
 import platform
+from json import JSONDecodeError
+
 import requests
 from requests.exceptions import Timeout, HTTPError
+
 import contentstack
 
 
@@ -36,14 +32,13 @@ def user_agents():
     header = {'sdk': dict(name=contentstack.__package__, version=contentstack.__version__),
               'os': get_os_platform,
               'Content-Type': 'application/json'}
-    package = "contentstack-python, - {}".format(contentstack.__version__)
+    package = "contentstack-python/{}".format(contentstack.__version__)
     return {'User-Agent': str(header), "X-User-Agent": package}
 
 
-# R0903: Too few public methods (1/2) (too-few-public-methods)
-# "pylint doesn't know what's best" - use your own judgement but as a rule.
-class HTTPSConnection:
+class HTTPSConnection:  # R0903: Too few public methods
     """Make Https Request to fetch the result as per requested url"""
+
     def __init__(self, endpoint, headers):
         if None not in (endpoint, headers):
             self.payload = None
@@ -59,8 +54,7 @@ def get(self, url):
         """
         try:
             self.headers.update(user_agents())
-            response = requests.get(url, verify=True,
-                                    timeout=self.default_timeout, headers=self.headers)
+            response = requests.get(url, verify=True, headers=self.headers)
             response.encoding = 'utf-8'
             return response.json()
         except Timeout:
@@ -75,11 +69,3 @@ def get(self, url):
     def update_connection_timeout(self, timeout: int):
         """Facilitate to update timeout for the https request"""
         self.default_timeout = timeout
-
-    def get_complete_url(self, base_url: str, params:dict):
-        if 'query' in params:
-            params["query"] = json.dumps(params["query"])
-        query = urlparse.urlencode(params)
-        url = '{}&{}'.format(base_url, query)
-        return url
-