contentful 2.15.4 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e84df2f0ef19ecf855ce77085b4270a9c01090ca58983f0ec08216e5e45b840
-  data.tar.gz: bba7eb0daaaf9d83120e4efec27e378d1876c798faf2290f1291db84d6c50160
+  metadata.gz: 1e63bedb0c0b22d7e44ea7c6c34ad61f9ff8acb9facc21820184cddf2db79990
+  data.tar.gz: 56197434b185928e747670908fdefac768e4ce8dc6be79e3849fd0fc91a022f5
 SHA512:
-  metadata.gz: 69620f883503572654fba4f5d6f0b4df752bb17f8f2c7d69dd01e246962e8a66fffa67c88ab0a77474075779c5bea3df74a89fd4eedd4a8c6097a30f39e3f73f
-  data.tar.gz: 490570518b664f9227e9fa28aba01276238187b24253ea7b52a4bbaa3ae76dcc5573eb810d704db090ef6ca18ec55ca75e86f3a1bd5e894fb4ccdee408c93201
+  metadata.gz: 5953cd706cfe07072824f19776a98342561e8259c7ac58f78d869ff533123b147ccdf156d919cbd557e009e21c52829b0309beaf7dc3f1e1f9df2cd28e180613
+  data.tar.gz: 1cdc591423e4586e84e44962a1860eb22288e053b0fc73d6105b46bf76c135621092f65d88ec976ec4fa370b72977a7b0584fa5c48cc61e2e27ec446a47a88a4

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 2.16.0
+
+### Added
+* Added `Contentful::ArrayLike#to_ary`. [#200](https://github.com/contentful/contentful.rb/issues/200)
+* Added `_metadata[:tags]` to read metadata tags on `entry` and `asset`.
+
 ## 2.15.4
 
 ### Fixed

data/README.md

@@ -424,6 +424,15 @@ entry.color # 'rainbow'
 entry.birthday # #<DateTime: 2011-04-04T22:00:00+00:00 ((2455656j,79200s,0n),+0s,2299161j)>
 ```
 
+#### Accessing tags
+
+Tags can be accessed via the `#_metadata` method.
+
+```ruby
+entry = client.entry 'nyancat'
+entry._metadata[:tags] # => [<Contentful::Link id='tagID'>]
+```
+
 #### Dynamic entries
 
 However, you can (and should) set `:dynamic_entries` to `:auto` in your client configuration.

data/lib/contentful/array_like.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contentful
   # Useful methods for array-like resources that can be included if an
   # :items property exists
@@ -47,5 +49,12 @@ module Contentful
     def last
       items.last
     end
+
+    # Delegates to items#to_ary
+    #
+    # @return [Contentful::Entry, Contentful::Asset]
+    def to_ary
+      items
+    end
   end
 end

data/lib/contentful/base_resource.rb

@@ -5,7 +5,7 @@ require_relative 'support'
 module Contentful
   # Base definition of a Contentful Resource containing Sys properties
   class BaseResource
-    attr_reader :raw, :default_locale, :sys
+    attr_reader :raw, :default_locale, :sys, :_metadata
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(item, configuration = {}, _localized = false, _includes = [], entries = {}, depth = 0, _errors = [])
@@ -15,6 +15,7 @@ module Contentful
       @depth = depth
       @configuration = configuration
       @sys = hydrate_sys
+      @_metadata = hydrate_metadata
 
       define_sys_methods!
     end
@@ -57,6 +58,7 @@ module Contentful
       @configuration = raw_object[:configuration]
       @default_locale = @configuration[:default_locale]
       @sys = hydrate_sys
+      @_metadata = hydrate_metadata
       @depth = 0
       define_sys_methods!
     end
@@ -93,6 +95,15 @@ module Contentful
       result
     end
 
+    def hydrate_metadata
+      result = {}
+      raw.fetch('metadata', {}).each do |k, v|
+        v.map! { |tag| build_link(tag) } if k == 'tags'
+        result[Support.snakify(k, @configuration[:use_camel_case]).to_sym] = v
+      end
+      result
+    end
+
     protected
 
     def repr_name

data/lib/contentful/version.rb

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

data/spec/array_spec.rb

@@ -60,6 +60,16 @@ describe Contentful::Array do
     end
   end
 
+  describe "#to_ary" do
+    it 'is an array' do
+      expect(array.to_ary).to be_a ::Array
+    end
+
+    it 'returns items' do
+      expect(array.to_ary).to eq array.items
+    end
+  end
+
   describe '#next_page' do
     it 'requests more of the same content from the server, using its limit and skip values' do
       array_page_1 = vcr('array_page_1') { create_client.content_types(skip: 3, limit: 2) }

data/spec/asset_spec.rb

@@ -189,4 +189,32 @@ describe Contentful::Asset do
       }
     end
   end
