contentful-management 0.8.0 → 0.9.0

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

@@ -2,7 +2,7 @@ module Contentful
   module Management
     module Resource
       # Useful methods for array-like resources that can be included if an
-      # :items property exists
+      # [#items] property exists
       module ArrayLike
         include Enumerable
 

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

@@ -1,6 +1,7 @@
 module Contentful
   module Management
     module Resource
+      # Adds Field Coercions for [Asset]
       module AssetFields
         # Special fields for Asset.
         def fields_coercions

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

@@ -1,7 +1,9 @@
 module Contentful
   module Management
     module Resource
+      # Adds Field Coercions for Entries
       module EntryFields
+        # Special fields for Entry.
         def fields_coercions
           {}
         end

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

@@ -1,7 +1,11 @@
 module Contentful
   module Management
     module Resource
+      # Module for creating Fields based off of ContentTypes
       module FieldAware
+        # Creates fields for entry based on it's ContentType
+        #
+        # @param [Entry] entry the expected entry to modify
         def self.create_fields_for_content_type(entry)
           entry.instance_eval do
             content_type.fields.each do |field|
@@ -15,16 +19,16 @@ module Contentful
               define_singleton_method accessor_name do
                 fields[field.id.to_sym]
               end
-              define_singleton_method "#{ accessor_name }_with_locales" do
+              define_singleton_method "#{accessor_name}_with_locales" do
                 fields_for_query[field.id.to_sym]
               end
-              define_singleton_method "#{ accessor_name }=" do |value|
+              define_singleton_method "#{accessor_name}=" do |value|
                 if localized_or_default_locale
-                    @fields[locale] ||= {}
-                    @fields[locale][field.id.to_sym] = value
+                  @fields[locale] ||= {}
+                  @fields[locale][field.id.to_sym] = value
                 end
               end
-              define_singleton_method "#{ accessor_name }_with_locales=" do |values|
+              define_singleton_method "#{accessor_name}_with_locales=" do |values|
                 values.each do |locale, value|
                   if localized_or_default_locale
                     @fields[locale] ||= {}
@@ -36,6 +40,13 @@ module Contentful
           end
         end
 
+        # Verifies if field is localized or default locale matches current locale
+        #
+        # @param [Field] field an entry field
+        # @param [String] default_locale
+        # @param [String] locale
+        #
+        # @return [Boolean]
         def self.localized_or_default_locale(field, default_locale, locale)
           field.localized || default_locale == locale
         end

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

@@ -3,47 +3,55 @@ require_relative '../file'
 module Contentful
   module Management
     module Resource
+      # Adds fields logic for [Resource] classes
       module Fields
+        # Returns the fields hash for the specified locale
+        #
+        # @param [String] wanted_locale
+        #
+        # @return [Hash] localized fields
         def fields(wanted_locale = default_locale)
           requested_locale = locale || wanted_locale
           @fields[requested_locale] = {} unless @fields[requested_locale]
           @fields[requested_locale]
         end
 
+        # @private
         def initialize(object = nil, *)
           super
           @fields = {}
           extract_fields_from_object! object if object
         end
 
+        # @private
         def inspect(info = nil)
           if fields.empty?
             super(info)
           else
-            super("#{ info } @fields=#{ fields.inspect }")
+            super("#{info} @fields=#{fields.inspect}")
           end
         end
 
         # Create accessors for content type, asset, entry objects.
         def self.included(base)
-          base.fields_coercions.keys.each { |name|
+          base.fields_coercions.keys.each do |name|
             accessor_name = Contentful::Management::Support.snakify(name)
             base.send :define_method, accessor_name do
               fields[name.to_sym]
             end
-            base.send :define_method, "#{ accessor_name }_with_locales" do
+            base.send :define_method, "#{accessor_name}_with_locales" do
               fields_for_query[name.to_sym]
             end
-            base.send :define_method, "#{ accessor_name }=" do |value|
+            base.send :define_method, "#{accessor_name}=" do |value|
               fields[name.to_sym] = value
             end
-            base.send :define_method, "#{ accessor_name }_with_locales=" do |values|
+            base.send :define_method, "#{accessor_name}_with_locales=" do |values|
               values.each do |locale, value|
                 @fields[locale] = {} unless @fields[locale]
                 @fields[locale][name.to_sym] = value
               end
             end
-          }
+          end
         end
 
         private
