contentful 2.12.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3c004cc764ee56ec8a0f8a9cf739f5e5ab10e8fda5c327e1708829b8585145
-  data.tar.gz: 57d48057485ff6260801e2090bd3dd37e71c1fb6afb53628f1f1e93bc5eabb3f
+  metadata.gz: 44bcfad09bdb03cc6460ebf0ac778f89e1b2820b9434f76bbbc297f63f84f7c7
+  data.tar.gz: a36e3d13ed3b67c501c34ceb7c777f60592188944905048839720d48490886d4
 SHA512:
-  metadata.gz: 88eb373835acf4f0cf9d90a48c407fa082efb9e73052c33b0c89c4ed1f685cf37d6ea6f90306a683e2b4f49c972e4aa0f3c5784fe4c2e44a4da0124373d5ec85
-  data.tar.gz: 5d7f33c79174fb1867a6509af1c59a76afec8b04d5a3cc557117d0e90cbd394bdd3243522404bba18e210d50aa941c773614a2815f868e1358f28dae0e665898
+  metadata.gz: 171a6d3f675e9596a9353c40d43ab5ee81fabf755407e13933fdf04a7934d1db058d33480b25a305609b52a27e00d46f6790a1186608495815b93cc29c0648d9
+  data.tar.gz: 763fc3a03017b6c10a5fdee30d6bd71eca0f0015aacbf4e3f250186985d347a20363d817265c4e6aa777b06b73df0817c865d4d9ddba8b3e0cace9b177eb62fb

data/CHANGELOG.md

@@ -1,6 +1,74 @@
 # Change Log
 
