contentful 2.8.1 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ad7719eac2d1ecec165d0a791478cce7cc1525bf6618b867b4b39284f6b84a2
-  data.tar.gz: 8d4441d877f5fda9817b9a6d813d18d0a489cdd01bf9668ad4f33fd0892db318
+  metadata.gz: 98009b534c8ea22dbfa1f4b1192aa715b8ead44425dbaf71ee2523ed67ec9202
+  data.tar.gz: 1a0f6a62fcc889d813d9e4d3ea603c37bfc09744a7d77541fc00bfbf0c9134b3
 SHA512:
-  metadata.gz: 62491bdaddf51c6e0ae687959969210ba3508cc32c991da3085b676dfe28c05d6c95c6d51732c07b49556a94d9df61d6fe4975503b1becc3b6a50a088f5a6313
-  data.tar.gz: a0f0e6b4cb28382025573024d72d5ec913772fd0d88ae152291008c7541dc07eebce0897953726fdc08906f34c94ef9d99ef3c80ebd88f762181f8872f80e6f6
+  metadata.gz: 9347ad13c5afd28b1da636e2468acf097c139175d3399eaae93cd627c7868d53d2c334b5a8a78c8f2ed2d91c656a1a46565a35f44f1297262b906dec7873e3b3
+  data.tar.gz: ec4acb6965b3e9c2a7dcd8a9045ac5fa8f02edb8a0e2a15fb2213e18c7837e798fb47a892f4df1fe909c68154520cd015e55dc8a27be51ec6180231e8af854bb

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## Unreleased
 
