contentful 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1f5e5d0ae0f81f3be2fcef1c4cdffbd4eeb253a
+  data.tar.gz: 7826b5a5d1dbbdd695617a02840a2e26cd79fb22
+SHA512:
+  metadata.gz: 68d88252df1d4fb897c243d05fea8cd104c342fa8431de9b693abf7bf49d931d76f7b821ad984841d6803ddd60291eb9e2745a0b1a69d2022088079f5deea471
+  data.tar.gz: 0dc914a52aa703c1cade8c1bbc10f3ed7d3aec2ef8d8c7db064d47664ec2fab7c27fbda756e56ebe7d183985600355fac35f134720bb836959455dac92c79c3f

data/.gitignore

@@ -1,2 +1,3 @@
 pkg
+coverage
 Gemfile.lock

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.1.1
+
+* Fix a bug that prevented fields with multiple resources to be parsed correctly
+* Restrict HTTP gem dependency to < 0.6
+
+
 ### 0.1.0
 
 * Initial release.

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+
+group :documentation do
+  gem 'coveralls', :require => false
+end

data/README.md

@@ -1,4 +1,5 @@
 # contentful.rb
+[![Gem Version](https://badge.fury.io/rb/contentful.png)](http://badge.fury.io/rb/contentful) [![Build Status](https://travis-ci.org/contentful/contentful.rb.png)](https://travis-ci.org/contentful/contentful.rb) [![Coverage Status](https://coveralls.io/repos/contentful/contentful.rb/badge.png?branch=master)](https://coveralls.io/r/contentful/contentful.rb?branch=master)
 
 Ruby client for the [Contentful](https://www.contentful.com) Content Delivery API.
 

data/contentful.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'http', '~> 0'
+  gem.add_dependency 'http', '~> 0', '< 0.6'
   gem.add_dependency 'multi_json', '~> 1'
 
   gem.add_development_dependency 'bundler', '~> 1.5'

data/lib/contentful/array.rb

@@ -42,6 +42,5 @@ module Contentful
     def empty?
       items.empty?
     end
-
   end
-end
+end

data/lib/contentful/asset.rb

@@ -21,13 +21,13 @@ module Contentful
         w:  options[:w]  || options[:width],
         h:  options[:h]  || options[:height],
         fm: options[:fm] || options[:format],
-        q:  options[:q]  || options[:quality],
-      }.reject{ |k,v| v.nil? }
+        q:  options[:q]  || options[:quality]
+      }.reject { |k, v| v.nil? }
 
       if query.empty?
         file.url
       else
-        "#{file.url}?#{ URI.encode_www_form(query) }"
+        "#{file.url}?#{URI.encode_www_form(query)}"
       end
     end
   end

data/lib/contentful/client.rb

@@ -17,12 +17,11 @@ module Contentful
       authentication_mechanism: :header,
       resource_builder: ResourceBuilder,
       resource_mapping: {},
-      raw_mode: false,
+      raw_mode: false
     }
 
     attr_reader :configuration, :dynamic_entry_cache
 
-
     # Wraps the actual HTTP request
     def self.get_http(url, query, headers = {})
       HTTP[headers].get(url, params: query)
@@ -101,9 +100,9 @@ module Contentful
 
     # Returns the headers used for the HTTP requests
     def request_headers
-      headers = { "User-Agent" => "RubyContentfulGem/#{Contentful::VERSION}" }
-      headers["Authorization"] = "Bearer #{configuration[:access_token]}" if configuration[:authentication_mechanism] == :header
-      headers["Content-Type"]  = "application/vnd.contentful.delivery.v#{configuration[:api_version].to_i}+json" if configuration[:api_version]
+      headers = { 'User-Agent' => "RubyContentfulGem/#{Contentful::VERSION}" }
+      headers['Authorization'] = "Bearer #{configuration[:access_token]}" if configuration[:authentication_mechanism] == :header
+      headers['Content-Type']  = "application/vnd.contentful.delivery.v#{configuration[:api_version].to_i}+json" if configuration[:api_version]
 
       headers
     end
@@ -125,7 +124,7 @@ module Contentful
         self.class.get_http(
           base_url + request.url,
           request_query(request.query),
-          request_headers,
+          request_headers
         ), request
       )
 
@@ -140,12 +139,12 @@ module Contentful
     # See README for details.
     def update_dynamic_entry_cache!
       @dynamic_entry_cache = Hash[
-        content_types(limit: 0).map{ |ct|
+        content_types(limit: 0).map do |ct|
           [
             ct.id.to_sym,
-            DynamicEntry.create(ct),
+            DynamicEntry.create(ct)
           ]
-        }
+        end
       ]
     end
 
@@ -155,39 +154,37 @@ module Contentful
       @dynamic_entry_cache[key.to_sym] = klass
     end
 
-
     private
 
     def normalize_configuration!
-      [:space, :access_token, :api_url].each{ |s| configuration[s] = configuration[s].to_s }
+      [:space, :access_token, :api_url].each { |s| configuration[s] = configuration[s].to_s }
       configuration[:authentication_mechanism] = configuration[:authentication_mechanism].to_sym
     end
 
     def validate_configuration!
       if configuration[:space].empty?