+
+  describe 'tags metadata' do
+    let(:asset_id) { '686aLBcjj1f47uFWxrepj6' }
+
+    it 'can load an asset with tags' do
+      vcr('asset/with_tags') {
+        expect {
+          asset = create_client.asset(asset_id)
+        }.not_to raise_error
+      }
+    end
+
+    it 'hydrates tags' do
+      vcr('asset/with_tags') {
+        asset = create_client.asset(asset_id)
+        expect(asset._metadata[:tags].first).to be_a Contentful::Link
+      }
+    end
+
+    it 'loads tag links with their proper attributes' do
+      vcr('asset/with_tags') {
+        asset = create_client.asset(asset_id)
+        tag = asset._metadata[:tags].first
+        expect(tag.id).to eq 'mobQa'
+        expect(tag.link_type).to eq 'Tag'
+      }
+    end
+  end
 end

data/spec/entry_spec.rb

@@ -784,4 +784,32 @@ describe Contentful::Entry do
       }
     end
   end
+
+  describe 'tags metadata' do
+    let(:entry_id) { '52GcYcPOPhuhlaogl05DIh' }
+
+    it 'can load an entry with tags' do
+      vcr('entry/with_tags') {
+        expect {
+          entry = create_client.entry(entry_id)
+        }.not_to raise_error
+      }
+    end
+
+    it 'hydrates tags' do
+      vcr('entry/with_tags') {
+        entry = create_client.entry(entry_id)
+        expect(entry._metadata[:tags].first).to be_a Contentful::Link
+      }
+    end
+
+    it 'loads tag links with their proper attributes' do
+      vcr('entry/with_tags') {
+        entry = create_client.entry(entry_id)
+        tag = entry._metadata[:tags].first
+        expect(tag.id).to eq 'mobQa'
+        expect(tag.link_type).to eq 'Tag'
+      }
+    end
+  end
 end

data/spec/fixtures/vcr_cassettes/asset/with_tags.yml

@@ -0,0 +1,138 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/environments/master/assets/686aLBcjj1f47uFWxrepj6
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.15.4; platform ruby/2.7.1; os macOS/19;
+      Authorization:
+      - Bearer b4c0n73n7fu1
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+      User-Agent:
+      - http.rb/4.4.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '1106'
+      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:
+      - a8fd17fd-5c8e-465f-bf8d-eb67f144dca0
+      Cf-Organization-Id:
+      - 4kQeJmhUWIKtNNmMkketza
+      Cf-Space-Id:
+      - cfexampleapi
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - W/"3103305513039094952"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/assets/:id"
+      Via:
+      - 1.1 varnish, 1.1 varnish
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Mon, 29 Mar 2021 10:27:50 GMT
+      Age:
+      - '0'
+      X-Served-By:
+      - cache-dca17737-DCA, cache-bom4746-BOM
+      X-Cache-Hits:
+      - 0, 0
+      X-Timer:
+      - S1617013670.812930,VS0,VE282
+      Vary:
+      - Accept-Encoding
+      X-Cache:
+      - MISS
+      X-Contentful-Request-Id:
+      - a82aa39b-c5fb-4f2c-8848-f1b26cc7d313
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "metadata": {
+            "tags": [
+              {
+                "sys": {
+                  "type": "Link",
+                  "linkType": "Tag",
+                  "id": "mobQa"
+                }
+              }
+            ]
+          },
+          "sys": {
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "cfexampleapi"
+              }
+            },
+            "id": "686aLBcjj1f47uFWxrepj6",
+            "type": "Asset",
+            "createdAt": "2021-02-06T05:59:37.794Z",
+            "updatedAt": "2021-03-29T10:22:06.152Z",
+            "environment": {
+              "sys": {
+                "id": "master",
+                "type": "Link",
+                "linkType": "Environment"
+              }
+            },
+            "revision": 2,
+            "locale": "en-US"
+          },
+          "fields": {
+            "title": "Avatar",
+            "description": "my photo",
+            "file": {
+              "url": "//images.ctfassets.net/cfexampleapi/686aLBcjj1f47uFWxrepj6/3bd27e35028b8210ca732eb037f4b567/WhatsApp_Image_2019-06-25_at_12.17.04.jpeg",
+              "details": {
+                "size": 108963,
+                "image": {
+                  "width": 868,
+                  "height": 1000
+                }
+              },
+              "fileName": "Avatar.jpeg",
+              "contentType": "image/jpeg"
+            }
+          }
+        }
+  recorded_at: Mon, 29 Mar 2021 10:27:49 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/entry/with_tags.yml