@@ -54,8 +62,8 @@ module Contentful
               nested_child_object.each do |object_locale, real_child_object|
                 @fields[object_locale] ||= {}
                 @fields[object_locale].merge! extract_from_object(
-                                                  {field_name => real_child_object}, :fields
-                                              )
+                  { field_name => real_child_object }, :fields
+                )
               end
             end
           else

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

@@ -11,6 +11,7 @@ module Contentful
           refresh_data(resource) if resource.is_a? self_class
         end
 
+        # @private
         def refresh_data(resource)
           if resource.is_a? Error
             resource

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

@@ -3,6 +3,8 @@ module Contentful
     module Resource
       # Adds the feature to have system properties to a Resource.
       module SystemProperties
+        # @private
+        # Coercions for System Properties to native types
         SYS_COERCIONS = {
           type: :string,
           id: :string,
@@ -16,38 +18,43 @@ module Contentful
         }
         attr_reader :sys
 
-        def initialize(object = {'sys' => nil}, *)
+        # @private
+        def initialize(object = { 'sys' => nil }, *)
           super
-          object ||= {'sys' => nil}
+          object ||= { 'sys' => nil }
           @sys = extract_from_object object['sys'], :sys
         end
 
+        # @private
         def inspect(info = nil)
           if sys.empty?
             super(info)
           else
-            super("#{ info } @sys=#{ sys.inspect }")
+            super("#{info} @sys=#{sys.inspect}")
           end
         end
 
+        # @private
         module ClassMethods
+          # @private
           def sys_coercions
             SYS_COERCIONS
           end
         end
 
+        # @private
         def self.included(base)
           base.extend(ClassMethods)
 
-          base.sys_coercions.keys.each { |name|
+          base.sys_coercions.keys.each do |name|
             accessor_name = Contentful::Management::Support.snakify(name)
             base.send :define_method, accessor_name do
               sys[name.to_sym]
             end
-            base.send :define_method, "#{ accessor_name }=" do |value|
+            base.send :define_method, "#{accessor_name}=" do |value|
               sys[name.to_sym] = value
             end
-          }
+          end
         end
       end
     end

data/lib/contentful/management/resource_builder.rb

@@ -14,15 +14,19 @@ module Contentful
     # Transforms a Contentful::Response into a Contentful::Resource or a Contentful::Error
     # See example/resource_mapping.rb for avanced usage
     class ResourceBuilder
+      # Default Resource Mapping
+      # @see _ README for more information on Resource Mapping
       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
+      # @see _ README for more information on Entry Mapping
       DEFAULT_ENTRY_MAPPING = {}
 
       attr_reader :client, :response, :resource_mapping, :entry_mapping, :resource
@@ -39,7 +43,7 @@ module Contentful
       end
 
       # Starts the parsing process.
-      # Either returns an Error, or the parsed Resource
+      # @return [Contentful::Management::Resource, Contentful::Management::Error]
       def run
         if response.status == :ok
           create_all_resources!
@@ -94,9 +98,8 @@ module Contentful
 
       # Finds the proper DynamicEntry class for an entry
       def get_dynamic_entry(object)
-        if content_id = content_type_id_for_entry(object)
-          client.dynamic_entry_cache[content_id.to_sym]
-        end
+        content_id = content_type_id_for_entry(object)
+        client.dynamic_entry_cache[content_id.to_sym] if content_id
       end
 
       # Returns the id of the related ContentType, if there is one
@@ -123,14 +126,14 @@ module Contentful
       def detect_resource_class(object)
         type = object['sys'] && object['sys']['type']
         case res_class = resource_mapping[type]
-          when Symbol
-            public_send(res_class, object)
-          when Proc
-            res_class[object]
-          when nil
-            fail UnparsableResource.new(response)
-          else
-            res_class
+        when Symbol
+          public_send(res_class, object)
+        when Proc
+          res_class[object]
+        when nil
+          fail UnparsableResource, response
+        else
+          res_class
         end
       end
 
