contentful 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 523acf1290d29cdeb2972c104b7897a1e41909b2
-  data.tar.gz: 4ed687d95992bac7c04427d244c98e9bc01ce5d4
+  metadata.gz: a7cecffd2cc6dc1c3b8becbfe965693955299401
+  data.tar.gz: 39bcfd617abf8f802cd18adb9c976965f5cec43f
 SHA512:
-  metadata.gz: 1cacccbb9ea40372b8bb393d5ccc6e3b8b6fdeaeff9598cecd165e7a353b6b60e4aa6dc64b44756c934abb6de9016ad113df57802ace3d6102ac3dda46c2dbe4
-  data.tar.gz: 692965f112c62b3b9e4d3dfbaf3ca37add478d78526ce53993e3cab8b394e2c0e6debc78ac58120a7ade93772d25ab622c92bd819ccc2afcdd249564ea623151
+  metadata.gz: 0a422e32a95b9d17d349d0b33a55e6b8dd02a3e0e635e5c1de4843e545895d9e0fce0c473372b8982fd4b22b7d2e804db3844195cc18f5e7212d2485a2f760aa
+  data.tar.gz: 748426ae43bac7533819f3ea42704894b715ab71a3b8f2ca4c6cc1d0bc47e4ff281b23c431c1f13028b2eb80095874c5650b896503717913136882ea0233fe7c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## Unreleased
+
+## 2.1.2
+### Fixed
+* Fixed Marshalling for Arrays with deeply nested resources. [#138](https://github.com/contentful/contentful.rb/issues/138)
+
 ## 2.1.1
 
 ### Fixed

data/Gemfile.lock

@@ -1,33 +1,32 @@
 PATH
   remote: .
   specs:
-    contentful (2.1.1)
+    contentful (2.1.2)
       http (> 0.8, < 3.0)
       multi_json (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
     ast (2.3.0)
     coderay (1.1.1)
-    coveralls (0.8.17)
+    coveralls (0.8.21)
       json (>= 1.8, < 3)
-      simplecov (~> 0.12.0)
+      simplecov (~> 0.14.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
+      thor (~> 0.19.4)
       tins (~> 1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     docile (1.1.5)
     domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.9.14)
-    ffi (1.9.14-java)
+    ffi (1.9.18)
     formatador (0.2.5)
-    guard (2.14.0)
+    guard (2.14.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (~> 1.0)
@@ -41,13 +40,13 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    guard-rubocop (1.2.0)
+    guard-rubocop (1.3.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
-    guard-yard (2.1.4)
+    guard-yard (2.2.0)
       guard (>= 1.1.0)
       yard (>= 0.7.0)
-    hashdiff (0.3.1)
+    hashdiff (0.3.4)
     http (2.2.2)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -57,50 +56,45 @@ GEM
       domain_name (~> 0.5)
     http-form_data (1.0.3)
     http_parser.rb (0.6.0)
-    json (2.0.2)
-    json (2.0.2-java)
+    json (2.1.0)
     listen (3.0.6)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
-    lumberjack (1.0.10)
+    lumberjack (1.0.12)
     method_source (0.8.2)
     multi_json (1.12.1)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parser (2.3.3.1)
+    parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry (0.10.4-java)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-      spoon (~> 0.0)
-    public_suffix (2.0.4)
-    rainbow (2.1.0)
+    public_suffix (2.0.5)
+    rainbow (2.2.2)
+      rake
     rake (10.5.0)
-    rb-fsevent (0.9.8)
-    rb-inotify (0.9.7)
-      ffi (>= 0.5.0)
-    rr (1.2.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rr (1.2.1)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     rubocop (0.41.2)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
@@ -111,31 +105,28 @@ GEM
     rubygems-tasks (0.2.4)
     safe_yaml (1.0.4)
     shellany (0.0.1)
-    simplecov (0.12.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
+    simplecov-html (0.10.1)
     slop (3.6.0)
-    spoon (0.0.6)
-      ffi
-    term-ansicolor (1.4.0)
+    term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.19.4)
     tins (1.6.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.4)
-    unicode-display_width (1.1.2)
+    unicode-display_width (1.3.0)
     vcr (3.0.3)
     webmock (1.24.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    yard (0.9.5)
+    yard (0.9.9)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES

data/lib/contentful/array.rb

@@ -37,7 +37,14 @@ module Contentful
       @total = raw.fetch('total', nil)
       @limit = raw.fetch('limit', nil)
       @skip = raw.fetch('skip', nil)
-      @items = raw.fetch('items', [])
+      @items = raw.fetch('items', []).map do |item|
+        require_relative 'resource_builder'
+        ResourceBuilder.new(
+          item.raw,
+          raw_object[:configuration].merge(includes_for_single: Support.includes_from_response(raw, false)),
+          item.respond_to?(:localized) ? item.localized : false
+        ).run
+      end
     end
 
     # @private

data/lib/contentful/entry.rb

@@ -12,9 +12,9 @@ module Contentful
 
     private
 
-    def coerce(field_id, value, localized, includes)
-      return build_nested_resource(value, localized, includes) if Support.link?(value)
-      return coerce_link_array(value, localized, includes) if Support.link_array?(value)
+    def coerce(field_id, value, includes)
+      return build_nested_resource(value, includes) if Support.link?(value)
+      return coerce_link_array(value, includes) if Support.link_array?(value)
 
       content_type = ContentTypeCache.cache_get(sys[:space].id, sys[:content_type].id)
 
@@ -23,13 +23,13 @@ module Contentful
         return content_type_field.coerce(value) unless content_type_field.nil?
       end
 
-      super(field_id, value, localized, includes)
+      super(field_id, value, includes)
     end
 
-    def coerce_link_array(value, localized, includes)
+    def coerce_link_array(value, includes)
       items = []
       value.each do |link|
-        items << build_nested_resource(link, localized, includes)
+        items << build_nested_resource(link, includes)
       end
 
       items
@@ -39,16 +39,16 @@ module Contentful
     # in case one of the included items has a reference in an upper level,
     # so we can keep the include chain for that object as well
     # Any included object after the maximum include resolution depth will be just a Link
-    def build_nested_resource(value, localized, includes)
+    def build_nested_resource(value, includes)
       if @depth < @configuration.fetch(:max_include_resolution_depth, 20)
         resource = Support.resource_for_link(value, includes)
-        return resolve_include(resource, localized, includes) unless resource.nil?
+        return resolve_include(resource, includes) unless resource.nil?
       end
 
       build_link(value)
     end
 
-    def resolve_include(resource, localized, includes)
+    def resolve_include(resource, includes)
       require_relative 'resource_builder'
 
       ResourceBuilder.new(

data/lib/contentful/fields_resource.rb

@@ -4,10 +4,13 @@ require_relative 'base_resource'
 module Contentful
   # Base definition of a Contentful Resource containing Field properties
   class FieldsResource < BaseResource
+    attr_reader :localized
+
     def initialize(item, _configuration, localized = false, includes = [], *)
       super
 
-      @fields = hydrate_fields(localized, includes)
+      @localized = localized
+      @fields = hydrate_fields(includes)
 
       define_fields_methods!
     end
@@ -45,15 +48,15 @@ module Contentful
       {
         configuration: @configuration,
         raw: raw_with_links,
-        localized: locales.size > 1
+        localized: localized
       }
     end
 
     # @private
     def marshal_load(raw_object)
       super(raw_object)
-      localized = raw_object[:localized]
-      @fields = hydrate_fields(localized, raw_object[:configuration].fetch(:includes_for_single, []))
+      @localized = raw_object[:localized]
+      @fields = hydrate_fields(raw_object[:configuration].fetch(:includes_for_single, []))
       define_fields_methods!
     end
 
@@ -78,7 +81,7 @@ module Contentful
       end
     end
 
-    def hydrate_fields(localized, includes)
+    def hydrate_fields(includes)
       return {} unless raw.key?('fields')
 
       locale = internal_resource_locale
@@ -91,7 +94,6 @@ module Contentful
             result[loc][Support.snakify(name).to_sym] = coerce(
               Support.snakify(name),
               value,
-              localized,
               includes
             )
           end
@@ -101,7 +103,6 @@ module Contentful
           result[locale][Support.snakify(name).to_sym] = coerce(
             Support.snakify(name),
             value,
-            localized,
             includes
           )
         end
@@ -112,7 +113,7 @@ module Contentful
 
     protected
 
-    def coerce(_field_id, value, _localized, _includes)
+    def coerce(_field_id, value, _includes)
       value
     end
   end

data/lib/contentful/resource_builder.rb

@@ -78,13 +78,7 @@ module Contentful
     end
 
     def fetch_includes
-      includes = json['items'].dup
-      %w(Entry Asset).each do |type|
-        if json.fetch('includes', {}).key?(type)
-          includes.concat(json['includes'].fetch(type, []))
-        end
-      end
-      includes
+      Support.includes_from_response(json)
     end
 
     def resource_class(item)

data/lib/contentful/support.rb

@@ -49,6 +49,28 @@ module Contentful
             i['sys']['type'] == link['sys']['linkType']
         end
       end
+
+      # Returns combined include array from an API Response
+      #
+      # @param [Hash] json JSON Response
+      # @param [Bool] raw Response pre-proccessed?
+      #
+      # @return [Array]
+      def includes_from_response(json, raw = true)
+        includes = if raw
+                     json['items'].dup
+                   else
+                     json['items'].map(&:raw)
+                   end
+
+        %w(Entry Asset).each do |type|
+          if json.fetch('includes', {}).key?(type)
+            includes.concat(json['includes'].fetch(type, []))
+          end
+        end
+
+        includes
+      end
     end
   end
 end

data/lib/contentful/version.rb

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

data/spec/array_spec.rb

@@ -73,5 +73,26 @@ describe Contentful::Array do
       expect(re_array.skip).to eq array.skip
       expect(re_array.items).to eq array.items
     end
+
+    it 'marshals nested includes propertly - #138' do
+      vcr('array/nested_resources') {
+        client = create_client(
+          space: 'j8tb59fszch7',
+          access_token: '5f711401f965951eb724ac72ac905e13d892294ba209268f13a9b32e896c8694',
+          dynamic_entries: :auto,
+          max_include_resolution_depth: 5
+        )
+        entries = client.entries(content_type: 'child')
+        rehydrated = Marshal.load(Marshal.dump(entries))
+
+        expect(entries.inspect).to eq rehydrated.inspect
+
+        expect(entries.first.image1.url).to eq rehydrated.first.image1.url
+        expect(entries.last.image1.url).to eq rehydrated.last.image1.url
+
+        expect(entries.first.image2.url).to eq rehydrated.first.image2.url
+        expect(entries.last.image2.url).to eq rehydrated.last.image2.url
+      }
+    end
   end
 end

data/spec/fixtures/vcr_cassettes/array/nested_resources.yml

@@ -0,0 +1,159 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/j8tb59fszch7/content_types?limit=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.1.1; platform ruby/2.4.1; os macOS/16;
+      Authorization:
+      - Bearer 5f711401f965951eb724ac72ac905e13d892294ba209268f13a9b32e896c8694
+      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
+      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
+      Etag:
+      - W/"dbd86bc89681ff36b482b61f9acf6336"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Request-Id:
+      - 2643d7904927f996839e1f7b7fc8db3a
+      Content-Length:
+      - '458'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 03 Aug 2017 16:22:25 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-gig17024-GIG
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1501777345.028288,VS0,VE442
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA9VVO2/CMBDe+RWR54KSkJCSDVXt1K1MrRhMYoqL86htkALiv/fsPHCiQJ9ShZfkzr73fXeHgWUhUQgUWgf4BUIWOQEKzTjHBQLe8Ua9kZnEDPiupsSG5kDYmmA0oRIox7ZLBpUkURpftMZSb8eMNiVyHClb9YuSaTijGJpZO/VI0w1SRk8HzKebeeX0k9bYeUBjFc/brVz605XYR+tAhVWfY/OvAy0PKmWiNWWxoa7x4y5LJUmlNmtIRZxgSeKZygZybScY2sHQ9efONHQnoe+OJlPv2RTY5vH3BDjZUUGzVKW78rZxG8VU5AwXD5SA16GVbhmrnUMpTnRZ2yGhmIiI01yWKlHjG1opJaciqrS0ylQmiCb4lTithDeW+u7O1hGxLMKM7olyfIWZIGYRESfvW8rPXELYeMnOXGbQm1CSXq1m58yEIPLUF0YvnAvbvRB25+56wq56aqG/VRKuGMA55gDTP0KwH3r2yHNvv4rg8Tj0g5FnOy0BA8HjHyG4E9NvIawHgujv5b679n5oofQ/MFzvGhOlnyyMHQwaGLsw8vR8W1zYJ/ep5HoJ1sfYFm2oALUYHAcfDww1W1AHAAA=
+    http_version: 
+  recorded_at: Thu, 03 Aug 2017 16:22:25 GMT
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/j8tb59fszch7/entries?content_type=child
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.1.1; platform ruby/2.4.1; os macOS/16;
+      Authorization:
+      - Bearer 5f711401f965951eb724ac72ac905e13d892294ba209268f13a9b32e896c8694
+      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
+      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
+      Etag:
+      - W/"64e5b95602a4210b7b8494cb21e4dc1b"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Request-Id:
+      - f3c2e62d826500ebd3bcd5a1123543a4
+      Content-Length:
+      - '1070'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 03 Aug 2017 16:22:26 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-gig17031-GIG
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1501777346.023170,VS0,VE420
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA+1YXW/iOBR976+o8jwQ2/FHwhtCLZrp0u4sZTvtah4cxwG3IbAkLKKj/ve1Q6CBCYTJ0korNQ8odnLte0/u8Tnix9n5uZUsE6t1/kPf6kG6nEo9stqzGV9aeu7lk3knnaQ80vMoGyVPaqoHIBtEaqxSPYJgNVapHJsF/8oWXC27s0u2UzLlwmy1fmM1WcjFTGST65x+U/GTZfZ8vfTu8dNtnnM/W3HnBRWYch7d1CdemDyLETNVra+XzX1W5+qyVjH3l+jh9o9o2u306WLYXo4X/atOYflNXhdxOlsWH4iZ5KkM2gYWCwHIGoA1ELmFXgt5LYyaFKCHYsB8GvxawEz+oxI1iQ3uhcTFJE5lnOaAnA7ZTmHdUnzFSEVBNbDRRPAo6y8ZNwb9dcAGeytUMgpe29F8D0uN+VDCk3ZKO0lkWt4p7PIxUn7UHrcn3d5iQFFPfqVP1aVlWaL3yhJO/e787gGxG9rt3YCbrhwPRXtPlnljr3o9x/p/zEviKfolxs/DpDvoL6j6fHEvu3f/lZgObAHcZOxoYpYHfBCzKCebE/XYI/wAMXH/25+3M3B1MVjeqV6vc8MHcjDY0/LFw/x9iXk9gPfi+uuX7uc2QsP21fjq77vJniy3ialH3zNFVbGI5oEsqPIKlrWmvqpqia7uUdbSN7Pj9cCn0U+r9NWke1BhtYMo6m1RPfJIWA7Z1psbW/LTwW0dEFsHtDBrQg8XxVZnfEBu94WU89oAVC5puXHKDUWJrBnkVboSQ8KkpNhDUCAScq5vQ8E85LrQY8KBzpZSaY3MoorqbmqaGX9m2XYmREkztwLhPNK3Y7togOxyxG1CQ04Z8n3IOPMZl4gxJwCuhAAGgHh2VZ7Nx+lwV1UDmXIVbUt6jkqink0hxMGYbrsK01WmjJ/KzDp2oYJ0lAVmjnP7skZSDUfGeVECd54WO3HrA2XLGlyv+TizJ3Uq3TZfqwLsx6kcVrB/XcPrB92y5GuwSuyyTrrstDWtlVviEsusn74HqcsNyglIrR00Ik3qwuNJvS/kTUl9OY/jZaPD08bvSqTzmUwaC5WO9Mw01c49acCT07oUc5tj6BLgUO5QDHiAsQdDxw1cD1EAHO7b1ZnWIzYFDNYiNkUHie0iXJvY9Wr9oHZ2Qq6Ufo8ROwG1tfhC1iTbHlzve1ivS0PelNoSaE8hBYfChQ6hDhUS6DnsYEiwK06u1+WI28ILOUKYBoQgj3tCC7UUNCSOywKBQ2pX5VmP1thjXi1aE4oP6jUltWldp9IPUhdIvedvjxOQGrktQpsE/Ype7wl5U1JXKgMipxbsctBtigjwgtADMsS+DBxXAAag73ucu4JhUS3Y2iDVsuKOPs+8XY4eY8UrFBsjVpvaR3yXsmLrsjvL87v+fTl7OfsXUKEY1CAXAAA=
+    http_version: 
+  recorded_at: Thu, 03 Aug 2017 16:22:26 GMT
+recorded_with: VCR 3.0.3