-## Unreleased
+## 2.17.0
+
+### Updated
+* Updated `http` gem version
+
+### Changed
+* CI/CD vendor from travis to circleci
+* Refactored `includes` to be a model (`Contentful::Includes`) with a lookup table instead of a plain Ruby array, for improved performance when `include_level` is set. Two related methods from `Support` have been moved to this new class. Any code that uses the undocumented `includes_for_single` option to any method will need to be updated. [#235](https://github.com/contentful/contentful.rb/pull/235)
+
+## 2.16.3
+### Fixed
+* Fixed an issue where `raw['metadata']` was unexpectedly overwritten by `BaseResource#hydrate_metadata` method.
+
+## 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)
+
+## 2.15.2
+### Fixed
+* Fixed unresolvable single linked entries and assets returning a JSON Link rather than being `nil`, the same way they are filtered from Link arrays.
+
+## 2.15.1
+### Fixed
+* Fixed how `entry_mapping` is cached in order to avoid errors when deserializing resources that have been serialized with previously deleted mapping classes. [#212](https://github.com/contentful/contentful.rb/issues/212)
+
+## 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)
+
+## 2.13.3
+### Fixed
+* Fixed unfiltered unresolvable entries and assets from re-marshalled entries. [#207](https://github.com/contentful/contentful.rb/pull/207)
+
+## 2.13.2
+### Fixed
+* Removed unnecessary object dups and moved some static arrays that were regenerated each time to constants.
+
+## 2.13.1
+### Fixed
+* Fixed detection of empty fields when `:use_camel_case` is `true`. [#203](https://github.com/contentful/contentful.rb/issues/203)
+
+## 2.13.0
+### Changed
+* Updated HTTP gem version limits. [#202](https://github.com/contentful/contentful.rb/pull/202)
 
 ## 2.12.0
 ### Added

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;
@@ -21,8 +21,8 @@
     <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License" />
   </a>
   &nbsp;
-  <a href="https://travis-ci.org/contentful/contentful.rb">
-    <img src="https://travis-ci.org/contentful/contentful.rb.svg?branch=master" alt="Build Status">
+  <a href="https://app.circleci.com/pipelines/github/contentful/contentful.rb?branch=master">
+    <img src="https://circleci.com/gh/contentful/contentful.rb/tree/master.svg?style=svg" alt="CircleCI">
   </a>
 </p>
 
@@ -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.rb

@@ -1,5 +1,6 @@
 require_relative 'base_resource'
 require_relative 'array_like'
+require_relative 'includes'
 
 module Contentful
   # Resource Class for Arrays (e.g. search results)
@@ -11,13 +12,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 +28,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,12 +43,15 @@ 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(
           item.raw,
-          raw_object[:configuration].merge(includes_for_single: Support.includes_from_response(raw, false)),
-          item.respond_to?(:localized) ? item.localized : false
+          raw_object[:configuration].merge(includes_for_single: Includes.from_response(raw, false)),
+          item.respond_to?(:localized) ? item.localized : false,
+          0,
+          raw_object[:configuration][:errors] || []
         ).run
       end
     end
@@ -70,7 +77,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

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

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

@@ -5,16 +5,17 @@ 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 = [])
+    def initialize(item, configuration = {}, _localized = false, _includes = Includes.new, entries = {}, depth = 0, _errors = [])
       entries["#{item['sys']['type']}:#{item['sys']['id']}"] = self if entries && item.key?('sys')
       @raw = item
       @default_locale = configuration[:default_locale]
       @depth = depth
       @configuration = configuration
       @sys = hydrate_sys
+      @_metadata = hydrate_metadata
 
       define_sys_methods!
     end
@@ -31,18 +32,33 @@ 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]
       @sys = hydrate_sys
+      @_metadata = hydrate_metadata
       @depth = 0
       define_sys_methods!
     end
@@ -59,9 +75,7 @@ module Contentful
 
     def define_sys_methods!
       @sys.each do |k, v|
-        define_singleton_method k do
-          v
-        end
+        define_singleton_method(k) { v } unless self.class.method_defined?(k)
       end
     end
 
@@ -81,6 +95,15 @@ module Contentful
       result
     end
 
+    def hydrate_metadata
+      result = {}
+      raw.fetch('metadata', {}).each do |k, v|
+        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
@@ -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/coercions.rb

@@ -155,10 +155,7 @@ module Contentful
 
       return nil if Support.unresolvable?(node['data']['target'], configuration[:errors])
 
-      resource = Support.resource_for_link(
-        node['data']['target'],
-        configuration[:includes_for_single]
-      )
+      resource = configuration[:includes_for_single].find_link(node['data']['target'])
 
       # Resource is valid but unreachable
       return Link.new(node['data']['target'], configuration) if resource.nil?

data/lib/contentful/entry.rb

@@ -2,6 +2,7 @@ require_relative 'error'
 require_relative 'fields_resource'
 require_relative 'content_type_cache'
 require_relative 'resource_references'
+require_relative 'includes'
 
 module Contentful
   # Resource class for Entry.
@@ -17,7 +18,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)
@@ -29,7 +31,7 @@ module Contentful
         content_type_field = content_type.field_for(field_id)
         coercion_configuration = @configuration.merge(
           includes_for_single:
-            @configuration.fetch(:includes_for_single, []) + includes,
+            @configuration.fetch(:includes_for_single, Includes.new) + includes,
           _entries_cache: entries,
           localized: localized,
           depth: @depth,
@@ -57,7 +59,7 @@ module Contentful
     # Any included object after the maximum include resolution depth will be just a Link
     def build_nested_resource(value, includes, entries, errors)
       if @depth < @configuration.fetch(:max_include_resolution_depth, 20)
-        resource = Support.resource_for_link(value, includes)
+        resource = includes.find_link(value)
         return resolve_include(resource, includes, entries, errors) unless resource.nil?
       end
 
@@ -71,7 +73,7 @@ module Contentful
         resource,
         @configuration.merge(
           includes_for_single:
-            @configuration.fetch(:includes_for_single, []) + includes,
+            @configuration.fetch(:includes_for_single, Includes.new) + includes,
           _entries_cache: entries
         ),
         localized,
@@ -103,9 +105,11 @@ module Contentful
     protected
 
     def content_type_field?(name)
+      content_type_key = Support.snakify('contentType', @configuration[:use_camel_case])
+
       content_type = ContentTypeCache.cache_get(
         sys[:space].id,
-        sys[:content_type].id
+        sys[content_type_key.to_sym].id
       )
 
       return false if content_type.nil?

data/lib/contentful/fields_resource.rb

@@ -2,6 +2,7 @@
 
 require_relative 'support'
 require_relative 'base_resource'
+require_relative 'includes'
 
 module Contentful
   # Base definition of a Contentful Resource containing Field properties
@@ -9,7 +10,7 @@ module Contentful
     attr_reader :localized
 
     # rubocop:disable Metrics/ParameterLists
-    def initialize(item, _configuration, localized = false, includes = [], entries = {}, depth = 0, errors = [])
+    def initialize(item, _configuration, localized = false, includes = Includes.new, entries = {}, depth = 0, errors = [])
       super
 
       @configuration[:errors] = errors
@@ -48,11 +49,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
@@ -60,7 +57,7 @@ module Contentful
       super(raw_object)
       @localized = raw_object[:localized]
       @fields = hydrate_fields(
-        raw_object[:configuration].fetch(:includes_for_single, []),
+        raw_object[:configuration].fetch(:includes_for_single, Includes.new),
         {},
         raw_object[:configuration].fetch(:errors, [])
       )
@@ -71,6 +68,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
@@ -83,9 +81,7 @@ module Contentful
 
     def define_fields_methods!
       fields.each do |k, v|
-        define_singleton_method k do
-          v
-        end
+        define_singleton_method(k) { v } unless self.class.method_defined?(k)
       end
     end
 
@@ -110,8 +106,8 @@ module Contentful
     end
 
     def hydrate_nonlocalized_fields(includes, errors, entries)
-      result = { locale => {} }
       locale = internal_resource_locale
+      result = { locale => {} }
       raw['fields'].each do |name, value|
         name = Support.snakify(name, @configuration[:use_camel_case])
         result[locale][name.to_sym] = coerce(

data/lib/contentful/includes.rb

@@ -0,0 +1,74 @@
+require_relative 'array_like'
+
+module Contentful
+  # The includes hashes returned when include_level is specified
+  class Includes
+    include ArrayLike
+
+    attr_accessor :items, :lookup
+
+    def initialize(items = [], lookup = nil)
+      self.items = items
+      self.lookup = lookup || build_lookup
+    end
+
+    def self.from_response(json, raw = true)
+      includes = if raw
+                   json['items'].dup
+                 else
+                   json['items'].map(&:raw)
+                 end
+
+      %w[Entry Asset].each do |type|
+        includes.concat(json['includes'].fetch(type, [])) if json.fetch('includes', {}).key?(type)
+      end
+
+      new includes || []
+    end
+
+    def find_link(link)
+      key = "#{link['sys']['linkType']}:#{link['sys']['id']}"
+      lookup[key]
+    end
+
+    # Override some of the features of Array to take into account the lookup
+    # field in a performant way.
+
+    # If the lookups are the same then these two objects are effectively the same
+    def ==(other)
+      object_id == other.object_id || lookup == other.lookup
+    end
+
+    def +(other)
+      # If we're being asked to add to itself, just return without duplicating
+      return self if self == other
+
+      dup.tap do |copy|
+        copy.items += other.items
+        copy.lookup.merge!(other.lookup)
+      end
+    end
+
+    def dup
+      self.class.new(items.dup, lookup.dup)
+    end
+
+    def marshal_dump
+      items
+    end
+
+    def marshal_load(array)
+      self.items = array
+      self.lookup = build_lookup
+    end
+
+    private
+
+    def build_lookup
+      items.each_with_object({}) do |i, h|
+        key = "#{i['sys']['type']}:#{i['sys']['id']}"
+        h[key] = i
+      end
+    end
+  end
+end

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