contentful-management 0.2.1 → 0.3.0

data/lib/contentful/management/client.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'contentful/management'
 require 'contentful/management/response'
 require 'contentful/management/resource_builder'
@@ -9,30 +8,39 @@ require 'contentful/management/http_client'
 require_relative 'request'
 require 'http'
 require 'json'
+require 'logger'
 
 module Contentful
   module Management
     class Client
       extend Contentful::Management::HTTPClient
 
-      attr_reader :access_token, :configuration
+      attr_reader :access_token, :configuration, :logger
       attr_accessor :organization_id, :version, :zero_length, :content_type_id, :dynamic_entry_cache
 
       DEFAULT_CONFIGURATION = {
-        api_url: 'api.contentful.com',
-        api_version: '1',
-        secure: true,
-        default_locale: 'en-US',
-        gzip_encoded: false
+          api_url: 'api.contentful.com',
+          api_version: '1',
+          secure: true,
+          default_locale: 'en-US',
+          gzip_encoded: false,
+          logger: false,
+          log_level: Logger::INFO
       }
 
       def initialize(access_token = nil, configuration = {})
         @configuration = default_configuration.merge(configuration)
+        setup_logger
         @access_token = access_token
         @dynamic_entry_cache = {}
         Thread.current[:client] = self
       end
 
+      def setup_logger
+        @logger = configuration[:logger]
+        logger.level = configuration[:log_level] if logger
+      end
+
       def update_dynamic_entry_cache_for_spaces!(spaces)
         spaces.each do |space|
           update_dynamic_entry_cache_for_space!(space)
@@ -49,8 +57,8 @@ module Contentful
         @dynamic_entry_cache = Hash[
             content_types.map do |ct|
               [
-                ct.id.to_sym,
-                DynamicEntry.create(ct)
+                  ct.id.to_sym,
+                  DynamicEntry.create(ct)
               ]
             end
         ]
@@ -75,7 +83,9 @@ module Contentful
       def execute_request(request)
         request_url = request.url
         url = request.absolute? ? request_url : base_url + request_url
+        logger.info(request: {url: url, query: request.query ,header: request_headers}) if logger
         raw_response = yield(url)
+        logger.debug(response: raw_response) if logger
         clear_headers
         Response.new(raw_response, request)
       end

data/lib/contentful/management/content_type.rb

@@ -1,7 +1,8 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 require_relative 'field'
+require_relative 'validation'
 require_relative 'content_type_entry_methods_factory'
+require_relative 'support'
 
 module Contentful
   module Management
@@ -9,16 +10,16 @@ module Contentful
     # https://www.contentful.com/developers/documentation/content-management-api/#resources-content-types
     class ContentType
       FIELD_TYPES = [
-        SYMBOL = 'Symbol',
-        TEXT = 'Text',
-        INTEGER = 'Integer',
-        FLOAT = 'Number',
-        DATE = 'Date',
-        BOOLEAN = 'Boolean',
-        LINK = 'Link',
-        ARRAY = 'Array',
-        OBJECT = 'Object',
-        LOCATION = 'Location'
+          SYMBOL = 'Symbol',
+          TEXT = 'Text',
+          INTEGER = 'Integer',
+          FLOAT = 'Number',
+          DATE = 'Date',
+          BOOLEAN = 'Boolean',
+          LINK = 'Link',
+          ARRAY = 'Array',
+          OBJECT = 'Object',
+          LOCATION = 'Location'
       ]
 
       include Contentful::Management::Resource
@@ -33,7 +34,10 @@ module Contentful
       # Takes an id of space and an optional hash of query options
       # Returns a Contentful::Management::Array of Contentful::Management::ContentType.
       def self.all(space_id, query = {})
-        request = Request.new("/#{ space_id }/content_types", query)
+        request = Request.new(
+            "/#{ space_id }/content_types",
+            query
+        )
         response = request.get
         result = ResourceBuilder.new(response, {}, {})
         content_types = result.run
@@ -69,7 +73,12 @@ module Contentful
       # Activates a content type.
       # Returns a Contentful::Management::ContentType.
       def activate
