contentful-management 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,30 +1,35 @@
+### 0.2.0
+* Fix: create entry with multiple locales, skip attributes for not localized fields in content types
+* Fix: reload Assets
+* add optional gzip envoding
+
 ### 0.1.0
- * Support for webhooks
- * add image url to asset
- * Cleaning code
- * Fix: remove implicit processing of assets.
- * Fix: Gem is modifying nil #17
- * Fix: rename asset.process_files to asset.process
+* Support for webhooks
+* add image url to asset
+* Cleaning code
+* Fix: remove implicit processing of assets.
+* Fix: Gem is modifying nil #17
+* Fix: rename asset.process_files to asset.process
 
 
 ### 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
+* 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.
+* Fix: Convert an Entry to a DynamicEntry after being created.
 
 ### 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
+* 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
+* alpha pre-release

data/lib/contentful/management/client.rb

@@ -22,7 +22,8 @@ module Contentful
           api_url: 'api.contentful.com',
           api_version: '1',
           secure: true,
-          default_locale: 'en-US'
+          default_locale: 'en-US',
+          gzip_encoded: false
       }
 
       def initialize(access_token = nil, configuration = {})
@@ -59,6 +60,10 @@ module Contentful
         configuration[:api_version]
       end
 
+      def gzip_encoded
+        configuration[:gzip_encoded]
+      end
+
       def default_configuration
         DEFAULT_CONFIGURATION.dup
       end
@@ -145,6 +150,10 @@ module Contentful
         Hash['Content-Length', 0]
       end
 
+      def accept_encoding_header(encoding)
+        Hash['Accept-Encoding', encoding]
+      end
+
       # XXX: headers should be supplied differently, maybe through the request object.
       def request_headers
         headers = {}
@@ -155,6 +164,7 @@ module Contentful
         headers.merge! version_header(version) if version
         headers.merge! zero_length_header if zero_length
         headers.merge! content_type_header(content_type_id) if content_type_id
+        headers.merge! accept_encoding_header('gzip') if gzip_encoded
         headers
       end
 

data/lib/contentful/management/dynamic_entry.rb

@@ -39,12 +39,16 @@ module Contentful
               fields_for_query[field.id.to_sym]
             end
             define_method "#{ accessor_name }=" do |value|
-              fields[field.id.to_sym] = value
+              if field.localized || default_locale == locale
+                fields[field.id.to_sym] = value
+              end
             end
             define_method "#{ accessor_name }_with_locales=" do |values|
               values.each do |locale, value|
-                @fields[locale] = {} if @fields[locale].nil?
-                @fields[locale][field.id.to_sym] = value
+                if field.localized || default_locale == locale
+                  @fields[locale] = {} if @fields[locale].nil?
+                  @fields[locale][field.id.to_sym] = value
+                end
               end
             end
           end

data/lib/contentful/management/entry.rb

@@ -156,7 +156,7 @@ module Contentful
         fields_names.each_with_object({}) do |field_name, results|
           results[field_name] = raw_fields.each_with_object({}) do |(locale, fields), field_results|
             # field_results[locale] = fields[field_name]
-            field_results[locale] = parse_update_attribute(fields[field_name])
+            field_results[locale] = parse_update_attribute(fields[field_name]) unless fields[field_name].nil?
           end
         end
       end

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

@@ -16,7 +16,7 @@ module Contentful
             resource
           else
             @properties = resource.instance_variable_get(:@properties)
-            @fields = resource.instance_variable_get(:@fields) if self.is_a?(Contentful::Management::Entry)
+            @fields = resource.instance_variable_get(:@fields)
             @sys = resource.instance_variable_get(:@sys).merge(locale: locale)
             self
           end

data/lib/contentful/management/response.rb

@@ -51,7 +51,8 @@ module Contentful
       end
 
       def parse_json!
-        @object = MultiJson.load(raw.to_s)
+        body =  unzip_response(raw)
+        @object = MultiJson.load(body)
         true
       rescue MultiJson::LoadError => error
         @status = :unparsable_json
