contentful 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1930a37ca31d693b4cb4ff55f065b85cc3271696ae3dd96b063093a2f9c24be
-  data.tar.gz: 5299cd8d71d9200873fcbc527d41bedd717ed216a323b0a537d9148d1b0a664d
+  metadata.gz: '09f8c373dc24453c4566564a0ac34244df2af9bb9eaf123daa91b514f6a0bf14'
+  data.tar.gz: a99d41fd2698f8dec1536822198fc661a248bc6eacd04c2f7dde555a22dd647d
 SHA512:
-  metadata.gz: 1b3f75e991ce3eecde93a3109acafb20f400e349df4f369463d2adfea36c863772cdc84d1353b7e24018342fbc4eb0cbf6ee9d884b445877817f4821ef26b3ef
-  data.tar.gz: 2bf465ba3e6a9e8129fe7648212d75454332866a478f2aebfb2effb8679a56338cf2890bcd0718a4815f20ca42292f496427aedda571f9b7ab4b5ac5470c0523
+  metadata.gz: bfe5899e858df982b9d1eeb475729503513d1b18e7315c3f93d35167c19512c301047f3bba4d0cabc37223bc1b06c64c34c70e7720a64ad4283e19616759cfcf
+  data.tar.gz: f06391fb774add42ea406736f5115d1e0ebf1a08b3ed1c4454640f5b4b240c9a919132170448d0449058b3d11f3d8ab161338d3801385b7e408c30d3e702e1ba

data/.rubocop.yml

@@ -21,6 +21,9 @@ AllCops:
 Metrics/ClassLength:
   Max: 280
 