@@ -158,9 +161,9 @@ module Contentful
         if object.is_a? Hash
           object.select do |_, value|
             value.is_a?(::Array) &&
-                value.first &&
-                value.first.is_a?(Hash) &&
-                value.first.key?('sys')
+              value.first &&
+              value.first.is_a?(Hash) &&
+              value.first.key?('sys')
           end
         else
           {}
@@ -188,30 +191,30 @@ module Contentful
       end
 
       def create_included_resources!(included_objects)
-        if included_objects
-          included_objects.each do |type, objects|
-            @included_resources[type] = Hash[
-                objects.map do |object|
-                  res = create_resource(object)
-                  [res.id, res]
-                end
-            ]
-          end
+        return unless included_objects
+
+        included_objects.each do |type, objects|
+          @included_resources[type] = Hash[
+            objects.map do |object|
+              res = create_resource(object)
+              [res.id, res]
+            end
+          ]
         end
       end
 
       def replace_links_with_known_resources(res, seen_resource_ids = [])
         seen_resource_ids << res.id
 
-        [:properties, :sys, :fields].map do |property_container_name|
+        property_containers = [:properties, :sys, :fields].map do |property_container_name|
           res.public_send(property_container_name)
-        end.compact.each do |property_container|
+        end.compact
+
+        property_containers.each do |property_container|
           replace_links_in_properties(property_container, seen_resource_ids)
         end
 
-        if res.array?
-          replace_links_in_array res.items, seen_resource_ids
-        end
+        replace_links_in_array res.items, seen_resource_ids if res.array?
       end
 
       def replace_links_in_properties(property_container, seen_resource_ids)
@@ -239,10 +242,10 @@ module Contentful
       end
 
       def maybe_replace_link(link, parent, key)
-        if  @known_resources[link.link_type] &&
-            @known_resources[link.link_type].key?(link.id)
-          parent[key] = @known_resources[link.link_type][link.id]
-        end
+        return unless @known_resources[link.link_type] &&
+                      @known_resources[link.link_type].key?(link.id)
+
+        parent[key] = @known_resources[link.link_type][link.id]
       end
 
       def replace_links_in_included_resources_with_known_resources

data/lib/contentful/management/space.rb

@@ -9,11 +9,13 @@ require_relative 'entry'
 require_relative 'space_entry_methods_factory'
 require_relative 'webhook'
 require_relative 'space_webhook_methods_factory'
+require_relative 'api_key'
+require_relative 'space_api_key_methods_factory'
 
 module Contentful
   module Management
     # Resource class for Space.
-    # https://www.contentful.com/developers/documentation/content-management-api/#resources-spaces
+    # @see _ https://www.contentful.com/developers/documentation/content-management-api/#resources-spaces
     class Space
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
@@ -26,7 +28,7 @@ module Contentful
       attr_accessor :found_locale
 
       # Gets a collection of spaces.
-      # Returns a Contentful::Management::Array of Contentful::Management::Space.
+      # @return [Contentful::Management::Array<Contentful::Management::Space>]
       def self.all
         request = Request.new('')
         response = request.get
@@ -37,10 +39,12 @@ module Contentful
       end
 
       # Gets a specific space.
-      # Takes an id of space.
-      # Returns a Contentful::Management::Space.
+      #
+      # @param [String] space_id
+      #
+      # @return [Contentful::Management::Space]
       def self.find(space_id)
-        request = Request.new("/#{ space_id }")
+        request = Request.new("/#{space_id}")
         response = request.get
         result = ResourceBuilder.new(response, {}, {})
         space = result.run
@@ -49,15 +53,20 @@ module Contentful
       end
 
       # Create a space.
