contentful 2.1.3 → 2.2.0

data/doc/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 17 09:42:18 2017 by
+  Generated on Tue Oct 24 14:05:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/lib/contentful/asset.rb

@@ -73,10 +73,10 @@ module Contentful
       is_localized = file_json.keys.none? { |f| %w(fileName contentType details url).include? f }
       if is_localized
         locales.each do |locale|
-          @fields[locale][:file] = ::Contentful::File.new(file_json[locale.to_s] || {})
+          @fields[locale][:file] = ::Contentful::File.new(file_json[locale.to_s] || {}, @configuration)
         end
       else
-        @fields[internal_resource_locale][:file] = ::Contentful::File.new(file_json)
+        @fields[internal_resource_locale][:file] = ::Contentful::File.new(file_json, @configuration)
       end
     end
 

data/lib/contentful/base_resource.rb

@@ -9,8 +9,8 @@ module Contentful
       @raw = item
       @default_locale = configuration[:default_locale]
       @depth = depth
-      @sys = hydrate_sys
       @configuration = configuration
+      @sys = hydrate_sys
 
       define_sys_methods!
     end
@@ -69,7 +69,7 @@ module Contentful
         elsif %w(createdAt updatedAt deletedAt).include?(k)
           v = DateTime.parse(v)
         end
-        result[Support.snakify(k).to_sym] = v
+        result[Support.snakify(k, @configuration[:use_camel_case]).to_sym] = v
       end
       result
     end
@@ -86,7 +86,7 @@ module Contentful
 
     def build_link(item)
       require_relative 'link'
-      ::Contentful::Link.new(item)
+      ::Contentful::Link.new(item, @configuration)
     end
   end
 end

data/lib/contentful/client.rb

@@ -36,13 +36,12 @@ module Contentful
       max_rate_limit_retries: 1,
       max_rate_limit_wait: 60,
       max_include_resolution_depth: 20,
+      use_camel_case: false,
       application_name: nil,
       application_version: nil,
       integration_name: nil,
       integration_version: nil
     }
-    # Rate Limit Reset Header Key
-    RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'
 
     attr_reader :configuration, :logger, :proxy
 
@@ -70,6 +69,7 @@ module Contentful
     # @option given_configuration [Number] :max_rate_limit_retries
     # @option given_configuration [Number] :max_rate_limit_wait
     # @option given_configuration [Number] :max_include_resolution_depth
+    # @option given_configuration [Boolean] :use_camel_case
     # @option given_configuration [Boolean] :gzip_encoded
     # @option given_configuration [Boolean] :raw_mode
     # @option given_configuration [false, ::Logger] :logger
@@ -294,7 +294,7 @@ module Contentful
         raise error if configuration[:raise_errors]
         return error
       rescue Contentful::RateLimitExceeded => rate_limit_error
-        reset_time = rate_limit_error.response.raw[RATE_LIMIT_RESET_HEADER_KEY].to_i
+        reset_time = rate_limit_error.reset_time.to_i
         if should_retry(retries_left, reset_time, configuration[:max_rate_limit_wait])
           retries_left -= 1
           logger.info(retry_message(retries_left, reset_time)) if logger

data/lib/contentful/coercions.rb

@@ -75,26 +75,7 @@ module Contentful
   class ObjectCoercion < BaseCoercion
     # Coerces value to hash, symbolizing each key
     def coerce
-      symbolize_recursive(value)
-    end
-
-    private
-
-    def symbolize_recursive(hash)
-      {}.tap do |h|
-        hash.each { |key, value| h[key.to_sym] = map_value(value) }
-      end
-    end
-
-    def map_value(thing)
-      case thing
-      when Hash
-        symbolize_recursive(thing)
-      when Array
-        thing.map { |v| map_value(v) }
-      else
-        thing
-      end
+      JSON.parse(JSON.dump(value), symbolize_names: true)
     end
   end
 

data/lib/contentful/content_type.rb

@@ -22,6 +22,8 @@ module Contentful
       fields.detect { |f| Support.snakify(f.id) == Support.snakify(field_id) }
     end
 
+    alias displayField display_field
+
     protected
 
     def repr_name

data/lib/contentful/entry.rb

@@ -16,7 +16,8 @@ module Contentful
       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)
+      content_type_key = Support.snakify('contentType', @configuration[:use_camel_case])
+      content_type = ContentTypeCache.cache_get(sys[:space].id, sys[content_type_key.to_sym].id)
 
       unless content_type.nil?
         content_type_field = content_type.field_for(field_id)
@@ -76,7 +77,8 @@ module Contentful
     protected
 
     def repr_name
-      "#{super}[#{sys[:content_type].id}]"
+      content_type_key = Support.snakify('contentType', @configuration[:use_camel_case]).to_sym
+      "#{super}[#{sys[content_type_key].id}]"
     end
   end
 end

data/lib/contentful/error.rb

@@ -6,56 +6,195 @@ module Contentful
 
     def initialize(response)
       @response = response
-      super @response.error_message
+      super best_available_message
     end
 
     # Shortcut for creating specialized error classes
     # USAGE rescue Contentful::Error[404]
     def self.[](error_status_code)
-      case error_status_code
-      when 404
-        NotFound
-      when 400
-        BadRequest
-      when 403
-        AccessDenied
-      when 401
-        Unauthorized
-      when 429
-        RateLimitExceeded
-      when 500
-        ServerError
-      when 503
-        ServiceUnavailable
-      else
-        Error
+      errors = {
+        400 => BadRequest,
+        401 => Unauthorized,
+        403 => AccessDenied,
+        404 => NotFound,
+        429 => RateLimitExceeded,
+        500 => ServerError,
+        502 => BadGateway,
+        503 => ServiceUnavailable
+      }
+
+      errors.key?(error_status_code) ? errors[error_status_code] : Error
+    end
+
+    protected
+
+    def default_error_message
+      "The following error was received: #{@response.raw.body}"
+    end
+
+    def handle_details(details)
+      details.to_s
+    end
+
+    def additional_info?
+      false
+    end
+
+    def additional_info
+      []
+    end
+
+    def best_available_message
+      error_message = [
+        "HTTP status code: #{@response.raw.status}"
+      ]
+
+      begin
+        response_json = @response.load_json
+        message = response_json.fetch('message', default_error_message)
+        details = response_json.fetch('details', nil)
+        request_id = response_json.fetch('requestId', nil)
+
+        error_message << "Message: #{message}"
+        error_message << "Details: #{handle_details(details)}" if details
+        error_message << "Request ID: #{request_id}" if request_id
+      rescue
+        error_message << "Message: #{default_error_message}"
       end
+
+      error_message << additional_info if additional_info?
+
+      error_message.join("\n")
     end
   end
 
-  # 404
-  class NotFound < Error; end
-
   # 400
-  class BadRequest < Error; end
+  class BadRequest < Error
+    protected
 
-  # 403
-  class AccessDenied < Error; end
+    def default_error_message
+      'The request was malformed or missing a required parameter.'
+    end
+
+    def handle_details(details)
+      return details if details.is_a?(String)
+
+      handle_detail = proc do |detail|
+        return detail if detail.is_a?(String)
+        detail.fetch('details', nil)
+      end
+
+      inner_details = details['errors'].map { |detail| handle_detail[detail] }.reject(&:nil?)
+      inner_details.join("\n\t")
+    end
+  end
 
   # 401
-  class Unauthorized < Error; end
+  class Unauthorized < Error
+    protected
+
+    def default_error_message
+      'The authorization token was invalid.'
+    end
+  end
+
+  # 403
+  class AccessDenied < Error
+    protected
+
+    def default_error_message
+      'The specified token does not have access to the requested resource.'
+    end
+
+    def handle_details(details)
+      "\n\tReasons:\n\t\t#{details['reasons'].join("\n\t\t")}"
+    end
+  end
+
+  # 404
+  class NotFound < Error
+    protected
+
+    def default_error_message
+      'The requested resource or endpoint could not be found.'
+    end
+
+    def handle_details(details)
+      message = "The requested #{details['type']} could not be found."
+
+      resource_id = details.fetch('id', nil)
+      message += " ID: #{resource_id}." if resource_id
+
+      message
+    end
+  end
 
   # 429
-  class RateLimitExceeded < Error; end
+  class RateLimitExceeded < Error
+    # Rate Limit Reset Header Key
+    RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'
+
+    def reset_time?
+      # rubocop:disable Style/DoubleNegation
+      !!reset_time
+      # rubocop:enable Style/DoubleNegation
+    end
+
+    # Time until next available request, in seconds.
+    def reset_time
+      @reset_time ||= @response.raw[RATE_LIMIT_RESET_HEADER_KEY]
+    end
+
+    protected
+
+    def additional_info?
+      reset_time?
+    end
+
+    def additional_info
+      ["Time until reset (seconds): #{reset_time}"]
+    end
+
+    def default_error_message
+      'Rate limit exceeded. Too many requests.'
+    end
+  end
 
   # 500
-  class ServerError < Error; end
+  class ServerError < Error
+    protected
+
+    def default_error_message
+      'Internal server error.'
+    end
+  end
+
+  # 502
+  class BadGateway < Error
+    protected
+
+    def default_error_message
+      'The requested space is hibernated.'
+    end
+  end
 
   # 503
-  class ServiceUnavailable < Error; end
+  class ServiceUnavailable < Error
+    protected
+
+    def default_error_message
+      'The request was malformed or missing a required parameter.'
+    end
+  end
 
   # Raised when response is no valid json
-  class UnparsableJson < Error; end
+  class UnparsableJson < Error
+    protected
+
+    def default_error_message
+      @response.error_message
+    end
+  end
 
   # Raised when response is not parsable as a Contentful::Resource
   class UnparsableResource < StandardError; end

data/lib/contentful/fields_resource.rb

@@ -65,7 +65,8 @@ module Contentful
       links = fields.keys.select { |property| known_link?(property) }
       processed_raw = raw.clone
       raw['fields'].each do |k, v|
-        processed_raw['fields'][k] = links.include?(Support.snakify(k).to_sym) ? send(Support.snakify(k)) : v
+        links_key = Support.snakify(k, @configuration[:use_camel_case])
+        processed_raw['fields'][k] = links.include?(links_key.to_sym) ? send(links_key) : v
       end
 
       processed_raw
@@ -91,8 +92,9 @@ module Contentful
         raw['fields'].each do |name, locales|
           locales.each do |loc, value|
             result[loc] ||= {}
-            result[loc][Support.snakify(name).to_sym] = coerce(
-              Support.snakify(name),
+            name = Support.snakify(name, @configuration[:use_camel_case])
+            result[loc][name.to_sym] = coerce(
+              name,
               value,
               includes
             )
@@ -100,8 +102,9 @@ module Contentful
         end
       else
         raw['fields'].each do |name, value|
-          result[locale][Support.snakify(name).to_sym] = coerce(
-            Support.snakify(name),
+          name = Support.snakify(name, @configuration[:use_camel_case])
+          result[locale][name.to_sym] = coerce(
+            name,
             value,
             includes
           )

data/lib/contentful/file.rb

@@ -1,12 +1,20 @@
 module Contentful
   # An Assets's file info
   class File
-    attr_reader :file_name, :content_type, :details, :url
-    def initialize(json)
-      @file_name = json.fetch('fileName', nil)
-      @content_type = json.fetch('contentType', nil)
-      @details = json.fetch('details', nil)
-      @url = json.fetch('url', nil)
+    def initialize(json, configuration)
+      @configuration = configuration
+
+      define_fields!(json)
+    end
+
+    private
+
+    def define_fields!(json)
+      json.each do |k, v|
+        define_singleton_method Support.snakify(k, @configuration[:use_camel_case]) do
+          v
+        end
+      end
     end
   end
 end

data/lib/contentful/response.rb

@@ -41,6 +41,11 @@ module Contentful
       end
     end
 
+    # Returns the JSON body of the response
+    def load_json
+      MultiJson.load(unzip_response(raw))
+    end
+
     private
 
     def error_object?
@@ -88,10 +93,6 @@ module Contentful
       UnparsableJson.new(self)
     end
 
-    def load_json
-      MultiJson.load(unzip_response(raw))
-    end
-
     def unzip_response(response)
       parsed_response = response.to_s
       if response.headers['Content-Encoding'].eql?('gzip')