contentful 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 055e3549fae94399369cbf11af030345ecca06a2
+  data.tar.gz: afcffb79eb459aa3b7fb55092c5be10594d98c63
+SHA512:
+  metadata.gz: 74469eca51e340966a57bf3e7d2bd4880c3c0f988e5eba58eaef49fcecc52d7a3a3ab4ea092a6211beb353642686052c92636a7502e0ef714c15793ca4d4666d
+  data.tar.gz: 8ccc5ef2d39f5b9e3fdab75b8fe47d9b39d2e8c734b84a6638707143f5e5782abf34e9830d7f96d817531644b0ef4bf2d70f7ed536db0f835d8e4757c5fbb6e9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.1.3
+
+* Better link inclusion processing, prevent "stack level to deep" errors
+
+
 ### 0.1.2
 
 * Fix the way all content types are retrieved

data/lib/contentful/resource_builder.rb

@@ -21,13 +21,14 @@ module Contentful
       'Link' => Link,
     }
 
-    attr_reader :client, :response, :resource_mapping
+    attr_reader :client, :response, :resource_mapping, :resource
 
 
     def initialize(client, response, resource_mapping = {})
       @response = response
       @client = client
       @included_resources = {}
+      @known_resources = Hash.new{ |h,k| h[k] = {} }
       @resource_mapping = default_resource_mapping.merge(resource_mapping)
     end
 
@@ -54,24 +55,25 @@ module Contentful
     # - raise error if response not valid
     # - look for included objects and parse them to resources
     # - parse main object to resource
-    # - replace links in included resources with included resources
-    # - replace links in main resource with included resources
+    # - replace links in included resources with known resources
+    # - replace links in main resource with known resources
     # - return main resource
     def create_all_resources!
       create_included_resources! response.object['includes']
-      res = create_resource(response.object)
+      @resource = create_resource(response.object)
 
       unless @included_resources.empty?
-        replace_links_in_included_resources_with_included_resources
-        replace_links_with_included_resources(res)
+        replace_links_in_included_resources_with_known_resources
+        replace_links_with_known_resources @resource
       end
 
-      res
+      @resource
     end
 
     # Creates a single resource from the
     def create_resource(object)
       res = detect_resource_class(object).new(object, response.request, client)
+      add_to_known_resources res
       replace_children res, object
       replace_child_array res.items if res.array?
 
@@ -143,6 +145,10 @@ module Contentful
       end
     end
 
+    def add_to_known_resources(res)
+      @known_resources[res.type][res.id] = res if res.sys && res.id && res.type != 'Link'
+    end
+
     def replace_children(res, object)
       object.each do |name, potential_objects|
         detect_child_objects(potential_objects).each do |child_name, child_object|
@@ -172,48 +178,55 @@ module Contentful
       end
     end
 
-    def replace_links_with_included_resources(res)
-      [:properties, :sys, :fields].each do |property_container_name|
-        if property_container = res.public_send(property_container_name)
-          property_container.each do |property_name, property_value|
-            if property_value.is_a? ::Array
-              sub_property_container = property_value
-              sub_property_container.each.with_index do |sub_property_value, sub_property_index|
-                replace_link_or_check_recursively sub_property_value, sub_property_container, sub_property_index
-              end
-            else
-              replace_link_or_check_recursively property_value, property_container, property_name
-            end
-          end
-        end
+    def replace_links_with_known_resources(res, seen_resource_ids = [])
+      seen_resource_ids << res.id
+
+      [:properties, :sys, :fields].map do |property_container_name|
+        res.public_send(property_container_name)
+      end.compact.each do |property_container|
+        replace_links_in_properties(property_container, seen_resource_ids)
       end
+
       if res.array?
-        property_container = res.items
-        property_container.each.with_index do|child_property, property_index|
-          replace_link_or_check_recursively child_property, property_container, property_index
+        replace_links_in_array res.items, seen_resource_ids
+      end
+    end
+
+    def replace_links_in_properties(property_container, seen_resource_ids)
+      property_container.each do |property_name, property_value|
+        if property_value.is_a? ::Array
+          replace_links_in_array property_value, seen_resource_ids
+        else
+          replace_link_or_check_recursively property_value, property_container, property_name, seen_resource_ids
         end
       end
     end
 
-    def replace_link_or_check_recursively(property_value, property_container, property_name)
+    def replace_links_in_array(property_container, seen_resource_ids)
+      property_container.each.with_index do |child_property, property_index|
+        replace_link_or_check_recursively child_property, property_container, property_index, seen_resource_ids
+      end
+    end
+
+    def replace_link_or_check_recursively(property_value, property_container, property_name, seen_resource_ids)
       if property_value.is_a? Link
         maybe_replace_link(property_value, property_container, property_name)
-      elsif property_value.is_a?(Resource) && property_value.sys
-        replace_links_with_included_resources(property_value)
+      elsif property_value.is_a?(Resource) && property_value.sys && !seen_resource_ids.include?(property_value.id)
+        replace_links_with_known_resources(property_value, seen_resource_ids)
       end
     end
 
     def maybe_replace_link(link, parent, key)
-      if  @included_resources[link.link_type] &&
-          @included_resources[link.link_type].key?(link.id)
-        parent[key] = @included_resources[link.link_type][link.id]
+      if  @known_resources[link.link_type] &&
+          @known_resources[link.link_type].key?(link.id)
+        parent[key] = @known_resources[link.link_type][link.id]
       end
     end
 
-    def replace_links_in_included_resources_with_included_resources
+    def replace_links_in_included_resources_with_known_resources
       @included_resources.each do |_, for_type|
         for_type.each do |_, res|
