contentful-management 0.8.0 → 0.9.0

data/lib/contentful/management/error.rb

@@ -8,9 +8,9 @@ module Contentful
       def initialize(response)
         @response = response
         @error = {
-            url: response.request.endpoint,
-            message: response.error_message,
-            details: response.raw.body.instance_variable_get(:@contents)
+          url: response.request.endpoint,
+          message: response.error_message,
+          details: response.raw.body.instance_variable_get(:@contents)
         }
         super @response.error_message
       end
@@ -19,26 +19,26 @@ module Contentful
       # USAGE rescue Contentful::Management::Error[404]
       def self.[](error_status_code)
         case error_status_code
-          when 404
-            NotFound
-          when 400
-            BadRequest
-          when 403
-            AccessDenied
-          when 409
-            Conflict
-          when 401
-            Unauthorized
-          when 422
-            UnprocessableEntity
-          when 429
-            RateLimitExceeded
-          when 500
-            ServerError
-          when 503
-            ServiceUnavailable
-          else
-            Error
+        when 404
+          NotFound
+        when 400
+          BadRequest
+        when 403
+          AccessDenied
+        when 409
+          Conflict
+        when 401
+          Unauthorized
+        when 422
+          UnprocessableEntity
+        when 429
+          RateLimitExceeded
+        when 500
+          ServerError
+        when 503
+          ServiceUnavailable
+        else
+          Error
         end
       end
     end

data/lib/contentful/management/field.rb

@@ -18,6 +18,7 @@ module Contentful
 
       # Takes a field object of content type
       # Merges existing properties, items and validations of field with new one
+      # @private
       def deep_merge!(field)
         merge_properties(field.properties)
         merge_items(field.items)
@@ -25,6 +26,7 @@ module Contentful
       end
 
       # Extract values of field to hash
+      # @private
       def properties_to_hash
         properties.each_with_object({}) do |(key, value), results|
           results[key] = parse_value(key, value)
@@ -32,17 +34,19 @@ module Contentful
       end
 
       # Return parsed value of field object
+      # @private
       def parse_value(key, value)
         case key
-          when :items
-            value.properties_to_hash if type == 'Array' && value.is_a?(Field)
-          when :validations
-            validations_to_hash(value) if value.is_a?(::Array)
-          else
-            value if self.class.value_exists?(value)
+        when :items
+          value.properties_to_hash if type == 'Array' && value.is_a?(Field)
+        when :validations
+          validations_to_hash(value) if value.is_a?(::Array)
+        else
+          value if self.class.value_exists?(value)
         end
       end
 
+      # @private
       def self.value_exists?(value)
         value.respond_to?(:empty?) && !value.empty? || !value.respond_to?(:empty?) && value
       end
@@ -62,12 +66,12 @@ module Contentful
       # 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
+        return unless 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
 
       def validations_by_type(validations)
@@ -84,7 +88,6 @@ module Contentful
           results << validation.properties_to_hash
         end
       end
-
     end
   end
 end

data/lib/contentful/management/http_client.rb

@@ -1,18 +1,47 @@
 module Contentful
   module Management
+    # Thin HTTP Client with Restful Operations
     module HTTPClient
+      # Get Request
+      #
+      # @param [String] url
+      # @param [Hash] query
+      # @param [Hash] headers
+      #
+      # @return [HTTP::Response]
       def get_http(url, query, headers = {})
         HTTP[headers].get(url, params: query)
       end
 
+      # Post Request
+      #
+      # @param [String] url
+      # @param [Hash] params
+      # @param [Hash] headers
+      #
+      # @return [HTTP::Response]
       def post_http(url, params, headers = {})
         HTTP[headers].post(url, json: params)
       end
 
+      # Delete Request
+      #
+      # @param [String] url
+      # @param [Hash] params
+      # @param [Hash] headers
+      #
+      # @return [HTTP::Response]
       def delete_http(url, params, headers = {})
         HTTP[headers].delete(url, params: params)
       end
 
+      # Put Request
+      #
+      # @param [String] url
+      # @param [Hash] params
+      # @param [Hash] headers
+      #
+      # @return [HTTP::Response]
       def put_http(url, params, headers = {})
         HTTP[headers].put(url, json: params)
       end

data/lib/contentful/management/link.rb

@@ -9,12 +9,12 @@ module Contentful
       include Contentful::Management::Resource::SystemProperties
 
       # Queries contentful for the Resource the Link is referring to