-        raise ArgumentError, "You will need to initialize a client with a :space"
+        raise ArgumentError, 'You will need to initialize a client with a :space'
       end
 
       if configuration[:access_token].empty?
-        raise ArgumentError, "You will need to initialize a client with an :access_token"
+        raise ArgumentError, 'You will need to initialize a client with an :access_token'
       end
 
       if configuration[:api_url].empty?
-        raise ArgumentError, "The client configuration needs to contain an :api_url"
+        raise ArgumentError, 'The client configuration needs to contain an :api_url'
       end
 
       unless configuration[:api_version].to_i >= 0
-        raise ArgumentError, "The :api_version must be a positive number or nil"
+        raise ArgumentError, 'The :api_version must be a positive number or nil'
       end
 
       unless [:header, :query_string].include? configuration[:authentication_mechanism]
-        raise ArgumentError, "The authentication mechanism must be :header or :query_string"
+        raise ArgumentError, 'The authentication mechanism must be :header or :query_string'
       end
 
       unless [:auto, :manual].include? configuration[:dynamic_entries]
-        raise ArgumentError, "The :dynamic_entries mode must be :auto or :manual"
+        raise ArgumentError, 'The :dynamic_entries mode must be :auto or :manual'
       end
     end
   end
 end
-

data/lib/contentful/content_type.rb

@@ -13,4 +13,4 @@ module Contentful
     property :fields, Field
     property :displayField, :string
   end
-end
+end

data/lib/contentful/dynamic_entry.rb

@@ -12,7 +12,7 @@ module Contentful
       'Float'    => :float,
       'Boolean'  => :boolean,
       'Date'     => :date,
-      'Location' => Location,
+      'Location' => Location
     }
 
     def self.create(content_type)
@@ -21,17 +21,17 @@ module Contentful
       end
 
       fields_coercions = Hash[
-        content_type.fields.map{ |field|
+        content_type.fields.map do |field|
           [field.id.to_sym, KNOWN_TYPES[field.type]]
-        }
+        end
       ]
 
       Class.new DynamicEntry do
-        content_type.fields.each{ |f|
+        content_type.fields.each do |f|
           define_method Support.snakify(f.id).to_sym do
             fields[f.id.to_sym]
           end
-        }
+        end
 
         define_singleton_method :fields_coercions do
           fields_coercions
@@ -51,4 +51,4 @@ module Contentful
       end
     end
   end
-end
+end

data/lib/contentful/entry.rb

@@ -9,4 +9,4 @@ module Contentful
     include Contentful::Resource::SystemProperties
     include Contentful::Resource::Fields
   end
-end
+end

data/lib/contentful/error.rb

@@ -11,8 +11,8 @@ module Contentful
 
     # Shortcut for creating specialized error classes
     # USAGE rescue Contentful::Error[404]
-    def self.[](no)
-      case no
+    def self.[](error_status_code)
+      case error_status_code
       when 404
         NotFound
       when 400
@@ -49,4 +49,4 @@ module Contentful
 
   # Raised when response is not parsable as a Contentful::Resource
   class UnparsableResource < Error; end
-end
+end

data/lib/contentful/field.rb

@@ -13,4 +13,4 @@ module Contentful
     property :required, :boolean
     property :localized, :boolean
   end
-end
+end

data/lib/contentful/file.rb

@@ -10,4 +10,4 @@ module Contentful
     property :details
     property :url, :string
   end
-end
+end

data/lib/contentful/link.rb

@@ -10,11 +10,11 @@ module Contentful
     # Queries contentful for the Resource the Link is refering to
     # Takes an optional query hash
     def resolve(query = {})
-      id_and_query = [(id unless link_type == "Space")].compact + [query]
+      id_and_query = [(id unless link_type == 'Space')].compact + [query]
       client.public_send(
         Contentful::Support.snakify(link_type).to_sym,
         *id_and_query
       )
     end
   end
-end
+end

data/lib/contentful/locale.rb

@@ -9,4 +9,4 @@ module Contentful
     property :code, :string
     property :name, :string
   end
-end
+end

data/lib/contentful/location.rb

@@ -9,4 +9,4 @@ module Contentful
     property :lat, :float
     property :lon, :float
   end
-end
+end

data/lib/contentful/resource.rb

@@ -12,11 +12,11 @@ module Contentful
   # by the client by default
   module Resource
     COERCIONS = {
-      string:  ->(v){ v.to_s },
-      integer: ->(v){ v.to_i },
-      float:   ->(v){ v.to_f },
-      boolean: ->(v){ !!v },
-      date:    ->(v){ DateTime.parse(v) },
+      string:  ->(v) { v.to_s },
+      integer: ->(v) { v.to_i },
+      float:   ->(v) { v.to_f },
+      boolean: ->(v) { !!v },
+      date:    ->(v) { DateTime.parse(v) }
     }
 
     attr_reader :properties, :request, :client
@@ -30,7 +30,7 @@ module Contentful
     end
 
     def inspect(info = nil)