@@ -0,0 +1,238 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/environments/master/content_types?limit=1000
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.15.4; platform ruby/2.7.1; os macOS/19;
+      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.4.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '731'
+      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:
+      - a8fd17fd-5c8e-465f-bf8d-eb67f144dca0
+      Cf-Organization-Id:
+      - 4kQeJmhUWIKtNNmMkketza
+      Cf-Space-Id:
+      - cfexampleapi
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - W/"1428365732249037051"
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/content_types"
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Sun, 28 Mar 2021 12:13:52 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '87766'
+      X-Served-By:
+      - cache-bom4721-BOM
+      X-Cache-Hits:
+      - '1'
+      X-Timer:
+      - S1616933633.514348,VS0,VE1
+      Vary:
+      - Accept-Encoding
+      X-Cache:
+      - HIT
+      X-Contentful-Request-Id:
+      - 4452e776-4432-4002-b3ea-ef8e597daa42
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA+1XTY/aMBC9769APhdkJyEsuaFqK1XqqcupFUIGzGKRrzqGlq747x07OImDWVB3FxWpvoA9nhnP8+R55vmu00HFrkBR5xn+wkTucgYzNBKC7hCs7T+oPTKTNIZ1X8+KNc9hgvUk5gmXMCMYlwtcskRZ/K4tlnZbbrSrIqdz5cvsKBcbh1ELetEc6gtP10g5rQe4T9fjw6EftcXWBr5Q8WTBKnwa/vTzLOMqLDP21X8daDlQqSNZIb2GueocH7NUslRqtw2tuWBUssVIoYE87JEu9rqkP8ZhFPgRwb3Qv//WVNjki2MFDxSCyB9EhPSCYGgpsHTLRZYm4Pwi4Mo4ElpIJtq4XArqQ8PnWeAE2/KCZ6nKB++wuwIWLXiRx3T3ibNYX0rCJAUEaHU0lNJEp58NPVqwYi54LkvLqN6/VKbqZFPXZ6VTCUBOUyv6ys2RwIDyGS74qYUZirM5jflvps6+pHHBmpmGBPux4eKEECKns/iEMIMPCPLGWHVlpCOoI/BU8FVkbqkJ73GXzLLYxuTq0R3inOjfQ5LcMFvQjVxlza/sr+gCh2Pcj/phhMOeT4LzdKEUYLcXBUFvMOzfLF2cZwvJZVzzbZXpIxv313IF3QIh2WRZuXLJTtLotejCIqHmazgqCibrt67xvjnYRPD5asx+STdPuqUm9K9O3avzSQ2EIz47eSyqHFt5pUX/efJ9q6p25WTwvrywIl2PjAmGIiki/R4Jw3NMCQrAlMMI+1GAe/cDuxK7pcLKC84WVqp8murayF1aTTXg5oN5LWWmm2TGBHFTRymctqRvU2dJsbFrsHcosxxQ2uwBUNuRm9iO6fTfokQg9bV8ifId0jei/GtcnGBLJljaagirt/yE2ARY9r/223qd8t/yaXrp5ot2piHeQo8CTRW0SrovmjTt6Xa97pcfUil0k29Goxu2q3OYTe72d38AoWM06DAQAAA=
+  recorded_at: Sun, 28 Mar 2021 12:13:52 GMT
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/environments/master/entries?sys.id=52GcYcPOPhuhlaogl05DIh
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Contentful-User-Agent:
+      - sdk contentful.rb/2.15.4; platform ruby/2.7.1; os macOS/19;
+      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.4.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '956'
+      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:
+      - a8fd17fd-5c8e-465f-bf8d-eb67f144dca0
+      Cf-Organization-Id:
+      - 4kQeJmhUWIKtNNmMkketza
+      Cf-Space-Id:
+      - cfexampleapi
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Contentful-Api:
+      - cda_cached
+      Etag:
+      - '"18024233839947354630"'
+      Server:
+      - Contentful
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Region:
+      - us-east-1
+      X-Contentful-Route:
+      - "/spaces/:space/environments/:environment/entries"
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Sun, 28 Mar 2021 12:13:52 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      X-Served-By:
+      - cache-bom4749-BOM
+      X-Cache-Hits:
+      - '1'
+      X-Timer:
+      - S1616933633.546080,VS0,VE285
+      Vary:
+      - Accept-Encoding
+      X-Cache:
+      - HIT
+      X-Contentful-Request-Id:
+      - 129a8fd6-d7a1-4873-8d23-b61c7fe7b62b
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "total": 1,
+          "skip": 0,
+          "limit": 100,
+          "items": [
+            {
+              "metadata": {
+                "tags": [
+                  {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "Tag",
+                      "id": "mobQa"
+                    }
+                  }
+                ]
+              },
+              "sys": {
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "id": "52GcYcPOPhuhlaogl05DIh",
+                "type": "Entry",
+                "createdAt": "2021-02-21T06:31:58.023Z",
+                "updatedAt": "2021-02-25T04:29:51.706Z",
+                "environment": {
+                  "sys": {
+                    "id": "master",
+                    "type": "Link",
+                    "linkType": "Environment"
+                  }
+                },
+                "revision": 3,
+                "contentType": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "ContentType",
+                    "id": "test2"
+                  }
+                },
+                "locale": "en-US"
+              },
+              "fields": {
+                "title": {
+                              "en-US": "Can't publish this"
+                            },
+                            "shortDescription": {
+                              "en-US": "What is going on here can I still write? changed"
+                            }
+              }
+            }
+          ]
+        }
+  recorded_at: Sun, 28 Mar 2021 12:13:52 GMT
+recorded_with: VCR 6.0.0