-      # Takes an optional query hash
+      # @param [Hash] query
       def resolve(query = {})
         id_and_query = [(id unless link_type == 'Space')].compact + [query]
         client.public_send(
-            Contentful::Management::Support.snakify(link_type).to_sym,
-            *id_and_query
+          Contentful::Management::Support.snakify(link_type).to_sym,
+          *id_and_query
         )
       end
     end

data/lib/contentful/management/locale.rb

@@ -16,58 +16,87 @@ module Contentful
       property :default, :boolean
 
       # Gets a collection of locales.
-      # Takes an id of a space.
-      # Returns a Contentful::Management::Array of Contentful::Management::Locale.
+      #
+      # @param [String] space_id
+      # @param [Hash] _parameters Search Parameters
+      # @option _parameters [String] :name
+      # @option _parameters [String] :code
+      #
+      # @return [Contentful::Management::Array<Contentful::Management::Locale>]
       def self.all(space_id = nil, _parameters = {})
-        request = Request.new("/#{ space_id }/locales")
+        request = Request.new("/#{space_id}/locales")
         response = request.get
-        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
+        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         result.run
       end
 
       # Gets a specific locale.
-      # Takes an id of a space and locale id.
-      # Returns a Contentful::Management::Locale.
+      #
+      # @param [String] space_id
+      # @param [String] locale_id
+      #
+      # @return [Contentful::Management::Locale]
       def self.find(space_id, locale_id)
-        request = Request.new("/#{ space_id }/locales/#{ locale_id }")
+        request = Request.new("/#{space_id}/locales/#{locale_id}")
         response = request.get
-        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
+        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         result.run
       end
 
       # Creates a locale.
-      # Takes a space id and hash with attributes:
-      #   :name
-      #   :code
-      #   :contentManagementApi
-      #   :contentDeliveryApi
-      #   :publish
-      # Returns a Contentful::Management::Locale.
+      #
+      # @param [String] space_id
+      # @param [Hash] attributes
+      # @option attributes [String] :name
+      # @option attributes [String] :code
+      #
+      # @return [Contentful::Management::Locale]
       def self.create(space_id, attributes)
         request = Request.new(
-            "/#{ space_id }/locales",
-            'name' => attributes.fetch(:name),
-            'code' => attributes.fetch(:code)
+          "/#{space_id}/locales",
+          'name' => attributes.fetch(:name),
+          'code' => attributes.fetch(:code)
         )
         response = request.post
-        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
+        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         result.run
       end
 
       # Updates a locale.
-      # Takes a hash with attributes.
-      # Returns a Contentful::Management::Locale.
+      #
+      # @param [Hash] attributes
+      # @option attributes [String] :name
+      # @option attributes [String] :code
+      #
+      # @return [Contentful::Management::Locale]
       def update(attributes)
+        parameters = {}
+        attributes.each { |k, v| parameters[k.to_s] = v }
+
         request = Request.new(
-            "/#{ space.id }/locales/#{ id }",
-            {'name' => attributes.fetch(:name)},
-            id = nil,
-            version: sys[:version]
+          "/#{space.id}/locales/#{id}",
+          parameters,
+          nil,
+          version: sys[:version]
         )
         response = request.put
-        result = ResourceBuilder.new(response, {'Locale' => Locale}, {})
+        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         refresh_data(result.run)
       end
+
+      # Deletes a locale.
+      #
+      # @return [true, Contentful::Management::Error] success
+      def destroy
+        request = Request.new("/#{space.id}/locales/#{id}")
+        response = request.delete
+        if response.status == :no_content
+          return true
+        else
+          result = ResourceBuilder.new(response, {}, {})
+          result.run
+        end
+      end
     end
   end
 end

data/lib/contentful/management/location.rb

@@ -3,7 +3,7 @@ require_relative 'resource'
 module Contentful
   module Management
     # Location Field Type
-    # You can directly query for them: https://www.contentful.com/developers/documentation/content-management-api/#search-filter-geo
+    # @see _ You can directly query for them: https://www.contentful.com/developers/documentation/content-management-api/#search-filter-geo
     class Location
       include Contentful::Management::Resource
 

data/lib/contentful/management/request.rb

@@ -15,11 +15,8 @@ module Contentful
         @client.content_type_id = header[:content_type_id]
         @client.zero_length = query.empty?
         @endpoint = endpoint