@@ -74,6 +75,16 @@ module Contentful
           @error_message = 'No contentful system properties found in object'
         end
       end
+
+      def unzip_response(response)
+        if response.headers['Content-Encoding'].eql?('gzip') then
+          sio = StringIO.new(response.to_s)
+          gz = Zlib::GzipReader.new(sio)
+          gz.read()
+        else
+          response.to_s
+        end
+      end
     end
   end
 end

data/lib/contentful/management/version.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 module Contentful
   module Management
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/spec/fixtures/vcr_cassettes/asset/reload_with_fields.yml

@@ -0,0 +1,235 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/bfsvtul0c41g/assets/8R4vbQXKbCkcSu26Wy2U0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContenfulManagementGem/0.0.2
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Content-Length:
+      - '0'
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 19 Aug 2014 10:10:30 GMT
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Content-Length:
+      - '1403'
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - Express
+      Cf-Space-Id:
+      - bfsvtul0c41g
+      Etag:
+      - '"2be36cc687cc0a25a0e36182b95f3ba7"'
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      "^access-Control-Expose-Headers":
+      - Etag
+      Access-Control-Max-Age:
+      - '1728000'
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "fields": {
+            "title": {
+              "en-US": "test"
+            },
+            "description": {
+              "en-US": "testowy"
+            },
+            "file": {
+              "en-US": {
+                "fileName": "Mowing_your_Lawn_-_Advice_and_Tips",
+                "contentType": "image/jpeg",
+                "details": {
+                  "image": {
+                    "width": 801,
+                    "height": 1000
+                  },
+                  "size": 105202
+                },
+                "url": "//images.contentful.com/bfsvtul0c41g/8R4vbQXKbCkcSu26Wy2U0/4ca4dabb0305045fa5c3c786bf5d7592/mow.jpg"
+              }
+            }
+          },
+          "sys": {
+            "id": "8R4vbQXKbCkcSu26Wy2U0",
+            "type": "Asset",
+            "createdAt": "2014-08-19T07:25:10.104Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            },
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "bfsvtul0c41g"
+              }
+            },
+            "firstPublishedAt": "2014-08-19T07:25:32.234Z",
+            "publishedCounter": 1,
+            "publishedAt": "2014-08-19T07:25:32.234Z",
+            "publishedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            },
+            "publishedVersion": 11,
+            "version": 14,
+            "updatedAt": "2014-08-19T10:09:26.237Z",
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            }
+          }
+        }
+    http_version: 
+  recorded_at: Tue, 19 Aug 2014 10:10:26 GMT
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/bfsvtul0c41g/assets/8R4vbQXKbCkcSu26Wy2U0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContenfulManagementGem/0.0.2
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Content-Length:
+      - '0'
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 19 Aug 2014 10:10:34 GMT
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Content-Length:
+      - '1403'
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - Express
+      Cf-Space-Id:
+      - bfsvtul0c41g
+      Etag:
+      - '"2be36cc687cc0a25a0e36182b95f3ba7"'
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      "^access-Control-Expose-Headers":
+      - Etag
+      Access-Control-Max-Age:
+      - '1728000'
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "fields": {
+            "title": {
+              "en-US": "test"
+            },
+            "description": {
+              "en-US": "testowy"
+            },
+            "file": {
+              "en-US": {
+                "fileName": "Mowing_your_Lawn_-_Advice_and_Tips",
+                "contentType": "image/jpeg",
+                "details": {
+                  "image": {
+                    "width": 801,
+                    "height": 1000
+                  },
+                  "size": 105202
+                },
+                "url": "//images.contentful.com/bfsvtul0c41g/8R4vbQXKbCkcSu26Wy2U0/4ca4dabb0305045fa5c3c786bf5d7592/mow.jpg"
+              }
+            }
+          },
+          "sys": {
+            "id": "8R4vbQXKbCkcSu26Wy2U0",
+            "type": "Asset",
+            "createdAt": "2014-08-19T07:25:10.104Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            },
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "bfsvtul0c41g"
+              }
+            },
+            "firstPublishedAt": "2014-08-19T07:25:32.234Z",
+            "publishedCounter": 1,
+            "publishedAt": "2014-08-19T07:25:32.234Z",
+            "publishedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            },
+            "publishedVersion": 11,
+            "version": 14,
+            "updatedAt": "2014-08-19T10:09:26.237Z",
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            }
+          }
+        }
+    http_version: 
+  recorded_at: Tue, 19 Aug 2014 10:10:30 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/vcr_cassettes/content_type/entry/create_only_with_localized_fields.yml