-      # Takes a hash of attributes with optional organization id if client has more than one organization.
-      # Returns a Contentful::Management::Space.
+      #
+      # @param [Hash] attributes
+      # @option attributes [String] :name
+      # @option attributes [String] :default_locale
+      # @option attributes [String] :organization_id Required if user has more than one organization
+      #
+      # @return [Contentful::Management::Space]
       def self.create(attributes)
         default_locale = attributes[:default_locale] || client.default_locale
         request = Request.new(
-            '',
-            {'name' => attributes.fetch(:name), defaultLocale: default_locale},
-            id = nil,
-            organization_id: attributes[:organization_id]
+          '',
+          { 'name' => attributes.fetch(:name), defaultLocale: default_locale },
+          nil,
+          organization_id: attributes[:organization_id]
         )
         response = request.post
         result = ResourceBuilder.new(response, {}, {})
@@ -67,15 +76,19 @@ module Contentful
       end
 
       # Updates a space.
-      # Takes a hash of attributes with optional organization id if client has more than one organization.
-      # Returns a Contentful::Management::Space.
+      #
+      # @param [Hash] attributes
+      # @option attributes [String] :name
+      # @option attributes [String] :organization_id Required if user has more than one organization
+      #
+      # @return [Contentful::Management::Space]
       def update(attributes)
         request = Request.new(
-            "/#{ id }",
-            {'name' => attributes.fetch(:name)},
-            id = nil,
-            version: sys[:version],
-            organization_id: attributes[:organization_id]
+          "/#{id}",
+          { 'name' => attributes.fetch(:name) },
+          nil,
+          version: sys[:version],
+          organization_id: attributes[:organization_id]
         )
         response = request.put
         result = ResourceBuilder.new(response, {}, {})
@@ -83,7 +96,9 @@ module Contentful
       end
 
       # If a space is new, an object gets created in the Contentful, otherwise the existing space gets updated.
-      # See README for details.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::Space]
       def save
         if id
           update(name: name, organization_id: organization)
@@ -94,12 +109,13 @@ module Contentful
       end
 
       # Destroys a space.
-      # Returns true if succeed.
+      #
+      # @return [true, Contentful::Management::Error] success
       def destroy
-        request = Request.new("/#{ id }")
+        request = Request.new("/#{id}")
         response = request.delete
         if response.status == :no_content
-          return true
+          true
         else
           ResourceBuilder.new(response, {}, {}).run
         end
@@ -107,48 +123,71 @@ module Contentful
 
       # Allows manipulation of content types in context of the current space
       # Allows listing all content types of space, creating new and finding one by id.
-      # See README for details.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceContentTypeMethodsFactory]
       def content_types
         SpaceContentTypeMethodsFactory.new(self)
       end
 
+      # Allows manipulation of api keys in context of the current space
+      # Allows listing all api keys of space, creating new and finding one by id.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceApiKeyMethodsFactory]
+      def api_keys
+        SpaceApiKeyMethodsFactory.new(self)
+      end
+
       # Allows manipulation of locales in context of the current space
       # Allows listing all locales of space, creating new and finding one by id.
-      # See README for details.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceLocaleMethodsFactory]
       def locales
         SpaceLocaleMethodsFactory.new(self)
       end
 
       # Allows manipulation of assets in context of the current space
       # Allows listing all assets of space, creating new and finding one by id.
-      # See README for details.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceAssetMethodsFactory]
       def assets
         SpaceAssetMethodsFactory.new(self)
       end
 
       # Allows manipulation of entries in context of the current space
       # Allows listing all entries for space and finding one by id.
-      # See README for details.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceEntryMethodsFactory]
       def entries
         SpaceEntryMethodsFactory.new(self)
       end
 
       # Allows manipulation of webhooks in context of the current space
       # Allows listing all webhooks for space and finding one by id.
-      # See README for details.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceWebhookMethodsFactory]
       def webhooks
         SpaceWebhookMethodsFactory.new(self)
       end
 
       # Retrieves Default Locale for current Space and leaves it cached
+      #
+      # @return [String]
       def default_locale
         self.found_locale ||= find_locale
       end
 
       # Finds Default Locale Code for current Space
       # This request makes an API call to the Locale endpoint
+      #
+      # @return [String]
       def find_locale
-        locale = ::Contentful::Management::Locale.all(self.id).detect { |l| l.default }
+        locale = ::Contentful::Management::Locale.all(id).detect(&:default)
         return locale.code unless locale.nil?
         @default_locale
       end