-        @absolute = true if @endpoint.start_with?('http')
 
-        @query = if query && !query.empty?
-                   normalize_query(query)
-                 end
+        @query = normalize_query(query) if query && !query.empty?
 
         if id
           @type = :single
@@ -32,7 +29,7 @@ module Contentful
 
       # Returns the final URL, relative to a contentful space
       def url
-        "#{@endpoint }#{ @type == :single ? "/#{ id }" : '' }"
+        "#{@endpoint}#{@type == :single ? "/#{id}" : ''}"
       end
 
       # Delegates the actual HTTP work to the client
@@ -50,13 +47,15 @@ module Contentful
         client.put(self)
       end
 
+      # Delegates the actual HTTP DELETE request to the client
       def delete
         client.delete(self)
       end
 
       # Returns true if endpoint is an absolute url
+      # @return [Boolean]
       def absolute?
-        !!@absolute
+        @endpoint.start_with?('http')
       end
 
       # Returns a new Request object with the same data
@@ -68,12 +67,12 @@ module Contentful
 
       def normalize_query(query)
         Hash[
-            query.map do |key, value|
-              [
-                  key.to_sym,
-                  value
-              ]
-            end
+          query.map do |key, value|
+            [
+              key.to_sym,
+              value
+            ]
+          end
         ]
       end
     end

data/lib/contentful/management/resource.rb

@@ -12,7 +12,12 @@ module Contentful
     #
     # Take a look at examples/resource_mapping.rb on how to register them to be returned
     # by the client by default
+    #
+    # @see _ examples/custom_classes.rb Custom Class as Resource
+    # @see _ examples/resource_mapping.rb Mapping a Custom Class
     module Resource
+      # @private
+      # rubocop:disable Style/DoubleNegation
       COERCIONS = {
         string: ->(value) { !value.nil? ? value.to_s : nil },
         integer: ->(value) { value.to_i },
@@ -20,10 +25,16 @@ module Contentful
         boolean: ->(value) { !!value },
         date: ->(value) { !value.nil? ? DateTime.parse(value) : nil }
       }
+      # rubocop:enable Style/DoubleNegation
 
       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])
+      # @private
+      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!
         @nested_locale_fields = nested_locale_fields
         @default_locale = default_locale
@@ -34,9 +45,10 @@ module Contentful
         @raw_object = object
       end
 
+      # @private
       def inspect(info = nil)
-        properties_info = properties.empty? ? '' : " @properties=#{ properties.inspect }"
-        "#<#{ self.class }:#{ properties_info }#{ info }>"
+        properties_info = properties.empty? ? '' : " @properties=#{properties.inspect}"
+        "#<#{self.class}:#{properties_info}#{info}>"
       end
 
       # Returns true for resources that behave like an array
@@ -46,7 +58,9 @@ module Contentful
 
       # By default, fields come flattened in the current locale. This is different for syncs
       def nested_locale_fields?
+        # rubocop:disable Style/DoubleNegation
         !!@nested_locale_fields
+        # rubocop:enable Style/DoubleNegation
       end
 
       # Resources that don't include SystemProperties return nil for #sys
@@ -71,8 +85,8 @@ module Contentful
           keys ||= object.keys
           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]
+              object.is_a?(::Array) ? object : object[name.to_s],
+              self.class.public_send(:"#{namespace}_coercions")[name.to_sym]
             )
           end
         else
@@ -90,16 +104,17 @@ module Contentful
 
       def coerce_or_create_class(value, what)
         case what
-          when Symbol
-            COERCIONS[what] ? COERCIONS[what][value] : value
-          when Class
-            what.new(value, client)
-          else
-            value
+        when Symbol
+          COERCIONS[what] ? COERCIONS[what][value] : value
+        when Class
+          what.new(value, client)
+        else
+          value
         end
       end
 
       # Register the resources properties on class level by using the #property method
+      # @private
       module ClassMethods
         # By default, fields come flattened in the current locale. This is different for sync
         def nested_locale_fields?
@@ -132,7 +147,7 @@ module Contentful
           define_method accessor_name do
             properties[name.to_sym]
           end
-          define_method "#{ accessor_name }=" do |value|
+          define_method "#{accessor_name}=" do |value|
             properties[name.to_sym] = value
           end
         end