contentful 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7db63bec4505f15a7698a8a0a122429abbb5c06c
-  data.tar.gz: cd8c4030d47bfb4b63929e3dcf70f9cbb2326860
+  metadata.gz: 8ed4d3309966895ce684008c996e75049713e264
+  data.tar.gz: 40123f61c8a46803a3c4ad2e880c4d5aeb7dcffc
 SHA512:
-  metadata.gz: 1af685dcbe8e195a48c27d0c5c3ff7b4b3f4faed20dd636d899cec8c71e9c3f1790116fbb00bc65be89f917ee99806a87636458a1db1ffa3921d32fd710c9611
-  data.tar.gz: 55b018b32477efa92e8878f58ffb17bcf1eaa97618e4b3634f2e443f16eb7c39f11bd1cd5c5d9a9a00a901b69ca76bd058ab76a3dd2def95e51ff30b40694d99
+  metadata.gz: 176f36cc905b504589f0a382435a441b1138fe7d91dc96c867fd512b54470bbf8da95d5e2a9b9c5d5f08f3a26b3d27571c2dec5ca10be38afef61cbf2aedd215
+  data.tar.gz: 89203b3ace82cc92b9e6b3f6d689b100e433c82a0b50ebc7b2713e05c0197c331b3dd35ff250be58c444f25d408fd53f5a44dd9167d18783dbff61ea88a2279a

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
+  - 2.2.1
   - 2.1.2
   - 2.1.1
   - 2.1
   - 2.0.0
   - 1.9.3
-#  - jruby-19mode

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # Change Log
 ## Unreleased
+
+## 0.6.0
+### Fixed
+* Parse nested locales in `AssetFields` [#66](https://github.com/contentful/contentful.rb/pull/66)
+
+### Other
+* Update http.rb dependency to v0.8.0
+* Fix typo in service unavailable error message [#61](https://github.com/contentful/contentful.rb/pull/61)
+* Enable gzip encoding by default [#62](https://github.com/contentful/contentful.rb/pull/62)
+
+## 0.5.0
 ### Fixed
-* Better handling of 503 responses from the API [#48](https://github.com/contentful/contentful-management.rb/pull/48)
-* Better handling of 429 responses from the API [#51](https://github.com/contentful/contentful-management.rb/pull/51)
+* Better handling of 503 responses from the API [#50](https://github.com/contentful/contentful.rb/pull/50)
+* Better handling of 429 responses from the API [#51](https://github.com/contentful/contentful.rb/pull/51)
 
 ### Added
 * `focus` and `fit` to image handling parameters [#44](https://github.com/contentful/contentful.rb/pull/44)

data/README.md

@@ -45,8 +45,10 @@ client.entry 'nyancat'
 You can pass the usual filter options to the query:
 
 ```ruby
+client.entries(content_type: 'cat') # query for a content-type by its ID (not name)
 client.entries('sys.id[ne]' => 'nyancat') # query for all entries except 'nyancat'
 client.entries(include: 1) # include one level of linked resources
+client.entries(content_type: 'cat', include: 1) # you can also combine multiple parameters
 ```
 
 The results are returned as Contentful::Resource objects. Multiple results will be returned as Contentful::Array. The properties of a resource can be accessed through Ruby methods.
@@ -326,10 +328,17 @@ first_entry.fields('de-DE') # Returns German localizations
 ```
 
 ## Rate-limit
-The library does not make assumptions on the rate limit but reacts to `HTTP 429` by returning an error object.
+The library does not make assumptions on the rate limit but reacts to `HTTP 429` by raising or returning an error (see [Client Configuration Options](#client-configuration-options)).
 You should handle this within your code and either do the delay calculation naive (fixed amount of seconds) or more elaborated (exponential increase) depending by the structure of your code.
 
 
+## Workarounds
+
+- When an entry has related entries that are unpublished, they still end up in the resource as unresolved links. We consider this correct, because it is in line with the API responses and our other SDKs. However, you can use the workaround from [issue #60](/../../issues/60) if you happen to want this working differently.
+
+- While this library doesn't directly allow parsing Contentful webhook responses, you can check out [this code snippet](https://gist.github.com/neonichu/17a987aeeb256d4bf6f3) for a way to do it.
+
+
 ## License
 
 Copyright (c) 2014 Contentful GmbH - Jan Lelis. See LICENSE.txt for further details.

data/contentful.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'http', '~> 0.6'
+  gem.add_dependency 'http', '~> 0.8'
   gem.add_dependency 'multi_json', '~> 1'
 
   gem.add_development_dependency 'bundler', '~> 1.5'

data/lib/contentful/client.rb

@@ -23,7 +23,7 @@ module Contentful
       entry_mapping: {},
       default_locale: 'en-US',
       raw_mode: false,
-      gzip_encoded: false,
+      gzip_encoded: true,
       logger: false,
       log_level: Logger::INFO,
       proxy_host: nil,

data/lib/contentful/resource.rb

@@ -69,6 +69,23 @@ module Contentful
 
     private
 
+    def initialize_fields_for_localized_resource(object)
+      @fields = {}
+
+      if nested_locale_fields?
+        object['fields'].each do |field_name, nested_child_object|
+          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
+            )
+          end
+        end
+      else
+        @fields[locale] = extract_from_object object['fields'], :fields
+      end
+    end
+
     def extract_from_object(object, namespace, keys = nil)
       if object
         keys ||= object.keys

data/lib/contentful/resource/asset_fields.rb

@@ -12,14 +12,15 @@ module Contentful
         file: File
       }
 
-      def fields
-        @fields[locale]
+      # Returns all fields of the asset
+      def fields(wanted_locale = default_locale)
+        @fields[locale || wanted_locale]
       end
 
       def initialize(object, *)
         super
-        @fields = {}
-        @fields[locale] = extract_from_object object['fields'], :fields
+
+        initialize_fields_for_localized_resource(object)
       end
 
       def inspect(info = nil)

data/lib/contentful/resource/fields.rb

@@ -26,20 +26,7 @@ module Contentful
       private
 
       def extract_fields_from_object!(object)
-        @fields = {}
-
-        if nested_locale_fields?
-          object['fields'].each do |field_name, nested_child_object|
-            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
-              )
-            end
-          end
-        else
-          @fields[locale] = extract_from_object object['fields'], :fields
-        end
+        initialize_fields_for_localized_resource(object)
       end
 
       module ClassMethods

data/lib/contentful/response.rb

@@ -62,7 +62,7 @@ module Contentful
 
     def service_unavailable_error
       @status = :error
-      @error_message = 'Service Unavailable, contenful.com API seems to be down'
+      @error_message = 'Service unavailable, contentful.com API seems to be down (503)'
       @object = Error[@raw.status].new(self)
     end
 

data/lib/contentful/version.rb

@@ -1,3 +1,3 @@
 module Contentful
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/error_requests_spec.rb

@@ -17,7 +17,7 @@ describe 'Error Requests' do
     skip
   end
 
-  it 'will return 401 (Unauthorized) if wrong credentials given' do
+  it 'will return 401 (Unauthorized) if wrong credentials are given' do
     client = Contentful::Client.new(space: 'wrong', access_token: 'credentials')
 
     expect_vcr('unauthorized'){
@@ -29,14 +29,14 @@ describe 'Error Requests' do
     skip
   end
 
-  it 'will return a 429 if the ratelimit is hit' do
+  it 'will return a 429 if the ratelimit is reached' do
     client = Contentful::Client.new(space: 'wrong', access_token: 'credentials')
     expect_vcr('ratelimit') {
       client.entry('nyancat')
     }.to raise_error(Contentful::RateLimitExceeded)
   end
 
-  it 'will return 503 (ServiceUnavailable) if connection time out' do
+  it 'will return 503 (ServiceUnavailable) when the service is unavailable' do
     client = Contentful::Client.new(space: 'wrong', access_token: 'credentials')
 
     expect_vcr('unavailable'){

data/spec/sync_spec.rb

@@ -81,4 +81,20 @@ describe Contentful::Sync do
       }}
     end
   end
+
+  describe 'Resource parsing' do
+    it 'will correctly parse the `file` field of an asset' do
+      sync = create_client.sync(initial: true)
+      vcr('sync_page') {
+        asset = sync.first_page.items.select { |item| item.is_a?(Contentful::Asset) }.first
+
+        expect(asset.file.properties[:fileName]).to eq 'doge.jpg'
+        expect(asset.file.properties[:contentType]).to eq 'image/jpeg'
+        expect(asset.file.properties[:details]['image']['width']).to eq 5800
+        expect(asset.file.properties[:details]['image']['height']).to eq 4350
+        expect(asset.file.properties[:details]['size']).to eq 522943
+        expect(asset.file.properties[:url]).to eq '//images.contentful.com/cfexampleapi/1x0xpXu4pSGS4OukSyWGUK/cc1239c6385428ef26f4180190532818/doge.jpg'
+      }
+    end
+  end
 end

metadata

@@ -1,130 +1,129 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
 - Contentful GmbH (Andreas Tiefenthaler)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
+        version: '0.8'
+  name: http
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-  type: :runtime
+  name: multi_json
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-  type: :development
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
-  name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-  type: :development
+  name: rubygems-tasks
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rr
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: vcr
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -133,8 +132,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.17.3
-  type: :development
+  name: webmock
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -262,7 +262,7 @@ homepage: https://github.com/contentful/contentful.rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -277,9 +277,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
 specification_version: 4
 summary: contentful
 test_files: