contentful 0.3.3 → 0.3.4

data/.gitignore

@@ -1,3 +1,5 @@
 pkg
 coverage
 Gemfile.lock
+.idea
+*.DS_Store

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.3.4
+* add optional gzip compression
+
+### 0.3.3
+* Fix: handle 503 errors from the api
+
 ### 0.3.2
 * add default property to locale, #23
 

data/README.md

@@ -13,6 +13,8 @@ Add to your Gemfile and bundle:
 gem 'contentful'
 ```
 
+
+
 ## Usage
 
 ```ruby
@@ -166,6 +168,9 @@ Defaults to `false`. If enabled, the API responses will not be parsed to resourc
 
 See next paragraph for explanation
 
+### :gzip_encoded
+
+Enables gzip response content encoding, default to: true
 
 ## Advanced Usage
 ### Custom Resource Classes
@@ -262,6 +267,11 @@ first_entry = client.sync(initial: true, type: 'Entry').first_page.items.first
 first_entry.fields('de-DE') # Returns German localizations
 ```
 
+## Ratelimit
+The library does not make assumptions on the rate limit but reacts to `HTTP 429` by returning an error object.
+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.
+
+
 ## License
 
 Copyright (c) 2014 Contentful GmbH - Jan Lelis. See LICENSE.txt for further details.

data/contentful.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.summary       = 'contentful'
   gem.description   = 'Ruby client for the https://www.contentful.com Content Delivery API'
   gem.license       = "MIT"
-  gem.authors       = ["Contentful GmbH (Jan Lelis)"]
+  gem.authors       = ["Contentful GmbH (Jan Lelis)",'Contentful GmbH (Andreas Tiefenthaler)']
   gem.email         = "rubygems@contentful.com"
   gem.homepage      = "https://github.com/contentful/contentful.rb"
 

data/lib/contentful/client.rb

@@ -21,7 +21,8 @@ module Contentful
       resource_mapping: {},
       entry_mapping: {},
       default_locale: 'en-US',
-      raw_mode: false
+      raw_mode: false,
+      gzip_encoded: false
     }
 
     attr_reader :configuration, :dynamic_entry_cache
@@ -107,7 +108,7 @@ module Contentful
       headers = { 'User-Agent' => "RubyContentfulGem/#{Contentful::VERSION}" }
       headers['Authorization'] = "Bearer #{configuration[:access_token]}" if configuration[:authentication_mechanism] == :header
       headers['Content-Type']  = "application/vnd.contentful.delivery.v#{configuration[:api_version].to_i}+json" if configuration[:api_version]
-
+      headers['Accept-Encoding'] = 'gzip' if configuration[:gzip_encoded]
       headers
     end
 

data/lib/contentful/response.rb

@@ -23,9 +23,9 @@ module Contentful
     attr_reader :raw, :object, :status, :error_message, :request
 
     def initialize(raw, request = nil)
-      @raw     = raw
+      @raw = raw
       @request = request
-      @status  = :ok
+      @status = :ok
 
       if service_unavailable_response?
         @status = :service_unavailable
@@ -49,7 +49,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 => e
       @status = :unparsable_json
@@ -73,5 +74,15 @@ module Contentful
       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

data/lib/contentful/version.rb

@@ -1,3 +1,3 @@
 module Contentful
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/spec/support/json_responses.rb

@@ -3,6 +3,7 @@ require 'multi_json'
 def raw_fixture(which,status = 200, as_json = false)
   object = Object.new
   stub(object).status { status }
+  stub(object).headers { {} }
   stub(object).to_s { File.read File.dirname(__FILE__) + "/../fixtures/json_responses/#{which}.json" }
 
   object

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
+- Contentful GmbH (Andreas Tiefenthaler)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -288,7 +289,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1847885584219532891
+      hash: 3440490191583500455
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -297,10 +298,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1847885584219532891
+      hash: 3440490191583500455
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: contentful