-        request = Request.new("/#{ space.id }/content_types/#{ id }/published", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/content_types/#{ id }/published",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -88,7 +97,7 @@ module Contentful
       # Checks if a content type is active.
       # Returns true if active.
       def active?
-        !sys[:publishedAt].nil?
+        sys[:publishedAt] ? true : false
       end
 
       # Creates a content type.
@@ -96,9 +105,12 @@ module Contentful
       # Returns a Contentful::Management::ContentType.
       def self.create(space_id, attributes)
         fields = fields_to_nested_properties_hash(attributes[:fields] || [])
-        request = Request.new("/#{ space_id }/content_types/#{ attributes[:id] || ''}", name: attributes.fetch(:name),
-                                                                                        description: attributes[:description],
-                                                                                        fields: fields)
+        request = Request.new(
+            "/#{ space_id }/content_types/#{ attributes[:id]}",
+            name: attributes.fetch(:name),
+            description: attributes[:description],
+            fields: fields
+        )
         response = attributes[:id].nil? ? request.post : request.put
         result = ResourceBuilder.new(response, {}, {}).run
         client.register_dynamic_entry(result.id, DynamicEntry.create(result)) if result.is_a?(self.class)
@@ -114,7 +126,12 @@ module Contentful
         parameters.merge!(name: (attributes[:name] || name))
         parameters.merge!(description: (attributes[:description] || description))
         parameters.merge!(fields: self.class.fields_to_nested_properties_hash(attributes[:fields] || fields))
-        request = Request.new("/#{ space.id }/content_types/#{ id }", parameters, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/content_types/#{ id }",
+            parameters,
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -123,11 +140,11 @@ module Contentful
       # If a content type is a new object gets created in the Contentful, otherwise the existing entry gets updated.
       # See README for details.
       def save
-        if id.nil?
+        if id
+          update(@properties)
+        else
           new_instance = self.class.create(space.id, @properties)
           refresh_data(new_instance)
-        else
-          update(@properties)
         end
       end
 
@@ -160,13 +177,11 @@ module Contentful
 
           fields.define_singleton_method(:create) do |params|
             field = Contentful::Management::Field.new
-            field.id = params.fetch(:id)
-            field.name = params[:name] if params[:name]
-            field.type = params[:type] if params[:type]
-            field.link_type = params[:link_type] if params[:link_type]
-            field.required = params[:required] if params[:required]
-            field.localized = params[:localized] if params[:localized]
-            field.items = params[:items] if params[:items]
+            Field.property_coercions.each do |key, _value|
+              snakify_key = Support.snakify(key)
+              param = params[snakify_key.to_sym]
+              field.send("#{snakify_key}=", param) if param
+            end
             content_type.update(fields: content_type.merged_fields(field))
           end
 

data/lib/contentful/management/dynamic_entry.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 require_relative 'resource/fields'
 require_relative 'location'
@@ -7,14 +6,14 @@ module Contentful
   module Management
     class DynamicEntry < Contentful::Management::Entry
       KNOWN_TYPES = {
-        'String' => :string,
-        'Text' => :string,
-        'Symbol' => :string,
-        'Integer' => :integer,
-        'Float' => :float,
-        'Boolean' => :boolean,
-        'Date' => :date,
-        'Location' => Location
+          'String' => :string,
+          'Text' => :string,
+          'Symbol' => :string,
+          'Integer' => :integer,
+          'Float' => :float,
+          'Boolean' => :boolean,
+          'Date' => :date,
+          'Location' => Location
       }
 
       def self.create(content_type)
@@ -22,7 +21,6 @@ module Contentful
           content_type = ContentType.new(content_type)
         end
 
-        # TODO no support for an empty content type (undefined method map for Field)
         fields_coercions = Hash[
             content_type.fields.map do |field|
               [field.id.to_sym, KNOWN_TYPES[field.type]]
@@ -39,14 +37,12 @@ module Contentful
               fields_for_query[field.id.to_sym]
             end
             define_method "#{ accessor_name }=" do |value|
-              if field.localized || default_locale == locale
-                fields[field.id.to_sym] = value
-              end
+              fields[field.id.to_sym] = value if localized_or_default_locale(field, locale)
             end
             define_method "#{ accessor_name }_with_locales=" do |values|
               values.each do |locale, value|
-                if field.localized || default_locale == locale
-                  @fields[locale] = {} if @fields[locale].nil?
+                if localized_or_default_locale(field, locale)
+                  @fields[locale] = {} unless @fields[locale]
                   @fields[locale][field.id.to_sym] = value
                 end
               end
@@ -70,6 +66,10 @@ module Contentful
           end
         end
       end
+
+      def localized_or_default_locale(field, locale)
+        field.localized || default_locale == locale
+      end
     end
   end
 end

data/lib/contentful/management/entry.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require_relative 'resource'
 require_relative 'resource/entry_fields'
 require_relative 'resource/fields'
@@ -20,7 +19,10 @@ module Contentful
       # Takes an id of space and hash of parameters with optional content_type_id.
       # Returns a Contentful::Management::Array of Contentful::Management::Entry.
       def self.all(space_id, parameters = {})
-        request = Request.new("/#{ space_id }/entries", parameters)
+        request = Request.new(
+            "/#{ space_id }/entries",
+            parameters
+        )
         response = request.get
         result = ResourceBuilder.new(response, {}, {})
         result.run
@@ -40,7 +42,7 @@ module Contentful
       # Takes a content type object and hash with attributes of content type.
       # Returns a Contentful::Management::Entry.
       def self.create(content_type, attributes)
-        custom_id = attributes[:id] || ''
+        custom_id = attributes[:id]
         locale = attributes[:locale]
         fields_for_create = if attributes[:fields] # create from initialized dynamic entry via save
                               tmp_entry = new
@@ -50,8 +52,13 @@ module Contentful
                               fields_with_locale content_type, attributes
                             end
 
-        request = Request.new("/#{ content_type.sys[:space].id  }/entries/#{ custom_id }", {fields: fields_for_create}, nil, content_type_id: content_type.id)
-        response = custom_id.empty? ? request.post : request.put
+        request = Request.new(
+            "/#{ content_type.sys[:space].id  }/entries/#{ custom_id }",
+            {fields: fields_for_create},
+            nil,
+            content_type_id: content_type.id
+        )
+        response = custom_id.nil? ? request.post : request.put
         result = ResourceBuilder.new(response, {}, {})
         client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
         entry = result.run
@@ -65,7 +72,12 @@ module Contentful
       def update(attributes)
         fields_for_update = Contentful::Management::Support.deep_hash_merge(fields_for_query, fields_from_attributes(attributes))
 
-        request = Request.new("/#{ space.id }/entries/#{ id }", {fields: fields_for_update}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/entries/#{ id }",
+            {fields: fields_for_update},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -74,18 +86,23 @@ module Contentful
       # If an entry is a new object gets created in the Contentful, otherwise the existing entry gets updated.
       # See README for details.
       def save
-        if id.nil?
+        if id
+          update({})
+        else
           new_instance = Contentful::Management::Entry.create(content_type, fields: instance_variable_get(:@fields))
           refresh_data(new_instance)
-        else
-          update({})
         end
       end
 
       # Publishes an entry.
       # Returns a Contentful::Management::Entry.
       def publish
-        request = Request.new("/#{ space.id }/entries/#{ id }/published", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/entries/#{ id }/published",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -94,7 +111,12 @@ module Contentful
       # Unpublishes an entry.
       # Returns a Contentful::Management::Entry.
       def unpublish
-        request = Request.new("/#{ space.id }/entries/#{ id }/published", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/entries/#{ id }/published",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.delete
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -103,7 +125,12 @@ module Contentful
       # Archives an entry.
       # Returns a Contentful::Management::Entry.
       def archive
-        request = Request.new("/#{ space.id }/entries/#{ id }/archived", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/entries/#{ id }/archived",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -112,7 +139,12 @@ module Contentful
       # Unarchives an entry.
       # Returns a Contentful::Management::Entry.
       def unarchive
-        request = Request.new("/#{ space.id }/entries/#{ id }/archived", {}, id = nil, version: sys[:version])
+        request = Request.new(
+            "/#{ space.id }/entries/#{ id }/archived",
+            {},
+            id = nil,
+            version: sys[:version]
+        )
         response = request.delete
         result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
@@ -134,13 +166,13 @@ module Contentful
       # Checks if an entry is published.
       # Returns true if published.
       def published?
-        !sys[:publishedAt].nil?
+        sys[:publishedAt] ? true : false
       end
 
       # Checks if an entry is archived.
       # Returns true if published.
       def archived?
-        !sys[:archivedAt].nil?
+        sys[:archivedAt] ? true : false
       end
 
       # Returns the currently supported local.
@@ -155,7 +187,7 @@ module Contentful
         fields_names = raw_fields.first[1].keys
         fields_names.each_with_object({}) do |field_name, results|
           results[field_name] = raw_fields.each_with_object({}) do |(locale, fields), field_results|
-            field_results[locale] = parse_update_attribute(fields[field_name]) unless fields[field_name].nil?
+            field_results[locale] = parse_update_attribute(fields[field_name]) if fields[field_name]
           end
         end
       end
@@ -182,35 +214,36 @@ module Contentful
       end
 
       def parse_update_attribute(attribute)
-        if attribute.is_a? Asset
-          {sys: {type: 'Link', linkType: 'Asset', id: attribute.id}}
-        elsif attribute.is_a? Entry
-          {sys: {type: 'Link', linkType: 'Entry', id: attribute.id}}
-        elsif attribute.is_a? Location
-          {lat: attribute.properties[:lat], lon: attribute.properties[:lon]}
-        elsif attribute.is_a? ::Array
-          self.class.parse_fields_array(attribute)
-        else
-          attribute
+        case attribute
+          when Asset
+            self.class.hash_with_link_object('Asset', attribute)
+          when Entry
+            self.class.hash_with_link_object('Entry', attribute)
+          when Location
+            {lat: attribute.properties[:lat], lon: attribute.properties[:lon]}
+          when ::Array
+            self.class.parse_fields_array(attribute)
+          else
+            attribute
         end
       end
 
+      def self.hash_with_link_object(type, attribute)
+        {sys: {type: 'Link', linkType: type, id: attribute.id}}
+      end
+
       def self.parse_fields_array(attributes)
-        type = attributes.first.class.to_s
-        if type == 'String'
-          attributes
-        else
-          parse_objects_array(attributes, type)
-        end
+        type = attributes.first.class
+        type == String ? attributes : parse_objects_array(attributes)
       end
 
-      def self.parse_objects_array(attributes, type)
+      def self.parse_objects_array(attributes)
         attributes.each_with_object([]) do |attr, arr|
-          arr << case type
-                   when /Entry/ then
-                     {sys: {type: 'Link', linkType: 'Entry', id: attr.id}}
-                   when /Asset/ then
-                     {sys: {type: 'Link', linkType: 'Asset', id: attr.id}}
+          arr << case attr
+                   when Entry then
+                     hash_with_link_object('Entry', attr)
+                   when Asset then
+                     hash_with_link_object('Asset', attr)
                  end
         end
       end
@@ -218,11 +251,11 @@ module Contentful
       def self.fields_with_locale(content_type, attributes)
         locale = attributes[:locale] || content_type.sys[:space].default_locale
         fields = content_type.properties[:fields]
-        field_names = fields.map { |f| f.id.to_sym }
+        field_names = fields.map { |field| field.id.to_sym }
         attributes.keep_if { |key| field_names.include?(key) }
 
         attributes.each do |id, value|
-          field = fields.select { |f| f.id.to_sym == id.to_sym }.first
+          field = fields.select { |field| field.id.to_sym == id.to_sym }.first
           attributes[id] = {locale => parse_attribute_with_field(value, field)}
         end
       end