contentful-management 3.6.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9945ef61ea841e1f83ad391afb7357f4b0a5dff52b5e783db87fffe702615c32
-  data.tar.gz: d96b10bfd523771b0161e8fc68263efff2cd3dfba0af7b93ab92e96a77299b9f
+  metadata.gz: 44fc3acb4083375be13c59c07c353f90819b79a5d7c2bb0fbf7a86ebd0a68c22
+  data.tar.gz: bc3e20e2a8d4c13a4db0800cc877feb8cabf7f4b875b0a923c374470881c54a4
 SHA512:
-  metadata.gz: e67cf1768b981723e1a1de202bd208c14e8ce57e84d79add3632f1c813766298ce9ba37263659f7692a60f2d92b17523da0b5d441c327414b14633c95799424c
-  data.tar.gz: bac2a142ac94353c09f4ea59003b5583a540c5ff7981c0d336e5a8417224f374fdc05ea7fad3f2888067e6a6151ce4ff377417e27faf6ffd52118163b63deb39
+  metadata.gz: 667643794c89aea0014825b1b3784676be4b9a9e9c141c92d0adac31cfb6342dcf267c172fc8ff80a6a91626bb100810451053fe2c96394fbb64f70c66008bc4
+  data.tar.gz: e802e14814ed3d5e73e9c0ff22a724e47ceb941d5cf6d6b9b1274b10916339dfeca2b5d5fc599307aae90b28ff05af4cf299f57a834ebe98c651292bbbb78482

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 
-## Master
+## 3.8.0
+* Added support for cross-space references 
+
+## 3.7.0
+* Replaces deprecated `URI.escape` with `URI.encode_www_form_component` in Contentful::Management::Request#id
+* Configured VCR to redact sensitive data
 
 ## 3.6.0
 * Updated readme for Entry References

data/README.md

@@ -468,6 +468,25 @@ or the field of link type:
 blog_post_content_type.fields.create(id: 'my_entry_link_field', name: 'My Entry Link Field', type: 'Link', link_type: 'Entry')
 ```
 
+or the field of ResourceLink type:
+```ruby
+blog_post_content_type.fields.create(
+  id: 'my_resource_link_id',
+  name: 'My Resource Link',
+  type: 'ResourceLink',
+  localized: true,
+  disabled: false,
+  omitted: false,
+  allowed_resources: [
+    {
+      type: 'Contentful:Entry',
+      source: 'crn:contentful:::content:spaces/space_id',
+      contentTypes: ["foo", "bar"]
+    }
+  ]
+)
+```
+
 or the field of an array type:
 ```ruby
 items = Contentful::Management::Field.new

data/lib/contentful/management/field.rb

@@ -16,6 +16,7 @@ module Contentful
       property :disabled, :boolean
       property :localized, :boolean
       property :validations, Validation
+      property :allowedResources
 
       # Takes a field object of content type
       # Merges existing properties, items and validations of field with new one

data/lib/contentful/management/request.rb

@@ -24,7 +24,7 @@ module Contentful
 
         if id
           @type = :single
-          @id = URI.escape(id)
+          @id = URI.encode_www_form_component(id)
         else
           @type = :multi
           @id = nil

data/lib/contentful/management/version.rb

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

data/spec/fixtures/vcr_cassettes/content_type/fields/resource_link_with_params.yml

