contentful-management 3.10.1 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88f88becc69661572e51767c99e8ea504b5becaecfc3079302546bc616636f25
-  data.tar.gz: ae295b1104be0cd2d1d9a04a4fbc038420c32d8c3dbcf5b228a180656cf008d3
+  metadata.gz: e11d5eba1080e56f80928b6e0b5eef8425b72c976fa814c78eef67b80eeb92c0
+  data.tar.gz: f7991340fd7452cd04503d8c036b36800629809e532a85dae6575efde55fafa9
 SHA512:
-  metadata.gz: d7102fdab6b2298804cacfdec564c8860037d5f52c74a80c9838cc088b1f2d9c8be8ee34ecc644d68b39cbf64071310bfd6a16d38aa04ab8d1beb6a4eb035781
-  data.tar.gz: e9cde486db4eda3b72ac6472ff9f5fddab54f39786c794b964e984278985c1ec6ed24f35b5ac00d8f15a9323b4f08c90590be43ebe33a3f73c2d3d27e64c9d58
+  metadata.gz: 6030d1c3af5683ccbd8596c4643c9ed32ff2776c4c409b1bf7c53000e9fed7a841695a458471a40752ba4b7abaa76f3162c3a7e9759cf2673d1f0f399682da01
+  data.tar.gz: 37c6ebbebb2502d64ea3e70f98036e5d81bff2503da5c6b7c41bfe92e37812b178e9fbb8d758ed80a0d6f76c022744f5038b0fbb5d870c3584bfe84a3e3c208b

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ### Unreleased
 
+## 3.11.0
+* Add support for general editor interfaces endpoint
+
 ## 3.10.1
 * Updated Ruby version requirements in gemspec and CircleCI config
 * Added support for Ruby 3.4 in CI/CD pipeline

data/lib/contentful/management/editor_interface.rb

@@ -52,9 +52,14 @@ module Contentful
       def self.build_endpoint(endpoint_options)
         space_id = endpoint_options.fetch(:space_id)
         environment_id = endpoint_options.fetch(:environment_id)
-        content_type_id = endpoint_options.fetch(:content_type_id)
+        base_path = "spaces/#{space_id}/environments/#{environment_id}"
 
-        "spaces/#{space_id}/environments/#{environment_id}/content_types/#{content_type_id}/editor_interface"
+        if endpoint_options.key?(:content_type_id)
+          content_type_id = endpoint_options.fetch(:content_type_id)
+          "#{base_path}/content_types/#{content_type_id}/editor_interface"
+        else
+          "#{base_path}/editor_interfaces"
+        end
       end
 
       # Updates an Editor Interface

data/lib/contentful/management/version.rb

@@ -5,6 +5,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '3.10.1'
+    VERSION = '3.11.0'
   end
 end