+Metrics/ParameterLists:
+  Max: 6
+
 Style/MutableConstant:
   Enabled: false
 

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 2.15.0
+### Added
+* Added the capability for `Array#next_page` to support carry-over of query parameters.
+
 ## 2.14.0
 ### Added
 * Allow user defined methods to override properties created by the SDK, if you want to access overriden fields or sys properties use `#fields[]` or `#sys[]` as accessors. [#210](https://github.com/contentful/contentful.rb/pull/210)

data/contentful.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'multi_json', '~> 1'
 
-  gem.add_development_dependency 'bundler', '~> 1.5'
+  gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'rake', '< 11.0'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
 

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/client.rb

@@ -386,7 +386,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/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.0'
 end

data/spec/array_spec.rb

@@ -63,6 +63,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/fixtures/vcr_cassettes/query_array_1.yml

@@ -0,0 +1,89 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/environments/master/entries?content_type=cat&limit=1
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.14.0; platform ruby/2.6.3; os macOS/18;
+      Authorization:
+      - Bearer b4c0n73n7fu1
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+      User-Agent:
+      - http.rb/4.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '1083'
+      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:
+      - b0e55a5c-6ee0-4c81-b32a-3bd22a568e43
+      Cf-Organization-Id:
+      - 7BLDDu2FYCNoN4QIWys1BR
+      Cf-Space-Id:
+      - cfexampleapi
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - W/"10877546587147223532"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Fri, 15 Nov 2019 09:46:36 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      X-Served-By:
+      - cache-bma1646-BMA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+      X-Contentful-Request-Id:
+      - 1cdde516-8e6a-465f-bdb1-efe27b1dfb07
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA92YS2/jNhCA7/kVga6tJZKSrMfNCLZogHZRIF4USFEEtETZjPWqRCfrXeS/L0k9TMmU7Wbdw1YwbJHUkDPDmU9Df725vTXqfW2Et1/5LW+wfUl4y1hUFd4bvO/tZ/EMKxhOeb8tW/WWlrwBZCOlGWW8BWWLMpKJ6f6S0zWTjtaQ69QljsRC3RNNp6KJ6JCdnUa/0XxriDUOF1873y5bjR/kjKMHaCyMiRLyGWdlSnBJhU3d9dbfSyuby2hkNrgs9xFmyoy9Kh9yVu3VgagimJF4IfxgIADtGZjPkLdEKHTmIQIm9OCjKrAr45EAhDPoL6Ebun4IkAmgPxAg+QutijwjuVjjvNcaIzJcM1KNnXKpRz8oa571WkVeaE2LnGvnK86MipxxndtNOq/3pbrdKfPq95xv3Vml0yLCqYx3ks8+PXQCfTQYCSVpfEgPESFGjjMp8quIkNu7YYikdEsO8d9GVLQh5MtqV635XvQ6/T3wUlpUYs61yDplYEVq9ktFSS7i+HreGwewtKsJmXyPcxH2Z323ohXbxFxdGfLAnkEwQ/4S2SEA/POT/FZtSemLdI0ERZdrGV5fFwOLuiZq0iqm9Smtt63tbaAgvuUOGTSP0l0sNW8Z2XivY9yBchrOTZBO+6TU9ET889FzvOt3cYp4nOeq8WrmjPZ/MNRpdRw3xmn0wcB0oa2SjKt4DD8QzICzBEEIg9AOTIC8kcg0/qZdeQKB/8rRExg85UoFhu7AkdM4nLbj8pCYhuIhMIapfcqICTi2JUGbwBpA8rU6RH7kMBkRUkbxMSN5d4Vpvipe6/HrKqH1RsWRAk4uFRUtOlvxgbQxyc9ruPs4G87A5pS3hzjl1QBwRE7wCkKPU+nHFqi27Q0zWUPVaxisY2sfWZoXx8jenjwdg5rfdj+NZvb/KVY15ST3XJfax47VcZVDEi2hE7rz0HZMNB9DUs9VLuKGEIbIMe35oArlCvy4XEWDiP8OVjHKmhJQV89xFyVUDqvFF+/dVeI4ZFgWFblWmxFLsKg8ajMnzFJfv5b9++Mf+fPj8r7eLu7vt7tdUd/VtWX7CDt+nGAUreA8cjzM7zyUeCtkrxIQWF3IvJrP5XoMxZgwTNNhZdoiuaZfhMJuENiB6qQGTlo0yKFXGrMNF0SePOUNL2ND6Hojzh524I1G1ZJi8HaQ0wr/fWxL5pMmDd+NhnSs9VyS9UQt2tVrnbKHHRocaRs7tAfOazBRd+zsmfgflWHvwoUDLirDVMIcify4uFAOHXx3roELfW3z3bRw1uWc4cXrn85d9rDeZf8gsv2UWUGMQRTDwJ77Hlz5sYdsxyZ+4GIA4jmEllDniR/cnpALys9PScVTzizzd4ADIg0BmnQ84uAQHK78R2gKHFyxd4PjUuu0DBFeUE89U3UI73+7ebv5BiVHfZkVEwAA
+    http_version: 
+  recorded_at: Fri, 15 Nov 2019 09:46:36 GMT
+recorded_with: VCR 5.0.0

data/spec/fixtures/vcr_cassettes/query_array_2.yml

@@ -0,0 +1,89 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/environments/master/entries?content_type=cat&limit=1&skip=1
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.14.0; platform ruby/2.6.3; os macOS/18;
+      Authorization:
+      - Bearer b4c0n73n7fu1
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+      User-Agent:
+      - http.rb/4.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '400'
+      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:
+      - b0e55a5c-6ee0-4c81-b32a-3bd22a568e43
+      Cf-Organization-Id:
+      - 7BLDDu2FYCNoN4QIWys1BR
+      Cf-Space-Id:
+      - cfexampleapi
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - W/"12211725640257057039"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Fri, 15 Nov 2019 09:46:47 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      X-Served-By:
+      - cache-bma1624-BMA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+      X-Contentful-Request-Id:
+      - 74c9dc83-4a97-4ac3-8780-8c3d2540f815
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA41TTW/CMAy98ytQrhtTGiagvaEJ7bIb7LKJg9cGZjVNqzSgVYj/viT9ChVSySGKndjv2X65TKZTUlYliaYXczSGrgpuLLJWCipifNdn+0bnGoTxz51VplgYI3CGwAx1Z6HmmU337dLVSQcYDqcsILZA7Yva6TGxDudsGX2gTIlF7JfBlumuYbx1GQcPMLHFxAf+B1khOBRoa2rXtTu7KutF6pgjqANykXgZOyobqVXlX8SKg+bJ2vaBMBrMZ3QxY8sdY9HrImL0ZcWCLz/gVCTDgJUNCGhEw4guX0IW3gRweUaVy4xLizHetbqIDErN1bApj3Z042GOdk3xM5aYS8OOec2Mc6kN52ZI47wf5fbm5b0/c9DjoxZ5DMLpncvZ57YN6NRAnAT672EVQiRkLuT9jkIEpryXfyMoASUcJfR09jcNErmy6XIF8ugLmPyg0r+J+YbmNgiXoRVVsNqxeUSNTOiT231VCTw4dHkSwoMQeHbusBliLXu77yfXyT+v5gceBAQAAA==
+    http_version: 
+  recorded_at: Fri, 15 Nov 2019 09:46:47 GMT
+recorded_with: VCR 5.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -50,16 +50,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -487,6 +487,8 @@ files:
 - spec/fixtures/vcr_cassettes/multi_locale_reference.yml
 - spec/fixtures/vcr_cassettes/not_found.yml
 - spec/fixtures/vcr_cassettes/nyancat.yml
+- spec/fixtures/vcr_cassettes/query_array_1.yml
+- spec/fixtures/vcr_cassettes/query_array_2.yml
 - spec/fixtures/vcr_cassettes/ratelimit.yml
 - spec/fixtures/vcr_cassettes/ratelimit_retry.yml
 - spec/fixtures/vcr_cassettes/reloaded_entry.yml
@@ -634,6 +636,8 @@ test_files:
 - spec/fixtures/vcr_cassettes/multi_locale_reference.yml
 - spec/fixtures/vcr_cassettes/not_found.yml
 - spec/fixtures/vcr_cassettes/nyancat.yml
+- spec/fixtures/vcr_cassettes/query_array_1.yml
+- spec/fixtures/vcr_cassettes/query_array_2.yml
 - spec/fixtures/vcr_cassettes/ratelimit.yml
 - spec/fixtures/vcr_cassettes/ratelimit_retry.yml
 - spec/fixtures/vcr_cassettes/reloaded_entry.yml