contentful-management 3.7.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48205cbf594bc68a7aff1b7017b9a46c4674c49c59af0294dd3ac16fe779deb1
-  data.tar.gz: 19138b713d5061b4730545a8952267904015963f5f5a06803bb3ae8ab63320fd
+  metadata.gz: c3fb532555b680e1310d4919295c046a81e7cf25143157b846aa2bffaa6e6fc8
+  data.tar.gz: 7e21aed3e6c01cfd0dec029553753a3eb059975f060831c26163b43361c63a52
 SHA512:
-  metadata.gz: ebb8d595852045a00a7a826584316799d36b58ec2953d5ef136d4e91d06a85e938c474a5c2cc6cde808fc5a59000c47bccaad43909a227b53479a084b2383fd8
-  data.tar.gz: d5f33999d52caeb9a63d08dd27c386ddf1e88c01977cda743cec149870fd853d3a9d3e157d52b708aaa25cea916385d4c8d0c24511cb752784a59eb435430189
+  metadata.gz: a8930ebc2559f4ac7e7664ee04c5edeb12adf679d26d6935037bc0786d0375a1d284a803a3139d98edd6f5eb65949c2ec093c677088756ce1c72df2a8a025d6a
+  data.tar.gz: 6a8a800dbb58060d2113ba8b3d62804cd26a682e10fad1fdc8e66129108a058a534d056ec3b4e6cc361402e9e724b074d8b562320b789aadfcdac9d168b23135

data/.circleci/config.yml

@@ -20,4 +20,4 @@ workflows:
       - test_and_lint:
           matrix:
             parameters:
-              ruby-version: ["2.6", "2.7", "3.0"]
+              ruby-version: ["3.0", "3.1", "3.2"]

data/.rubocop_todo.yml

@@ -1,24 +1,89 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-08-25 10:16:28 -0300 using RuboCop version 0.35.1.
+# on 2023-09-07 21:06:26 UTC using RuboCop version 1.56.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 12
+# Offense count: 1
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/contentful/management/resource.rb'
+
+# Offense count: 1
+# Configuration parameters: MaximumRangeSize.
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'lib/contentful/management/snapshot.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'lib/contentful/management/entry.rb'
+    - 'lib/contentful/management/error.rb'
+    - 'lib/contentful/management/resource.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Lint/UselessMethodDefinition:
+  Exclude:
+    - 'lib/contentful/management/client_personal_access_tokens_methods_factory.rb'
+    - 'lib/contentful/management/client_user_methods_factory.rb'
+
+# Offense count: 14
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 45
+  Max: 42
 
 # Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 9
 
-# Offense count: 18
-# Configuration parameters: CountComments.
+# Offense count: 21
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 25
+  Max: 22
+
+# Offense count: 2
+# Configuration parameters: Max, CountKeywordArgs.
+Metrics/ParameterLists:
+  MaxOptionalParameters: 4
 
 # Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 10
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/contentful/management/entry.rb'
+
+# Offense count: 1
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/contentful/management/entry.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/contentful/management/entry.rb'
+    - 'lib/contentful/management/resource.rb'
+
+# Offense count: 5
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/contentful/management/asset.rb'
+    - 'lib/contentful/management/client.rb'
+    - 'lib/contentful/management/resource_builder.rb'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+### Unlreleased
+
+## 3.9.0
+* Update ruby versions in CI/CD
+* Require ruby >= 3.0
+
+## 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

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/contentful-management.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Ruby client for the https://www.contentful.com Content Management API}
   spec.homepage      = 'https://github.com/contentful/contentful-management.rb'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'http', '> 1.0', '< 5.0'
+  spec.add_dependency 'http', '~> 5.0'
   spec.add_dependency 'multi_json', '~> 1'
   spec.add_dependency 'json', '>= 1.8', '< 3.0'
 
@@ -30,9 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'guard-yard'
-  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'rubocop', '~> 1.56.2'
   spec.add_development_dependency 'listen', '~> 3.0'
-  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'vcr', '~> 6.2.0'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'tins', '~> 1.6.0'
   spec.add_development_dependency 'simplecov'

data/lib/contentful/management/api_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource'
 
 module Contentful

data/lib/contentful/management/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource'
 require_relative 'resource/array_like'
 

data/lib/contentful/management/asset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource'
 require_relative 'resource/fields'
 require_relative 'resource/archiver'
@@ -52,7 +54,7 @@ module Contentful
       #
       # @return [Contentful::Management::Asset]
       def process_file
-        instance_variable_get(:@fields).keys.each do |locale|
+        instance_variable_get(:@fields).each_key do |locale|
           request = Request.new(
             client,
             process_url(locale),
@@ -75,8 +77,8 @@ module Contentful
       # Parser for assets attributes, creates appropriate form of request.
       def fields_for_query
         self.class.fields_coercions.keys.each_with_object({}) do |field_name, results|
-          results[field_name] = @fields.each_with_object({}) do |(locale, fields), field_results|
-            field_results[locale] = get_value_from(fields, field_name)
+          results[field_name] = @fields.transform_values do |fields|
+            get_value_from(fields, field_name)
           end
         end
       end

data/lib/contentful/management/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'http'
 require 'json'
 require 'logger'
@@ -68,7 +70,7 @@ module Contentful
       }.freeze
 
       # Rate Limit Reset Header Key
-      RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'.freeze
+      RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'
 
       # @param [String] access_token
       # @param [Hash] configuration
@@ -395,8 +397,8 @@ module Contentful
           logger.debug(response: raw_response) if logger
           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