@@ -0,0 +1,316 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/yr5m0jky5hsh/environments/master/content_types/8KSpuKrl04eMAGQoQckweq
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/3.5.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:
+      - '1313'
+      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-Environment-Id:
+      - master
+      Cf-Environment-Uuid:
+      - master
+      Cf-Space-Id:
+      - yr5m0jky5hsh
+      Etag:
+      - '"10374541921030338982"'
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/content_types/: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'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Mon, 26 Dec 2022 21:49:29 GMT
+      X-Contentful-Request-Id:
+      - e9306e05-aafe-417c-a16c-14922c2afad2
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "yr5m0jky5hsh"
+              }
+            },
+            "id": "8KSpuKrl04eMAGQoQckweq",
+            "type": "ContentType",
+            "createdAt": "2022-12-26T19:31:48.068Z",
+            "updatedAt": "2022-12-26T21:49:17.143Z",
+            "environment": {
+              "sys": {
+                "id": "master",
+                "type": "Link",
+                "linkType": "Environment"
+              }
+            },
+            "publishedVersion": 10,
+            "publishedAt": "2022-12-26T21:49:17.143Z",
+            "firstPublishedAt": "2022-12-26T19:31:48.360Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            },
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            },
+            "publishedCounter": 4,
+            "version": 11,
+            "publishedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            }
+          },
+          "displayField": "title",
+          "name": "From Ruby SDK",
+          "description": "",
+          "fields": [
+            {
+              "id": "title",
+              "name": "title",
+              "type": "Symbol",
+              "localized": false,
+              "required": false,
+              "validations": [],
+              "disabled": false,
+              "omitted": false
+            }
+          ]
+        }
+    http_version:
+  recorded_at: Mon, 26 Dec 2022 21:49:30 GMT
+- request:
+    method: put
+    uri: https://api.contentful.com/spaces/yr5m0jky5hsh/environments/master/content_types/8KSpuKrl04eMAGQoQckweq
+    body:
+      encoding: UTF-8
+      string: '{"displayField":"title","name":"From Ruby SDK","description":"","fields":[{"id":"title","name":"title","type":"Symbol"},{"id":"myResourceLink","name":"My
+        Resource Link","type":"ResourceLink","localized":true,"allowedResources":[{"type":"Contentful:Entry","source":"crn:contentful:::content:spaces/yb41ceqgyiw5","contentTypes":["category","course"]}]}]}'
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful-management.rb/3.5.0; platform ruby/3.0.0; os macOS/21;
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      X-Contentful-Version:
+      - '11'
+      Version:
+      - '11'
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+      User-Agent:
+      - http.rb/4.4.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '1791'
+      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-Environment-Id:
+      - master
+      Cf-Environment-Uuid:
+      - master
+      Cf-Space-Id:
+      - yr5m0jky5hsh
+      Etag:
+      - '"2125699879861347044"'
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/content_types/: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'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Mon, 26 Dec 2022 21:49:30 GMT
+      X-Contentful-Request-Id:
+      - 77d8a503-bee7-43a4-815d-e6d111692c46
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "yr5m0jky5hsh"
+              }
+            },
+            "id": "8KSpuKrl04eMAGQoQckweq",
+            "type": "ContentType",
+            "createdAt": "2022-12-26T19:31:48.068Z",
+            "updatedAt": "2022-12-26T21:49:30.449Z",
+            "environment": {
+              "sys": {
+                "id": "master",
+                "type": "Link",
+                "linkType": "Environment"
+              }
+            },
+            "publishedVersion": 10,
+            "publishedAt": "2022-12-26T21:49:17.143Z",
+            "firstPublishedAt": "2022-12-26T19:31:48.360Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            },
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            },
+            "publishedCounter": 4,
+            "version": 12,
+            "publishedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "59Erm8D1JuuD273aXNb65T"
+              }
+            }
+          },
+          "displayField": "title",
+          "name": "From Ruby SDK",
+          "description": "",
+          "fields": [
+            {
+              "id": "title",
+              "name": "title",
+              "type": "Symbol",
+              "localized": false,
+              "required": false,
+              "validations": [],
+              "disabled": false,
+              "omitted": false
+            },
+            {
+              "id": "myResourceLink",
+              "name": "My Resource Link",
+              "type": "ResourceLink",
+              "localized": true,
+              "required": false,
+              "validations": [],
+              "disabled": false,
+              "omitted": false,
+              "allowedResources": [
+                {
+                  "type": "Contentful:Entry",
+                  "source": "crn:contentful:::content:spaces/yb41ceqgyiw5",
+                  "contentTypes": [
+                    "foo",
+                    "bar"
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+    http_version:
+  recorded_at: Mon, 26 Dec 2022 21:49:30 GMT
+recorded_with: VCR 4.0.0

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

@@ -440,6 +440,34 @@ module Contentful
             expect(content_type.fields[11].type).to eq field_type
           end
         end
+        it 'creates a new ResourceLink field with additional parameters' do
+          vcr('content_type/fields/resource_link_with_params') do
+            content_type = subject.find('8KSpuKrl04eMAGQoQckweq')
+            content_type.fields.create(
+              id: 'myResourceLink',
+              name: 'My Resource Link',
+              type: 'ResourceLink',
+              localized: true,
+              disabled: false,
+              omitted: false,
+              allowed_resources: [
+                {
+                  type: 'Contentful:Entry',
+                  source: 'crn:contentful:::content:spaces/yb41ceqgyiw5',
+                  contentTypes: ["foo", "bar"]
+                }
+              ]
+            )
+            expect(content_type.fields.size).to eq 2
+            field = content_type.fields.last
+            expect(field.name).to eq 'My Resource Link'
+            expect(field.type).to eq 'ResourceLink'
+            expect(field.allowed_resources.size).to eq 1
+            expect(field.allowed_resources.first['type']).to eq 'Contentful:Entry'
+            expect(field.allowed_resources.first['source']).to eq 'crn:contentful:::content:spaces/yb41ceqgyiw5'
+            expect(field.allowed_resources.first['contentTypes']).to eq ["foo", "bar"]
+          end
+        end
       end
 
       describe '#fields.add' do

data/spec/support/vcr.rb

@@ -5,6 +5,15 @@ VCR.configure do |c|
   c.ignore_localhost = true
   c.hook_into :webmock
   c.default_cassette_options = {record: :once}
+
+  # Redact Contentful Management API tokens from VCR recordings
+  c.filter_sensitive_data('<ACCESS_TOKEN>') do |interaction|
+    if (auths = interaction.request.headers['Authorization']&.first)
+      if (match = auths.match(/^Bearer\s+([^,\s]+)/))
+        match.captures.first
+      end
+    end
+  end
 end
 
 def vcr(name, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful-management
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Piotr Protas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -518,6 +518,7 @@ files:
 - spec/fixtures/vcr_cassettes/content_type/fields/create_array_with_params.yml
 - spec/fixtures/vcr_cassettes/content_type/fields/create_with_params.yml
 - spec/fixtures/vcr_cassettes/content_type/fields/destroy.yml
+- spec/fixtures/vcr_cassettes/content_type/fields/resource_link_with_params.yml
 - spec/fixtures/vcr_cassettes/content_type/fields/update_field.yml
 - spec/fixtures/vcr_cassettes/content_type/find.yml
 - spec/fixtures/vcr_cassettes/content_type/find_not_found.yml
@@ -834,7 +835,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: contentful management api
@@ -951,6 +952,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/content_type/fields/create_array_with_params.yml
 - spec/fixtures/vcr_cassettes/content_type/fields/create_with_params.yml
 - spec/fixtures/vcr_cassettes/content_type/fields/destroy.yml
+- spec/fixtures/vcr_cassettes/content_type/fields/resource_link_with_params.yml
 - spec/fixtures/vcr_cassettes/content_type/fields/update_field.yml
 - spec/fixtures/vcr_cassettes/content_type/find.yml
 - spec/fixtures/vcr_cassettes/content_type/find_not_found.yml