Rename StructuredText to RichText (contentful#38)

Author: dlitvakb

CHANGELOG.md

@@ -1,6 +1,8 @@
 # CHANGELOG
 
 ## Unreleased
+### Changed
+* Renamed `StructuredText` to `RichText`.
 
 ## v1.10.2
 ### Added

contentful/client.py

@@ -487,8 +487,8 @@ def _request_headers(self):
 
         if self.authorization_as_header:
             headers['Authorization'] = 'Bearer {0}'.format(self.access_token)
-        if self.gzip_encoded:
-            headers['Accept-Encoding'] = 'gzip'
+
+        headers['Accept-Encoding'] = 'gzip' if self.gzip_encoded else 'identity'
 
         return headers
 

contentful/content_type_field_types.py

@@ -144,9 +144,9 @@ def coerce(self, value, **kwargs):
         return json.loads(json.dumps(value))
 
 
-class StructuredTextField(BasicField):
+class RichTextField(BasicField):
     """
-    Coerces Structured Text fields and resolves includes for entries included.
+    Coerces Rich Text fields and resolves includes for entries included.
     """
 
     def _coerce_link(self, value, includes=None, errors=None, resources=None, default_locale='en-US', locale=None):
@@ -215,7 +215,7 @@ def _coerce_block(self, value, includes=None, errors=None, resources=None, defau
         return value
 
     def coerce(self, value, includes=None, errors=None, resources=None, default_locale='en-US', locale=None):
-        """Coerces Structured Text properly."""
+        """Coerces Rich Text properly."""
 
         return self._coerce_block(
             value,

fixtures/fields/rich_text.yaml

@@ -391,11 +391,12 @@ def test_unresolvable_entries_dont_get_included(self):
         entry = client.entry('1HR1QvURo4MoSqO0eqmUeO')
         self.assertEqual(len(entry.modules), 2)
 
-    @vcr.use_cassette('fixtures/fields/structured_text.yaml')
-    def test_structured_text_field(self):
+    @vcr.use_cassette('fixtures/fields/rich_text.yaml')
+    def test_rich_text_field(self):
         client = Client(
             'jd7yc4wnatx3',
-            '6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248'
+            '6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248',
+            gzip_encoded=False
         )
 
         entry = client.entry('4BupPSmi4M02m0U48AQCSM')
@@ -410,8 +411,8 @@ def test_structured_text_field(self):
                 embedded_entry_index += 1
         self.assertEqual(expected_entry_occurrances, 0)
 
-    @vcr.use_cassette('fixtures/fields/structured_text_lists_with_embeds.yaml')
-    def test_structured_text_field_with_embeds_in_lists(self):
+    @vcr.use_cassette('fixtures/fields/rich_text_lists_with_embeds.yaml')
+    def test_rich_text_field_with_embeds_in_lists(self):
         client = Client(
             'jd7yc4wnatx3',
             '6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248',

fixtures/fields/rich_text_lists_with_embeds.yaml

@@ -14,7 +14,7 @@
     LinkField,
     ArrayField,
     ObjectField,
-    StructuredTextField
+    RichTextField
 )
 
 
@@ -129,17 +129,17 @@ def test_object_field(self):
         self.assertEqual(object_field.coerce([{'foo': 'bar'}, {'baz': 'qux'}]), [{'foo': 'bar'}, {'baz': 'qux'}])
 
 
-class StructuredTextFieldTest(TestCase):
-    def test_structured_text_field(self):
-        st_field = StructuredTextField()
+class RichTextFieldTest(TestCase):
+    def test_rich_text_field(self):
+        rt_field = RichTextField()
 
-        self.assertEqual(repr(st_field), '<StructuredTextField>')
+        self.assertEqual(repr(rt_field), '<RichTextField>')
 
-        # on empty or non structured text field will return the value as is
-        self.assertEqual(st_field.coerce({}), {})
-        self.assertEqual(st_field.coerce(123), 123)
+        # on empty or non rich text field will return the value as is
+        self.assertEqual(rt_field.coerce({}), {})
+        self.assertEqual(rt_field.coerce(123), 123)
 
-        # on proper structured text field, but without embedded entries will return as is
+        # on proper rich text field, but without embedded entries will return as is
         document = {
             "nodeType": "document",
             "content": [{
@@ -155,7 +155,7 @@ def test_structured_text_field(self):
                 }]
             }]
         }
-        self.assertEqual(st_field.coerce(document), document)
+        self.assertEqual(rt_field.coerce(document), document)
 
         # with embedded entries but with errors, will remove the node
         document = {
@@ -177,7 +177,7 @@ def test_structured_text_field(self):
 
         errors = [{"details": {"id": "4JJ21pcEI0QSsea20g6K6K"}}]
 
-        self.assertEqual(st_field.coerce(document, errors=errors), {
+        self.assertEqual(rt_field.coerce(document, errors=errors), {
             "nodeType": "document",
             "content": []
         })