contentful-management 0.0.1.pre → 0.0.1

data/CHANGELOG.md

@@ -1,2 +1,10 @@
+### 0.0.1
+ * Fix: Headers not properly cleared between requests
+ * Fix: Create entries with custom identifier
+ * Code cleanup
+ * Adding rdoc
+ * Adding filter by content_type id
+
+
 ### 0.0.1-pre
  * alpha pre-release

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2014 Andreas Tiefenthaler
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2014 Contentful GmbH
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,4 +1,6 @@
+
 # Contentful::Management
+[![Gem Version](https://badge.fury.io/rb/contentful-management.svg)](http://badge.fury.io/rb/contentful-management) [![Build Status](https://travis-ci.org/contentful/contentful-management.rb.svg)](https://travis-ci.org/contentful/contentful-management.rb)
 
 Ruby client for the Contentful Content Management API.
 
@@ -79,12 +81,6 @@ blog_space.save
 
 Retrieving all content types from a space:
 
-```ruby
-blog_post_content_types = blog_space.content_types
-```
-
-or
-
 ```ruby
 blog_post_content_types = blog_space.content_types.all
 ```
@@ -170,12 +166,6 @@ blog_post_content_type.update(name: 'Post', description: 'Post Description', fie
 
 Retrieving all locales from the space:
 
-```ruby
-blog_post_locales = blog_space.locales
-```
-
-or
-
 ```ruby
 blog_post_locales = blog_space.locales.all
 ```
@@ -200,11 +190,6 @@ blog_post_locale.update(name: 'German', code: 'de-DE')
 
 Retrieving all assets from the space:
 
-```ruby
-blog_post_assets = blog_space.assets
-```
-
-or
 
 ```ruby
 blog_post_assets = blog_space.assets.all
@@ -308,13 +293,19 @@ my_image_asset.published?
 Retrieving all entries from the space:
 
 ```ruby
-entries = blog_space.entries
+entries = blog_space.entries.all
+```
+
+Retrieving all entries from the space with given content type:
+
+```ruby
+entries = blog_space.entries.all(content_type_id: content_type.id)
 ```
 
 or
 
 ```ruby
-entries = blog_space.entries.all
+entries = content_type.entries.all
 ```
 
 Retrieving an entry by id:

data/examples/blog.rb

@@ -27,11 +27,13 @@ blog_space.locales.create(name: 'German', code: 'de-DE')
 category_type = blog_space.content_types.create(name: 'Category')
 category_type.fields.create(id: 'category_name', name: 'Category Name', type: 'Text', localized: true)
 category_type.fields.create(id: 'category_description', name: 'Category Description', type: 'Text', localized: true)
+category_type.update(displayField: 'category_name')
 
 post_type = blog_space.content_types.create(name: 'Post')
 post_type.fields.create(id: 'post_title', name: 'Post Title', type: 'Text', localized: true)
 post_type.fields.create(id: 'post_author', name: 'Post Author', type: 'Text', localized: true)
 post_type.fields.create(id: 'post_body', name: 'Post Body', type: 'Text', localized: true)
+post_type.update(displayField: 'post_title')
 
 categories = Contentful::Management::Field.new
 categories.id = 'post_category'

data/examples/create_space.rb

@@ -18,7 +18,7 @@ dat_space = Contentful::Management::Space.find(my_space.id)
 
 dat_space.locales.create(name: 'English', code: 'en-US')
 
-locales = dat_space.locales
+locales = dat_space.locales.all
 # locales.map(&:destroy) # not implemented yet?
 
 dat_space.destroy

data/lib/contentful/management.rb

@@ -1,12 +1,4 @@
 # -*- encoding: utf-8 -*-
 require 'contentful/management/version'
 require 'contentful/management/support'
-require 'contentful/management/resource'
 require 'contentful/management/client'
-require 'contentful/management/space'
-
-module Contentful
-  module Management
-    # Your code goes here...
-  end
-end

data/lib/contentful/management/asset.rb

@@ -1,26 +1,23 @@
 # -*- encoding: utf-8 -*-
 require_relative 'resource'
+require_relative 'resource/asset_fields'
 require_relative 'resource/fields'
 
 module Contentful
   module Management
+     # Resource class for Asset.
+     # https://www.contentful.com/developers/documentation/content-management-api/#resources-assets
     class Asset
 
-      FIELDS_COERCIONS = {
-          title: :hash,
-          description: :hash,
-          file: Contentful::Management::File
-      }
-
-      def self.fields_coercions
-        FIELDS_COERCIONS
-      end
-
       include Contentful::Management::Resource
+      extend Contentful::Management::Resource::AssetFields
       include Contentful::Management::Resource::Fields
       include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
 
+      # Gets a collection of assets.
+      # Takes an id of space.
+      # Returns a Contentful::Management::Array of Contentful::Management::Asset.
       def self.all(space_id)
         request = Request.new("/#{ space_id }/assets")
         response = request.get
@@ -28,6 +25,9 @@ module Contentful
         result.run
       end
 
+      # Gets a specific asset.
+      # Takes an id of space and asset.
+      # Returns a Contentful::Management::Asset.
       def self.find(space_id, asset_id)
         request = Request.new("/#{ space_id }/assets/#{ asset_id }")
         response = request.get
@@ -35,47 +35,60 @@ module Contentful
         result.run
       end
 
+      # Creates an asset.
+      # Takes a space id and hash with attributes (title, description, file)
+      # Returns a Contentful::Management::Asset.
       def self.create(space_id, attributes)
-        asset = self.new
+        asset = new
         asset.instance_variable_set(:@fields, attributes[:fields] || {})
         asset.locale = attributes[:locale] if attributes[:locale]
         asset.title = attributes[:title] if attributes[:title]
         asset.description = attributes[:description] if attributes[:description]
         asset.file = attributes[:file] if attributes[:file]
 
-        request = Request.new("/#{ space_id }/assets/#{ attributes[:id] || ''}", { fields: asset.fields_for_query })
+        request = Request.new("/#{ space_id }/assets/#{ attributes[:id] || ''}", {fields: asset.fields_for_query})
         response = attributes[:id].nil? ? request.post : request.put
         result = ResourceBuilder.new(self, response, {}, {}).run
         result.process_files if result.is_a? self
         result
       end
 
+      # This method is used only when an asset is created. Processes the uploaded file.
       def process_files
         instance_variable_get(:@fields).keys.each do |locale|
           request = Request.new("/#{ space.id }/assets/#{ id }/files/#{ locale }/process", {}, id = nil, version: sys[:version])
           request.put
         end
+        sys[:version] += 1
+        self
       end
 
+      # Updates an asset.
+      # Takes hash with attributes (title, description, file)
+      # Returns a Contentful::Management::Asset.
       def update(attributes)
         self.title = attributes[:title] if attributes[:title]
         self.description = attributes[:description] if attributes[:description]
         self.file = attributes[:file] if attributes[:file]
-        request = Request.new("/#{ space.id }/assets/#{ id }", { fields: fields_for_query }, id = nil, version: sys[:version])
+        request = Request.new("/#{ space.id }/assets/#{ id }", {fields: fields_for_query}, id = nil, version: sys[:version])
         response = request.put
         result = ResourceBuilder.new(self, response, {}, {}).run
         refresh_data(result)
       end
 
+      # If an asset is a new object gets created in the Contentful, otherwise the existing asset gets updated.
+      # See README for details.
       def save
         if id.nil?
-          new_instance = self.class.create(self.sys[:space].id, { fields: instance_variable_get(:@fields) })
+          new_instance = self.class.create(self.sys[:space].id, {fields: instance_variable_get(:@fields)})
           refresh_data(new_instance)
         else
           update(title: title, description: description, file: file)
         end
       end
 
+      # Destroys an asset.
+      # Returns true if succeed.
       def destroy
         request = Request.new("/#{ space.id }/assets/#{ id }")
         response = request.delete
@@ -87,6 +100,8 @@ module Contentful
         end
       end
 
+      # Publishes an asset.
+      # Returns a Contentful::Management::Asset.
       def publish
         request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.put
@@ -94,6 +109,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # Unpublishes an asset.
+      # Returns a Contentful::Management::Asset.
       def unpublish
         request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.delete
@@ -101,6 +118,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # Archive an asset.
+      # Returns a Contentful::Management::Asset.
       def archive
         request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.put
@@ -108,6 +127,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # Unarchvie an asset.
+      # Returns a Contentful::Management::Asset.
       def unarchive
         request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.delete
@@ -115,18 +136,24 @@ module Contentful
         refresh_data(result)
       end
 
+      # Checks if an asset is published.
+      # Returns true if published.
       def published?
         !sys[:publishedAt].nil?
       end
 
+      # Checks if an asset is archvied.
+      # Returns true if archived.
       def archived?
         !sys[:archivedAt].nil?
       end
 
+      # Returns currently supported local or default locale.
       def locale
         sys && sys[:locale] ? sys[:locale] : default_locale
       end
 
+      # Parser for assets attributes, creates appropriate form of request.
       def fields_for_query
         self.class.fields_coercions.keys.each_with_object({}) do |field_name, results|
           results[field_name] = @fields.each_with_object({}) do |(locale, fields), field_results|
@@ -134,30 +161,6 @@ module Contentful
           end
         end
       end
-
-      # Returns the image url of an asset
-      # Allows you to pass in the following options for image resizing:
-      #   :width
-      #   :height
-      #   :format
-      #   :quality
-      # See https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing
-      def image_url(options = {})
-        query = {
-            w: options[:w] || options[:width],
-            h: options[:h] || options[:height],
-            fm: options[:fm] || options[:format],
-            q: options[:q] || options[:quality]
-        }.reject { |_k, v| v.nil? }
-
-        if query.empty?
-          file.url
-        else
-          "#{ file.url }?#{ URI.encode_www_form(query) }"
-        end
-      end
-
     end
   end
 end
-

data/lib/contentful/management/client.rb

@@ -42,7 +42,7 @@ module Contentful
       # Use this method together with the client's :dynamic_entries configuration.
       # See README for details.
       def update_dynamic_entry_cache_for_space!(space)
-        update_dynamic_entry_cache!(space.content_types)
+        update_dynamic_entry_cache!(space.content_types.all)
       end
 
       def update_dynamic_entry_cache!(content_types)
@@ -72,9 +72,16 @@ module Contentful
         request_url = request.url
         url = request.absolute? ? request_url : base_url + request_url
         raw_response = yield(url)
+        clear_headers
         Response.new(raw_response, request)
       end
 
+      def clear_headers
+        self.content_type_id = nil
+        self.version = nil
+        self.organization_id = nil
+      end
+
       def delete(request)
         execute_request(request) do |url|
           self.class.delete_http(url, {}, request_headers)

data/lib/contentful/management/content_type.rb

@@ -4,8 +4,9 @@ require_relative 'field'
 
 module Contentful
   module Management
+    # Resource class for ContentType.
+    # https://www.contentful.com/developers/documentation/content-management-api/#resources-content-types
     class ContentType
-
       FIELD_TYPES = [
           SYMBOL = 'Symbol',
           TEXT = 'Text',
@@ -26,8 +27,10 @@ module Contentful
       property :name, :string
       property :description, :string
       property :fields, Field
-      property :displayField, :string
 
+      # Gets a collection of content types.
+      # Takes an id of space.
+      # Returns a Contentful::Management::Array of Contentful::Management::ContentType.
       def self.all(space_id)
         request = Request.new("/#{ space_id }/content_types")
         response = request.get
@@ -37,6 +40,9 @@ module Contentful
         content_types
       end
 
+      # Gets a specific entry.
+      # Takes an id of space and content type.
+      # Returns a Contentful::Management::ContentType.
       def self.find(space_id, content_type_id)
         request = Request.new("/#{ space_id }/content_types/#{ content_type_id }")
         response = request.get
@@ -46,6 +52,8 @@ module Contentful
         content_type
       end
 
+      # Destroys a content type.
+      # Returns true if succeed.
       def destroy
         request = Request.new("/#{ space.id }/content_types/#{ id }")
         response = request.delete
@@ -57,6 +65,8 @@ module Contentful
         end
       end
 
+      # 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])
         response = request.put
@@ -64,6 +74,9 @@ module Contentful
         refresh_data(result)
       end
 
+      # Deactivates a content type.
+      # Only content type that has no entries can be deactivated.
+      # Returns a Contentful::Management::ContentType.
       def deactivate
         request = Request.new("/#{ space.id }/content_types/#{ id }/published")
         response = request.delete
@@ -71,10 +84,15 @@ module Contentful
         refresh_data(result)
       end
 
+      # Checks if a content type is active.
+      # Returns true if active.
       def active?
         !sys[:publishedAt].nil?
       end
 
+      # Creates a content type.
+      # Takes an id of space and hash with attributes.
+      # 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),
@@ -86,8 +104,12 @@ module Contentful
         result
       end
 
+      # Updates a content type.
+      # Takes a hash with attributes.
+      # Returns a Contentful::Management::ContentType.
       def update(attributes)
         parameters = {}
+        parameters.merge!(displayField: attributes[:displayField]) if  attributes[:displayField]
         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))
@@ -97,6 +119,8 @@ module Contentful
         refresh_data(result)
       end
 
+      # 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?
           new_instance = self.class.create(space.id, @properties)
@@ -106,6 +130,7 @@ module Contentful
         end
       end
 
+      # This method merges existing fields with new one, when adding, creating or updating new fields.
       def merged_fields(new_field)
         field_ids = []
         merged_fields = fields.each_with_object([]) do |field, fields|
@@ -119,6 +144,10 @@ module Contentful
 
       alias_method :orig_fields, :fields
 
+      # Use this method only in the context of content type.
+      # Allows you to add and create a field with specified attributes or destroy by pass field id.
+      # Returns a Contentful::Management::ContentType.
+      # See README for details.
       def fields
         fields = orig_fields
 
@@ -150,15 +179,25 @@ module Contentful
         fields
       end
 
-      #TODO refactor and move
+      # Use this method only in the context of content type.
+      # Allows you to create an entry.
+      # Returns a Contentful::Management::Entry.
+      # See README for details.
       def entries
-        entries = []
+        entries = nil
+
         entries.instance_exec(self) do |content_type|
+
+          define_singleton_method(:all) do
+            Contentful::Management::Entry.all(content_type.space.id, content_type_id: content_type.id)
+          end
+
           define_singleton_method(:create) do |params|
             Entry.create(content_type, params)
           end
+
           define_singleton_method(:new) do
-            dynamic_entry_class =   Contentful::Management::Client.shared_instance.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
+            dynamic_entry_class = Contentful::Management::Client.shared_instance.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
             dynamic_entry = dynamic_entry_class.new
             dynamic_entry.content_type = content_type
             dynamic_entry
@@ -174,7 +213,6 @@ module Contentful
           field.properties.replace(field.properties_to_hash)
         end
       end
-
     end
   end
 end