contentful-management 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c115843f4cb0a16069a1a41ada3cc3661f274ab5b2e53a3b51f085f30bd7377
-  data.tar.gz: 2c9c760b683b0f2174b24d1d40473a90dc1d001f6da8fccd32c70e5f511e1633
+  metadata.gz: 9945ef61ea841e1f83ad391afb7357f4b0a5dff52b5e783db87fffe702615c32
+  data.tar.gz: d96b10bfd523771b0161e8fc68263efff2cd3dfba0af7b93ab92e96a77299b9f
 SHA512:
-  metadata.gz: be21b3435d4a8c17661f3db6f31e17a799962ed6cb0acac6edfdeee6f6242283cbd610f0b3af9e6929148b3a0c9fb39a9c3f13fc7f1f6d7d45ee56f138ba8a99
-  data.tar.gz: a8cabfecc97f19740953a33dd92e6d5bc44479f4b393359d614d85c23d7a85f37cba0cc1de80c628a47598006a0154d9ba8c9119d85765e9a32751cefce463c1
+  metadata.gz: e67cf1768b981723e1a1de202bd208c14e8ce57e84d79add3632f1c813766298ce9ba37263659f7692a60f2d92b17523da0b5d441c327414b14633c95799424c
+  data.tar.gz: bac2a142ac94353c09f4ea59003b5583a540c5ff7981c0d336e5a8417224f374fdc05ea7fad3f2888067e6a6151ce4ff377417e27faf6ffd52118163b63deb39

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Master
 
+## 3.6.0
+* Updated readme for Entry References
+* Added examples of fetching entries by field values in readme
+* Added pagination support for environments
+
+## 3.5.0
+* Added support for Entry References API
+
 ## 3.4.0
 * Changed CI/CD vendor
 * Added support for Tags API

data/README.md

@@ -331,6 +331,14 @@ Retrieving an entry by ID:
 entry = environment.entries.find('entry_id')
 ```
 
+Retrieving entries by any other field value:
+
+```ruby
+entries = environment.entries.all(content_type: content_type.id, 'fields.fieldName' => 'value')
+```
+
+Note: all [search parameters](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/search-parameters) are supported.
+
 Creating a location:
 
 ```ruby