-      properties_info = properties.empty? ? "" : " @properties=#{properties.inspect}"
+      properties_info = properties.empty? ? '' : " @properties=#{properties.inspect}"
       "#<#{self.class}:#{properties_info}#{info}>"
     end
 
@@ -59,18 +59,17 @@ module Contentful
       end
     end
 
-
     private
 
     def extract_from_object(object, namespace, keys = nil)
       if object
         keys ||= object.keys
-        keys.each.with_object({}){ |name, res|
+        keys.each.with_object({}) do |name, res|
           res[name.to_sym] = coerce_value_or_array(
             object.is_a?(::Array) ? object : object[name.to_s],
-            self.class.public_send(:"#{namespace}_coercions")[name.to_sym],
+            self.class.public_send(:"#{namespace}_coercions")[name.to_sym]
           )
-        }
+        end
       else
         {}
       end
@@ -78,7 +77,7 @@ module Contentful
 
     def coerce_value_or_array(value, what = nil)
       if value.is_a? ::Array
-        value.map{ |v| coerce_or_create_class(v, what) }
+        value.map { |v| coerce_or_create_class(v, what) }
       else
         coerce_or_create_class(value, what)
       end

data/lib/contentful/resource_builder.rb

@@ -58,7 +58,7 @@ module Contentful
     # - replace links in main resource with included resources
     # - return main resource
     def create_all_resources!
-      create_included_resources! response.object["includes"]
+      create_included_resources! response.object['includes']
       res = create_resource(response.object)
 
       unless @included_resources.empty?
@@ -73,7 +73,7 @@ module Contentful
     def create_resource(object)
       res = detect_resource_class(object).new(object, response.request, client)
       replace_children res, object
-      replace_children_array(res, :items) if res.array?
+      replace_child_array res.items if res.array?
 
       res
     end
@@ -123,74 +123,98 @@ module Contentful
     private
 
     def detect_child_objects(object)
-      if object.is_a?(Hash)
-        object.select{ |k,v| v.is_a?(Hash) && v.has_key?("sys") }
+      if object.is_a? Hash
+        object.select { |_, v| v.is_a?(Hash) && v.key?('sys') }
+      else
+        {}
+      end
+    end
+
+    def detect_child_arrays(object)
+      if object.is_a? Hash
+        object.select do |_, v|
+          v.is_a?(::Array) &&
+          v.first &&
+          v.first.is_a?(Hash) &&
+          v.first.key?('sys')
+        end
       else
         {}
       end
     end
 
     def replace_children(res, object)
-      object.each{ |name, potential_objects|
-        detect_child_objects(potential_objects).each{ |child_name, child_object|
+      object.each do |name, potential_objects|
+        detect_child_objects(potential_objects).each do |child_name, child_object|
           res.public_send(name)[child_name.to_sym] = create_resource(child_object)
-        }
-      }
+        end
+        next if name == 'includes'
+        detect_child_arrays(potential_objects).each do |child_name, child_array|
+          replace_child_array res.public_send(name)[child_name.to_sym]
+        end
+      end
     end
 
-    def replace_children_array(res, array_field)
-      items = res.public_send(array_field)
-      items.map!{ |resource_object| create_resource(resource_object) }
+    def replace_child_array(child_array)
+      child_array.map! { |resource_object| create_resource(resource_object) }
     end
 
     def create_included_resources!(included_objects)
       if included_objects
-        included_objects.each{ |type, objects|
+        included_objects.each do |type, objects|
           @included_resources[type] = Hash[
-            objects.map{ |object|
+            objects.map do |object|
               res = create_resource(object)
               [res.id, res]
-            }
+            end
           ]
-        }
+        end
       end
     end
 
     def replace_links_with_included_resources(res)
-      [:properties, :sys, :fields].each{ |_what|
-        if what = res.public_send(_what)
-          what.each{ |name, child_res|
-            replace_link_or_check_recursively child_res, what, name, 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
-      }
+      end
       if res.array?
-        res.each.with_index{ |child_res, index|
-          replace_link_or_check_recursively child_res, res.items, index, child_res
-        }
+        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
+        end
       end
     end
 
-    def replace_link_or_check_recursively(res, what, name, resource_to_replace)
-      if res.is_a? Link
-        maybe_replace_link(res, what, name)
-      elsif res.is_a?(Resource) && res.sys
-        replace_links_with_included_resources(resource_to_replace)
+    def replace_link_or_check_recursively(property_value, property_container, property_name)
+      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)
       end
     end
 
-    def replace_links_in_included_resources_with_included_resources
-      @included_resources.each{ |_, for_type|
-        for_type.each{ |_, res|
-          replace_links_with_included_resources(res)
-        }
-      }
+    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]
+      end
     end
 
-    def maybe_replace_link(resource, parent, index)
-      if  @included_resources[resource.link_type] &&
-          @included_resources[resource.link_type].has_key?(resource.id)
-        parent[index] = @included_resources[resource.link_type][resource.id]
+    def replace_links_in_included_resources_with_included_resources
+      @included_resources.each do |_, for_type|
+        for_type.each do |_, res|
+          replace_links_with_included_resources(res)
+        end
       end
     end
   end