data/spec/fixtures/vcr_cassettes/editor_interfaces/all.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/oe3b689om6k5/environments/master/editor_interfaces
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/3.10.0; platform ruby/3.4.3; os macOS/24;
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+      User-Agent:
+      - http.rb/5.0.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '5583'
+      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'
+      Cf-Space-Id:
+      - oe3b689om6k5
+      Cf-Environment-Id:
+      - master
+      Cf-Environment-Uuid:
+      - master
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/editor_interfaces"
+      Etag:
+      - '"1358933671436039259"'
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      Server:
+      - Contentful
+      Contentful-Api:
+      - cma
+      Contentful-Upstream:
+      - content-api
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,CF-Context,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,X-Contentful-Comment-Body-Format,X-Contentful-Parent-Entity-Reference,X-Contentful-Include-Invocation-Metadata,X-Contentful-Async-Ai-Action
+      Access-Control-Expose-Headers:
+      - Etag,x-contentful-request-id,x-contentful-ai-actions-ratelimit-reset
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,PATCH,OPTIONS
+      Access-Control-Max-Age:
+      - '1728000'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Fri, 20 Jun 2025 12:56:28 GMT
+      X-Contentful-Request-Id:
+      - fc76cc7a-be78-4e41-9ac2-604f55ad634f
+    body:
+      encoding: ASCII-8BIT
+      string: '{"sys":{"type":"Array"},"total":8,"items":[{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":2,"createdAt":"2025-02-12T10:25:48.347Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2025-02-12T10:25:49.441Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"aaa","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"title","widgetId":"singleLine","widgetNamespace":"builtin"},{"fieldId":"bar","widgetId":"richTextEditor","widgetNamespace":"builtin"}]},{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":2,"createdAt":"2024-05-24T17:30:14.460Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2024-05-24T17:30:15.365Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"author","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"name","widgetId":"singleLine","widgetNamespace":"builtin"},{"fieldId":"avatar","widgetId":"assetLinkEditor","widgetNamespace":"builtin"}]},{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":4,"createdAt":"2025-03-21T05:51:01.897Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2025-03-21T06:40:13.391Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"blogPost","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"title","widgetId":"singleLine","widgetNamespace":"builtin"},{"fieldId":"body","widgetId":"singleLine","widgetNamespace":"builtin"}]},{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":2,"createdAt":"2024-05-04T08:09:45.250Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2024-05-04T08:09:46.204Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"category","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"title","widgetId":"singleLine","widgetNamespace":"builtin"},{"fieldId":"photo","widgetId":"assetLinkEditor","widgetNamespace":"builtin"},{"fieldId":"subCategory","widgetId":"entryLinkEditor","widgetNamespace":"builtin"}]},{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":2,"createdAt":"2022-12-25T18:51:16.158Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2022-12-25T18:51:16.936Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"crossSpace","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"title","widgetId":"singleLine","widgetNamespace":"builtin"},{"fieldId":"singleSpace","widgetId":"resourceLinkEditor","widgetNamespace":"builtin"}]},{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":4,"createdAt":"2024-07-25T21:05:25.045Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2024-07-25T21:05:51.516Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"footer","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"id","widgetId":"numberEditor","widgetNamespace":"builtin"},{"fieldId":"dag","widgetId":"singleLine","widgetNamespace":"builtin"}]},{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":2,"createdAt":"2024-07-25T21:13:26.095Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2024-07-25T21:13:26.814Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"oneWithDefaultValue","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"title","widgetId":"singleLine","widgetNamespace":"builtin"}]},{"sys":{"type":"EditorInterface","space":{"sys":{"id":"oe3b689om6k5","type":"Link","linkType":"Space"}},"version":8,"createdAt":"2024-05-24T17:26:07.699Z","createdBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"updatedAt":"2024-05-24T17:29:32.411Z","updatedBy":{"sys":{"id":"59Erm8D1JuuD273aXNb65T","type":"Link","linkType":"User"}},"contentType":{"sys":{"id":"post","type":"Link","linkType":"ContentType"}},"environment":{"sys":{"id":"master","type":"Link","linkType":"Environment"}}},"controls":[{"fieldId":"fTitle","widgetId":"singleLine","widgetNamespace":"builtin"},{"fieldId":"same","widgetId":"entryLinkEditor","widgetNamespace":"builtin"},{"fieldId":"different","widgetId":"resourceLinkEditor","widgetNamespace":"builtin"}]}]}
+
+        '
+  recorded_at: Fri, 20 Jun 2025 12:56:28 GMT
+recorded_with: VCR 6.2.0

data/spec/lib/contentful/management/editor_interface_spec.rb

@@ -25,6 +25,15 @@ module Contentful
 
       subject { client.editor_interfaces(space_id, 'master', content_type_id) }
 
+      describe '.all' do
+        it 'class method also works' do
+          vcr('editor_interfaces/all') { expect(Contentful::Management::EditorInterface.all(client, space_id, 'master')).to be_kind_of Contentful::Management::Array }
+        end
+        it 'builds a Contentful::Management::Entry object' do
+          vcr('editor_interfaces/all') { expect(Contentful::Management::EditorInterface.all(client, space_id, 'master').first).to be_kind_of Contentful::Management::EditorInterface }
+        end
+      end
+
       describe '.default' do
         it 'class method also works' do
           vcr('editor_interfaces/default_for_space') { expect(Contentful::Management::EditorInterface.default(client, space_id, 'master', content_type_id)).to be_kind_of Contentful::Management::EditorInterface }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful-management
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.11.0
 platform: ruby
 authors:
 - Piotr Protas
@@ -544,6 +544,7 @@ files:
 - spec/fixtures/vcr_cassettes/content_type/validation/size.yml
 - spec/fixtures/vcr_cassettes/content_type/validation/unique.yml
 - spec/fixtures/vcr_cassettes/delete_request.yml
+- spec/fixtures/vcr_cassettes/editor_interfaces/all.yml
 - spec/fixtures/vcr_cassettes/editor_interfaces/default_for_space.yml
 - spec/fixtures/vcr_cassettes/editor_interfaces/update.yml
 - spec/fixtures/vcr_cassettes/editor_interfaces/update_sidebar.yml
@@ -978,6 +979,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/content_type/validation/size.yml
 - spec/fixtures/vcr_cassettes/content_type/validation/unique.yml
 - spec/fixtures/vcr_cassettes/delete_request.yml
+- spec/fixtures/vcr_cassettes/editor_interfaces/all.yml
 - spec/fixtures/vcr_cassettes/editor_interfaces/default_for_space.yml
 - spec/fixtures/vcr_cassettes/editor_interfaces/update.yml
 - spec/fixtures/vcr_cassettes/editor_interfaces/update_sidebar.yml