contentful 2.15.3 → 2.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0961f6c5c63757f6312f2a0a7ba6fa0ae1fdfa9741021a6f691593fc5fdb389
-  data.tar.gz: 014f41f41ac940c9f26aedf60c39dda66ebbedb48eac0b3872e0a695ba3443e1
+  metadata.gz: c77c841eb951e64584e685f03ce1d0da8534420e162f336330813c877481c12e
+  data.tar.gz: 52b7416520d57ffba83e2f06490714fd620c4553c8f3dd8ede4361f411879c9c
 SHA512:
-  metadata.gz: 43d0444456c462f1a8f4f8176558fdaa29d804587455513fe5db80e1c6dae2f7446277ef78af021150e180374350aa86ce63487613e86ac56e5fb4aaaee2c079
-  data.tar.gz: f77176128208a7df1b6e6f9e422917788a68d626921f46932cdbaca2f9d0141ed829a6a5ff271dc879851ee499d6a2863e389468740dd79e338916121a766bfe
+  metadata.gz: 5a64c6adfc0fabf56f44b87e12b3df902bcfaa43b2282b0e52f04bed468e8137263b8ad67622b16987480a1c7bf95e4a6e6eb94cd2fc6fb653442ac0dcca3769
+  data.tar.gz: 80a5851644694f7967b1e3e38db6e11cf03f06bb4463a4bf9fa23b37dfc6ca80a8bb8152c0332515cfa7b56952b7a6c59434522312814988940864c9e0c304aa

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## Unreleased
 
