contentful-management 0.0.1.pre → 0.0.1

data/lib/contentful/management/entry.rb

@@ -1,29 +1,37 @@
 # -*- encoding: utf-8 -*-
 require_relative 'resource'
+require_relative 'resource/entry_fields'
 require_relative 'resource/fields'
 
 module Contentful
   module Management
+    # Resource class for Entry.
+    # https://www.contentful.com/developers/documentation/content-management-api/#resources-entries
     class Entry
 
-      def self.fields_coercions
-        {}
-      end
-
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
+      extend Contentful::Management::Resource::EntryFields
       include Contentful::Management::Resource::Fields
 
       attr_accessor :content_type
 
-      def self.all(space_id)
-        request = Request.new("/#{ space_id }/entries")
+      # Gets a collection of entries.
+      # 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 = {})
+        path = "/#{ space_id }/entries"
+        path += "?content_type=#{parameters[:content_type_id]}" if parameters[:content_type_id]
+        request = Request.new(path)
         response = request.get
         result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {})
         result.run
       end
 
+      # Gets a specific entry.
+      # Takes an id of space and entry.
+      # Returns a Contentful::Management::Entry.
       def self.find(space_id, entry_id)
         request = Request.new("/#{ space_id }/entries/#{ entry_id }")
         response = request.get
@@ -31,40 +39,51 @@ module Contentful
         result.run
       end
 
+      # Creates an entry.
+      # 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] || ''
         fields_for_create = if attributes[:fields] #create from initialized dynamic entry via save
-                              tmp_entry = self.new
+                              tmp_entry = new
                               tmp_entry.instance_variable_set(:@fields, attributes.delete(:fields) || {})
                               Contentful::Management::Support.deep_hash_merge(tmp_entry.fields_for_query, tmp_entry.fields_from_attributes(attributes))
                             else
                               fields_with_locale content_type, attributes
                             end
 
-        request = Request.new("/#{ content_type.sys[:space].id  }/entries/#{ attributes[:id] || ''}", { fields: fields_for_create }, nil, content_type_id: content_type.id)
+        request = Request.new("/#{ content_type.sys[:space].id  }/entries/#{ custom_id }", {fields: fields_for_create}, nil, content_type_id: content_type.id)
 
-        response = attributes[:id].nil? ? request.post : request.put
+        response = custom_id.empty? ? request.post : request.put
         result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {})
         result.run
       end
 
+      # Updates an entry.
+      # Takes an optional hash with attributes of content type.
+      # Returns a Contentful::Management::Entry.
       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/#{ self.id }", { fields: fields_for_update }, id = nil, version: sys[:version])
         response = request.put
         result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {}).run
         refresh_data(result)
       end
 
+      # 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?
-          new_instance = Contentful::Management::Entry.create(content_type, { fields: instance_variable_get(:@fields) })
+          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])
         response = request.put
