contentful-management 0.2.1 → 0.3.0

data/lib/contentful/management/error.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Contentful
   module Management
     # All errors raised by the contentful gem are either instances of Contentful::Error
@@ -25,6 +24,8 @@ module Contentful
             Unauthorized
           when 500
             ServerError
+          when 503
+            ServiceUnavailable
           else
             Error
         end
@@ -51,6 +52,10 @@ module Contentful
     class ServerError < Error
     end
 
+    # 503
+    class ServiceUnavailable < Error
+    end
+
     # Raised when response is no valid json
     class UnparsableJson < Error
     end

data/lib/contentful/management/field.rb

@@ -1,6 +1,5 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
-
+require_relative 'validation'
 module Contentful
   module Management
     # A ContentType's field schema
@@ -14,21 +13,77 @@ module Contentful
       property :items, Field
       property :required, :boolean
       property :localized, :boolean
+      property :validations, Validation
 
+      # Takes a field object of content type
+      # Merges existing properties, items and validations of field with new one
       def deep_merge!(field)
-        properties.merge!(field.properties.select { |name, _type| name != :items })
-        items.properties.merge!(field.items.properties) if items.respond_to?(:properties) && field.items.respond_to?(:properties)
+        merge_properties(field.properties)
+        merge_items(field.items)
+        merge_validations(field.validations)
       end
 
+      # Extract values of field to hash
       def properties_to_hash
         properties.each_with_object({}) do |(key, value), results|
-          if key == :items
-            results[key] = value.properties_to_hash if type == 'Array' && value.is_a?(Field)
+          results[key] = parse_value(key, value)
+        end
+      end
+
+      # Return parsed value of field object
+      def parse_value(key, value)
+        case key
+          when :items
+            value.properties_to_hash if type == 'Array' && type.is_a?(Field)
+          when :validations
+            validations_to_hash(value) if value.is_a?(::Array)
           else
-            results[key] = value if !value.nil? && (value.respond_to?(:empty?) && !value.empty? || !value.respond_to?(:empty?) && value)
-          end
+            value if self.class.value_exists?(value)
+        end
+      end
+
+      def self.value_exists?(value)
+        value.respond_to?(:empty?) && !value.empty? || !value.respond_to?(:empty?) && value
+      end
+
+      private
+
+      # Update properties of field object
+      def merge_properties(new_properties)
+        properties.merge!(new_properties.select { |name, _type| name != :items && name != :validations })
+      end
+
+      # Update items of field object
+      def merge_items(new_items)
+        items.properties.merge!(new_items.properties) if items.respond_to?(:properties) && new_items.respond_to?(:properties)
+      end
+
+      # Takes an array with new validations
+      # Returns merged existing and new validations
+      def merge_validations(new_validations)
+        if new_validations
+          validations_by_type = validations_by_type(validations)
+          new_validations_by_type = validations_by_type(new_validations)
+          validations_by_type.delete_if { |type, _v| new_validations_by_type[type] }
+          self.validations = validations_by_type.values + new_validations_by_type.values
         end
       end
+
+      def validations_by_type(validations)
+        validations.is_a?(::Array) ? index_by_type(validations) : {}
+      end
+
+      # Build hash with validations
+      def index_by_type(validations)
+        validations.each_with_object({}) { |validation, results| results[validation.type] = validation }
+      end
+
+      def validations_to_hash(validations)
+        validations.each_with_object([]) do |validation, results|
+          results << validation.properties_to_hash
+        end
+      end
+
     end
   end
 end

data/lib/contentful/management/file.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 
 module Contentful

data/lib/contentful/management/http_client.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Contentful
   module Management
     module HTTPClient

data/lib/contentful/management/link.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 
 module Contentful

data/lib/contentful/management/locale.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 
 module Contentful
@@ -44,7 +43,11 @@ module Contentful
       #   :publish
       # Returns a Contentful::Management::Locale.
       def self.create(space_id, attributes)
-        request = Request.new("/#{ space_id }/locales", 'name' => attributes.fetch(:name), 'code' => attributes.fetch(:code))
+        request = Request.new(
+            "/#{ space_id }/locales",
+            'name' => attributes.fetch(:name),
+            'code' => attributes.fetch(:code)
+        )
         response = request.post
         result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
         result.run
@@ -54,7 +57,12 @@ module Contentful
       # Takes a hash with attributes.
       # Returns a Contentful::Management::Locale.
       def update(attributes)
