contentful 2.10.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4411b6feaa1a20d23b04be5850b00c6bc4d3b97f009c94d5b3a2f647c49d08c5
-  data.tar.gz: 4b8e2a124c217803421cf8fd4dedaaec8cb7fc0eba5d62b55610005dbb6f205a
+  metadata.gz: 4119a15a3968b909e9128d54c7a1daefe677940a9b9a4fb0665daba4717887c0
+  data.tar.gz: dce1c341f2e1826c5ef7116d4cbe81f03ceb833e925aaa452e844075a1586fdb
 SHA512:
-  metadata.gz: 2c706107331d0135a2908945f9b7edc6d66e7aacf7746170a07ed2fb9c24a0d55ed72723660dfc3641a89402652d285d9f4506ab5ed936413787587f24579dc6
-  data.tar.gz: bfe4e04fa103f7137e0e79dbadedf3778ac5efb27844dd3f2e658bdc2ed0ae96d0c4cfefd085ceb4424006ce66aa1ac7632e3d35f035cfe9a75ac29b498c8edd
+  metadata.gz: e18f6f53144ad186ca24fe6f8305bb1c432d3d691068e7181232ea7996bd6625048cbeae61fd931b2ce7948bc34b1b12c905fc93afe927f21f52c1005b0733e0
+  data.tar.gz: 69a2cf198c6ec8e1972c99cb887daa23d11338a2249a585c81cf52d3dacb263bbef8e58161532de933872e2b1d05328ea0b63e877b4bea6e585cd3229facf05e

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+## 2.11.0
+### Added
+* Added `:raise_for_empty_fields` configuration option. [#190](https://github.com/contentful/contentful.rb/issues/190)
+
+### Fixed
+* Links in `RichText` fields, that are published but unreachable, due to not having enough include depth on the request, are now returned as `Link` objects.
+
+### Changed
+* Included resources for embedded entries and assets in Rich Text fields are now properly serialized to `data.target` instead of the top level `data`.
+
 ## 2.10.1
 ### Fixed
 * Fixed `Marshal.load` for entries with unpublished related entries.

data/README.md

@@ -229,6 +229,11 @@ client = Contentful::Client.new(
       <td><code>true</code></td>
       <td>Determines whether errors are raised or returned.</td>
     </tr>
+    <tr>
+      <td><code>raise_for_empty_fields</code></td>
+      <td><code>true</code></td>
+      <td>Determines whether <code>EmptyFieldError</code> is raised when empty fields are requested on an entry or <code>nil</code> is returned.</td>
+    </tr>
     <tr>
       <td><code>dynamic_entries</code></td>
       <td><code>:manual</code></td>

data/contentful.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
     gem.add_development_dependency'term-ansicolor', '~> 1.3.0'
     gem.add_development_dependency 'public_suffix', '< 1.5'
   else
-    gem.add_dependency 'http', '> 0.8', '< 3.0'
+    gem.add_dependency 'http', '> 0.8', '< 4.0'
   end
 
   gem.add_dependency 'multi_json', '~> 1'
@@ -39,6 +39,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rr'
   gem.add_development_dependency 'vcr'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
+  gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'tins', '~> 1.6.0'
 end

data/lib/contentful/client.rb

@@ -17,6 +17,7 @@ module Contentful
     DEFAULT_CONFIGURATION = {
       secure: true,
       raise_errors: true,
+      raise_for_empty_fields: true,
       dynamic_entries: :manual,
       api_url: 'cdn.contentful.com',
       api_version: 1,
@@ -76,6 +77,7 @@ module Contentful
     # @option given_configuration [false, ::Logger] :logger
     # @option given_configuration [::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN, ::Logger::ERROR] :log_level
     # @option given_configuration [Boolean] :raise_errors
+    # @option given_configuration [Boolean] :raise_for_empty_fields
     # @option given_configuration [::Array<String>] :dynamic_entries
     # @option given_configuration [::Hash<String, Contentful::Resource>] :resource_mapping
     # @option given_configuration [::Hash<String, Contentful::Resource>] :entry_mapping

data/lib/contentful/coercions.rb

@@ -1,4 +1,5 @@
 require_relative 'location'
+require_relative 'link'
 
 module Contentful
   # Basic Coercion
@@ -127,7 +128,7 @@ module Contentful
           link = coerce_link(node, configuration)
 
           if !link.nil?
-            node['data'] = link
+            node['data']['target'] = link
           else
             invalid_nodes << index
           end
@@ -158,6 +159,9 @@ module Contentful
         configuration[:includes_for_single]
       )
 
+      # Resource is valid but unreachable
+      return Link.new(node['data']['target'], configuration) if resource.nil?
+
       ResourceBuilder.new(
         resource,
         configuration,

data/lib/contentful/entry.rb

@@ -1,3 +1,4 @@
+require_relative 'error'
 require_relative 'fields_resource'
 require_relative 'content_type_cache'
 require_relative 'resource_references'
@@ -89,8 +90,34 @@ module Contentful
       (object.is_a?(Contentful::Entry) || object.is_a?(Contentful::Asset))
     end
 
+    def method_missing(name, *args, &block)
+      return empty_field_error(name) if content_type_field?(name)
+
+      super
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      content_type_field?(name) || super
+    end
+
     protected
 
+    def content_type_field?(name)
+      content_type = ContentTypeCache.cache_get(
+        sys[:space].id,
+        sys[:content_type].id
+      )
+
+      return false if content_type.nil?
+
+      !content_type.field_for(name).nil?
+    end
+
+    def empty_field_error(name)
+      return nil unless @configuration[:raise_for_empty_fields]
+      fail EmptyFieldError, name
+    end
+
     def repr_name
       content_type_key = Support.snakify('contentType', @configuration[:use_camel_case]).to_sym
       "#{super}[#{sys[content_type_key].id}]"

data/lib/contentful/error.rb

@@ -201,4 +201,11 @@ module Contentful
 
   # Raised when response is not parsable as a Contentful::Resource
   class UnparsableResource < StandardError; end
+
+  # Raised when an undefined field is requested
+  class EmptyFieldError < StandardError
+    def initialize(name)
+      super("The field '#{name}' is empty and unavailable in the response")
+    end
+  end
 end

data/lib/contentful/version.rb

@@ -1,5 +1,5 @@
 # Contentful Namespace
 module Contentful
   # Gem Version
-  VERSION = '2.10.1'
+  VERSION = '2.11.0'
 end

data/spec/entry_spec.rb

@@ -540,6 +540,45 @@ describe Contentful::Entry do
     end
   end
 
+  describe 'empty fields' do
+    it 'raises an exception by default' do
+      vcr('entries/empty_fields') {
+        entry = create_client(
+          space: 'z4ssexir3p93',
+          access_token: 'e157fdaf7b325b71d07a94b7502807d4cfbbb1a34e69b7856838e25b92777bc6',
+          dynamic_entries: :auto
+        ).entry('2t1x77MgUA4SM2gMiaUcsy')
+
+        expect { entry.title }.to raise_error Contentful::EmptyFieldError
+      }
+    end
+
+    it 'returns nil if raise_for_empty_fields is false' do
+      vcr('entries/empty_fields') {
+        entry = create_client(
+          space: 'z4ssexir3p93',
+          access_token: 'e157fdaf7b325b71d07a94b7502807d4cfbbb1a34e69b7856838e25b92777bc6',
+          dynamic_entries: :auto,
+          raise_for_empty_fields: false
+        ).entry('2t1x77MgUA4SM2gMiaUcsy')
+
+        expect(entry.title).to be_nil
+      }
+    end
+
+    it 'will properly raise NoMethodError for non-fields' do
+      vcr('entries/empty_fields') {
+        entry = create_client(
+          space: 'z4ssexir3p93',
+          access_token: 'e157fdaf7b325b71d07a94b7502807d4cfbbb1a34e69b7856838e25b92777bc6',
+          dynamic_entries: :auto
+        ).entry('2t1x77MgUA4SM2gMiaUcsy')
+
+        expect { entry.unexisting_field }.to raise_error NoMethodError
+      }
+    end
+  end
+
   describe 'rich text support' do
     it 'properly serializes and resolves includes' do
       vcr('entries/rich_text') {
@@ -555,8 +594,8 @@ describe Contentful::Entry do
         embedded_entry_index = 1
         entry.body['content'].each do |content|
           if content['nodeType'] == 'embedded-entry-block'
-            expect(content['data']).to be_a Contentful::Entry
-            expect(content['data'].body).to eq "Embedded #{embedded_entry_index}"
+            expect(content['data']['target']).to be_a Contentful::Entry
+            expect(content['data']['target'].body).to eq "Embedded #{embedded_entry_index}"
             expected_entry_occurrances -= 1
             embedded_entry_index += 1
           end
@@ -605,10 +644,25 @@ describe Contentful::Entry do
         ).entry('6NGLswCREsGA28kGouScyY')
 
         expect(entry.body['content'][3]['nodeType']).to eq('unordered-list')
-        expect(entry.body['content'][3]['content'][2]['content'][0]['data'].is_a?(Contentful::Entry)).to be_truthy
+        expect(entry.body['content'][3]['content'][2]['content'][0]['data']['target'].is_a?(Contentful::Entry)).to be_truthy
 
         expect(entry.body['content'][4]['nodeType']).to eq('ordered-list')
-        expect(entry.body['content'][4]['content'][2]['content'][0]['data'].is_a?(Contentful::Entry)).to be_truthy
+        expect(entry.body['content'][4]['content'][2]['content'][0]['data']['target'].is_a?(Contentful::Entry)).to be_truthy
+      }
+    end
+
+    it 'returns a link when resource is valid but unreachable' do
+      vcr('entries/rich_text_unresolved_relationships') {
+        parent = create_client(
+          space: 'jd7yc4wnatx3',
+          access_token: '6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248',
+          raise_errors: true,
+          dynamic_entries: :auto,
+          gzip_encoded: false
+        ).entry('4fvSwl5Ob6UEWKg6MQicuC')
+
+        entry = parent.rich_text_child
+        expect(entry.body['content'][19]['data']['target'].is_a?(Contentful::Link)).to be_truthy
       }
     end
   end

data/spec/fixtures/vcr_cassettes/entries/empty_fields.yml

@@ -0,0 +1,246 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/z4ssexir3p93/environments/master/content_types?limit=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.10.1; platform ruby/2.5.1; os macOS/16;
+      Authorization:
+      - Bearer e157fdaf7b325b71d07a94b7502807d4cfbbb1a34e69b7856838e25b92777bc6
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+      User-Agent:
+      - http.rb/2.2.2
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      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'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - '"736965822f777aebb01c9ee4ac6d1b2a"'
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      X-Contentful-Request-Id:
+      - 43dd26ec0162d8b206895bf92ec3cb7c
+      Content-Length:
+      - '945'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 08 Nov 2018 13:19:20 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '11024'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-fra19123-FRA
+      X-Cache:
+      - HIT
+      X-Cache-Hits:
+      - '1'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "total": 1,
+          "skip": 0,
+          "limit": 1000,
+          "items": [
+            {
+              "sys": {
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "z4ssexir3p93"
+                  }
+                },
+                "id": "test",
+                "type": "ContentType",
+                "createdAt": "2018-11-08T10:14:31.609Z",
+                "updatedAt": "2018-11-08T10:14:31.609Z",
+                "environment": {
+                  "sys": {
+                    "id": "master",
+                    "type": "Link",
+                    "linkType": "Environment"
+                  }
+                },
+                "revision": 1
+              },
+              "displayField": "title",
+              "name": "Test",
+              "description": "",
+              "fields": [
+                {
+                  "id": "title",
+                  "name": "Title",
+                  "type": "Symbol",
+                  "localized": false,
+                  "required": false,
+                  "disabled": false,
+                  "omitted": false
+                }
+              ]
+            }
+          ]
+        }
+    http_version: 
+  recorded_at: Thu, 08 Nov 2018 13:19:20 GMT
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/z4ssexir3p93/environments/master/entries?sys.id=2t1x77MgUA4SM2gMiaUcsy
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.10.1; platform ruby/2.5.1; os macOS/16;
+      Authorization:
+      - Bearer e157fdaf7b325b71d07a94b7502807d4cfbbb1a34e69b7856838e25b92777bc6
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+      User-Agent:
+      - http.rb/2.2.2
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      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'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - '"08908121582750c6cc9ba9d71bfd6e0f"'
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      X-Contentful-Request-Id:
+      - 0e4aaa81032e63c7a619be69843ff267
+      Content-Length:
+      - '842'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 08 Nov 2018 13:19:20 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-fra19146-FRA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "total": 1,
+          "skip": 0,
+          "limit": 100,
+          "items": [
+            {
+              "sys": {
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "z4ssexir3p93"
+                  }
+                },
+                "id": "2t1x77MgUA4SM2gMiaUcsy",
+                "type": "Entry",
+                "createdAt": "2018-11-08T10:14:42.223Z",
+                "updatedAt": "2018-11-08T10:14:42.223Z",
+                "environment": {
+                  "sys": {
+                    "id": "master",
+                    "type": "Link",
+                    "linkType": "Environment"
+                  }
+                },
+                "revision": 1,
+                "contentType": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "ContentType",
+                    "id": "test"
+                  }
+                },
+                "locale": "en-US"
+              },
+              "fields": {}
+            }
+          ]
+        }
+    http_version: 
+  recorded_at: Thu, 08 Nov 2018 13:19:21 GMT
+recorded_with: VCR 4.0.0