🎉 Live Preview

Author: ishaileshmishra

contentstack/__init__.py

@@ -18,6 +18,6 @@
 __title__ = 'contentstack-python'
 __author__ = 'Contentstack'
 __status__ = 'debug'
-__version__ = '1.7.0'
+__version__ = '1.8.0'
 __endpoint__ = 'cdn.contentstack.io'
 __email__ = 'shailesh.mishra@contentstack.com'

contentstack/https_connection.py

@@ -58,7 +58,7 @@ def get(self, url):
 
         """
         Here we create a response object, `response` which will store the request-response.
-        We use requests.get method since we are sending a GET request.
+        We use requests. Get method since we are sending a GET request.
         The four arguments we pass are url, verify(ssl), timeout, headers
         """
         try:

contentstack/query.py

@@ -1,10 +1,13 @@
 """
 Contentstack provides certain queries that you can use to fetch filtered results
 """
+
 import enum
 import json
 import logging
 from urllib import parse
+
+import deprecation
 import empty
 
 from contentstack.basequery import BaseQuery
@@ -118,10 +121,15 @@ def tags(self, *tags):
             self.query_params["tags"] = ",".join(tags)
         return self
 
+    @deprecation.deprecated(
+        deprecated_in="1.7.0",
+        current_version='1.8.0',
+        details="Use regex function instead")
     def search(self, value: str):
         """
         This method provides only the entries matching
         the specified value.
+        @Deprecated deprecated in 1.7.0, Use #regex instaead
         Arguments:
             value {str} -- value used to match or compare
         Raises:
@@ -314,4 +322,61 @@ def __execute_network_call(self):
         encoded_string = parse.urlencode(self.query_params, doseq=True)
         url = f'{self.base_url}?{encoded_string}'
         # url = '{}?{}'.format(self.base_url, encoded_string)
+        if 'content_type_uid' in self.http_instance.live_preview and 'live_preview' in url:
+            query_response = self.http_instance.get(url)
+            return self._map_live_preview(query_response)
         return self.http_instance.get(url)
+
+    def _map_live_preview(self, query_response):
+        _preview = self.http_instance.live_preview['resp']  # Gets Live Preview Stored Data From Dict
+        if 'entries' in query_response:
+            query_response = query_response['entries']
+            for index, it in enumerate(query_response):  # it in query_response:
+                if isinstance(it, dict):
+                    if it['uid'] == _preview['uid']:
+                        # return self.merge_it(self.resp, _preview)
+                        merged = {**query_response[index], **_preview}
+                        return query_response
+                #   self._map_live_preview(query_response)
+                # elif isinstance(query_response, list):
+                #     for obj in query_response:
+                #         self.iter_dict(obj,_preview['uid'])
+                #     pass
+        else:
+            return None
+
+    # def iter_dict(self, item, uid):
+    #     if isinstance(item, dict):
+    #         if item['uid'] == uid:
+    #             # return self.merge_it(self.resp, preview_response)
+    #             merged = {**query_response[index], **preview_response}
+    #             return merged
+    #         self._map_live_preview(query_response)
+
+    def merge_it(self, resp, lp_resp):
+        resp.update(lp_resp)
+        # merged
+        merged = {**resp, **lp_resp}
+        print(f"merged: {merged}")
+        return resp
+
+    def deep_merge(self, resp, lp_resp):
+        query_set = set(resp)
+        live_set = set(lp_resp)
+        store_keys = []
+        for key in live_set.intersection(query_set):  # Iterates for common keys between query & livePreview
+            store_keys.append(key)
+            if isinstance(resp[key], dict):
+                # match keys and update value
+                self.merge_it(resp[key], lp_resp[key])
+            elif isinstance(resp[key], list):
+                # match keys and update value
+                for i in lp_resp[key]:
+                    if isinstance(resp[i], dict):
+                        self.merge_it(resp[key], lp_resp[key])
+                    resp.update({key: f"New Fake:{lp_resp[key]}"})
+            resp.update({key: f"New Fake:{lp_resp[key]}"})
+
+            # name, myNames[name]
+        print(f"new query resp: {resp}")
+        print(f"store_keys {store_keys}")

contentstack/stack.py

@@ -14,9 +14,9 @@
 from contentstack.https_connection import HTTPSConnection
 from contentstack.image_transform import ImageTransform
 
-__author__ = "ishaileshmishra (ishaileshmishra@gmail.com)"
+__author__ = "ishaileshmishra (shailesh.mishra@contentstack.com)"
 __license__ = "MIT"
-__version__ = '1.7.0'
+__version__ = '1.8.0'
 
 log = logging.getLogger(__name__)
 DEFAULT_HOST = 'cdn.contentstack.io'
@@ -79,13 +79,14 @@ def __init__(self, api_key: str, delivery_token: str, environment: str,
         **Example:**
 
         >>> _strategy = Retry(total=5, backoff_factor=1, status_forcelist=[408, 429])
+        >>> import contentstack
         >>> stack = contentstack.Stack("api_key", "delivery_token", "environment",
         live_preview={enable=True, authorization='your auth token'}, retry_strategy= _strategy)
         ```
         """
+        logging.basicConfig(level=logging.DEBUG)
         if live_preview is None:
             live_preview = {'enable': False}
-        logging.basicConfig(level=logging.DEBUG)
         self.headers = {}
         self._query_params = {}
         self.sync_param = {}
