Add environment support to sync (contentful#31)

Author: dlitvakb

CHANGELOG.md

@@ -1,6 +1,8 @@
 # CHANGELOG
 
 ## Unreleased
+### Added
+* Added support of environments to `sync`.
 
 ## v1.7.0
 ### Added

contentful/client.py

@@ -336,15 +336,12 @@ def sync(self, query=None):
             <SyncPage next_sync_token='w5ZGw6JFwqZmVcKsE8Kow4grw45QdybC...'>
         """
 
-        if self.environment != 'master':
-            raise NotSupportedException('The sync endpoint is only available for the master environment.')
-
         if query is None:
             query = {}
         self._normalize_sync(query)
 
         return self._get(
-            '/sync',
+            self.environment_url('/sync'),
             query
         )
 

contentful/resource.py

@@ -43,7 +43,7 @@ def __init__(
     def _hydrate_sys(self, item):
         sys = {}
         for k, v in item.get('sys', {}).items():
-            if k in ['space', 'contentType']:
+            if k in ['space', 'contentType', 'environment']:
                 v = self._build_link(v)
             if k in ['createdAt', 'updatedAt', 'deletedAt']:
                 v = dateutil.parser.parse(v)

fixtures/client/sync.yaml

@@ -9,7 +9,7 @@ interactions:
       Content-Type: [application/vnd.contentful.delivery.v1+json]
       User-Agent: [PythonContentfulClient/0.1.0]
     method: GET
-    uri: https://cdn.contentful.com/spaces/cfexampleapi/sync?initial=true
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?initial=true
   response:
     body:
       string: !!binary |

fixtures/client/sync_environments.yaml

@@ -0,0 +1,71 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept: ['*/*']
+      Accept-Encoding: [gzip]
+      Authorization: [Bearer bfbc63cf745a037125dbcc64f716a9a0e9d091df1a79e84920b890f87a6e7ab9]
+      Connection: [keep-alive]
+      Content-Type: [application/vnd.contentful.delivery.v1+json]
+      User-Agent: [python-requests/2.12.1]
+      X-Contentful-User-Agent: [sdk contentful.py/1.7.0; platform python/3.6.3; os
+          macOS/16.7.0;]
+    method: GET
+    uri: https://cdn.contentful.com/spaces/a22o2qgm356c/environments/staging/sync?initial=true
+  response:
+    body:
+      string: !!binary |
+        H4sIAAAAAAAAA+1bXXOiSBR9n19h8bIvG8JHg0jV1pZBwiYGGReNY7ampgi2SBRaBEOYqfnv24gf
+        aDTBdeKKhQ8RSN/ua9Pn3HPpy49PpRLhRz4hln7gQ3wSRGOIz4jqZGJEBL728/e4jR1AJ271z6xV
+        0nbDdGbujw0ztl+0SC6mBogvzC4uBrqz3SERj7H6ECN8rTV3RJ/1uNHA7sU+GgyDGM9yWI43Y1cX
+        n5/L45nzyYdIbG5D5TZSo4cmAM2O01F03tejVPdLv2Q3mKz9w5xAI4C9ahAPzVC0cEGBC4ZvURWR
+        4kWGJyug/JDuaTru7WcA3Wd7glwHuvEY709h8ov8wLBs19qcoqzzK6cGfXcOJ/DZ9m3kYvfo1NSa
+        yA2w0/Nb9r7jWX2TUv1uXQEO6sFRxw4GsjMOZst1yxqYX12uBaJvw1FvteZjE8I1nFfrFroXbT2+
+        2zUEffe3oPSX8QxLG0OllxicebFx65a99BFaebhYo8n3vJMc44ptXjWad/dm0LlpqxFQZbUtS/WD
+        gUVjbJECBzIDa6tBASy8wtOkeirA+svwEzyVrmNMni88QNv9Iku9kK9WwwhKbfNm6kmHxB2uRdMi
+        x4tAICnAZYAHNgAizYsURQKaXzPIFTyYU4g7E4SCBvSxHPiwmPP3cojSRSk+SYEjNQUTOIpFxq6g
+        k+i1RVBMR+ZZ1EtLv1XsfFudzQzTZLKplBYdzRUX5/eq4PqZQ0DXYOQB3RM8R0nPW2yw0mybZ19X
+        am4RyWff+Y+ZO2YmdXcXQmlziontYnRJChzJ03Q2UkhY5LVBrkjhJMTosUmBzisjgMdK97Opcw9Q
+        HUK/G3abQ8GpF4xQInbMzC9gBJos88w+jPDaoGCEfVX0sRmBOV8BzUmNxxfTNDgttG54AerTjo+Y
+        A/LLJFYCkauQFE9lRgYnUhWyzKw/6ckVMk5CQLsfK54TbV7KbYRkrbEsqc/6na5JQmgNm7zSZLwi
+        QpaIHTNzaITEPMCTZZBdM281yBUPnIRmPg4PpONirnJnZnw9fVRvp/eeqtu+AiUHedApeABvwGyf
+        mcN5APAkANmVMhC3GBQ8sK9SPg4PsOerj9l6o99QB0+spzB8XWkjRjGp5qH6mKFFGpBc9sxxu0GB
+        h33x8AhHyLX8FlINN/psTOIt4Y/a3bxKj4UfNifDlXYETXNgj3rYnxN+4gym9ouGHzoHHUrlhRvf
+        9Nqe1SmiJn6+5DhN33b0K9t3hnIVdG1LPTyLxqCnWJIrZ86itxsULJFDltiRYhcskeNajh38eaC2
+        ZiiRLZN0JXOOvd2gYImDWEKKw/fRpMTGaOdW9ERPdQ/pg37gRJrVriqeR1WRfIDoBnGRBsBbshzJ
+        8lmKnt4wKICyL1AGhh/L7RZ+Nq3GhYUfBpO47CkeaSW2d4TRYOHKerUi/mGLqsITKPAAI2Q0qnSN
+        Gg5lh4rkLuzYlvCO3F4Fk7iW438pTAGwb02/t/qMRRkdAykM061q6jt+p5Kw8y1M2TEz/10ALGmK
+        IqlylirpNwwKXtuX15YscgxCm4X8tYcHZ1a1tYPuDgcHW8FBv5JhJ3oBji0GBThyAI50sD8zcLCu
+        DJAZqrCpah00VU0gtK3wUEVMMSLNkQwrZAUHNgCAFDb2c3MFjpMo0zhO5NBciJXwmeeKXGUIGG58
+        y9V5CVUpgb+RZdP+FcgQcD1S5rARQ+m1Qa6QcRKFCzhXxMv2OKligo/5tsx7meKufZn1FGtH5f9b
+        b2VuBNbNkvSk6n9e878jDKSSp/WK/9Qbm+sBEZ99jZUV4cKXQI9csz0ZxW/kDYJg7IuXl2bPJedv
+        H/anI3zoXM5eQfUv0y+HXvrY8s/4z7cADaH7R8g9KCF/ex16D869WfdloY5CYE1CwDV70UMYlr/U
+        RqrW1wVNvVfuas++1g/BXc0RNDOcvHS7uH0jepKQoLV7vtYKUa8ejlkpUL7Vpr4W3QuaItXGjvb0
+        RXIH3yWk1sfheMjKqsaGnjy4ce4fu8o3CYXl2uCq3Q8nj9L4+oV+vGKlpybx6eenfwHizlnhmjsA
+        AA==
+    headers:
+      Accept-Ranges: [bytes]
+      Access-Control-Allow-Headers: ['Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation,X-Contentful-User-Agent,X-Contentful-Enable-Alpha-Feature']
+      Access-Control-Allow-Methods: ['GET,HEAD,OPTIONS']
+      Access-Control-Allow-Origin: ['*']
+      Access-Control-Expose-Headers: [Etag]
+      Access-Control-Max-Age: ['86400']
+      Age: ['0']
+      Cache-Control: [max-age=0]
+      Connection: [keep-alive]
+      Content-Encoding: [gzip]
+      Content-Length: ['1540']
+      Content-Type: [application/vnd.contentful.delivery.v1+json]
+      Date: ['Fri, 27 Apr 2018 12:10:19 GMT']
+      ETag: [W/"92eb9c4a934fbd7ea0ddb14043495da1"]
+      Server: [Contentful]
+      Vary: [Accept-Encoding]
+      Via: [1.1 varnish]
+      X-Cache: [MISS]
+      X-Cache-Hits: ['0']
+      X-Content-Type-Options: [nosniff]
+      X-Contentful-Request-Id: [14d452445089292caddea6d19c87a583]
+      X-Served-By: [cache-hhn1541-HHN]
+      X-Timer: ['S1524831019.669045,VS0,VE336']
+    status: {code: 200, message: OK}
+version: 1

tests/client_test.py

@@ -160,12 +160,12 @@ def test_client_sync(self):
         self.assertEqual(str(sync), "<SyncPage next_sync_token='w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1wrzCrBzCqMOpZAwOOcOvCcOAwqHDv0XCiMKaOcOxZA8BJUzDr8K-wo1lNx7DnHE'>")
         self.assertEqual(str(sync.items[0]), "<Entry[1t9IbcfdCk6m04uISSsaIK] id='5ETMRzkl9KM4omyMwKAOki'>")
 
-    def test_client_sync_should_fail_on_non_master_environment(self):
-        # We'll create the client without Content Type Cache, to avoid having to do a fake request.
-        client = Client('cfexampleapi', 'b4c0n73n7fu1', content_type_cache=False, environment='foo')
+    @vcr.use_cassette('fixtures/client/sync_environments.yaml')
+    def test_client_sync_with_environments(self):
+        client = Client('a22o2qgm356c', 'bfbc63cf745a037125dbcc64f716a9a0e9d091df1a79e84920b890f87a6e7ab9', environment='staging', content_type_cache=False)
+        sync = client.sync({'initial': True})
 
-        with self.assertRaises(NotSupportedException):
-            client.sync({'initial': True})
+        self.assertEquals(sync.items[0].environment.id, 'staging')
 
     @vcr.use_cassette('fixtures/client/array_endpoints.yaml')
     def test_client_creates_wrapped_arrays(self):

tests/resource_builder_test.py

@@ -11,14 +11,14 @@ def test__when_build_recieves_a_sync_page__returns_a_SyncPage(self):
                     "type": "Array"
                 },
                 "items": [],
-                "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
+                "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
             },
             {
                 "sys": {
                     "type": "Array"
                 },
                 "items": [],
-                "nextPageUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
+                "nextPageUrl": "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
             }
         ]
 

tests/sync_page_test.py

@@ -146,10 +146,10 @@ def test_sync_page_deleted_items(self):
                     }
                 }
             ],
-            "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
+            "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
         })
 
-        self.assertEqual(sync_page.next_sync_url,  "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM")
+        self.assertEqual(sync_page.next_sync_url,  "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM")
         self.assertEqual(sync_page.next_sync_token, "w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM")
         self.assertEqual(len(sync_page.items), 8)
         self.assertEqual(str(sync_page.items[-1]), "<DeletedEntry id='CVebBDcQsSsu6yKKIayy'>")
@@ -726,10 +726,10 @@ def test_sync_page_initial(self):
                     }
                 }
             ],
-            "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1wrzCrBzCqMOpZAwOOcOvCcOAwqHDv0XCiMKaOcOxZA8BJUzDr8K-wo1lNx7DnHE"
+            "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1wrzCrBzCqMOpZAwOOcOvCcOAwqHDv0XCiMKaOcOxZA8BJUzDr8K-wo1lNx7DnHE"
         })
 
-        self.assertEqual(sync_page.next_sync_url,  "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1wrzCrBzCqMOpZAwOOcOvCcOAwqHDv0XCiMKaOcOxZA8BJUzDr8K-wo1lNx7DnHE")
+        self.assertEqual(sync_page.next_sync_url,  "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1wrzCrBzCqMOpZAwOOcOvCcOAwqHDv0XCiMKaOcOxZA8BJUzDr8K-wo1lNx7DnHE")
         self.assertEqual(sync_page.next_sync_token, "w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1wrzCrBzCqMOpZAwOOcOvCcOAwqHDv0XCiMKaOcOxZA8BJUzDr8K-wo1lNx7DnHE")
         self.assertEqual(len(sync_page.items), 14)
         self.assertEqual(str(sync_page.items[-1]), "<Entry[cat] id='garfield'>")
@@ -759,10 +759,10 @@ def test__when_sync_has_multiple_pages__extracts_sync_token_from_next_page_url(s
                     }
                 }
             ],
-            "nextPageUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
+            "nextPageUrl": "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
         })
 
-        self.assertEqual(sync_page.next_page_url,  "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM")
+        self.assertEqual(sync_page.next_page_url,  "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM")
 
 
     def test__when_SyncPage_has_property_next_page_url__get_sync_token_extracts_token_from_it(self):
@@ -789,7 +789,7 @@ def test__when_SyncPage_has_property_next_page_url__get_sync_token_extracts_toke
                     }
                 }
             ],
-            "nextPageUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
+            "nextPageUrl": "https://cdn.contentful.com/spaces/cfexampleapi/environments/master/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM"
         })
 
         self.assertEqual(sync_page._get_sync_token(),  "w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCnV_Cg8OASMKpwo1UY8K8bsKFwqJrw7DDhcKnM2RDOVbDt1E-wo7CnDjChMKKGsK1w5zCrA3CnU7CgEvDtsK6w7B2wrRZwrwPIgDCjVo8PMOoUcK2wqTCl8O1wpY8wpjCkGM")