contentful-management 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.0.3
+ * Fix: next_page feature
+ * Fix: create entry with specific locale
+ * Fix: service unavailable error (503)
+ * Fix: reload method on objects
+ * Code cleanup
+ * More documentation
+
 ### 0.0.2
  * Fix: Convert an Entry to a DynamicEntry after being created.
 

data/README.md

@@ -2,6 +2,8 @@
 # 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)
 
+# This Gem does not yet support the full API functionality.
+
 Ruby client for the Contentful Content Management API.
 
 Contentful is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.
@@ -14,6 +16,9 @@ Add this line to your application's Gemfile:
 
 ## Usage
 
+### Examples
+Some examples can be found in the ```examples/``` directory or you take a look at this [extended example script](https://github.com/contentful/cma_import_script).
+
 ### Client
 
 At the beginning the API client instance should be created for each thread that is going to be used in your application:
@@ -108,6 +113,11 @@ blog_post_content_type.fields.create(id: 'title_field_id', name: 'Post Title', t
 ```
 - if the field_id exists, the related field will be updated.
 
+or the field of link type:
+```ruby
+blog_post_content_type.fields.create(id: 'my_entry_link_field', name: 'My Entry Link Field', type: 'Link', link_type: 'Entry')
+```
+
 or the field of an array type:
 ```ruby
 items = Contentful::Management::Field.new
@@ -389,6 +399,13 @@ Checking if the entry is published:
 my_entry.published?
 ```
 
+### Pagination
+
+```ruby
+blog_space.entries.all(limit: 5).next_page
+blog_space.assets.all(limit: 5).next_page
+blog_space.entries.all(limit: 5).next_page
+``` 
 
 ## Contributing
 

data/lib/contentful/management/array.rb

@@ -25,7 +25,9 @@ module Contentful
           new_skip = (skip || 0) + (limit || DEFAULT_LIMIT)
           new_request = request.copy
           new_request.query[:skip] = new_skip
-          new_request.get
+          response = new_request.get
+          result = ResourceBuilder.new(response, {}, {})
+          result.run
         else
           false
         end

data/lib/contentful/management/asset.rb

@@ -5,8 +5,8 @@ require_relative 'resource/fields'
 
 module Contentful
   module Management
-     # Resource class for Asset.
-     # https://www.contentful.com/developers/documentation/content-management-api/#resources-assets
+    # Resource class for Asset.
+    # https://www.contentful.com/developers/documentation/content-management-api/#resources-assets
     class Asset
 
       include Contentful::Management::Resource
@@ -16,12 +16,12 @@ module Contentful
       include Contentful::Management::Resource::Refresher
 
       # Gets a collection of assets.
-      # Takes an id of space.
+      # Takes an id of space and an optional hash of query options
       # Returns a Contentful::Management::Array of Contentful::Management::Asset.
-      def self.all(space_id)
-        request = Request.new("/#{ space_id }/assets")
+      def self.all(space_id, query = {})
+        request = Request.new("/#{ space_id }/assets", query)
         response = request.get
-        result = ResourceBuilder.new(self, response, {}, {})
+        result = ResourceBuilder.new(response, {}, {})
         result.run
       end
 
@@ -31,7 +31,7 @@ module Contentful
       def self.find(space_id, asset_id)
         request = Request.new("/#{ space_id }/assets/#{ asset_id }")
         response = request.get
-        result = ResourceBuilder.new(self, response, {}, {})
+        result = ResourceBuilder.new(response, {}, {})
         result.run
       end
 
@@ -39,6 +39,7 @@ module Contentful
       # Takes a space id and hash with attributes (title, description, file)
       # Returns a Contentful::Management::Asset.
       def self.create(space_id, attributes)
+        locale = attributes[:locale]
         asset = new
         asset.instance_variable_set(:@fields, attributes[:fields] || {})
         asset.locale = attributes[:locale] if attributes[:locale]
@@ -48,8 +49,9 @@ module Contentful
 
         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 = ResourceBuilder.new(response, {}, {}).run
         result.process_files if result.is_a? self
+        result.locale = locale if locale
         result
       end
 
@@ -72,7 +74,7 @@ module Contentful
         self.file = attributes[:file] if attributes[:file]
         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
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -95,7 +97,7 @@ module Contentful
         if response.status == :no_content
           return true
         else
-          result = ResourceBuilder.new(self, response, {}, {})
+          result = ResourceBuilder.new(response, {}, {})
           result.run
         end
       end
@@ -105,7 +107,7 @@ module Contentful
       def publish
         request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.put
-        result = ResourceBuilder.new(self, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -114,7 +116,7 @@ module Contentful
       def unpublish
         request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.delete
-        result = ResourceBuilder.new(self, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -123,7 +125,7 @@ module Contentful
       def archive
         request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.put
-        result = ResourceBuilder.new(self, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -132,7 +134,7 @@ module Contentful
       def unarchive
         request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.delete
-        result = ResourceBuilder.new(self, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 

data/lib/contentful/management/client.rb

@@ -90,7 +90,7 @@ module Contentful
 
       def get(request)
         execute_request(request) do |url|
-          self.class.get_http(url, {}, request_headers)
+          self.class.get_http(url, request.query, request_headers)
         end
       end
 

data/lib/contentful/management/content_type.rb

@@ -29,14 +29,14 @@ module Contentful
       property :fields, Field
 
       # Gets a collection of content types.
-      # Takes an id of space.
+      # 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)
-        request = Request.new("/#{ space_id }/content_types")
+      def self.all(space_id, query = {})
+        request = Request.new("/#{ space_id }/content_types", query)
         response = request.get
-        result = ResourceBuilder.new(self, response, {}, {})
+        result = ResourceBuilder.new(response, {}, {})
         content_types = result.run
-        Contentful::Management::Client.shared_instance.update_dynamic_entry_cache!(content_types)
+        client.update_dynamic_entry_cache!(content_types)
         content_types
       end
 
@@ -46,9 +46,9 @@ module Contentful
       def self.find(space_id, content_type_id)
         request = Request.new("/#{ space_id }/content_types/#{ content_type_id }")
         response = request.get
-        result = ResourceBuilder.new(self, response, {}, {})
+        result = ResourceBuilder.new(response, {}, {})
         content_type = result.run
-        Contentful::Management::Client.shared_instance.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type)) if content_type.is_a?(self)
+        client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type)) if content_type.is_a?(self)
         content_type
       end
 
@@ -60,7 +60,7 @@ module Contentful
         if response.status == :no_content
           return true
         else
-          result = ResourceBuilder.new(self, response, {}, {})
+          result = ResourceBuilder.new(response, {}, {})
           result.run
         end
       end
@@ -70,7 +70,7 @@ module Contentful
       def activate
         request = Request.new("/#{ space.id }/content_types/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.put
-        result = ResourceBuilder.new(self, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -80,7 +80,7 @@ module Contentful
       def deactivate
         request = Request.new("/#{ space.id }/content_types/#{ id }/published")
         response = request.delete
-        result = ResourceBuilder.new(self, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -95,12 +95,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(self, response, {}, {}).run
-        Contentful::Management::Client.shared_instance.register_dynamic_entry(result.id, DynamicEntry.create(result)) if result.is_a?(self.class)
+        result = ResourceBuilder.new(response, {}, {}).run
+        client.register_dynamic_entry(result.id, DynamicEntry.create(result)) if result.is_a?(self.class)
         result
       end
 
@@ -115,7 +115,7 @@ module Contentful
         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])
         response = request.put
-        result = ResourceBuilder.new(self, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -189,7 +189,7 @@ module Contentful
         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)
+            Contentful::Management::Entry.all(content_type.space.id, content_type: content_type.id)
           end
 
           define_singleton_method(:create) do |params|
@@ -197,7 +197,7 @@ module Contentful
           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 = content_type.client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
             dynamic_entry = dynamic_entry_class.new
             dynamic_entry.content_type = content_type
             dynamic_entry

data/lib/contentful/management/entry.rb

@@ -21,11 +21,9 @@ 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 = {})
-        path = "/#{ space_id }/entries"
-        path += "?content_type=#{parameters[:content_type_id]}" if parameters[:content_type_id]
-        request = Request.new(path)
+        request = Request.new("/#{ space_id }/entries", parameters)
         response = request.get
-        result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {})
+        result = ResourceBuilder.new(response, {}, {})
         result.run
       end
 
@@ -35,7 +33,7 @@ module Contentful
       def self.find(space_id, entry_id)
         request = Request.new("/#{ space_id }/entries/#{ entry_id }")
         response = request.get
-        result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {})
+        result = ResourceBuilder.new(response, {}, {})
         result.run
       end
 
@@ -44,6 +42,7 @@ module Contentful
       # Returns a Contentful::Management::Entry.
       def self.create(content_type, attributes)
         custom_id = attributes[:id] || ''
+        locale = attributes[:locale]
         fields_for_create = if attributes[:fields] #create from initialized dynamic entry via save
                               tmp_entry = new
                               tmp_entry.instance_variable_set(:@fields, attributes.delete(:fields) || {})
@@ -55,9 +54,11 @@ module Contentful
         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
-        result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {})
-        Contentful::Management::Client.shared_instance.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
-        result.run
+        result = ResourceBuilder.new(response, {}, {})
+        client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type))
+        entry = result.run
+        entry.locale = locale if locale
+        entry
       end
 
       # Updates an entry.
@@ -66,9 +67,9 @@ 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/#{ self.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
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -88,7 +89,7 @@ module Contentful
       def publish
         request = Request.new("/#{ space.id }/entries/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.put
-        result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -97,7 +98,7 @@ module Contentful
       def unpublish
         request = Request.new("/#{ space.id }/entries/#{ id }/published", {}, id = nil, version: sys[:version])
         response = request.delete
-        result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -106,7 +107,7 @@ module Contentful
       def archive
         request = Request.new("/#{ space.id }/entries/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.put
-        result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -115,7 +116,7 @@ module Contentful
       def unarchive
         request = Request.new("/#{ space.id }/entries/#{ id }/archived", {}, id = nil, version: sys[:version])
         response = request.delete
-        result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {}).run
+        result = ResourceBuilder.new(response, {}, {}).run
         refresh_data(result)
       end
 
@@ -127,7 +128,7 @@ module Contentful
         if response.status == :no_content
           return true
         else
-          result = ResourceBuilder.new(Contentful::Management::Client.shared_instance, response, {}, {})
+          result = ResourceBuilder.new(response, {}, {})
           result.run
         end
       end
@@ -173,11 +174,11 @@ 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 } } if attribute
+            {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
@@ -203,7 +204,7 @@ module Contentful
         if type == 'String'
           attributes
         else
-           attributes.each_with_object([]) do |attr, arr|
+          attributes.each_with_object([]) do |attr, arr|
             arr << case type
                      when /Entry/ then
                        {sys: {type: 'Link', linkType: 'Entry', id: attr.id}}
@@ -231,7 +232,7 @@ module Contentful
       end
 
       def self.fields_with_locale(content_type, attributes)
-        locale = content_type.sys[:space].default_locale
+        locale = attributes[:locale] || content_type.sys[:space].default_locale
         fields = content_type.properties[:fields]
         field_names = fields.map { |f| f.id.to_sym }
         attributes.keep_if { |key| field_names.include?(key) }

data/lib/contentful/management/locale.rb

@@ -21,7 +21,7 @@ module Contentful
       def self.all(space_id = nil)
         request = Request.new("/#{ space_id }/locales")
         response = request.get
-        result = ResourceBuilder.new(self, response, { 'Locale' => Locale }, {})
+        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         result.run
       end
 
@@ -31,7 +31,7 @@ module Contentful
       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 = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         result.run
       end
 
@@ -46,7 +46,7 @@ module Contentful
       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 = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         result.run
       end
 
@@ -56,7 +56,7 @@ module Contentful
       def update(attributes)
         request = Request.new("/#{ space.id }/locales/#{ id }", { 'name' => attributes.fetch(:name) }, id = nil, version: sys[:version])
         response = request.put
-        result = ResourceBuilder.new(self, response, { 'Locale' => Locale }, {})
+        result = ResourceBuilder.new(response, { 'Locale' => Locale }, {})
         refresh_data(result.run)
       end
     end