+## 2.9.1
+
+**Note:** This release includes support for `StructuredText`, this is an **alpha** feature and changes are to be expected. Further releases of this feature
+will not increase a major version even if changes are breaking.
+
+### Added
+* Added support for `StructuredText` field type.
+
+### Fixed
+* Fixed `DateCoercion` when value is already a `Date`, `DateTime` or `Time` object. [contentful_model/#121](https://github.com/contentful/contentful_model/issues/121)
+
+## 2.9.0 **YANKED**
+
+Yanked due to faulty release
+
 ## 2.8.1
 ### Fixed
 * Fixed deeply nested resources now also filter unresolvable entries. [#177](https://github.com/contentful/contentful.rb/issues/177)

data/lib/contentful/coercions.rb

@@ -10,7 +10,7 @@ module Contentful
     end
 
     # Coerces value
-    def coerce
+    def coerce(*)
       value
     end
   end
@@ -18,7 +18,7 @@ module Contentful
   # Coercion for String Types
   class StringCoercion < BaseCoercion
     # Coerces value to String
-    def coerce
+    def coerce(*)
       value.to_s
     end
   end
@@ -32,7 +32,7 @@ module Contentful
   # Coercion for Integer Types
   class IntegerCoercion < BaseCoercion
     # Coerces value to Integer
-    def coerce
+    def coerce(*)
       value.to_i
     end
   end
@@ -40,7 +40,7 @@ module Contentful
   # Coercion for Float Types
   class FloatCoercion < BaseCoercion
     # Coerces value to Float
-    def coerce
+    def coerce(*)
       value.to_f
     end
   end
@@ -48,7 +48,7 @@ module Contentful
   # Coercion for Boolean Types
   class BooleanCoercion < BaseCoercion
     # Coerces value to Boolean
-    def coerce
+    def coerce(*)
       # rubocop:disable Style/DoubleNegation
       !!value
       # rubocop:enable Style/DoubleNegation
@@ -58,8 +58,9 @@ module Contentful
   # Coercion for Date Types
   class DateCoercion < BaseCoercion
     # Coerces value to DateTime
-    def coerce
+    def coerce(*)
       return nil if value.nil?
+      return value if value.is_a?(Date)
 
       DateTime.parse(value)
     end
@@ -68,7 +69,7 @@ module Contentful
   # Coercion for Location Types
   class LocationCoercion < BaseCoercion
     # Coerces value to Location
-    def coerce
+    def coerce(*)
       Location.new(value)
     end
   end
@@ -76,7 +77,7 @@ module Contentful
   # Coercion for Object Types
   class ObjectCoercion < BaseCoercion
     # Coerces value to hash, symbolizing each key
-    def coerce
+    def coerce(*)
       JSON.parse(JSON.dump(value), symbolize_names: true)
     end
   end
@@ -90,10 +91,73 @@ module Contentful
   # Coercion for Array Types
   class ArrayCoercion < BaseCoercion
     # Coerces value for each element
-    def coerce
+    def coerce(*)
       value.map do |e|
         options[:coercion_class].new(e).coerce
       end
     end
   end
+
+  # Coercion for StructuredText Types
+  class StructuredTextCoercion < BaseCoercion
+    # Resolves includes and removes unresolvable nodes
+    def coerce(configuration)
+      coerce_block(value, configuration)
+    end
+
+    private
+
+    def link?(node)
+      node['nodeClass'] == 'block' && node.key?('data')
+    end
+
+    def content_block?(node)
+      node['nodeClass'] == 'block' && node.key?('content')
+    end
+
+    def coerce_block(block, configuration)
+      return block unless block.is_a?(Hash) && block.key?('content')
+
+      invalid_nodes = []
+      block['content'].each_with_index do |node, index|
+        if link?(node)
+          link = coerce_link(node, configuration)
+
+          if !link.nil?
+            node['data'] = link
+          else
+            invalid_nodes << index
+          end
+        elsif content_block?(node)
+          node['content'] = coerce_block(node, configuration)
+        end
+      end
+
+      invalid_nodes.each do |index|
+        block['content'].delete_at(index)
+      end
+
+      block
+    end
+
+    def coerce_link(node, configuration)
+      return node unless node.key?('data') && node['data'].key?('target')
+      return node unless node['data']['target']['sys']['type'] == 'Link'
+
+      return nil if Support.unresolvable?(node['data']['target'], configuration[:errors])
+
+      resource = Support.resource_for_link(
+        node['data']['target'],
+        configuration[:includes_for_single]
+      )
+
+      ResourceBuilder.new(
+        resource,
+        configuration,
+        configuration[:localized],
+        configuration[:depth] + 1,
+        configuration[:errors]
+      ).run
+    end
+  end
 end

data/lib/contentful/entry.rb

@@ -26,7 +26,15 @@ module Contentful
 
       unless content_type.nil?
         content_type_field = content_type.field_for(field_id)
-        return content_type_field.coerce(value) unless content_type_field.nil?
+        coercion_configuration = @configuration.merge(
+          includes_for_single:
+            @configuration.fetch(:includes_for_single, []) + includes,
+          _entries_cache: entries,
+          localized: localized,
+          depth: @depth,
+          errors: errors
+        )
+        return content_type_field.coerce(value, coercion_configuration) unless content_type_field.nil?
       end
 
       super(field_id, value, includes, errors, entries)

data/lib/contentful/field.rb

@@ -7,17 +7,18 @@ module Contentful
   class Field
     # Coercions from Contentful Types to Ruby native types
     KNOWN_TYPES = {
-      'String'   => StringCoercion,
-      'Text'     => TextCoercion,
-      'Symbol'   => SymbolCoercion,
-      'Integer'  => IntegerCoercion,
-      'Number'   => FloatCoercion,
-      'Boolean'  => BooleanCoercion,
-      'Date'     => DateCoercion,
-      'Location' => LocationCoercion,
-      'Object'   => ObjectCoercion,
-      'Array'    => ArrayCoercion,
-      'Link'     => LinkCoercion
+      'String'         => StringCoercion,
+      'Text'           => TextCoercion,
+      'Symbol'         => SymbolCoercion,
+      'Integer'        => IntegerCoercion,
+      'Number'         => FloatCoercion,
+      'Boolean'        => BooleanCoercion,
+      'Date'           => DateCoercion,
+      'Location'       => LocationCoercion,
+      'Object'         => ObjectCoercion,
+      'Array'          => ArrayCoercion,
+      'Link'           => LinkCoercion,
+      'StructuredText' => StructuredTextCoercion
     }
 
     attr_reader :raw, :id, :name, :type, :link_type, :items, :required, :localized
@@ -34,13 +35,13 @@ module Contentful
     end
 
     # Coerces value to proper type
-    def coerce(value)
+    def coerce(value, configuration)
       return value if type.nil?
       return value if value.nil?
 
       options = {}
       options[:coercion_class] = KNOWN_TYPES[items.type] unless items.nil?
-      KNOWN_TYPES[type].new(value, options).coerce
+      KNOWN_TYPES[type].new(value, options).coerce(configuration)
     end
   end
 end

data/lib/contentful/support.rb

@@ -20,6 +20,8 @@ module Contentful
       end
 
       def unresolvable?(value, errors)
+        return true if value.nil?
+
         errors.any? { |i| i.fetch('details', {}).fetch('id', nil) == value['sys']['id'] }
       end
 

data/lib/contentful/version.rb

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

data/spec/entry_spec.rb

@@ -513,4 +513,30 @@ describe Contentful::Entry do
       }
     end
   end
+
+  describe 'structured text support' do
+    it 'properly serializes and resolves includes' do
+      vcr('entries/structured_text') {
+        entry = create_client(
+          space: 'jd7yc4wnatx3',
+          access_token: '6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248',
+          raise_errors: true,
+          dynamic_entries: :auto
+        ).entry('4BupPSmi4M02m0U48AQCSM')
+
+        expected_entry_occurrances = 2
+        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}"
+            expected_entry_occurrances -= 1
+            embedded_entry_index += 1
+          end
+        end
+
+        expect(expected_entry_occurrances).to eq 0
+      }
+    end
+  end
 end

