Work on upgrading to new contentful client with localization support.

Author: jeremydw

Makefile

@@ -0,0 +1,6 @@
+SHELL := /bin/bash
+PATH := $(PATH):$(HOME)/bin
+
+test:
+	grow install example
+	grow build example

contentful_ext/contentful_ext.py

@@ -1,19 +1,15 @@
-from contentful.cda import client
-from contentful.cda import resources
+import contentful
 from grow.common import utils
 from protorpc import messages
+import datetime
 import grow
+import json
 import os
 
 
-class KeyMessage(messages.Message):
-    preview = messages.StringField(1)
-    production = messages.StringField(2)
-
-
 class BindingMessage(messages.Message):
     collection = messages.StringField(1)
-    contentModel = messages.StringField(2)
+    content_type = messages.StringField(2)
 
 
 class ContentfulPreprocessor(grow.Preprocessor):
@@ -22,22 +18,27 @@ class ContentfulPreprocessor(grow.Preprocessor):
     _edit_space_url_format = 'https://app.contentful.com/spaces/{space}/entries'
     _preview_endpoint = 'preview.contentful.com'
 
+    def encoder(self):
+        preprocessor = self
+        class ContentfulEncoder(json.JSONEncoder):
+            def default(self, obj):
+                if isinstance(obj, datetime.datetime):
+                    return obj.isoformat()
+                if hasattr(obj, 'type') and obj.type == 'Entry':
+                    return obj.fields()
+                if hasattr(obj, 'type') and obj.type == 'Link':
+                    return obj.raw
+                if hasattr(obj, 'type') and obj.type == 'Asset':
+                    return obj.url()
+                return json.JSONEncoder.default(self, obj)
+        return ContentfulEncoder
+
     class Config(messages.Message):
         space = messages.StringField(2)
-        keys = messages.MessageField(KeyMessage, 3)
+        access_token = messages.StringField(3)
         bind = messages.MessageField(BindingMessage, 4, repeated=True)
         limit = messages.IntegerField(5)
-
-    def _parse_field(self, field):
-        if isinstance(field, resources.Asset):
-            return field.url
-        elif isinstance(field, resources.Entry):
-            return field.sys['id']
-        elif isinstance(field, resources.ResourceLink):
-            return self.cda.resolve_resource_link(field)
-        elif isinstance(field, list):
-            return [self._parse_field(sub_field) for sub_field in field]
-        return field
+        preview = messages.BooleanField(6, default=False)
 
     def _parse_entry(self, entry):
         """Parses an entry from Contentful."""
@@ -63,48 +64,49 @@ def _parse_entry(self, entry):
             body = body.encode('utf-8')
         return fields, body, basename
 
-    def bind_collection(self, entries, collection_pod_path, contentful_model):
+    def bind_collection(self, entries, collection_pod_path):
         """Binds a Grow collection to a Contentful collection."""
         collection = self.pod.get_collection(collection_pod_path)
         existing_pod_paths = [
             doc.pod_path for doc in collection.list_docs(recursive=False, inject=False)]
         new_pod_paths = []
         for i, entry in enumerate(entries):
-            if entry.sys['contentType']['sys']['id'] != contentful_model:
-                continue
-            fields, body, basename = self._parse_entry(entry)
-            # TODO: Ensure `create_doc` doesn't die if the file doesn't exist.
-            path = os.path.join(collection.pod_path, basename)
-            if not self.pod.file_exists(path):
-                self.pod.write_yaml(path, {})
-            doc = collection.create_doc(basename, fields=fields, body=body)
-            new_pod_paths.append(doc.pod_path)
-            self.pod.logger.info('Saved -> {}'.format(doc.pod_path))
+            result = json.dumps(entry.fields(), cls=self.encoder())
+            print result
+
+#            if entry.sys['contentType']['sys']['id'] != contentful_model:
+#                continue
+#            fields, body, basename = self._parse_entry(entry)
+#            # TODO: Ensure `create_doc` doesn't die if the file doesn't exist.
+#            path = os.path.join(collection.pod_path, basename)
+#            if not self.pod.file_exists(path):
+#                self.pod.write_yaml(path, {})
+#            doc = collection.create_doc(basename, fields=fields, body=body)
+#            new_pod_paths.append(doc.pod_path)
+#            self.pod.logger.info('Saved -> {}'.format(doc.pod_path))
+
         pod_paths_to_delete = set(existing_pod_paths) - set(new_pod_paths)
         for pod_path in pod_paths_to_delete:
             self.pod.delete_file(pod_path)
             self.pod.logger.info('Deleted -> {}'.format(pod_path))
 
     def run(self, *args, **kwargs):
-        request = self.cda.fetch(resources.Entry)
-        if self.config.limit:
-            request.params['limit'] = self.config.limit
-        entries = request.all()
         for binding in self.config.bind:
-            self.bind_collection(entries, binding.collection,
-                                 binding.contentModel)
+            content_type = binding.content_type
+            entries = self.client.entries({
+                'content_type': content_type,
+            })
+            self.bind_collection(entries, binding.collection)
 
     @property
     @utils.memoize
-    def cda(self):
+    def client(self):
         """Contentful API client."""
-        endpoint = None
-        token = self.config.keys.production
-        # Use preview endpoint if preview key is provided.
-        if self.config.keys.preview:
-            token = self.config.keys.preview
-            endpoint = ContentfulPreprocessor._preview_endpoint
-        return client.Client(self.config.space, token, endpoint=endpoint)
+        access_token = self.config.access_token
+        if self.config.preview:
+            api_url = 'preview.contentful.com'
+            return contentful.Client(self.config.space, access_token, api_url=api_url)
+        return contentful.Client(self.config.space, access_token)
 
     def can_inject(self, doc=None, collection=None):
         if not self.injected:

example/.podcache.yaml

@@ -7,11 +7,7 @@ preprocessors:
   autorun: true
   inject: true
   space: cfexampleapi
-  keys:
-    # preview: exampleContentfulPreviewKey
-    production: b4c0n73n7fu1
+  access_token: b4c0n73n7fu1
   bind:
-  - collection: /content/city/
-    contentModel: city
   - collection: /content/cat/
-    contentModel: cat
+    content_type: cat

example/podspec.yaml

@@ -12,6 +12,6 @@
         'contentful_ext',
     ],
     install_requires=[
-        'contentful.py==0.9.3',
+        'contentful==1.10.2',
     ],
 )