+## 2.16.2
+### Fixed
+* Fixed an issue where entry's `raw['fields']` was unexpectedly overwritten by `FieldsResource#raw_with_links` method.
+
+## 2.16.1
+* Removed unncessary files from gem release package.
+
+## 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
+* Fixed an issue where the `log_level` of `Logger` was changed unintentionally [#222](https://github.com/contentful/contentful.rb/pull/222)
+* Fixed an issue cause by a `Logger` not being correctly thrown away, causing an exception. [#220](https://github.com/contentful/contentful.rb/pull/220)
+* Added `title` field to assets to prevent Error raising when the field is empty. [#218](https://github.com/contentful/contentful.rb/pull/218)
+* Fixed an issue with `ArrayLike` not taking multiple arguments leading to Errors when using it with pagination libraries. [#215](https://github.com/contentful/contentful.rb/pull/215)
+
 ## 2.15.3
 ### Fixed
 * Fixed a deprecation warning in Ruby 2.7.0 for `URI::escape` and replaced it with a backwards compatible mechanism. [#217](https://github.com/contentful/contentful.rb/issues/217)

data/README.md

@@ -10,10 +10,10 @@
   </a>
 </p>
 
-# contentful.rb - Contentful Ruby Delivery SDK
+# contentful.rb - Contentful Ruby Delivery Library
 [![Gem Version](https://badge.fury.io/rb/contentful.png)](http://badge.fury.io/rb/contentful)
 
-> Ruby SDK for the Contentful [Content Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/) and [Content Preview API](https://www.contentful.com/developers/docs/references/content-preview-api/). It helps you to easily access your Content stored in Contentful with your Ruby applications.
+> Ruby library for the Contentful [Content Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/) and [Content Preview API](https://www.contentful.com/developers/docs/references/content-preview-api/). It helps you to easily access your Content stored in Contentful with your Ruby applications.
 
 <p align="center">
   <img src="https://img.shields.io/badge/Status-Maintained-green.svg" alt="This repository is actively maintained" /> &nbsp;
@@ -45,12 +45,12 @@
 
 <!-- TOC -->
 
-- [contentful.rb - Contentful Ruby Delivery SDK](#contentfulrb---contentful-ruby-delivery-sdk)
+- [contentful.rb - Contentful Ruby Delivery library](#contentfulrb---contentful-ruby-delivery-library)
   - [Core Features](#core-features)
   - [Getting started](#getting-started)
     - [Installation](#installation)
     - [Your first request](#your-first-request)
-    - [Using this SDK with the Preview API](#using-this-sdk-with-the-preview-api)
+    - [Using this library with the Preview API](#using-this-library-with-the-preview-api)
     - [Authentication](#authentication)
   - [Documentation & References](#documentation--references)
     - [Configuration](#configuration)
@@ -94,11 +94,11 @@
 
 ## Getting started
 
-In order to get started with the Contentful Ruby SDK you'll need not only to install it, but also to get credentials which will allow you to have access to your content in Contentful.
+In order to get started with the Contentful Ruby library you'll need not only to install it, but also to get credentials which will allow you to have access to your content in Contentful.
 
 - [Installation](#installation)
 - [Your first request](#your-first-request)
-- [Using this SDK with the Preview API](#using-this-sdk-with-the-preview-api)
+- [Using this library with the Preview API](#using-this-library-with-the-preview-api)
 - [Authentication](#authentication)
 - [Documentation & References](#documentation--references)
 
@@ -118,7 +118,7 @@ gem i contentful
 
 ### Your first request
 
-The following code snippet is the most basic one you can use to get some content from Contentful with this SDK:
+The following code snippet is the most basic one you can use to get some content from Contentful with this library:
 
 ```ruby
 require 'contentful'
@@ -132,9 +132,9 @@ client = Contentful::Client.new(
 entry = client.entry('nyancat')
 ```
 
-### Using this SDK with the Preview API
+### Using this library with the Preview API
 
-This SDK can also be used with the Preview API. In order to do so, you need to use the Preview API Access token, available on the same page where you get the Delivery API token, and specify the host of the preview API, such as:
+This library can also be used with the Preview API. In order to do so, you need to use the Preview API Access token, available on the same page where you get the Delivery API token, and specify the host of the preview API, such as:
 
 ```ruby
 require 'contentful'
@@ -168,7 +168,7 @@ For more information, check the [Contentful REST API reference on Authentication
 - [Migrating to 2.x](#migrating-to-2x)
 
 
-To help you get the most out of this SDK, we've prepared all available client configuration options, reference documentation, tutorials and other examples that will help you learn and understand how to use this library.
+To help you get the most out of this library, we've prepared all available client configuration options, reference documentation, tutorials and other examples that will help you learn and understand how to use this library.
 
 ### Configuration
 
@@ -287,7 +287,7 @@ client = Contentful::Client.new(
       <td><code>max_include_resolution_depth</code></td>
       <td><code>20</code></td>
       <td>
-        Maximum amount of levels to resolve includes for SDK entities
+        Maximum amount of levels to resolve includes for library entities
         (this is independent of API-level includes - it represents the maximum depth the include resolution
         tree is allowed to resolved before falling back to <code>Link</code> objects).
         This include resolution strategy is in place in order to avoid having infinite circular recursion on resources with circular dependencies.
@@ -363,6 +363,8 @@ client = Contentful::Client.new(
       <td>
         The default severity is set to INFO and logs only the request attributes (headers, parameters and url).
         Setting it to DEBUG will also log the raw JSON response.
+        WARNING: Setting this will override the level on the logger instance. Leave out this key to preserve
+        the original log_level on the logger, for example when using Rails.logger.
       </td>
     </tr>
   </tbody>
@@ -422,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
@@ -37,8 +39,8 @@ module Contentful
     # Delegates to items#[]
     #
     # @return [Contentful::Entry, Contentful::Asset]
-    def [](index)
-      items[index]
+    def [](*args)
+      items[*args]
     end
 
     # Delegates to items#last
@@ -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/asset.rb

@@ -93,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

@@ -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
@@ -36,7 +37,8 @@ module Contentful
       end
 
       {
-        configuration: @configuration.merge(entry_mapping: entry_mapping),
+        # 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
@@ -56,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
@@ -92,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/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

data/lib/contentful/fields_resource.rb

@@ -67,6 +67,7 @@ module Contentful
     def raw_with_links
       links = fields.keys.select { |property| known_link?(property) }
       processed_raw = raw.clone
+      processed_raw['fields'] = raw['fields'].clone
       raw['fields'].each do |k, v|
         links_key = Support.snakify(k, @configuration[:use_camel_case])
         processed_raw['fields'][k] = links.include?(links_key.to_sym) ? send(links_key) : v

data/lib/contentful/version.rb

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