contentful 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca7aa5d86409ba09e10e10ad5056804799157b03
-  data.tar.gz: e8a7314fea96f4053656adaa1c88b1a0264f203d
+  metadata.gz: 7db63bec4505f15a7698a8a0a122429abbb5c06c
+  data.tar.gz: cd8c4030d47bfb4b63929e3dcf70f9cbb2326860
 SHA512:
-  metadata.gz: 2f36a0f4e0bdef6bc0740a697f6b055eb4df6846af106695daf7dc9f54f47b9cdf914ed4ea0a5037591804920a81202c616b358779ff45826edfef168ffed596
-  data.tar.gz: d019ae9b609ae364304b4057dabab58e736e3233c90ba2685e97ebbb39d371097d68fea725f8b485d5974519ec8ef6ff6a679ed765ac340e8d58c1e46aba95e4
+  metadata.gz: 1af685dcbe8e195a48c27d0c5c3ff7b4b3f4faed20dd636d899cec8c71e9c3f1790116fbb00bc65be89f917ee99806a87636458a1db1ffa3921d32fd710c9611
+  data.tar.gz: 55b018b32477efa92e8878f58ffb17bcf1eaa97618e4b3634f2e443f16eb7c39f11bd1cd5c5d9a9a00a901b69ca76bd058ab76a3dd2def95e51ff30b40694d99

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 # Change Log
+## Unreleased
+### 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)
+
+### Added
+* `focus` and `fit` to image handling parameters [#44](https://github.com/contentful/contentful.rb/pull/44)
+
 ## 0.4.0
 ### Added
 * Proxy support

data/README.md

@@ -24,6 +24,16 @@ client = Contentful::Client.new(
 )
 ```
 
+If you plan on using the [Preview API](https://www.contentful.com/developers/documentation/content-delivery-api/ruby/#preview-api-usage) you need to specify the `api_url`:
+
+```ruby
+client = Contentful::Client.new(
+  access_token: 'b4c0n73n7fu1',
+  space: 'cfexampleapi',
+  api_url: 'preview.contentful.com'
+)
+```
+
 You can query for entries, assets, etc. very similar as described in the
 [Delivery API Documentation](https://www.contentful.com/developers/documentation/content-delivery-api/). Please note, that **all methods of the Ruby client library are snake_cased, instead of JavaScript's camelCase**:
 

data/lib/contentful/asset.rb

@@ -18,10 +18,12 @@ module Contentful
     # 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]
+        w:   options[:w]  || options[:width],
+        h:   options[:h]  || options[:height],
+        fm:  options[:fm] || options[:format],
+        q:   options[:q]  || options[:quality],
+        f:   options[:f]  || options[:focus],
+        fit: options[:fit]
       }.reject { |_k, v| v.nil? }
 
       if query.empty?

data/lib/contentful/client.rb

@@ -12,24 +12,24 @@ module Contentful
   # See README for details
   class Client
     DEFAULT_CONFIGURATION = {
-        secure: true,
-        raise_errors: true,
-        dynamic_entries: :manual,
-        api_url: 'cdn.contentful.com',
-        api_version: 1,
-        authentication_mechanism: :header,
-        resource_builder: ResourceBuilder,
-        resource_mapping: {},
-        entry_mapping: {},
-        default_locale: 'en-US',
-        raw_mode: false,
-        gzip_encoded: false,
-        logger: false,
-        log_level: Logger::INFO,
-        proxy_host: nil,
-        proxy_username: nil,
-        proxy_password: nil,
-        proxy_port: nil
+      secure: true,
+      raise_errors: true,
+      dynamic_entries: :manual,
+      api_url: 'cdn.contentful.com',
+      api_version: 1,
+      authentication_mechanism: :header,
+      resource_builder: ResourceBuilder,
+      resource_mapping: {},
+      entry_mapping: {},
+      default_locale: 'en-US',
+      raw_mode: false,
+      gzip_encoded: false,
+      logger: false,
+      log_level: Logger::INFO,
+      proxy_host: nil,
+      proxy_username: nil,
+      proxy_password: nil,
+      proxy_port: nil
     }
 
     attr_reader :configuration, :dynamic_entry_cache, :logger, :proxy
@@ -63,10 +63,10 @@ module Contentful
 
     def proxy_params
       {
-          host: configuration[:proxy_host],
-          port: configuration[:proxy_port],
-          username: configuration[:proxy_username],
-          password: configuration[:proxy_password]
+        host: configuration[:proxy_host],
+        port: configuration[:proxy_port],
+        username: configuration[:proxy_username],
+        password: configuration[:proxy_password]
       }
     end
 
@@ -131,7 +131,7 @@ module Contentful
 
     # Returns the headers used for the HTTP requests
     def request_headers
-      headers = {'User-Agent' => "RubyContentfulGem/#{Contentful::VERSION}"}
+      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]
@@ -151,7 +151,7 @@ module Contentful
     # return Response objects instead
     def get(request, build_resource = true)
       url = request.absolute? ? request.url : base_url + request.url
-      logger.info(request: {url: url, query: request.query, header: request_headers}) if logger
+      logger.info(request: { url: url, query: request.query, header: request_headers }) if logger
       response = Response.new(
           self.class.get_http(
               url,
@@ -179,12 +179,12 @@ module Contentful
     # See README for details.
     def update_dynamic_entry_cache!
       @dynamic_entry_cache = Hash[
-          content_types(limit: 1000).map do |ct|
-            [
-                ct.id.to_sym,
-                DynamicEntry.create(ct)
-            ]
-          end
+                             content_types(limit: 1000).map do |ct|
+                               [
+                                 ct.id.to_sym,
+                                 DynamicEntry.create(ct)
+                               ]
+                             end
       ]
     end
 
@@ -197,7 +197,7 @@ module Contentful
     # Create a new synchronisation object
     # Takes sync options or a sync_url
     # You will need to call #each_page or #first_page on it
-    def sync(options = {initial: true})
+    def sync(options = { initial: true })
       Sync.new(self, options)
     end
 

data/lib/contentful/dynamic_entry.rb

@@ -21,9 +21,9 @@ module Contentful
       end
 
       fields_coercions = Hash[
-        content_type.fields.map do |field|
-          [field.id.to_sym, KNOWN_TYPES[field.type]]
-        end
+                         content_type.fields.map do |field|
+                           [field.id.to_sym, KNOWN_TYPES[field.type]]
+                         end
       ]
 
       Class.new DynamicEntry do

data/lib/contentful/error.rb

@@ -21,6 +21,8 @@ module Contentful
         AccessDenied
       when 401
         Unauthorized
+      when 429
+        RateLimitExceeded
       when 500
         ServerError
       when 503
@@ -43,6 +45,9 @@ module Contentful
   # 401
   class Unauthorized < Error; end
 
+  # 429
+  class RateLimitExceeded < Error; end
+
   # 500
   class ServerError < Error; end
 

data/lib/contentful/resource/asset_fields.rb

@@ -9,7 +9,7 @@ module Contentful
       FIELDS_COERCIONS = {
         title: :string,
         description: :string,
-        file: File,
+        file: File
       }
 
       def fields
@@ -39,11 +39,11 @@ module Contentful
       def self.included(base)
         base.extend(ClassMethods)
 
-        base.fields_coercions.keys.each{ |name|
+        base.fields_coercions.keys.each do |name|
           base.send :define_method, Contentful::Support.snakify(name) do
             fields[name.to_sym]
           end
-        }
+        end
       end
     end
   end

data/lib/contentful/resource/system_properties.rb

@@ -11,7 +11,7 @@ module Contentful
         revision: :integer,
         createdAt: :date,
         updatedAt: :date,
-        locale: :string,
+        locale: :string
       }
       attr_reader :sys
 
@@ -37,11 +37,11 @@ module Contentful
       def self.included(base)
         base.extend(ClassMethods)
 
-        base.sys_coercions.keys.each{ |name|
+        base.sys_coercions.keys.each do |name|
           base.send :define_method, Contentful::Support.snakify(name) do
             sys[name.to_sym]
           end
-        }
+        end
       end
     end
   end

data/lib/contentful/resource_builder.rb

@@ -12,7 +12,7 @@ require_relative 'deleted_asset'
 
 module Contentful
   # Transforms a Contentful::Response into a Contentful::Resource or a Contentful::Error
-  # See example/resource_mapping.rb for avanced usage
+  # See example/resource_mapping.rb for advanced usage
   class ResourceBuilder
     DEFAULT_RESOURCE_MAPPING = {
       'Space' => Space,
@@ -22,7 +22,7 @@ module Contentful
       'Array' => :array_or_sync_page,
       'Link' => Link,
       'DeletedEntry' => DeletedEntry,
-      'DeletedAsset' => DeletedAsset,
+      'DeletedAsset' => DeletedAsset
     }
     DEFAULT_ENTRY_MAPPING = {}
 
@@ -103,9 +103,9 @@ module Contentful
     # Returns the id of the related ContentType, if there is one
     def content_type_id_for_entry(object)
       object['sys'] &&
-      object['sys']['contentType'] &&
-      object['sys']['contentType']['sys'] &&
-      object['sys']['contentType']['sys']['id']
+        object['sys']['contentType'] &&
+        object['sys']['contentType']['sys'] &&
+        object['sys']['contentType']['sys']['id']
     end
 
     # Detects if a resource is an Contentful::Array or a SyncPage
@@ -163,9 +163,9 @@ module Contentful
       if object.is_a? Hash
         object.select do |_, v|
           v.is_a?(::Array) &&
-          v.first &&
-          v.first.is_a?(Hash) &&
-          v.first.key?('sys')
+            v.first &&
+            v.first.is_a?(Hash) &&
+            v.first.key?('sys')
         end
       else
         {}
@@ -196,10 +196,10 @@ module Contentful
       if included_objects
         included_objects.each do |type, objects|
           @included_resources[type] = Hash[
-            objects.map do |object|
-              res = create_resource(object)
-              [res.id, res]
-            end
+                                      objects.map do |object|
+                                        res = create_resource(object)
+                                        [res.id, res]
+                                      end
           ]
         end
       end

data/lib/contentful/response.rb

@@ -31,8 +31,10 @@ module Contentful
         parse_json!
       elsif no_content_response?
         @status = :no_content
-      elsif no_resource_or_bad_request?
+      elsif invalid_response?
         parse_contentful_error
+      elsif service_unavailable_response?
+        service_unavailable_error
       else
         parse_http_error
       end
@@ -54,12 +56,22 @@ module Contentful
       [200, 201].include?(raw.status)
     end
 
+    def service_unavailable_response?
+      @raw.status == 503
+    end
+
+    def service_unavailable_error
+      @status = :error
+      @error_message = 'Service Unavailable, contenful.com API seems to be down'
+      @object = Error[@raw.status].new(self)
+    end
+
     def parse_http_error
       @status = :error
       @object = Error[raw.status].new(self)
     end
 
-    def no_resource_or_bad_request?
+    def invalid_response?
       [400, 404].include?(raw.status)
     end
 

data/lib/contentful/version.rb

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

data/spec/array_spec.rb

@@ -63,7 +63,7 @@ describe Contentful::Array do
     end
 
     it 'will return false if #request not available' do
-      expect(Contentful::Array.new({}).reload).to be_false
+      expect(Contentful::Array.new({}).reload).to be_falsey
     end
   end
 end

data/spec/asset_spec.rb

@@ -54,9 +54,9 @@ describe Contentful::Asset do
     end
 
     it 'adds image options if given' do
-      url = asset.image_url(width: 100, format: 'jpg', quality: 50)
+      url = asset.image_url(width: 100, format: 'jpg', quality: 50, focus: 'top_right', fit: 'thumb')
       expect(url).to include asset.file.url
-      expect(url).to include '?w=100&fm=jpg&q=50'
+      expect(url).to include '?w=100&fm=jpg&q=50&f=top_right&fit=thumb'
     end
   end
 end

data/spec/error_class_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Contentful::Error do
-  let(:r) { Contentful::Response.new raw_fixture('not_found',404) }
+  let(:r) { Contentful::Response.new raw_fixture('not_found', 404) }
 
   describe '#response' do
     it 'returns the response the error has been initialized with' do
@@ -28,26 +28,31 @@ describe Contentful::Error do
   end
 
   describe '.[]' do
-    it 'returns NotFound error class for 404' do
-      expect(Contentful::Error[404]).to eq Contentful::NotFound
-    end
 
     it 'returns BadRequest error class for 400' do
       expect(Contentful::Error[400]).to eq Contentful::BadRequest
     end
 
+    it 'returns Unauthorized error class for 401' do
+      expect(Contentful::Error[401]).to eq Contentful::Unauthorized
+    end
+
     it 'returns AccessDenied error class for 403' do
       expect(Contentful::Error[403]).to eq Contentful::AccessDenied
     end
 
-    it 'returns Unauthorized error class for 401' do
-      expect(Contentful::Error[401]).to eq Contentful::Unauthorized
+    it 'returns NotFound error class for 404' do
+      expect(Contentful::Error[404]).to eq Contentful::NotFound
     end
 
     it 'returns ServerError error class for 500' do
       expect(Contentful::Error[500]).to eq Contentful::ServerError
     end
 
+    it 'returns ServiceUnavailable error class for 503' do
+      expect(Contentful::Error[503]).to eq Contentful::ServiceUnavailable
+    end
+
     it 'returns generic error class for any other value' do
       expect(Contentful::Error[nil]).to eq Contentful::Error
       expect(Contentful::Error[200]).to eq Contentful::Error

data/spec/error_requests_spec.rb

@@ -14,18 +14,33 @@ describe 'Error Requests' do
   end
 
   it 'will return 403 (AccessDenied) if ...' do
-    pending
+    skip
   end
 
   it 'will return 401 (Unauthorized) if wrong credentials given' do
     client = Contentful::Client.new(space: 'wrong', access_token: 'credentials')
 
     expect_vcr('unauthorized'){
-      client.entry 'nyancat'
+      client.entry('nyancat')
     }.to raise_error(Contentful::Unauthorized)
   end
 
   it 'will return 500 (ServerError) if ...' do
-    pending
+    skip
+  end
+
+  it 'will return a 429 if the ratelimit is hit' 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
+    client = Contentful::Client.new(space: 'wrong', access_token: 'credentials')
+
+    expect_vcr('unavailable'){
+      client.entry('nyancat')
+    }.to raise_error(Contentful::ServiceUnavailable)
   end
 end

data/spec/field_spec.rb

@@ -26,11 +26,11 @@ describe Contentful::Field do
     end
 
     it 'has #required' do
-      expect(field.required).to be_true
+      expect(field.required).to be_truthy
     end
 
     it 'has #localized' do
-      expect(field.required).to be_true
+      expect(field.required).to be_truthy
     end
   end
 end

data/spec/fixtures/vcr_cassettes/ratelimit.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/wrong/entries/nyancat
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulGem/0.1.1
+      Authorization:
+      - Bearer credentials
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Host:
+      - cdn.contentful.com
+  response:
+    status:
+      code: 429
+      message: ServiceUnavailable
+    headers:
+      Date:
+      - Wed, 16 Apr 2014 09:00:24 GMT
+      Server:
+      - nginx/1.1.19
+      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:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '86400'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Content-Length:
+      - '179'
+      Accept-Ranges:
+      - bytes
+      Via:
+      - 1.1 varnish
+      X-Served-By:
+      - cache-am72-AMS
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "sys": {
+            "type": "Error",
+            "id": "RateLimitExceeded"
+          },
+          "message": "Ratelimit Exceeded",
+          "requestId": "85f-649640521"
+        }
+    http_version:
+  recorded_at: Wed, 16 Apr 2014 09:00:24 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/unavailable.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/wrong/entries/nyancat
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulGem/0.1.1
+      Authorization:
+      - Bearer credentials
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Host:
+      - cdn.contentful.com
+  response:
+    status:
+      code: 503
+      message: ServiceUnavailable
+    headers:
+      Date:
+      - Wed, 16 Apr 2014 09:00:24 GMT
+      Server:
+      - nginx/1.1.19
+      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:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '86400'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Content-Length:
+      - '179'
+      Accept-Ranges:
+      - bytes
+      Via:
+      - 1.1 varnish
+      X-Served-By:
+      - cache-am72-AMS
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "sys": {
+            "type": "Error",
+            "id": "ServiceUnavailable"
+          },
+          "message": "Service Unavailable, contenful.com API seems to be down",
+          "requestId": "85f-649640521"
+        }
+    http_version: 
+  recorded_at: Wed, 16 Apr 2014 09:00:24 GMT
+recorded_with: VCR 2.9.0

data/spec/resource_spec.rb

@@ -46,7 +46,7 @@ describe Contentful::Resource do
     end
 
     it 'will return false if #request not available' do
-      expect(Contentful::ContentType.new({}).reload).to be_false
+      expect(Contentful::ContentType.new({}).reload).to be_falsey
     end
   end
 end

data/spec/sync_page_spec.rb

@@ -82,21 +82,21 @@ describe Contentful::SyncPage do
 
   describe '#next_page?' do
     it 'will return true if there is a next page' do
-      expect(page_with_more.next_page?).to be_true
+      expect(page_with_more.next_page?).to be_truthy
     end
 
     it 'will return false if last page' do
-      expect(page.next_page?).to be_false
+      expect(page.next_page?).to be_falsey
     end
   end
 
   describe '#last_page?' do
     it 'will return true if no more pages available' do
-      expect(page.last_page?).to be_true
+      expect(page.last_page?).to be_truthy
     end
 
     it 'will return false if more pages available' do
-      expect(page_with_more.last_page?).to be_false
+      expect(page_with_more.last_page?).to be_falsey
     end
   end
 

data/spec/sync_spec.rb

@@ -63,11 +63,11 @@ describe Contentful::Sync do
 
   describe '#completed?' do
     it 'will return true if no more pages to request in the current sync' do
-      expect(first_page.next_sync_url).to be_false
+      expect(first_page.next_sync_url).to be_falsey
     end
 
     it 'will return true if not all pages requested, yet' do
-      expect(last_page.next_sync_url).to be_true
+      expect(last_page.next_sync_url).to be_truthy
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -234,6 +234,7 @@ files:
 - spec/fixtures/vcr_cassettes/location.yml
 - spec/fixtures/vcr_cassettes/not_found.yml
 - spec/fixtures/vcr_cassettes/nyancat.yml
+- spec/fixtures/vcr_cassettes/ratelimit.yml
 - spec/fixtures/vcr_cassettes/reloaded_entry.yml
 - spec/fixtures/vcr_cassettes/space.yml
 - spec/fixtures/vcr_cassettes/sync_deleted_asset.yml
@@ -242,6 +243,7 @@ files:
 - spec/fixtures/vcr_cassettes/sync_page.yml
 - spec/fixtures/vcr_cassettes/sync_page_2.yml
 - spec/fixtures/vcr_cassettes/unauthorized.yml
+- spec/fixtures/vcr_cassettes/unavailable.yml
 - spec/link_spec.rb
 - spec/locale_spec.rb
 - spec/location_spec.rb
@@ -318,6 +320,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/location.yml
 - spec/fixtures/vcr_cassettes/not_found.yml
 - spec/fixtures/vcr_cassettes/nyancat.yml
+- spec/fixtures/vcr_cassettes/ratelimit.yml
 - spec/fixtures/vcr_cassettes/reloaded_entry.yml
 - spec/fixtures/vcr_cassettes/space.yml
 - spec/fixtures/vcr_cassettes/sync_deleted_asset.yml
@@ -326,6 +329,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/sync_page.yml
 - spec/fixtures/vcr_cassettes/sync_page_2.yml
 - spec/fixtures/vcr_cassettes/unauthorized.yml
+- spec/fixtures/vcr_cassettes/unavailable.yml
 - spec/link_spec.rb
 - spec/locale_spec.rb
 - spec/location_spec.rb