data/spec/field_spec.rb

@@ -84,6 +84,12 @@ describe Contentful::Field do
         coercion = Contentful::DateCoercion.new(nil)
         expect(coercion.coerce).to eq(nil)
       end
+
+      it 'can coerce properly when value is already datetime' do
+        value = DateTime.new
+        coercion = Contentful::DateCoercion.new(value)
+        expect(coercion.coerce).to eq value
+      end
     end
   end
 end

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

@@ -0,0 +1,167 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/jd7yc4wnatx3/environments/master/content_types?limit=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.8.1; platform ruby/2.5.1; os macOS/16;
+      Authorization:
+      - Bearer 6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248
+      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-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - W/"0ecb92174772cc7a40d4a981e109aaab"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      X-Contentful-Request-Id:
+      - 1a2b79142c2ef390f65d8cb4f0c541e2
+      Content-Length:
+      - '459'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 23 Aug 2018 11:27:31 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-mia17622-MIA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1535023652.578501,VS0,VE253
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA91VPW/CMBDd+RXIc0Em0DbKRis6VV1gasVg4kNycZzUNpQU8d9rOyRxoqJSFakfXvCdfffuXu6ZXafbRSpXKOruzNYYOs/AWGgsJcmR8e0v7B2dasKNP3CWWrHMGNgZnCVMG2uAceFgGhKb8cllLPK2YByUykhsscobhdMrxjqcsyzqnokVsqD1MvBiNTsUPXUZWxcYtf080+s8Hr0KordD21a59tXeNVosVMRAsgBKgXoZq1JuU6FBaIfsBcYSiAY6toSgAA/CHg57QTAb4Gg0ivB1PwyvHv2AdUa/FgBiw2QqEgN+EndFKwlRGmSbmlN5nXiYn3InYcMUS4UdicPlilpEmco4ye8YcPdZFinNq6qQIIkbvkmbeERBxZJlusiL6pClzVRPm/1+jXkq2m/A2DsV1I1fgDspSZnmySLlDcoQT2PC2ZsZiai7JFyBP2tIwsuaySOHpnOy4EcOUyMhMzZl1nomD7u5+z3Q+IcVpfQMlD6TnobRJe6HODhZTx8G/C89OQWVQ1kN+bRJ+3fV1ABpqOnBh/99aqrVeq43Qst1rNdG8zPY+nNt/xd/9q0wL8a8s++8A8NDyyriBwAA
+    http_version: 
+  recorded_at: Thu, 23 Aug 2018 11:27:32 GMT
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/jd7yc4wnatx3/environments/master/entries?sys.id=4BupPSmi4M02m0U48AQCSM
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.8.1; platform ruby/2.5.1; os macOS/16;
+      Authorization:
+      - Bearer 6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248
+      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-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - W/"e5e280b9148978c6597c59a64282d404"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      X-Contentful-Request-Id:
+      - 152b5492a6f5a30dc61b85b2c8e38b98
+      Content-Length:
+      - '1194'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 23 Aug 2018 11:27:32 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-mia17627-MIA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1535023652.232526,VS0,VE316
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA+1aW3PaOBR+z6/w+HnJGBco8MYy6U4mzXSzhNnd7vRBWGqiYsusLNMwnfz36uKLJNvATiGkrHlIsJHOOfp0rtL5duE4brJJ3LHzjX/lD2yzQvzJnVAKNi5/9/yLGMNiBkL+viufkiVe8QdPPoQ4wkz85KlnzFAkCP4jCSqyFhfJKVmBQLDKR6iXmizihXyZy/Qek6UreJYfzp0s7zOZZ5KiNQBDsZwv8O0m6H0lgD29EavKP8/Fd7lO9XHVnN6v6er3WYR7t54fefPecHI3nd1q9AvBrgijG/2HgCLAEJwIXFzf6w473rDj+/ddb9zrj/vdy0Fv9FGfkK5g/YQ3Y2849vzLkd83JiCyxjQmESKCx24M1ZIikDBEbYj2xfdK47kTQ4rWOMEx4dL5GrRBTBiXOduy3XLvK9tUo1urAQm7RwnbvfdhHIBQmgAinfksn1Coh/sZoxCWFiNUxiUgUlYThs47vvUpRYm+vYsYbuxtypAoLCXXPh0TSZxrBhCTNQ3N9LSJhPjZJiNJRYAupW1+MjHK6K1BmMp1zOIIOY8IQEweLG3JhpIYotzuGHpizaOmIUgET1cOM6xX0CotUFGuSObqrDKZOt0KPzms4LXg27g0mVnw2ficAubKIuQmnQjaFaDggYLVY0Wqg0Fb2XyXAfqAbA+mFKEmZuQ/SJgyJz2i8ef36/XT9AO+vr3Gg2g5BLiyBDVzWyQpmOoRRTn2ithVra2+eUFrrV3tqdQIRQsEIYId7uXppqMM0fY2B9OoF0RZ+sQkXbxmt+hXVOFVIl1jUPUBSxp6Y/wrTDZPEhZxCCsIFKPixRcUyIxMhMFqJBID7Wgk3lUikpTKjJWNnE9lhi/gzQ9pe8fSCMzLFhycRicUbz0PzFXxrIP8z6AWKYGI8kBvV4vaBh3TW2xn37qMbBvsFF363X1LmFqbb6FtoS1tfN+KsBKcfrxs6X98N7rr3Qzwn7O/r+f+h3nizcFdrc5ynd9yCJKvxjgIa8sWDoudylXSOMMZnG3ZUqtTrR88hB+UFSEFX538HM4uc2XAOt/jnENmehXrlNgVRVarxUc7650QJyWrdBHi5BFBRzrCcYv30fD+v0F7hOzpX//xt7+WsM+up5to0JsED+jmphbXNnkq090iVTRuSg5xK3O2yZOM8FFM0dmFeM0qjdBrpCswDlJ5w6wnNuaJcjGkIJjn3eq/+CsZuIjSmO7TGKAudkjM/kBJHK7Bgl/HajfIeTEk6VWvZyFiAIfW/awiucttNNVZzbWVvUZMgjCF/O636KdQpVjeDaGfcht9F8o2a3siOHR6h0Zpz03iZrR2dUZwutt7I8wSykj29r98a+yR4Oy3d0n43uVgaDQ98CmNfRKysUJOGeh9EkLvGjslmpHd0i2xK6JYylJ2aRhxUC9OTWS1vgnZbFN47ebOieZ1bD04MCRt7p8o9CT38ta1uiajuZKGToqspSjT0ppuCs4w65dwr7LLRKdbMi38S45OeUxYYyg/m0ntcTD0AyY1unzb/Y8mVTelNSnHrWlG44qrO91XblJ+jUlJW/7E/z5fPF98BxAE8RQdKAAA
+    http_version: 
+  recorded_at: Thu, 23 Aug 2018 11:27:32 GMT
+recorded_with: VCR 4.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.9.1
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -337,6 +337,7 @@ files:
 - doc/Contentful/ServiceUnavailable.html
 - doc/Contentful/Space.html
 - doc/Contentful/StringCoercion.html
+- doc/Contentful/StructuredTextCoercion.html
 - doc/Contentful/Support.html
 - doc/Contentful/SymbolCoercion.html
 - doc/Contentful/Sync.html
@@ -452,6 +453,7 @@ files:
 - spec/fixtures/vcr_cassettes/entries.yml
 - spec/fixtures/vcr_cassettes/entries/issue_117.yml
 - spec/fixtures/vcr_cassettes/entries/issue_125.yml
+- spec/fixtures/vcr_cassettes/entries/structured_text.yml
 - spec/fixtures/vcr_cassettes/entries/unresolvable_filter.yml
 - spec/fixtures/vcr_cassettes/entries/unresolvable_filter_deeply_nested.yml
 - spec/fixtures/vcr_cassettes/entry.yml
@@ -593,6 +595,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/entries.yml
 - spec/fixtures/vcr_cassettes/entries/issue_117.yml
 - spec/fixtures/vcr_cassettes/entries/issue_125.yml
+- spec/fixtures/vcr_cassettes/entries/structured_text.yml
 - spec/fixtures/vcr_cassettes/entries/unresolvable_filter.yml
 - spec/fixtures/vcr_cassettes/entries/unresolvable_filter_deeply_nested.yml
 - spec/fixtures/vcr_cassettes/entry.yml