-          reset_time = rate_limit_error.response.raw[RATE_LIMIT_RESET_HEADER_KEY].to_i
+        rescue Contentful::Management::RateLimitExceeded => e
+          reset_time = e.response.raw[RATE_LIMIT_RESET_HEADER_KEY].to_i
           if should_retry(retries_left, reset_time, configuration[:max_rate_limit_wait])
             retries_left -= 1
             logger.info(retry_message(retries_left, reset_time)) if logger
@@ -428,7 +430,7 @@ module Contentful
 
       # @private
       def should_retry(retries_left, reset_time, max_wait)
-        retries_left > 0 && max_wait > reset_time
+        retries_left.positive? && max_wait > reset_time
       end
 
       # @private
@@ -502,6 +504,7 @@ module Contentful
       # @return [HTTP::Response]
       def http_send(type, url, params, headers, proxy)
         return proxy_send(type, url, params, headers, proxy) unless proxy[:host].nil?
+
         HTTP[headers].public_send(type, url, params)
       end
 
@@ -592,6 +595,7 @@ module Contentful
         result = []
         header.each do |key, values|
           next unless values[:name]
+
           result << format_user_agent_header(key, values)
         end
 

data/lib/contentful/management/client_api_key_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_asset_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_association_all_published_method_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contentful
   module Management
     # Wrapper for /public API for usage from within Client Wrapper Classes

data/lib/contentful/management/client_association_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource_requester'
 
 module Contentful

data/lib/contentful/management/client_content_type_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 require_relative 'client_association_all_published_method_factory'
 

data/lib/contentful/management/client_editor_interface_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'editor_interface'
 require_relative 'client_association_methods_factory'
 

data/lib/contentful/management/client_entry_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_environment_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment'
 require_relative 'resource_requester'
 

data/lib/contentful/management/client_locale_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_organization_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_organization_periodic_usage_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_personal_access_tokens_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_preview_api_key_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_role_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_snapshot_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_space_membership_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_space_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource_requester'
 
 module Contentful

data/lib/contentful/management/client_space_periodic_usage_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_tag_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_ui_extension_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_upload_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_user_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_webhook_call_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_webhook_health_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/client_webhook_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/content_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'field'
 require_relative 'support'
 require_relative 'resource'
@@ -16,17 +18,17 @@ module Contentful
     class ContentType
       # Shortcuts for Contentful Field Types
       FIELD_TYPES = [
-        SYMBOL = 'Symbol'.freeze,
-        TEXT = 'Text'.freeze,
-        INTEGER = 'Integer'.freeze,
-        FLOAT = 'Number'.freeze,
-        DATE = 'Date'.freeze,
-        BOOLEAN = 'Boolean'.freeze,
-        LINK = 'Link'.freeze,
-        ARRAY = 'Array'.freeze,
-        OBJECT = 'Object'.freeze,
-        LOCATION = 'Location'.freeze,
-        STRUCTURED_TEXT = 'RichText'.freeze
+        SYMBOL = 'Symbol',
+        TEXT = 'Text',
+        INTEGER = 'Integer',
+        FLOAT = 'Number',
+        DATE = 'Date',
+        BOOLEAN = 'Boolean',
+        LINK = 'Link',
+        ARRAY = 'Array',
+        OBJECT = 'Object',
+        LOCATION = 'Location',
+        STRUCTURED_TEXT = 'RichText'
       ].freeze
 
       include Contentful::Management::Resource

data/lib/contentful/management/content_type_editor_interface_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'client_editor_interface_methods_factory'
 require_relative 'editor_interface'
 

data/lib/contentful/management/content_type_entry_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource_requester'
 
 module Contentful

data/lib/contentful/management/content_type_snapshot_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource_requester'
 
 module Contentful

data/lib/contentful/management/dynamic_entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource'
 require_relative 'location'
 require_relative 'resource/fields'
@@ -49,9 +51,7 @@ module Contentful
 
       # @private
       def self.create(content_type, client)
-        unless content_type.is_a? ContentType
-          content_type = ContentType.new(content_type)
-        end
+        content_type = ContentType.new(content_type) unless content_type.is_a? ContentType
 
         Class.new DynamicEntry do
           DynamicEntry.define_singleton_properties(self, content_type, client)

data/lib/contentful/management/editor_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource'
 require_relative 'resource/environment_aware'
 
@@ -96,7 +98,7 @@ module Contentful
           controls: controls,
           sidebar: sidebar
         }.merge(
-          attributes.each_with_object({}) { |(k, v), result| result[k.to_sym] = v }
+          attributes.transform_keys(&:to_sym)
         )
       end
     end

data/lib/contentful/management/entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource'
 require_relative 'resource/fields'
 require_relative 'resource/archiver'
@@ -72,11 +74,11 @@ module Contentful
       # @private
       def self.parse_attribute_with_field(attribute, field)
         case field.type
-        when ContentType::LINK then
+        when ContentType::LINK
           { sys: { type: field.type, linkType: field.link_type, id: attribute.id } } if attribute
-        when ContentType::ARRAY then
+        when ContentType::ARRAY
           parse_fields_array(attribute)
-        when ContentType::LOCATION then
+        when ContentType::LOCATION
           { lat: attribute.properties[:lat], lon: attribute.properties[:lon] } if attribute
         else
           attribute

data/lib/contentful/management/entry_association_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource_requester'
 
 module Contentful

data/lib/contentful/management/entry_snapshot_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'entry_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_asset_methods_factory'
 require_relative 'environment_entry_methods_factory'
 require_relative 'environment_locale_methods_factory'

data/lib/contentful/management/environment_asset_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/environment_association_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource_requester'
 
 module Contentful

data/lib/contentful/management/environment_content_type_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/environment_editor_interface_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/environment_entry_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/environment_locale_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/environment_tag_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_association_methods_factory'
 
 module Contentful

data/lib/contentful/management/environment_ui_extension_methods_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'environment_association_methods_factory'
 
 module Contentful