@@ -144,10 +145,6 @@ def _validate_stack(self):
     def _validate_live_preview(self):
         if isinstance(self.live_preview_dict, dict):
             if 'enable' in self.live_preview_dict and self.live_preview_dict['enable']:
-                if 'authorization' not in self.live_preview_dict:
-                    raise PermissionError("management token is required")
-                if 'host' not in self.live_preview_dict:
-                    raise PermissionError("host is required")
                 self.headers['authorization'] = self.live_preview_dict['authorization']
                 self.host = self.live_preview_dict['host']
                 self.endpoint = f'https://{self.host}/{self.version}'
@@ -200,7 +197,7 @@ def content_type(self, content_type_uid=None):
         """
         Content type defines the structure or schema of a page or a section
         of your web or mobile property.
-        :param content_type_uid:
+        param content_type_uid:
         :return: ContentType
         """
         return ContentType(self.http_instance, content_type_uid)
@@ -209,7 +206,7 @@ def asset(self, uid):
         """
         Assets refer to all the media files (images, videos, PDFs, audio files, and so on)
         uploaded in your Contentstack repository for future use.
-        :param uid: asset_uid of the Asset
+        param uid: asset_uid of the Asset
         :return: Asset
 
         -----------------------------
@@ -242,7 +239,7 @@ def asset_query(self):
     def sync_init(self, content_type_uid=None, start_from=None, locale=None, publish_type=None):
         """
         Set init to ‘true’ if you want to sync all the published entries and assets.
-        This is usually used when the app does not have any content and you want to
+        This is usually used when the app does not have any content, and you want to
         get all the content for the first time.\n
 
         :param content_type_uid: (optional) content type UID. e.g., products
@@ -285,7 +282,7 @@ def pagination(self, pagination_token: str):
         paginated. It provides pagination token in the response.
         However, you do not have to use the pagination token
         manually to get the next batch.
-        :param pagination_token:
+        param pagination_token:
         :return: list of sync items
         ------------------------------
         Example:
@@ -303,7 +300,7 @@ def sync_token(self, sync_token):
         to get the updated content next time. The sync token fetches
         only the content that was added
         after your last sync, and the details of the content that was deleted or updated.
-        :param sync_token: sync_token
+        param sync_token: sync_token
         :return: list of Sync Result
         ------------------------------
         [Example]:
@@ -318,7 +315,7 @@ def sync_token(self, sync_token):
 
     def __sync_request(self):
         r"""Sends a GET request.
-        :param url URL for :class:`Request` object.
+        param url is URL for :class:`Request` object.
         in the query string for the :class:`Request`.
         :param \*\*kwargs: Optional arguments that ``request`` takes.
         :return: :class:`Response <Response>` object
@@ -350,6 +347,27 @@ def image_transform(self, image_url, **kwargs):
     def live_preview_query(self, **kwargs):
         """
         live_preview_query accepts key value pair objects to the query
-        i.e hash and content_type_uid
+        hash, content_type_uid and entry_uid
+        Example:
+            # def live_preview_query(**kwargs):
+            # kwargs is a dict of the keyword args passed to the function
+            for key, value in kwargs.iteritems():
+                print "%s = %s" % (key, value)
+            Uses:=>
+            live_preview_query(
+                host='api.contentstack.io',
+                entry_uid='your_entry_uid',
+                hash='hashcode'
+                )
         """
         self.live_preview_dict.update(kwargs)
+        self._execute_management_api()
+        return self
+
+    def _execute_management_api(self):
+        _ct_uid = self.live_preview_dict.get("content_type_uid")
+        _entry_uid = self.live_preview_dict.get("entry_uid")
+        _url = f'{self.http_instance.endpoint}/content_types/{_ct_uid}/entries/{_entry_uid}'
+        _resp = self.http_instance.get(_url)
+        self.live_preview_dict['resp'] = _resp['entry']
+        return self

contentstack/utility.py

@@ -1,7 +1,7 @@
 """
 Utils
 contentstack
-Last modified by Shailesh Mishra on 06/08/20.
+Last modified by ishaileshmishra on 06/08/20.
 Copyright 2019 Contentstack. All rights reserved.
 """
 

tests/__init__.py

@@ -1,4 +1,4 @@
-# pytest --html=tests/report/test-report.html 
+# pytest --html=tests/report/test-report.html
 # above command runs tests and test reports generates in tests/report location.
 # nosetests --with-coverage --cover-html
 # clean all the .pyc files
@@ -7,9 +7,7 @@
 # pytest --cov=contentstack
 # pytest -v --cov=contentstack --cov-report=html
 # pytest --html=tests/report/test-report.html
-import unittest
 from unittest import TestLoader, TestSuite
-
 from .test_assets import TestAsset
 from .test_entry import TestEntry
 from .test_query import TestQuery
@@ -25,5 +23,5 @@ def all_tests():
         test_module_stack,
         test_module_asset,
         test_module_entry,
-        test_module_query
+        test_module_query,
     ])

tests/test_live_preview_config.py

@@ -14,6 +14,7 @@
 ENVIRONMENT = config.ENVIRONMENT
 HOST = config.HOST
 
+
 class TestLivePreviewConfig(unittest.TestCase):
 
     def setUp(self):
@@ -124,5 +125,6 @@ def test_branching(self):
         stack.content_type('product')
         self.assertEqual('dev_branch', stack.get_branch)
 
-# if __name__ == '__main__':
-#     unittest.main()
+
+if __name__ == '__main__':
+    unittest.main()