-          replace_links_with_included_resources(res)
+          replace_links_with_known_resources(res)
         end
       end
     end

data/lib/contentful/version.rb

@@ -1,3 +1,3 @@
 module Contentful
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/fixtures/json_responses/self_link.json

@@ -0,0 +1,82 @@
+{
+  "sys": {
+    "type": "Array"
+  },
+  "total": 1,
+  "skip": 0,
+  "limit": 100,
+  "items": [
+    {
+      "sys": {
+        "space": {
+          "sys": {
+            "type": "Link",
+            "linkType": "Space",
+            "id": "6yahkaf5ehkk"
+          }
+        },
+        "type": "Entry",
+        "contentType": {
+          "sys": {
+            "type": "Link",
+            "linkType": "ContentType",
+            "id": "tSFLnCNqvuyoMA6SKkQ2W"
+          }
+        },
+        "id": "6HM4G3D4iciuoIk6CW2OK6",
+        "revision": 2,
+        "createdAt": "2014-04-16T17:52:42.289Z",
+        "updatedAt": "2014-04-16T17:53:28.780Z",
+        "locale": "en-US"
+      },
+      "fields": {
+        "foo": "777777777",
+        "e": {
+          "sys": {
+            "type": "Link",
+            "linkType": "Entry",
+            "id": "55t1gz1JUIQ2s4mcMwQ8cA"
+          }
+        }
+      }
+    }
+  ],
+  "includes": {
+    "Entry": [
+      {
+        "sys": {
+          "space": {
+            "sys": {
+              "type": "Link",
+              "linkType": "Space",
+              "id": "6yahkaf5ehkk"
+            }
+          },
+          "type": "Entry",
+          "contentType": {
+            "sys": {
+              "type": "Link",
+              "linkType": "ContentType",
+              "id": "tSFLnCNqvuyoMA6SKkQ2W"
+            }
+          },
+          "id": "55t1gz1JUIQ2s4mcMwQ8cA",
+          "revision": 1,
+          "createdAt": "2014-04-16T17:53:15.753Z",
+          "updatedAt": "2014-04-16T17:53:15.753Z",
+          "locale": "en-US"
+        },
+        "fields": {
+          "foo": "88888888888",
+          "e": {
+            "sys": {
+              "type": "Link",
+              "linkType": "Entry",
+              "id": "6HM4G3D4iciuoIk6CW2OK6"
+            }
+          }
+        }
+      }
+    ]
+  }
+}

data/spec/resource_building_spec.rb

@@ -17,4 +17,13 @@ describe 'Resource Building Examples' do
     expect( resource.fields[:links] ).to be_a Array
     expect( resource.fields[:links].first ).to be_a Contentful::Entry
   end
+
+  it 'can also reference itself' do
+    response = Contentful::Response.new raw_fixture('self_link')
+    resource = Contentful::ResourceBuilder.new(create_client, response).run.first
+
+    other_resource = resource.fields[:e]
+    expect( other_resource ).to be_a Contentful::Entry
+    expect( other_resource.fields[:e] ).to be resource
+  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -14,157 +13,139 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.17.3
 description: Ruby client for the https://www.contentful.com Content Delivery API
@@ -173,21 +154,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
-- coverage/.last_run.json
-- coverage/.resultset.json
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
 - contentful.gemspec
+- coverage/.last_run.json
+- coverage/.resultset.json
 - examples/custom_classes.rb
 - examples/dynamic_entries.rb
 - examples/example_queries.rb
 - examples/raise_errors.rb
 - examples/raw_mode.rb
 - examples/resource_mapping.rb
-- Gemfile
-- Gemfile.lock
+- lib/contentful.rb
 - lib/contentful/array.rb
 - lib/contentful/asset.rb
 - lib/contentful/client.rb
@@ -201,19 +186,15 @@ files:
 - lib/contentful/locale.rb
 - lib/contentful/location.rb
 - lib/contentful/request.rb
+- lib/contentful/resource.rb
 - lib/contentful/resource/asset_fields.rb
 - lib/contentful/resource/fields.rb
 - lib/contentful/resource/system_properties.rb
-- lib/contentful/resource.rb
 - lib/contentful/resource_builder.rb
 - lib/contentful/response.rb
 - lib/contentful/space.rb
 - lib/contentful/support.rb
 - lib/contentful/version.rb
-- lib/contentful.rb
-- LICENSE.txt
-- Rakefile
-- README.md
 - spec/array_spec.rb
 - spec/asset_spec.rb
 - spec/auto_includes_spec.rb
@@ -232,6 +213,7 @@ files:
 - spec/fixtures/json_responses/link_array.json
 - spec/fixtures/json_responses/not_found.json
 - spec/fixtures/json_responses/nyancat.json
+- spec/fixtures/json_responses/self_link.json
 - spec/fixtures/json_responses/unparsable.json
 - spec/fixtures/vcr_cassettes/array.yml
 - spec/fixtures/vcr_cassettes/array_page_1.yml
@@ -265,33 +247,26 @@ files:
 homepage: https://github.com/contentful/contentful.rb
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4173593734953116730
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4173593734953116730
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: contentful
 test_files:
 - spec/array_spec.rb
@@ -312,6 +287,7 @@ test_files:
 - spec/fixtures/json_responses/link_array.json
 - spec/fixtures/json_responses/not_found.json
 - spec/fixtures/json_responses/nyancat.json
+- spec/fixtures/json_responses/self_link.json
 - spec/fixtures/json_responses/unparsable.json
 - spec/fixtures/vcr_cassettes/array.yml
 - spec/fixtures/vcr_cassettes/array_page_1.yml