@@ -72,6 +91,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # Unpublishes an entry.
+      # Returns a Contentful::Management::Entry.
       def unpublish
         request = Request.new("/#{ space.id }/entries/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.delete
@@ -79,6 +100,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # Archives an entry.
+      # Returns a Contentful::Management::Entry.
       def archive
         request = Request.new("/#{ space.id }/entries/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.put
@@ -86,6 +109,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # Unarchives an entry.
+      # Returns a Contentful::Management::Entry.
       def unarchive
         request = Request.new("/#{ space.id }/entries/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.delete
@@ -93,6 +118,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # Destroys an entry.
+      # Returns true if succeed.
       def destroy
         request = Request.new("/#{ space.id }/entries/#{ id }")
         response = request.delete
@@ -104,18 +131,25 @@ module Contentful
         end
       end
 
+      # Checks if an entry is published.
+      # Returns true if published.
       def published?
         !sys[:publishedAt].nil?
       end
 
+      # Checks if an entry is archived.
+      # Returns true if published.
       def archived?
         !sys[:archivedAt].nil?
       end
 
+      # Returns the currently supported local.
       def locale
         sys[:locale] || default_locale
       end
 
+      # Parser for assets attributes from query.
+      # Returns a hash of existing fields.
       def fields_for_query
         raw_fields = self.instance_variable_get(:@fields)
         fields_names = raw_fields.first[1].keys
@@ -129,7 +163,7 @@ module Contentful
 
       def fields_from_attributes(attributes)
         attributes.each do |id, value|
-          attributes[id] = { locale => parse_update_attribute(value) }
+          attributes[id] = {locale => parse_update_attribute(value)}
         end
       end
 
@@ -138,24 +172,24 @@ module Contentful
       def self.parse_attribute_with_field(attribute, field)
         case field.type
           when ContentType::LINK then
-            { sys: { type: field.type, linkType: field.link_type, id: attribute.id }}
+            { sys: { type: field.type, linkType: field.link_type, id: attribute.id } } if attribute
           when ContentType::ARRAY then
             parse_fields_array(attribute)
           when ContentType::LOCATION then
-            { lat: attribute.properties[:lat], lon: attribute.properties[:lon]}
+            { lat: attribute.properties[:lat], lon: attribute.properties[:lon] }
           else
             attribute
         end
       end
 
-      #TODO refactor
+      # TODO refactor
       def parse_update_attribute(attribute)
         if attribute.is_a? Asset
-          { sys: { type: 'Link', linkType: 'Asset', id: attribute.id } }
+          {sys: {type: 'Link', linkType: 'Asset', id: attribute.id}}
         elsif attribute.is_a? Entry
-          { sys: { type: 'Link', linkType: 'Entry', id: attribute.id } }
+          {sys: {type: 'Link', linkType: 'Entry', id: attribute.id}}
         elsif attribute.is_a? Location
-          { lat: attribute.properties[:lat], lon: attribute.properties[:lon] }
+          {lat: attribute.properties[:lat], lon: attribute.properties[:lon]}
         elsif attribute.is_a? ::Array
           parse_update_fields_array(attribute)
         else
@@ -163,20 +197,19 @@ module Contentful
         end
       end
 
-      #TODO refactor
       def parse_update_fields_array(attributes)
         type = attributes.first.class.to_s
-        unless type == 'String'
-          attributes.each_with_object([]) do |attr, arr|
+        if type == 'String'
+          attributes
+        else
+           attributes.each_with_object([]) do |attr, arr|
             arr << case type
                      when /Entry/ then
-                       { sys: { type: 'Link', linkType: 'Entry', id: attr.id } }
+                       {sys: {type: 'Link', linkType: 'Entry', id: attr.id}}
                      when /Asset/ then
-                       { sys: { type: 'Link', linkType: 'Asset', id: attr.id } }
+                       {sys: {type: 'Link', linkType: 'Asset', id: attr.id}}
                    end
           end
-        else
-          attributes
         end
       end
 
@@ -186,9 +219,9 @@ module Contentful
           attributes.each_with_object([]) do |attr, arr|
             arr << case type.to_s
                      when /Entry/ then
-                       { sys: { type: 'Link', linkType: 'Entry', id: attr.id } }
+                       {sys: {type: 'Link', linkType: 'Entry', id: attr.id}}
                      when /Asset/ then
-                       { sys: { type: 'Link', linkType: 'Asset', id: attr.id } }
+                       {sys: {type: 'Link', linkType: 'Asset', id: attr.id}}
                    end
           end
         else
@@ -204,10 +237,9 @@ module Contentful
 
         attributes.each do |id, value|
           field = fields.select { |f| f.id.to_sym == id.to_sym }.first
-          attributes[id] = { locale => parse_attribute_with_field(value, field) }
+          attributes[id] = {locale => parse_attribute_with_field(value, field)}
         end
       end
-
     end
   end
 end

data/lib/contentful/management/field.rb

@@ -3,6 +3,7 @@ require_relative 'resource'
 
 module Contentful
   module Management
+    # A ContentType's field schema
     class Field
       include Contentful::Management::Resource
 
@@ -28,7 +29,6 @@ module Contentful
           end
         end
       end
-
     end
   end
 end

data/lib/contentful/management/file.rb

@@ -3,6 +3,7 @@ require_relative 'resource'
 
 module Contentful
   module Management
+   # An Asset's file schema
     class File
       include Contentful::Management::Resource
 

data/lib/contentful/management/link.rb

@@ -9,7 +9,7 @@ module Contentful
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
 
-      # Queries contentful for the Resource the Link is refering to
+      # Queries contentful for the Resource the Link is referring to
       # Takes an optional query hash
       def resolve(query = {})
         id_and_query = [(id unless link_type == 'Space')].compact + [query]

data/lib/contentful/management/locale.rb

@@ -2,9 +2,8 @@
 require_relative 'resource'
 
 module Contentful
-
   module Management
-
+    # Resource class for Locale.
     class Locale
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
@@ -16,6 +15,9 @@ module Contentful
       property :contentDeliveryApi, :boolean
       property :publish, :boolean
 
+      # Gets a collection of locales.
+      # Takes an id of a space.
+      # Returns a Contentful::Management::Array of Contentful::Management::Locale.
       def self.all(space_id = nil)
         request = Request.new("/#{ space_id }/locales")
         response = request.get
@@ -23,20 +25,34 @@ module Contentful
         result.run
       end
 
-      def self.create(space_id, attributes)
-        request = Request.new("/#{ space_id }/locales", { 'name' => attributes.fetch(:name), 'code' => attributes.fetch(:code) })
-        response = request.post
+      # Gets a specific locale.
+      # Takes an id of a space and locale id.
+      # Returns a Contentful::Management::Locale.
+      def self.find(space_id, locale_id)
+        request = Request.new("/#{ space_id }/locales/#{ locale_id }")
+        response = request.get
         result = ResourceBuilder.new(self, response, { 'Locale' => Locale }, {})
         result.run
       end
 
-      def self.find(space_id, locale_id)
-        request = Request.new("/#{ space_id }/locales/#{ locale_id }")
-        response = request.get
+      # Creates a locale.
+      # Takes a space id and hash with attributes:
+      #   :name
+      #   :code
+      #   :contentManagementApi
+      #   :contentDeliveryApi
+      #   :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) })
+        response = request.post
         result = ResourceBuilder.new(self, response, { 'Locale' => Locale }, {})
         result.run
       end
 
+      # Updates a locale.
+      # 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])
         response = request.put

data/lib/contentful/management/location.rb

@@ -4,7 +4,7 @@ require_relative 'resource'
 module Contentful
   module Management
     # Location Field Type
-    # You can directly query for them: https://www.contentful.com/developers/documentation/content-delivery-api/#search-filter-geo
+    # 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/resource/asset_fields.rb

@@ -0,0 +1,17 @@
+module Contentful
+  module Management
+    module Resource
+      module AssetFields
+
+        def fields_coercions
+          {
+              title: :hash,
+              description: :hash,
+              file: Contentful::Management::File
+          }
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Contentful
+  module Management
+    module Resource
+      module EntryFields
+
+        def fields_coercions
+          {}
+        end
+
+      end
+    end
+  end
+end

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

@@ -26,6 +26,7 @@ module Contentful
           end
         end
 
+        # Create accessors for content type, asset, entry objects.
         def self.included(base)
           base.fields_coercions.keys.each { |name|
             accessor_name = Contentful::Management::Support.snakify(name)

data/lib/contentful/management/resource_builder.rb

@@ -26,7 +26,6 @@ module Contentful
 
       attr_reader :client, :response, :resource_mapping, :entry_mapping, :resource
 
-
       def initialize(client, response, resource_mapping = {}, entry_mapping = {})
         @response = response
         @client = client

data/lib/contentful/management/space.rb

@@ -7,6 +7,8 @@ require_relative 'entry'
 
 module Contentful
   module Management
+    # Resource class for Space.
+    # https://www.contentful.com/developers/documentation/content-management-api/#resources-spaces
     class Space
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
@@ -16,6 +18,8 @@ module Contentful
       property :organization, :string
       property :locales, Locale
 
+      # Gets a collection of spaces.
+      # Returns a Contentful::Management::Array of Contentful::Management::Space.
       def self.all
         request = Request.new('')
         response = request.get
@@ -25,29 +29,40 @@ module Contentful
         spaces
       end
 
+      # Gets a specific space.
+      # Takes an id of space.
+      # Returns a Contentful::Management::Space.
       def self.find(space_id)
         request = Request.new("/#{ space_id }")
         response = request.get
         result = ResourceBuilder.new(self, response, {}, {})
         space = result.run
-        Contentful::Management::Client.shared_instance.update_dynamic_entry_cache_for_space!(space) if space.is_a?Space
+        Contentful::Management::Client.shared_instance.update_dynamic_entry_cache_for_space!(space) if space.is_a? Space
         space
       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.
       def self.create(attributes)
-        request = Request.new('', { 'name' => attributes.fetch(:name) }, id = nil, organization_id: attributes[:organization_id])
+        request = Request.new('', {'name' => attributes.fetch(:name)}, id = nil, organization_id: attributes[:organization_id])
         response = request.post
         result = ResourceBuilder.new(self, response, {}, {})
         result.run
       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.
       def update(attributes)
-        request = Request.new("/#{ id }", { 'name' => attributes.fetch(:name) }, id = nil,{ version: sys[:version], organization_id: attributes[:organization_id]})
+        request = Request.new("/#{ id }", { 'name' => attributes.fetch(:name) }, id = nil, version: sys[:version], organization_id: attributes[:organization_id])
         response = request.put
         result = ResourceBuilder.new(self, response, {}, {})
         refresh_data(result.run)
       end
 
+      # If a space is new, an object gets created in the Contentful, otherwise the existing space gets updated.
+      # See README for details.
       def save
         if id.nil?
           new_instance = self.class.create(name: name, organization_id: organization)
@@ -57,6 +72,8 @@ module Contentful
         end
       end
 
+      # Destroys a space.
+      # Returns true if succeed.
       def destroy
         request = Request.new("/#{ id }")
         response = request.delete
@@ -67,8 +84,11 @@ module Contentful
         end
       end
 
+      # 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.
       def content_types
-        content_types = ContentType.all(id)
+        content_types = nil
 
         content_types.instance_exec(self) do |space|
 
@@ -94,8 +114,11 @@ module Contentful
         content_types
       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.
       def locales
-        locales = Locale.all(id)
+        locales = nil
 
         locales.instance_exec(self) do |space|
           define_singleton_method(:all) do
@@ -114,8 +137,11 @@ module Contentful
         locales
       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.
       def assets
-        assets = Asset.all(id)
+        assets = nil
 
         assets.instance_exec(self) do |space|
           define_singleton_method(:all) do
@@ -139,12 +165,15 @@ module Contentful
         assets
       end
 
+      # Allows manipulation of entries in context of the current space
+      # Allows listing all entries of space and finding one by id.
+      # See README for details.
       def entries
-        entries = Entry.all(id)
+        entries = nil
 
         entries.instance_exec(self) do |space|
-          define_singleton_method(:all) do
-            Entry.all(space.id)
+          define_singleton_method(:all) do |attributes = {}|
+            Entry.all(space.id, attributes)
           end
 
           define_singleton_method(:find) do |entry_id|
@@ -153,7 +182,6 @@ module Contentful
         end
         entries
       end
-
     end
   end
 end