@@ -0,0 +1,217 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/v2umtz8ths9v/content_types/category_content_type
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContenfulManagementGem/0.1.0
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Content-Length:
+      - '0'
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      "^access-Control-Expose-Headers":
+      - Etag
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '1728000'
+      Cf-Space-Id:
+      - v2umtz8ths9v
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Date:
+      - Tue, 02 Sep 2014 08:15:34 GMT
+      Etag:
+      - '"391c3aafd988f750695ae5676d7130d6"'
+      Server:
+      - nginx
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '1254'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "displayField": "name",
+          "name": "Category",
+          "description": "",
+          "fields": [
+            {
+              "id": "name",
+              "name": "Name",
+              "type": "Text",
+              "localized": true,
+              "uiid": "3ic0t3qi51c"
+            },
+            {
+              "id": "description",
+              "name": "Description",
+              "type": "Text",
+              "localized": false,
+              "uiid": "38xiq8fobnk"
+            }
+          ],
+          "sys": {
+            "id": "category_content_type",
+            "type": "ContentType",
+            "createdAt": "2014-08-21T13:32:20.955Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            },
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "v2umtz8ths9v"
+              }
+            },
+            "firstPublishedAt": "2014-08-21T13:32:27.109Z",
+            "publishedCounter": 6,
+            "publishedAt": "2014-09-02T07:13:04.738Z",
+            "publishedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            },
+            "publishedVersion": 17,
+            "version": 18,
+            "updatedAt": "2014-09-02T07:13:04.749Z",
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            }
+          }
+        }
+    http_version: 
+  recorded_at: Tue, 02 Sep 2014 08:16:05 GMT
+- request:
+    method: post
+    uri: https://api.contentful.com/spaces/v2umtz8ths9v/entries/
+    body:
+      encoding: UTF-8
+      string: '{"fields":{"name":{"en-US":"Contentful EN","de-DE":"Contentful DE","pl-PL":"Contentful
+        PL"},"description":{"en-US":"Description EN"}}}'
+    headers:
+      User-Agent:
+      - RubyContenfulManagementGem/0.1.0
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      X-Contentful-Content-Type:
+      - category_content_type
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      "^access-Control-Expose-Headers":
+      - Etag
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '1728000'
+      Cf-Space-Id:
+      - v2umtz8ths9v
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Date:
+      - Tue, 02 Sep 2014 08:15:35 GMT
+      Etag:
+      - '"31fdedb609685a76a992f08ab55226a6"'
+      Server:
+      - nginx
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '932'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "fields": {
+            "name": {
+              "en-US": "Contentful EN",
+              "de-DE": "Contentful DE",
+              "pl-PL": "Contentful PL"
+            },
+            "description": {
+              "en-US": "Description EN"
+            }
+          },
+          "sys": {
+            "id": "3SxjTVeUF2AEKg6kQQS4MG",
+            "type": "Entry",
+            "version": 1,
+            "createdAt": "2014-09-02T08:15:35.205Z",
+            "createdBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            },
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "v2umtz8ths9v"
+              }
+            },
+            "contentType": {
+              "sys": {
+                "type": "Link",
+                "linkType": "ContentType",
+                "id": "category_content_type"
+              }
+            },
+            "updatedAt": "2014-09-02T08:15:35.205Z",
+            "updatedBy": {
+              "sys": {
+                "type": "Link",
+                "linkType": "User",
+                "id": "1E7acJL8I5XUXAMHQt9Grs"
+              }
+            }
+          }
+        }
+    http_version: 
+  recorded_at: Tue, 02 Sep 2014 08:16:06 GMT
+recorded_with: VCR 2.9.2