-        request = Request.new("/#{ space.id }/locales/#{ id }", {'name' => attributes.fetch(:name)}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/locales/#{ id }",
+            {'name' => attributes.fetch(:name)},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
         refresh_data(result.run)

data/lib/contentful/management/location.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 
 module Contentful

data/lib/contentful/management/request.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Contentful
   module Management
     # This object represents a request that is to be made. It gets initialized by the client
@@ -11,9 +10,9 @@ module Contentful
         @header = header
         @initial_id = id
         @client = Contentful::Management::Client.shared_instance
-        @client.version = header[:version] if  header[:version]
-        @client.organization_id = header[:organization_id] if  header[:organization_id]
-        @client.content_type_id = header[:content_type_id] if  header[:content_type_id]
+        @client.version = header[:version]
+        @client.organization_id = header[:organization_id]
+        @client.content_type_id = header[:content_type_id]
         @client.zero_length = query.empty?
         @endpoint = endpoint
         @absolute = true if @endpoint.start_with?('http')
@@ -71,9 +70,8 @@ module Contentful
         Hash[
             query.map do |key, value|
               [
-                key.to_sym,
-                value
-                # value.is_a?(::Array) ? value.join(',') : value
+                  key.to_sym,
+                  value
               ]
             end
         ]

data/lib/contentful/management/resource.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource/system_properties'
 require_relative 'resource/refresher'
 require 'date'
@@ -22,7 +21,7 @@ module Contentful
         date: ->(value) { !value.nil? ? DateTime.parse(value) : nil }
       }
 
-      attr_reader :properties, :request, :client, :default_locale
+      attr_reader :properties, :request, :client, :default_locale, :raw_object
 
       def initialize(object = nil, request = nil, client = nil, nested_locale_fields = false, default_locale = Contentful::Management::Client::DEFAULT_CONFIGURATION[:default_locale])
         self.class.update_coercions!
@@ -32,6 +31,7 @@ module Contentful
         @properties = extract_from_object object, :property, self.class.property_coercions.keys
         @request = request
         @client = client
+        @raw_object = object
       end
 
       def inspect(info = nil)
@@ -82,7 +82,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 { |row| coerce_or_create_class(row, what) }
         else
           coerce_or_create_class(value, what)
         end

data/lib/contentful/management/resource/array_like.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Contentful
   module Management
     module Resource

data/lib/contentful/management/resource/fields.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative '../file'
 
 module Contentful
@@ -40,7 +39,7 @@ module Contentful
             end
             base.send :define_method, "#{ accessor_name }_with_locales=" do |values|
               values.each do |locale, value|
-                @fields[locale] = {} if @fields[locale].nil?
+                @fields[locale] = {} unless @fields[locale]
                 @fields[locale][name.to_sym] = value
               end
             end

data/lib/contentful/management/resource/refresher.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Contentful
   module Management
     module Resource
@@ -7,8 +6,9 @@ module Contentful
         # Reload an object
         # Updates the current version of the object to the version on the system
         def reload
-          resource = self.is_a?(Space) ? self.class.find(id) : self.class.find(space.id, id)
-          refresh_data(resource) if resource.is_a? self.class
+          self_class = self.class
+          resource = self.is_a?(Space) ? self_class.find(id) : self_class.find(space.id, id)
+          refresh_data(resource) if resource.is_a? self_class
         end
 
         def refresh_data(resource)

data/lib/contentful/management/resource/system_properties.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 module Contentful
   module Management
     module Resource

data/lib/contentful/management/resource_builder.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'error'
 require_relative 'resource'
 require_relative 'entry'
@@ -16,13 +15,13 @@ module Contentful
     # See example/resource_mapping.rb for avanced usage
     class ResourceBuilder
       DEFAULT_RESOURCE_MAPPING = {
-        'Space' => Contentful::Management::Space,
-        'ContentType' => Contentful::Management::ContentType,
-        'Entry' => :find_entry_class,
-        'Asset' => Contentful::Management::Asset,
-        'Array' => :array_or_sync_page,
-        'Link' => Contentful::Management::Link,
-        'WebhookDefinition' => Contentful::Management::Webhook
+          'Space' => Contentful::Management::Space,
+          'ContentType' => Contentful::Management::ContentType,
+          'Entry' => :find_entry_class,
+          'Asset' => Contentful::Management::Asset,
+          'Array' => :array_or_sync_page,
+          'Link' => Contentful::Management::Link,
+          'WebhookDefinition' => Contentful::Management::Webhook
       }
       DEFAULT_ENTRY_MAPPING = {}
 