@@ -1096,6 +1104,14 @@ Retrieving a snapshot for a given entry:
 snapshot = entry.snapshots.find('some_snapshot_id')
 ```
 
+### Entry references
+
+Retrieving entry references:
+
+```ruby
+references = entry.references(include: 1)
+```
+
 ### Content Type Snapshots
 
 Retrieving all snapshots for a given content type:

data/lib/contentful/management/client.rb

@@ -393,7 +393,6 @@ module Contentful
           logger.info(request: { url: url, query: request.query, header: request_headers(request) }) if logger
           raw_response = yield(url)
           logger.debug(response: raw_response) if logger
-          clear_headers
           result = Response.new(raw_response, request)
           fail result.object if result.object.is_a?(Error) && configuration[:raise_errors]
         rescue Contentful::Management::RateLimitExceeded => rate_limit_error
@@ -406,6 +405,8 @@ module Contentful
           end
 
           raise
+        ensure
+          clear_headers
         end
 
         result

data/lib/contentful/management/client_environment_methods_factory.rb

@@ -17,9 +17,12 @@ module Contentful
       # Gets a collection of environments.
       #
       # @return [Contentful::Management::Array<Contentful::Management::Environment>]
-      def all
+      def all(params = {})
         @resource_requester.all(
-          space_id: @space_id
+          {
+            space_id: @space_id
+          },
+          params
         )
       end
 

data/lib/contentful/management/entry.rb

@@ -179,6 +179,19 @@ module Contentful
         EntrySnapshotMethodsFactory.new(self)
       end
 
+      def references(query = {}, headers = {})
+        ResourceRequester.new(client, self.class).all(
+          {
+            space_id: space.id,
+            environment_id: environment_id,
+            resource_id: id,
+            suffix: '/references'
+          },
+          query,
+          headers
+        )
+      end
+
       protected
 
       def query_attributes(attributes)

data/lib/contentful/management/version.rb

@@ -3,6 +3,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '3.4.0'.freeze
+    VERSION = '3.6.0'.freeze
   end
 end

data/spec/fixtures/vcr_cassettes/entry/references.yml

@@ -0,0 +1,496 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/yr5m0jky5hsh/environments/master/entries/4Rouux8SoUCKwkyCq2I0E0
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/3.4.0; platform ruby/3.0.0; os macOS/21;
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+      User-Agent:
+      - http.rb/4.4.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '1634'
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      X-Contentful-Ratelimit-Hour-Remaining:
+      - '35999'
+      X-Contentful-Ratelimit-Second-Remaining:
+      - '9'
+      X-Contentful-Ratelimit-Hour-Limit:
+      - '36000'
+      X-Contentful-Ratelimit-Second-Limit:
+      - '10'
+      X-Contentful-Ratelimit-Reset:
+      - '0'
+      Accept-Patch:
+      - application/json-patch+json
+      Cf-Environment-Id:
+      - master
+      Cf-Environment-Uuid:
+      - master
+      Cf-Space-Id:
+      - yr5m0jky5hsh
+      Etag:
+      - '"7516995411287516067"'
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/entries/:id"
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      Contentful-Api:
+      - cma
+      Server:
+      - Contentful
+      Contentful-Upstream:
+      - content-api
+      Access-Control-Allow-Origin:
+      - "*"
+      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-Tag-Visibility,X-Contentful-User-Agent,X-Contentful-Enable-Alpha-Feature,X-Contentful-Source-Environment,X-Contentful-Team,X-Contentful-Parent-Id,x-contentful-validate-only,X-Contentful-Skip-UI-Draft-Validation,X-Contentful-Marketplace,X-Contentful-UI-Content-Auto-Save,cf-trace
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,PATCH,OPTIONS
+      Access-Control-Max-Age:
+      - '1728000'
+      Cache-Control:
+      - no-store
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Tue, 07 Jun 2022 08:10:26 GMT
+      X-Contentful-Request-Id:
+      - c459707d-a600-4711-b45a-4e6c5c46e3fc
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "metadata": {
+            "tags": []
+          },
+          "sys": {
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "yr5m0jky5hsh"
+              }
+            },
+            "id": "4Rouux8SoUCKwkyCq2I0E0",
+            "type": "Entry",
+            "createdAt": "2022-05-05T08:31:57.029Z",
+            "updatedAt": "2022-05-10T06:57:20.997Z",
+            "environment": {
+              "sys": {
+                "id": "master",
+                "type": "Link",
+                "linkType": "Environment"
+              }
+            },
+            "publishedVersion": 5,
+            "publishedAt": "2022-05-10T06:57:20.997Z",
+            "firstPublishedAt": "2022-05-05T08:32:19.385Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            },
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            },
+            "publishedCounter": 2,
+            "version": 6,
+            "publishedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            },
+            "contentType": {
+              "sys": {
+                "type": "Link",
+                "linkType": "ContentType",
+                "id": "withReferences"
+              }
+            }
+          },
+          "fields": {
+            "title": {
+              "en-US": "first ref"
+            },
+            "ref1": {
+              "en-US": {
+                "sys": {
+                  "type": "Link",
+                  "linkType": "Entry",
+                  "id": "K1ONQrCXf2N7G6wjboGZu"
+                }
+              }
+            },
+            "ref21": {
+              "en-US": [
+                {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Entry",
+                    "id": "5W0cO0oCa4yDh2Z5CvoVxZ"
+                  }
+                }
+              ]
+            }
+          }
+        }
+    http_version:
+  recorded_at: Tue, 07 Jun 2022 08:10:26 GMT
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/yr5m0jky5hsh/environments/master/entries/4Rouux8SoUCKwkyCq2I0E0/references?include=1
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/3.4.0; platform ruby/3.0.0; os macOS/21;
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+      User-Agent:
+      - http.rb/4.4.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '5861'
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      X-Contentful-Ratelimit-Hour-Remaining:
+      - '35998'
+      X-Contentful-Ratelimit-Second-Remaining:
+      - '8'
+      X-Contentful-Ratelimit-Hour-Limit:
+      - '36000'
+      X-Contentful-Ratelimit-Second-Limit:
+      - '10'
+      X-Contentful-Ratelimit-Reset:
+      - '0'
+      Accept-Patch:
+      - application/json-patch+json
+      Cf-Environment-Id:
+      - master
+      Cf-Environment-Uuid:
+      - master
+      Cf-Space-Id:
+      - yr5m0jky5hsh
+      Etag:
+      - '"14536440406235544239"'
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/entries/:id/references"
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      Contentful-Api:
+      - cma
+      Server:
+      - Contentful
+      Contentful-Upstream:
+      - content-api
+      Access-Control-Allow-Origin:
+      - "*"
+      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-Tag-Visibility,X-Contentful-User-Agent,X-Contentful-Enable-Alpha-Feature,X-Contentful-Source-Environment,X-Contentful-Team,X-Contentful-Parent-Id,x-contentful-validate-only,X-Contentful-Skip-UI-Draft-Validation,X-Contentful-Marketplace,X-Contentful-UI-Content-Auto-Save,cf-trace
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,PATCH,OPTIONS
+      Access-Control-Max-Age:
+      - '1728000'
+      Cache-Control:
+      - no-store
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Tue, 07 Jun 2022 08:10:27 GMT
+      X-Contentful-Request-Id:
+      - 1fcefb5b-0bb5-4840-895e-9c9a7603406e
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "items": [
+            {
+              "metadata": {
+                "tags": []
+              },
+              "sys": {
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "yr5m0jky5hsh"
+                  }
+                },
+                "id": "4Rouux8SoUCKwkyCq2I0E0",
+                "type": "Entry",
+                "createdAt": "2022-05-05T08:31:57.029Z",
+                "updatedAt": "2022-05-10T06:57:20.997Z",
+                "environment": {
+                  "sys": {
+                    "id": "master",
+                    "type": "Link",
+                    "linkType": "Environment"
+                  }
+                },
+                "publishedVersion": 5,
+                "publishedAt": "2022-05-10T06:57:20.997Z",
+                "firstPublishedAt": "2022-05-05T08:32:19.385Z",
+                "createdBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "59Erm8D1JuuD273aXNb65T"
+                  }
+                },
+                "updatedBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "59Erm8D1JuuD273aXNb65T"
+                  }
+                },
+                "publishedCounter": 2,
+                "version": 6,
+                "publishedBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "59Erm8D1JuuD273aXNb65T"
+                  }
+                },
+                "contentType": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "ContentType",
+                    "id": "withReferences"
+                  }
+                }
+              },
+              "fields": {
+                "title": {
+                  "en-US": "first ref"
+                },
+                "ref1": {
+                  "en-US": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "Entry",
+                      "id": "K1ONQrCXf2N7G6wjboGZu"
+                    }
+                  }
+                },
+                "ref21": {
+                  "en-US": [
+                    {
+                      "sys": {
+                        "type": "Link",
+                        "linkType": "Entry",
+                        "id": "5W0cO0oCa4yDh2Z5CvoVxZ"
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ],
+          "includes": {
+            "Entry": [
+              {
+                "metadata": {
+                  "tags": []
+                },
+                "sys": {
+                  "space": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "Space",
+                      "id": "yr5m0jky5hsh"
+                    }
+                  },
+                  "id": "5W0cO0oCa4yDh2Z5CvoVxZ",
+                  "type": "Entry",
+                  "createdAt": "2022-05-10T06:56:06.593Z",
+                  "updatedAt": "2022-05-10T06:57:16.956Z",
+                  "environment": {
+                    "sys": {
+                      "id": "master",
+                      "type": "Link",
+                      "linkType": "Environment"
+                    }
+                  },
+                  "publishedVersion": 4,
+                  "publishedAt": "2022-05-10T06:57:16.956Z",
+                  "firstPublishedAt": "2022-05-10T06:57:16.956Z",
+                  "createdBy": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "User",
+                      "id": "59Erm8D1JuuD273aXNb65T"
+                    }
+                  },
+                  "updatedBy": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "User",
+                      "id": "59Erm8D1JuuD273aXNb65T"
+                    }
+                  },
+                  "publishedCounter": 1,
+                  "version": 5,
+                  "publishedBy": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "User",
+                      "id": "59Erm8D1JuuD273aXNb65T"
+                    }
+                  },
+                  "automationTags": [],
+                  "contentType": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "ContentType",
+                      "id": "footer"
+                    }
+                  }
+                },
+                "fields": {
+                  "title": {
+                    "en-US": "footer1"
+                  },
+                  "foobarRef": {
+                    "en-US": [
+                      {
+                        "sys": {
+                          "type": "Link",
+                          "linkType": "Entry",
+                          "id": "6zLEPQQNT9XZI3Ret5NcpV"
+                        }
+                      },
+                      {
+                        "sys": {
+                          "type": "Link",
+                          "linkType": "Entry",
+                          "id": "5qPzFnmjTsobP7R6JldiTN"
+                        }
+                      }
+                    ]
+                  }
+                }
+              },
+              {
+                "metadata": {
+                  "tags": []
+                },
+                "sys": {
+                  "space": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "Space",
+                      "id": "yr5m0jky5hsh"
+                    }
+                  },
+                  "id": "K1ONQrCXf2N7G6wjboGZu",
+                  "type": "Entry",
+                  "createdAt": "2022-05-05T08:32:06.913Z",
+                  "updatedAt": "2022-05-05T08:32:13.839Z",
+                  "environment": {
+                    "sys": {
+                      "id": "master",
+                      "type": "Link",
+                      "linkType": "Environment"
+                    }
+                  },
+                  "publishedVersion": 2,
+                  "publishedAt": "2022-05-05T08:32:13.839Z",
+                  "firstPublishedAt": "2022-05-05T08:32:13.839Z",
+                  "createdBy": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "User",
+                      "id": "59Erm8D1JuuD273aXNb65T"
+                    }
+                  },
+                  "updatedBy": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "User",
+                      "id": "59Erm8D1JuuD273aXNb65T"
+                    }
+                  },
+                  "publishedCounter": 1,
+                  "version": 3,
+                  "publishedBy": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "User",
+                      "id": "59Erm8D1JuuD273aXNb65T"
+                    }
+                  },
+                  "automationTags": [],
+                  "contentType": {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "ContentType",
+                      "id": "simple"
+                    }
+                  }
+                },
+                "fields": {
+                  "name": {
+                    "en-US": "simplwaala"
+                  }
+                }
+              }
+            ]
+          }
+        }
+    http_version:
+  recorded_at: Tue, 07 Jun 2022 08:10:27 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/entry/too_many_requests_retry.yml

@@ -743,7 +743,7 @@ http_interactions:
       Content-Type:
       - application/vnd.contentful.management.v1+json
       X-Contentful-Version:
-      - '30'
+      - '1'
       Content-Length:
       - '0'
       Host: