contentful 2.14.0 → 2.15.4

data/lib/contentful/array.rb

@@ -11,13 +11,15 @@ module Contentful
 
     include Contentful::ArrayLike
 
-    attr_reader :total, :limit, :skip, :items, :endpoint
+    attr_reader :total, :limit, :skip, :items, :endpoint, :query
 
     def initialize(item = nil,
                    configuration = {
                      default_locale: Contentful::Client::DEFAULT_CONFIGURATION[:default_locale]
                    },
-                   endpoint = '', *)
+                   endpoint = '',
+                   query = {},
+                   *)
       super(item, configuration)
 
       @endpoint = endpoint
@@ -25,11 +27,12 @@ module Contentful
       @limit = item.fetch('limit', nil)
       @skip = item.fetch('skip', nil)
       @items = item.fetch('items', [])
+      @query = query
     end
 
     # @private
     def marshal_dump
-      super.merge(endpoint: endpoint)
+      super.merge(endpoint: endpoint, query: query)
     end
 
     # @private
@@ -39,6 +42,7 @@ module Contentful
       @total = raw.fetch('total', nil)
       @limit = raw.fetch('limit', nil)
       @skip = raw.fetch('skip', nil)
+      @query = raw_object[:query]
       @items = raw.fetch('items', []).map do |item|
         require_relative 'resource_builder'
         ResourceBuilder.new(
@@ -72,7 +76,8 @@ module Contentful
         'Asset' => 'assets',
         'Locale' => 'locales'
       }
-      client.public_send(plurals[items.first.type], limit: limit, skip: new_skip)
+
+      client.public_send(plurals[items.first.type], query.merge(limit: limit, skip: new_skip))
     end
   end
 end

data/lib/contentful/array_like.rb

@@ -37,8 +37,8 @@ module Contentful
     # Delegates to items#[]
     #
     # @return [Contentful::Entry, Contentful::Asset]
-    def [](index)
-      items[index]
+    def [](*args)
+      items[*args]
     end
 
     # Delegates to items#last

data/lib/contentful/asset.rb

@@ -10,10 +10,7 @@ module Contentful
 
     # @private
     def marshal_dump
-      {
-        configuration: @configuration,
-        raw: raw
-      }
+      super.merge(raw: raw)
     end
 
     # @private
@@ -23,6 +20,11 @@ module Contentful
       define_asset_methods!
     end
 
+    # @private
+    def known_link?(*)
+      false
+    end
+
     # @private
     def inspect
       "<#{repr_name} id='#{sys[:id]}' url='#{url}'>"
@@ -91,6 +93,10 @@ module Contentful
     end
 
     def define_asset_methods!
+      define_singleton_method :title do
+        fields.fetch(:title, nil)
+      end
+
       define_singleton_method :description do
         fields.fetch(:description, nil)
       end

data/lib/contentful/base_resource.rb

@@ -31,14 +31,28 @@ module Contentful
 
     # @private
     def marshal_dump
+      entry_mapping = @configuration[:entry_mapping].each_with_object({}) do |(k, v), res|
+        res[k] = v.to_s
+      end
+
       {
-        configuration: @configuration,
+        # loggers usually have a file handle that can't be marshalled, so let's not return that
+        configuration: @configuration.merge(entry_mapping: entry_mapping, logger: nil),
         raw: raw
       }
     end
 
     # @private
     def marshal_load(raw_object)
+      raw_object[:configuration][:entry_mapping] = raw_object[:configuration].fetch(:entry_mapping, {}).each_with_object({}) do |(k, v), res|
+        begin
+          v = v.to_s unless v.is_a?(::String)
+          res[k] = v.split('::').inject(Object) { |o, c| o.const_get c }
+        rescue
+          next
+        end
+      end
+
       @raw = raw_object[:raw]
       @configuration = raw_object[:configuration]
       @default_locale = @configuration[:default_locale]

data/lib/contentful/client.rb

@@ -30,7 +30,6 @@ module Contentful
       raw_mode: false,
       gzip_encoded: true,
       logger: false,
-      log_level: Logger::INFO,
       proxy_host: nil,
       proxy_username: nil,
       proxy_password: nil,
@@ -105,7 +104,7 @@ module Contentful
     # @private
     def setup_logger
       @logger = configuration[:logger]
-      logger.level = configuration[:log_level] if logger
+      logger.level = configuration[:log_level] if logger && configuration.key?(:log_level)
     end
 
     # @private
@@ -386,7 +385,9 @@ module Contentful
         response.object,
         configuration.merge(endpoint: response.request.endpoint),
         (response.request.query || {}).fetch(:locale, nil) == '*',
-        0
+        0,
+        [],
+        response.request.query || {}
       ).run
     end
 

data/lib/contentful/entry.rb

@@ -17,7 +17,8 @@ module Contentful
     private
 
     def coerce(field_id, value, includes, errors, entries = {})
-      if Support.link?(value) && !Support.unresolvable?(value, errors)
+      if Support.link?(value)
+        return nil if Support.unresolvable?(value, errors)
         return build_nested_resource(value, includes, entries, errors)
       end
       return coerce_link_array(value, includes, errors, entries) if Support.link_array?(value)

data/lib/contentful/fields_resource.rb

@@ -48,11 +48,7 @@ module Contentful
 
     # @private
     def marshal_dump
-      {
-        configuration: @configuration,
-        raw: raw_with_links,
-        localized: localized
-      }
+      super.merge(raw: raw_with_links, localized: localized)
     end
 
     # @private

data/lib/contentful/request.rb

@@ -13,7 +13,12 @@ module Contentful
 
       if id
         @type = :single
-        @id = URI.escape(id)
+        # Given the deprecation of `URI::escape` and `URI::encode`
+        # it is needed to replace it with `URI::encode_www_form_component`.
+        # This method, does replace spaces with `+` instead of `%20`.
+        # Therefore, to keep backwards compatibility, we're replacing the resulting `+`
+        # back with `%20`.
+        @id = URI.encode_www_form_component(id).gsub('+', '%20')
       else
         @type = :multi
         @id = nil

data/lib/contentful/resource_builder.rb

@@ -32,9 +32,9 @@ module Contentful
     # Buildable Resources
     BUILDABLES = %w[Entry Asset ContentType Space DeletedEntry DeletedAsset Locale].freeze
 
-    attr_reader :json, :default_locale, :endpoint, :depth, :localized, :resource_mapping, :entry_mapping, :resource
+    attr_reader :json, :default_locale, :endpoint, :depth, :localized, :resource_mapping, :entry_mapping, :resource, :query
 
-    def initialize(json, configuration = {}, localized = false, depth = 0, errors = [])
+    def initialize(json, configuration = {}, localized = false, depth = 0, errors = [], query = {})
       @json = json
       @default_locale = configuration.fetch(:default_locale, ::Contentful::Client::DEFAULT_CONFIGURATION[:default_locale])
       @resource_mapping = default_resource_mapping.merge(configuration.fetch(:resource_mapping, {}))
@@ -46,6 +46,7 @@ module Contentful
       @configuration = configuration
       @resource_cache = configuration[:_entries_cache] || {}
       @errors = errors
+      @query = query
     end
 
     # Starts the parsing process.
@@ -69,7 +70,7 @@ module Contentful
         build_item(item, includes, errors)
       end
       array_class = fetch_array_class
-      array_class.new(json.merge('items' => result), @configuration, endpoint)
+      array_class.new(json.merge('items' => result), @configuration, endpoint, query)
     end
 
     def build_single

data/lib/contentful/version.rb

@@ -1,5 +1,5 @@
 # Contentful Namespace
 module Contentful
   # Gem Version
-  VERSION = '2.14.0'
+  VERSION = '2.15.4'
 end

data/spec/array_spec.rb

@@ -36,6 +36,16 @@ describe Contentful::Array do
     end
   end
 
+  describe '#[]' do
+    it 'provides access to items by index' do
+      expect(array[0]).to be_a Contentful::BaseResource
+    end
+
+    it 'provides access to items by two indices' do
+      expect(array[0, 4]).to eq array.items
+    end
+  end
+
   describe '#each' do
     it 'is an Enumerator' do
       expect(array.each).to be_a Enumerator
@@ -63,6 +73,25 @@ describe Contentful::Array do
     it 'will return false if #request not available' do
       expect(Contentful::Array.new({}).reload).to be_falsey
     end
+
+    it 'respects query parameters' do
+      array_page_1 = vcr('query_array_1') { client.entries(content_type: 'cat', limit: 1) }
+      array_page_2 = vcr('query_array_2') { array_page_1.next_page(client) }
+
+      expect(array_page_1).to be_a Contentful::Array
+      expect(array_page_2).to be_a Contentful::Array
+
+      expect(array_page_1.query).to include(content_type: 'cat')
+      expect(array_page_2.query).to include(content_type: 'cat')
+
+      expect(array_page_1.size).to eq 1
+      expect(array_page_2.size).to eq 1
+
+      expect(array_page_1[0].content_type.id).to eq 'cat'
+      expect(array_page_2[0].content_type.id).to eq 'cat'
+
+      expect(array_page_1[0].id).not_to eq array_page_2[0].id
+    end
   end
 
   describe 'marshalling' do

data/spec/client_class_spec.rb

@@ -28,7 +28,7 @@ describe Contentful::Client do
     end
 
     it 'uses Request#query' do
-      expect(request).to receive(:query).twice.and_call_original
+      expect(request).to receive(:query).thrice.and_call_original
       vcr('content_type') { client.get(request) }
     end
 

data/spec/client_configuration_spec.rb

@@ -48,6 +48,23 @@ describe 'Client Configuration Options' do
     end
   end
 
+  describe ':log_level' do
+
+    let(:logger) { Logger.new(STDOUT) }
+
+    it 'changes the level of the logger instance when given' do
+      expect do
+        create_client(logger: logger, log_level: ::Logger::WARN)
+      end.to change { logger.level }.from(::Logger::DEBUG).to(::Logger::WARN)
+    end
+
+    it 'does not change the level of the logger instance when not given' do
+      expect do
+        create_client(logger: logger)
+      end.not_to change { logger.level }
+    end
+  end
+
   describe ':dynamic_entries' do
     before :each do
       Contentful::ContentTypeCache.clear!

data/spec/entry_spec.rb

@@ -160,6 +160,7 @@ describe Contentful::Entry do
   describe 'can be marshalled' do
     def test_dump(nyancat)
       dump = Marshal.dump(nyancat)
+      yield if block_given?
       new_cat = Marshal.load(dump)
 
       # Attributes
@@ -184,6 +185,14 @@ describe Contentful::Entry do
       expect(new_cat.image.file.url).to eq "//images.contentful.com/cfexampleapi/4gp6taAwW4CmSgumq2ekUm/9da0cd1936871b8d72343e895a00d611/Nyan_cat_250px_frame.png"
     end
 
+    it 'marshals properly when entry_mapping changed' do
+      vcr('entry/marshall') {
+        class TestEntryMapping; end
+        nyancat = create_client(gzip_encoded: false, max_include_resolution_depth: 2, entry_mapping: { 'irrelevant_model' => TestEntryMapping }).entries(include: 2, 'sys.id' => 'nyancat').first
+        test_dump(nyancat) { Object.send(:remove_const, :TestEntryMapping) }
+      }
+    end
+
     it 'marshals properly' do
       vcr('entry/marshall') {
         nyancat = create_client(gzip_encoded: false, max_include_resolution_depth: 2).entries(include: 2, 'sys.id' => 'nyancat').first
@@ -191,6 +200,16 @@ describe Contentful::Entry do
       }
     end
 
+    it 'marshals with a logger set but keeps the instance' do
+      logger = Logger.new(IO::NULL)
+      vcr('entry/marshall') {
+        nyancat = create_client(gzip_encoded: false, max_include_resolution_depth: 2, logger: logger).entries(include: 2, 'sys.id' => 'nyancat').first
+        expect(nyancat.instance_variable_get(:@configuration)[:logger]).to eq(logger)
+        test_dump(nyancat)
+        expect(nyancat.instance_variable_get(:@configuration)[:logger]).to eq(logger)
+      }
+    end
+
     it 'can remarshall an unmarshalled object' do
       vcr('entry/marshall') {
         nyancat = create_client(max_include_resolution_depth: 2).entries(include: 2, 'sys.id' => 'nyancat').first
@@ -477,6 +496,17 @@ describe Contentful::Entry do
   end
 
   describe 'issues' do
+    it 'filters out unresolvable assets' do
+      vcr('entries/unresolvable_assets') {
+        client = create_client(space: 'facgnwwgj5fe', access_token: '4d0f55d940975f78139daae5d965b463c0816e88ad16062d2c1ee3d6cb930521')
+        entry = client.entry('gLVzQlb09IeOeU181fwtz')
+
+        expect(entry.single_asset).to be_nil
+        expect(entry.multi_asset.size).to eq 1
+        expect(entry.raw["fields"]["multiAsset"].size).to eq 2
+      }
+    end
+
     it 'Symbol/Text field with null values should be serialized as nil - #117' do
       vcr('entries/issue_117') {
         client = create_client(space: '8jbbayggj9gj', access_token: '4ce0108f04e55c76476ba84ab0e6149734db73d67cd1b429323ef67f00977e07')

data/spec/fixtures/vcr_cassettes/entries/unresolvable_assets.yml

@@ -0,0 +1,89 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/facgnwwgj5fe/environments/master/entries?sys.id=gLVzQlb09IeOeU181fwtz
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.15.1; platform ruby/2.6.3; os macOS/18;
+      Authorization:
+      - Bearer 4d0f55d940975f78139daae5d965b463c0816e88ad16062d2c1ee3d6cb930521
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+      User-Agent:
+      - http.rb/4.2.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      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,X-Contentful-Skip-Transformation,X-Contentful-User-Agent,X-Contentful-Enable-Alpha-Feature
+      Access-Control-Allow-Methods:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '86400'
+      Cf-Environment-Id:
+      - master
+      Cf-Environment-Uuid:
+      - 7df33faa-1d21-4dea-83e9-9ebda5f47ba9
+      Cf-Organization-Id:
+      - 4SsuxQCaMaemfIms52Jr8s
+      Cf-Space-Id:
+      - facgnwwgj5fe
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - W/"14036385179019726604"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      Content-Length:
+      - '832'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 19 Dec 2019 09:54:02 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-ams21023-AMS
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+      X-Contentful-Request-Id:
+      - e8767cee-9cbe-46be-8fab-47d35d6c5db7
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA81WW2+bMBR+769APK8J5NbSt25r127VqqZJq22qIgMHYkoMwiZZWuW/zxdIHEpINk3TUBRhG5/znet3Xo8Mw6RLap4Zr/yVL9gyBb4yz7MMLU2+t3onvmEJQzHft+WKPuOULyy5iPEMM3FkqTVmMBMCf0iBSmxFi9REU+QJVeUXalPDIjbkZonpBpNnU+jcPFw7eR4VmO+lxMoH2BfmBMgLyWIRRv0AhFXls1q/SzvVY6o74c3Dy13sWs413MLYPrWDBXvRxK9xXRCWLfUDLwPEwD8XbjE7lu0c251j2xlZzlnf5r9Wtzf4rl/IU//3LgCZ4ywhMyBCx34XKotmiDLIqh461L0Xms69LsxgjilOSJkzhWe9hDCOuYjYftyHYvugya1NgJykuRtjOuVhoRQY3Z8FceKhWBYDkOPxfXlhnShmgCH2N7UjTDQZZurOeKPQKDRqGUYxCWOQ+wfF71A/KIm1HhhEEXr46OZkNIiW6PLh5+XYuRrvd8MsjxkukaqiVsHUo1dT4EXEG5DL5rEp3zrs/BOVup34PWTzG5/ln/E1HV4NrShiCx09b1V6Vuo++KdIH++6wym6fQzpt9GXr/e9IB/M4waga9BPxZsyQ/w/yQYLWZZkh3RU5SmSsCHQJJ4jl2eilnNlJKS8t9nsA0M4rqZz0VorrbcxbgdFrDBSwdtNEv+XSc0lVI0bJl6c+6CRa7WKNnm5RcJF5dQR5N+oszqaXNfZLqJsqK4i3vV5r5fhZriQfW/rqIEye5w1rVZ/YOuUyQE3kOauK7tpc7djG6iTXzq8ve2gzybH1pOoaJv11FRMa0X+1NCTAFwS1Kck9oEYGbAMwxwyg88snJWMFIfUCJKkEqAAS16rtNI8E1Oh2W7jGQqBtjwWIEmvLQKsrSdTuzY/2l3PPUXd7kkHen3/xHVcO+gg1wPUCzpgn1ptBXOyhjlRMCcC5kTAbEVpWB1p6npZWVX4Rdjh2J2T7jZPihoQVryxUhL7Avtsyo/6asxV0sp/cwo4nAoqH/QdjYXEuc5KWwGSYoVbv6KZHDP+yNTtiUpZ0I5SCHcw+xbJCMpZHa2OfgEgI0mYCAwAAA==
+    http_version: 
+  recorded_at: Thu, 19 Dec 2019 09:54:02 GMT
+recorded_with: VCR 5.0.0