@@ -32,7 +31,7 @@ module Contentful
         @response = response
         @client = Contentful::Management::Client.shared_instance
         @included_resources = {}
-        @known_resources = Hash.new { |h, k| h[k] = {} }
+        @known_resources = Hash.new { |hash, key| hash[key] = {} }
         @nested_locales = true
         @default_locale = (client.configuration || Contentful::Client::DEFAULT_CONFIGURATION)[:default_locale]
         @resource_mapping = default_resource_mapping.merge(resource_mapping)
@@ -42,19 +41,10 @@ module Contentful
       # Starts the parsing process.
       # Either returns an Error, or the parsed Resource
       def run
-        case response.status
-          when :contentful_error
-            Error[response.raw.status].new(response)
-          when :unparsable_json
-            UnparsableJson.new(response)
-          when :not_contentful
-            Error.new(response)
-          else
-            begin
-              create_all_resources!
-            rescue UnparsableResource => error
-              error
-            end
+        if response.status == :ok
+          create_all_resources!
+        else
+          response.object
         end
       end
 
@@ -75,6 +65,8 @@ module Contentful
         end
 
         @resource
+      rescue UnparsableResource => error
+        error
       end
 
       # Creates a single resource from the response object
@@ -109,10 +101,7 @@ module Contentful
 
       # Returns the id of the related ContentType, if there is one
       def content_type_id_for_entry(object)
-        object['sys'] &&
-            object['sys']['contentType'] &&
-            object['sys']['contentType']['sys'] &&
-            object['sys']['contentType']['sys']['id']
+        object['sys']['contentType']['sys']['id']
       end
 
       # Detects if a resource is an Contentful::Array or a SyncPage
@@ -159,7 +148,7 @@ module Contentful
 
       def detect_child_objects(object)
         if object.is_a? Hash
-          object.select { |_, value| value.is_a?(Hash) && value.key?('sys') }
+          object.select { |_key, value| value.is_a?(Hash) && value.key?('sys') }
         else
           {}
         end

data/lib/contentful/management/response.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'error'
 require 'multi_json'
 
@@ -29,60 +28,65 @@ module Contentful
         @request = request
         @status = :ok
 
-        if service_unavailable_response?
-          @status = :service_unavailable
-          @error_message = 'Service Unavailable, contenful.com API seems to be down'
+        if valid_http_response?
+          parse_json!
         elsif no_content_response?
           @status = :no_content
-          @object = true
-        elsif parse_json!
-          parse_contentful_error!
+        elsif no_resource_or_bad_request?
+          parse_contentful_error
+        else
+          parse_http_error
         end
       end
 
       private
 
-      def service_unavailable_response?
-        @raw.status == 503
+      def error_object?
+        object['sys']['type'] == 'Error'
+      end
+
+      def parse_contentful_error
+        @object = load_json
+        @error_message = object['message'] if error_object?
+        parse_http_error
+      end
+
+      def valid_http_response?
+        [200, 201].include?(raw.status)
+      end
+
+      def parse_http_error
+        @status = :error
+        @object = Error[raw.status].new(self)
+      end
+
+      def no_resource_or_bad_request?
+        [400, 404].include?(raw.status)
       end
 
       def no_content_response?
-        @raw.to_s == '' && @raw.status == 204
+        raw.to_s == '' && raw.status == 204
       end
 
       def parse_json!
-        body =  unzip_response(raw)
-        @object = MultiJson.load(body)
-        true
+        @object = load_json
       rescue MultiJson::LoadError => error
-        @status = :unparsable_json
         @error_message = error.message
-        @object = error
-        false
+        UnparsableJson.new(self)
       end
 
-      def parse_contentful_error!
-        if @object && @object['sys']
-          if @object['sys']['type'] == 'Error'
-            @status = :contentful_error
-            @error_message = object['message']
-            true
-          else
-            false
-          end
-        else
-          @status = :not_contentful
-          @error_message = 'No contentful system properties found in object'
-        end
+      def load_json
+        MultiJson.load(unzip_response(raw))
       end
 
       def unzip_response(response)
-        if response.headers['Content-Encoding'].eql?('gzip') then
-          sio = StringIO.new(response.to_s)
+        parsed_response = response.to_s
+        if response.headers['Content-Encoding'].eql?('gzip')
+          sio = StringIO.new(parsed_response)
           gz = Zlib::GzipReader.new(sio)
           gz.read
         else
-          response.to_s
+          parsed_response
         end
       end
     end