RubyGems - contentful - Versions diffs - 2.12.0 → 2.17.0 - Mend

contentful 2.12.0 → 2.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (250) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +69 -1
data/README.md +24 -13
data/lib/contentful/array.rb +14 -6
data/lib/contentful/array_like.rb +11 -2
data/lib/contentful/asset.rb +10 -4
data/lib/contentful/base_resource.rb +29 -6
data/lib/contentful/client.rb +4 -3
data/lib/contentful/coercions.rb +1 -4
data/lib/contentful/entry.rb +9 -5
data/lib/contentful/fields_resource.rb +7 -11
data/lib/contentful/includes.rb +74 -0
data/lib/contentful/request.rb +6 -1
data/lib/contentful/resource_builder.rb +15 -12
data/lib/contentful/support.rb +0 -35
data/lib/contentful/version.rb +1 -1
metadata +15 -370
data/.gitignore +0 -7
data/.rspec +0 -1
data/.rubocop.yml +0 -28
data/.rubocop_todo.yml +0 -35
data/.travis.yml +0 -13
data/.yardopts +0 -4
data/Gemfile +0 -9
data/Gemfile.lock +0 -152
data/Guardfile +0 -24
data/RELEASE.md +0 -8
data/Rakefile +0 -33
data/contentful.gemspec +0 -44
data/coverage/.last_run.json +0 -5
data/coverage/.resultset.json +0 -2419
data/coverage/.resultset.json.lock +0 -0
data/coverage/assets/0.10.2/application.css +0 -799
data/coverage/assets/0.10.2/application.js +0 -1707
data/coverage/assets/0.10.2/colorbox/border.png +0 -0
data/coverage/assets/0.10.2/colorbox/controls.png +0 -0
data/coverage/assets/0.10.2/colorbox/loading.gif +0 -0
data/coverage/assets/0.10.2/colorbox/loading_background.png +0 -0
data/coverage/assets/0.10.2/favicon_green.png +0 -0
data/coverage/assets/0.10.2/favicon_red.png +0 -0
data/coverage/assets/0.10.2/favicon_yellow.png +0 -0
data/coverage/assets/0.10.2/loading.gif +0 -0
data/coverage/assets/0.10.2/magnify.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png +0 -0
data/coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
data/coverage/index.html +0 -15071
data/doc/Contentful/AccessDenied.html +0 -159
data/doc/Contentful/Array.html +0 -765
data/doc/Contentful/ArrayCoercion.html +0 -242
data/doc/Contentful/ArrayLike.html +0 -625
data/doc/Contentful/Asset.html +0 -487
data/doc/Contentful/BadGateway.html +0 -159
data/doc/Contentful/BadRequest.html +0 -159
data/doc/Contentful/BaseCoercion.html +0 -445
data/doc/Contentful/BaseResource.html +0 -599
data/doc/Contentful/BooleanCoercion.html +0 -242
data/doc/Contentful/Client.html +0 -1740
data/doc/Contentful/ContentType.html +0 -618
data/doc/Contentful/ContentTypeCache.html +0 -428
data/doc/Contentful/DateCoercion.html +0 -244
data/doc/Contentful/DeletedAsset.html +0 -157
data/doc/Contentful/DeletedEntry.html +0 -157
data/doc/Contentful/EmptyFieldError.html +0 -217
data/doc/Contentful/Entry.html +0 -334
data/doc/Contentful/Error.html +0 -410
data/doc/Contentful/Field.html +0 -936
data/doc/Contentful/FieldsResource.html +0 -583
data/doc/Contentful/File.html +0 -218
data/doc/Contentful/FloatCoercion.html +0 -238
data/doc/Contentful/IntegerCoercion.html +0 -238
data/doc/Contentful/Link.html +0 -249
data/doc/Contentful/LinkCoercion.html +0 -158
data/doc/Contentful/Locale.html +0 -537
data/doc/Contentful/Location.html +0 -383
data/doc/Contentful/LocationCoercion.html +0 -238
data/doc/Contentful/NotFound.html +0 -159
data/doc/Contentful/ObjectCoercion.html +0 -238
data/doc/Contentful/RateLimitExceeded.html +0 -346
data/doc/Contentful/Request.html +0 -887
data/doc/Contentful/ResourceBuilder.html +0 -978
data/doc/Contentful/ResourceReferences.html +0 -254
data/doc/Contentful/Response.html +0 -710
data/doc/Contentful/RichTextCoercion.html +0 -238
data/doc/Contentful/ServerError.html +0 -159
data/doc/Contentful/ServiceUnavailable.html +0 -159
data/doc/Contentful/Space.html +0 -393
data/doc/Contentful/StringCoercion.html +0 -242
data/doc/Contentful/StructuredTextCoercion.html +0 -238
data/doc/Contentful/Support.html +0 -788
data/doc/Contentful/SymbolCoercion.html +0 -169
data/doc/Contentful/Sync.html +0 -653
data/doc/Contentful/SyncPage.html +0 -807
data/doc/Contentful/TextCoercion.html +0 -169
data/doc/Contentful/Unauthorized.html +0 -159
data/doc/Contentful/UnparsableJson.html +0 -159
data/doc/Contentful/UnparsableResource.html +0 -135
data/doc/Contentful.html +0 -157
data/doc/_index.html +0 -563
data/doc/class_list.html +0 -51
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -58
data/doc/css/style.css +0 -496
data/doc/file.CHANGELOG.html +0 -729
data/doc/file.LICENSE.html +0 -70
data/doc/file.README.html +0 -925
data/doc/file_list.html +0 -66
data/doc/frames.html +0 -17
data/doc/index.html +0 -925
data/doc/js/app.js +0 -292
data/doc/js/full_list.js +0 -216
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -1171
data/doc/top-level-namespace.html +0 -110
data/examples/custom_classes.rb +0 -39
data/examples/example_queries.rb +0 -26
data/examples/raise_errors.rb +0 -20
data/examples/raw_mode.rb +0 -14
data/spec/array_spec.rb +0 -122
data/spec/asset_spec.rb +0 -192
data/spec/auto_includes_spec.rb +0 -12
data/spec/client_class_spec.rb +0 -86
data/spec/client_configuration_spec.rb +0 -377
data/spec/content_type_spec.rb +0 -49
data/spec/deleted_asset_spec.rb +0 -38
data/spec/deleted_entry_spec.rb +0 -38
data/spec/entry_spec.rb +0 -688
data/spec/error_class_spec.rb +0 -327
data/spec/error_requests_spec.rb +0 -87
data/spec/field_spec.rb +0 -95
data/spec/file_spec.rb +0 -33
data/spec/fixtures/json_responses/400_details_errors_object.json +0 -14
data/spec/fixtures/json_responses/400_details_errors_string.json +0 -12
data/spec/fixtures/json_responses/400_details_string.json +0 -8
data/spec/fixtures/json_responses/403_reasons.json +0 -13
data/spec/fixtures/json_responses/404_details_string.json +0 -8
data/spec/fixtures/json_responses/404_id.json +0 -11
data/spec/fixtures/json_responses/404_sys_type.json +0 -12
data/spec/fixtures/json_responses/404_type.json +0 -10
data/spec/fixtures/json_responses/content_type.json +0 -83
data/spec/fixtures/json_responses/default_400.json +0 -7
data/spec/fixtures/json_responses/default_401.json +0 -7
data/spec/fixtures/json_responses/default_403.json +0 -7
data/spec/fixtures/json_responses/default_404.json +0 -7
data/spec/fixtures/json_responses/default_429.json +0 -7
data/spec/fixtures/json_responses/default_500.json +0 -7
data/spec/fixtures/json_responses/default_502.json +0 -7
data/spec/fixtures/json_responses/default_503.json +0 -7
data/spec/fixtures/json_responses/includes.json +0 -111
data/spec/fixtures/json_responses/link_array.json +0 -43
data/spec/fixtures/json_responses/not_found.json +0 -13
data/spec/fixtures/json_responses/nyancat.json +0 -48
data/spec/fixtures/json_responses/other_error.json +0 -9
data/spec/fixtures/json_responses/other_error_no_details.json +0 -8
data/spec/fixtures/json_responses/other_error_no_message.json +0 -8
data/spec/fixtures/json_responses/other_error_no_request_id.json +0 -8
data/spec/fixtures/json_responses/other_error_nothing.json +0 -6
data/spec/fixtures/json_responses/self_link.json +0 -82
data/spec/fixtures/json_responses/unparsable.json +0 -13
data/spec/fixtures/vcr_cassettes/array/marshal_custom_classes.yml +0 -159
data/spec/fixtures/vcr_cassettes/array/nested_resources.yml +0 -159
data/spec/fixtures/vcr_cassettes/array.yml +0 -288
data/spec/fixtures/vcr_cassettes/arrayField.yml +0 -87
data/spec/fixtures/vcr_cassettes/array_page_1.yml +0 -106
data/spec/fixtures/vcr_cassettes/array_page_2.yml +0 -73
data/spec/fixtures/vcr_cassettes/asset/select_empty_array.yml +0 -104
data/spec/fixtures/vcr_cassettes/asset/select_no_sys.yml +0 -119
data/spec/fixtures/vcr_cassettes/asset/select_one_field.yml +0 -97
data/spec/fixtures/vcr_cassettes/asset/select_only_sys.yml +0 -88
data/spec/fixtures/vcr_cassettes/asset.yml +0 -96
data/spec/fixtures/vcr_cassettes/assets/issues_129.yml +0 -90
data/spec/fixtures/vcr_cassettes/assets/issues_jekyll_46.yml +0 -115
data/spec/fixtures/vcr_cassettes/bad_request.yml +0 -76
data/spec/fixtures/vcr_cassettes/content_type.yml +0 -147
data/spec/fixtures/vcr_cassettes/entries/empty_fields.yml +0 -246
data/spec/fixtures/vcr_cassettes/entries/issue_117.yml +0 -201
data/spec/fixtures/vcr_cassettes/entries/issue_125.yml +0 -198
data/spec/fixtures/vcr_cassettes/entries/rich_text.yml +0 -1707
data/spec/fixtures/vcr_cassettes/entries/rich_text_hydration_issue.yml +0 -460
data/spec/fixtures/vcr_cassettes/entries/rich_text_nested_fields.yml +0 -653
data/spec/fixtures/vcr_cassettes/entries/rich_text_unresolved_relationships.yml +0 -983
data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter.yml +0 -159
data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter_deeply_nested.yml +0 -167
data/spec/fixtures/vcr_cassettes/entries.yml +0 -561
data/spec/fixtures/vcr_cassettes/entry/custom_resource.yml +0 -168
data/spec/fixtures/vcr_cassettes/entry/include_resolution.yml +0 -101
data/spec/fixtures/vcr_cassettes/entry/include_resolution_uniques.yml +0 -81
data/spec/fixtures/vcr_cassettes/entry/json_objects.yml +0 -88
data/spec/fixtures/vcr_cassettes/entry/json_objects_client.yml +0 -86
data/spec/fixtures/vcr_cassettes/entry/marshal_138.yml +0 -159
data/spec/fixtures/vcr_cassettes/entry/marshal_unpublished.yml +0 -303
data/spec/fixtures/vcr_cassettes/entry/marshall.yml +0 -293
data/spec/fixtures/vcr_cassettes/entry/raw.yml +0 -201
data/spec/fixtures/vcr_cassettes/entry/search_link_to_asset.yml +0 -81
data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry.yml +0 -81
data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry_with_custom_query.yml +0 -115
data/spec/fixtures/vcr_cassettes/entry/select_empty_array.yml +0 -111
data/spec/fixtures/vcr_cassettes/entry/select_no_sys.yml +0 -102
data/spec/fixtures/vcr_cassettes/entry/select_one_field.yml +0 -76
data/spec/fixtures/vcr_cassettes/entry/select_one_field_proper.yml +0 -114
data/spec/fixtures/vcr_cassettes/entry/select_only_sys.yml +0 -111
data/spec/fixtures/vcr_cassettes/entry.yml +0 -102
data/spec/fixtures/vcr_cassettes/entry_cache.yml +0 -288
data/spec/fixtures/vcr_cassettes/entry_locales.yml +0 -104
data/spec/fixtures/vcr_cassettes/field.yml +0 -147
data/spec/fixtures/vcr_cassettes/human.yml +0 -118
data/spec/fixtures/vcr_cassettes/linkField.yml +0 -83
data/spec/fixtures/vcr_cassettes/locale.yml +0 -83
data/spec/fixtures/vcr_cassettes/locale_from_environment.yml +0 -121
data/spec/fixtures/vcr_cassettes/location.yml +0 -193
data/spec/fixtures/vcr_cassettes/multi_locale_array_reference.yml +0 -196
data/spec/fixtures/vcr_cassettes/multi_locale_reference.yml +0 -214
data/spec/fixtures/vcr_cassettes/not_found.yml +0 -76
data/spec/fixtures/vcr_cassettes/nyancat.yml +0 -102
data/spec/fixtures/vcr_cassettes/ratelimit.yml +0 -64
data/spec/fixtures/vcr_cassettes/ratelimit_retry.yml +0 -294
data/spec/fixtures/vcr_cassettes/reloaded_entry.yml +0 -102
data/spec/fixtures/vcr_cassettes/space.yml +0 -83
data/spec/fixtures/vcr_cassettes/sync_deleted_asset.yml +0 -174
data/spec/fixtures/vcr_cassettes/sync_deleted_entry.yml +0 -89
data/spec/fixtures/vcr_cassettes/sync_deletion.yml +0 -191
data/spec/fixtures/vcr_cassettes/sync_environment.yml +0 -81
data/spec/fixtures/vcr_cassettes/sync_page.yml +0 -637
data/spec/fixtures/vcr_cassettes/sync_page_2.yml +0 -71
data/spec/fixtures/vcr_cassettes/sync_page_short.yml +0 -106
data/spec/fixtures/vcr_cassettes/unauthorized.yml +0 -64
data/spec/fixtures/vcr_cassettes/unavailable.yml +0 -76
data/spec/link_spec.rb +0 -50
data/spec/locale_spec.rb +0 -37
data/spec/location_spec.rb +0 -25
data/spec/request_spec.rb +0 -57
data/spec/resource_building_spec.rb +0 -31
data/spec/response_spec.rb +0 -62
data/spec/space_spec.rb +0 -31
data/spec/spec_helper.rb +0 -14
data/spec/support/client.rb +0 -6
data/spec/support/json_responses.rb +0 -18
data/spec/support/vcr.rb +0 -16
data/spec/sync_page_spec.rb +0 -103
data/spec/sync_spec.rb +0 -180

data/doc/index.html DELETED Viewed

@@ -1,925 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  File: README
-    &mdash; Documentation by YARD 0.9.18
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "README";
-  relpath = '';
-</script>
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="_index.html">Index</a> &raquo;
-    <span class="title">File: README</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><div id='filecontents'>
-<p><img src="./.github/header.png"> &lt;p align=“center”&gt;  &lt;a href=“<a
-href="https://www.contentful.com/slack">www.contentful.com/slack</a>/”&gt;
-&lt;img src=“<a
-href="https://img.shields.io/badge/-Join%20Community%20Slack-2AB27B.svg?logo=slack&maxAge=31557600">img.shields.io/badge/-Join%20Community%20Slack-2AB27B.svg?logo=slack&maxAge=31557600</a>”
-alt=“Join Contentful Community Slack”&gt;  &lt;/a&gt;     &lt;a href=“<a
-href="https://www.contentfulcommunity.com">www.contentfulcommunity.com</a>/”&gt;
-&lt;img src=“<a
-href="https://img.shields.io/badge/-Join%20Community%20Forum-3AB2E6.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MiA1OSI+CiAgPHBhdGggZmlsbD0iI0Y4RTQxOCIgZD0iTTE4IDQxYTE2IDE2IDAgMCAxIDAtMjMgNiA2IDAgMCAwLTktOSAyOSAyOSAwIDAgMCAwIDQxIDYgNiAwIDEgMCA5LTkiIG1hc2s9InVybCgjYikiLz4KICA8cGF0aCBmaWxsPSIjNTZBRUQyIiBkPSJNMTggMThhMTYgMTYgMCAwIDEgMjMgMCA2IDYgMCAxIDAgOS05QTI5IDI5IDAgMCAwIDkgOWE2IDYgMCAwIDAgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0UwNTM0RSIgZD0iTTQxIDQxYTE2IDE2IDAgMCAxLTIzIDAgNiA2IDAgMSAwLTkgOSAyOSAyOSAwIDAgMCA0MSAwIDYgNiAwIDAgMC05LTkiLz4KICA8cGF0aCBmaWxsPSIjMUQ3OEE0IiBkPSJNMTggMThhNiA2IDAgMSAxLTktOSA2IDYgMCAwIDEgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0JFNDMzQiIgZD0iTTE4IDUwYTYgNiAwIDEgMS05LTkgNiA2IDAgMCAxIDkgOSIvPgo8L3N2Zz4K&maxAge=31557600">img.shields.io/badge/-Join%20Community%20Forum-3AB2E6.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MiA1OSI+CiAgPHBhdGggZmlsbD0iI0Y4RTQxOCIgZD0iTTE4IDQxYTE2IDE2IDAgMCAxIDAtMjMgNiA2IDAgMCAwLTktOSAyOSAyOSAwIDAgMCAwIDQxIDYgNiAwIDEgMCA5LTkiIG1hc2s9InVybCgjYikiLz4KICA8cGF0aCBmaWxsPSIjNTZBRUQyIiBkPSJNMTggMThhMTYgMTYgMCAwIDEgMjMgMCA2IDYgMCAxIDAgOS05QTI5IDI5IDAgMCAwIDkgOWE2IDYgMCAwIDAgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0UwNTM0RSIgZD0iTTQxIDQxYTE2IDE2IDAgMCAxLTIzIDAgNiA2IDAgMSAwLTkgOSAyOSAyOSAwIDAgMCA0MSAwIDYgNiAwIDAgMC05LTkiLz4KICA8cGF0aCBmaWxsPSIjMUQ3OEE0IiBkPSJNMTggMThhNiA2IDAgMSAxLTktOSA2IDYgMCAwIDEgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0JFNDMzQiIgZD0iTTE4IDUwYTYgNiAwIDEgMS05LTkgNiA2IDAgMCAxIDkgOSIvPgo8L3N2Zz4K&maxAge=31557600</a>”
-alt=“Join Contentful Community Forum”&gt;  &lt;/a&gt; &lt;/p&gt;</p>
-<h1 id="label-contentful.rb+-+Contentful+Ruby+Delivery+SDK">contentful.rb - Contentful Ruby Delivery SDK</h1>
-<p><a href="http://badge.fury.io/rb/contentful"><img
-src="https://badge.fury.io/rb/contentful.png"></a></p>
-<blockquote>
-<p>Ruby SDK for the Contentful <a
-href="https://www.contentful.com/developers/docs/references/content-delivery-api/">Content
-Delivery API</a> and <a
-href="https://www.contentful.com/developers/docs/references/content-preview-api/">Content
-Preview API</a>. It helps you to easily access your Content stored in
-Contentful with your Ruby applications.</p>
-</blockquote>
-<p align="center">
-  <img src="https://img.shields.io/badge/Status-Maintained-green.svg" alt="This repository is actively maintained" /> &nbsp;
-  <a href="LICENSE.txt">
-    <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>
-</p><p align="center">
-  <a href="https://rubygems.org/gems/contentful">
-    <img src="https://img.shields.io/gem/v/contentful.svg" alt="RubyGems version">
-  </a>
-  &nbsp;
-  <a href="https://rubygems.org/gems/contentful">
-    <img src="https://img.shields.io/gem/dt/contentful.svg" alt="RubyGems downloads">
-  </a>
-</p>
-<p><strong>What is Contentful?</strong></p>
-<p><a href="https://www.contentful.com/">Contentful</a> provides content
-infrastructure for digital teams to power websites, apps, and devices.
-Unlike a CMS, Contentful was built to integrate with the modern software
-stack. It offers a central hub for structured content, powerful management
-and delivery APIs, and a customizable web app that enable developers and
-content creators to ship their products faster.</p>
-<p>&lt;details&gt; &lt;summary&gt;Table of contents&lt;/summary&gt;</p>
-<!-- TOC --><ul><li>
-<p><a href="#contentfulrb---contentful-ruby-delivery-sdk">contentful.rb -
-Contentful Ruby Delivery SDK</a></p>
-</li><li>
-<p><a href="#core-features">Core Features</a></p>
-</li><li>
-<p><a href="#getting-started">Getting started</a></p>
-<ul><li>
-<p><a href="#installation">Installation</a></p>
-</li><li>
-<p><a href="#your-first-request">Your first request</a></p>
-</li><li>
-<p><a href="#using-this-sdk-with-the-preview-api">Using this SDK with the
-Preview API</a></p>
-</li><li>
-<p><a href="#authentication">Authentication</a></p>
-</li></ul>
-</li><li>
-<p><a href="#documentation--references">Documentation & References</a></p>
-<ul><li>
-<p><a href="#configuration">Configuration</a></p>
-</li><li>
-<p><a href="#reference-documentation">Reference documentation</a></p>
-</li><li>
-<p><a href="#basic-queries">Basic queries</a></p>
-</li><li>
-<p><a href="#filtering-options">Filtering options</a></p>
-</li><li>
-<p><a href="#accessing-fields-and-sys-properties">Accessing fields and sys
-properties</a></p>
-</li><li>
-<p><a href="#dynamic-entries">Dynamic entries</a></p>
-</li><li>
-<p><a href="#using-different-locales">Using different locales</a></p>
-</li><li>
-<p><a href="#arrays">Arrays</a></p>
-</li><li>
-<p><a href="#links">Links</a></p>
-</li><li>
-<p><a href="#assets">Assets</a></p>
-</li><li>
-<p><a href="#resource-options">Resource options</a></p>
-</li><li>
-<p><a href="#field-type-object">Field type Object</a></p>
-</li><li>
-<p><a href="#advanced-concepts">Advanced concepts</a></p>
-</li><li>
-<p><a href="#proxy-example">Proxy example</a></p>
-</li><li>
-<p><a href="#custom-resource-classes">Custom resource classes</a></p>
-</li><li>
-<p><a href="#synchronization">Synchronization</a></p>
-</li><li>
-<p><a href="#migrating-to-2x">Migrating to 2.x</a></p>
-</li><li>
-<p><a href="#tutorials--other-resources">Tutorials & other resources</a></p>
-</li></ul>
-</li><li>
-<p><a href="#reach-out-to-us">Reach out to us</a></p>
-<ul><li>
-<p><a href="#you-have-questions-about-how-to-use-this-library">You have
-questions about how to use this library?</a></p>
-</li><li>
-<p><a href="#you-found-a-bug-or-want-to-propose-a-feature">You found a bug or
-want to propose a feature?</a></p>
-</li><li>
-<p><a
-href="#you-need-to-share-confidential-information-or-have-other-questions">You
-need to share confidential information or have other questions?</a></p>
-</li></ul>
-</li><li>
-<p><a href="#get-involved">Get involved</a></p>
-</li><li>
-<p><a href="#license">License</a></p>
-</li><li>
-<p><a href="#code-of-conduct">Code of Conduct</a></p>
-</li></ul>
-<!-- /TOC -->
-<p>&lt;/details&gt;</p>
-<h2 id="label-Core+Features">Core Features</h2>
-<ul><li>
-<p>Content retrieval through <a
-href="https://www.contentful.com/developers/docs/references/content-delivery-api/">Content
-Delivery API</a> and <a
-href="https://www.contentful.com/developers/docs/references/content-preview-api/">Content
-Preview API</a>.</p>
-</li><li>
-<p><a
-href="https://www.contentful.com/developers/docs/concepts/sync/">Synchronization</a></p>
-</li><li>
-<p><a
-href="https://www.contentful.com/developers/docs/concepts/locales/">Localization
-support</a></p>
-</li><li>
-<p><a href="https://www.contentful.com/developers/docs/concepts/links/">Link
-resolution</a></p>
-</li><li>
-<p>Built in rate limiting recovery procedures</p>
-</li><li>
-<p>Supports <a
-href="https://www.contentful.com/developers/docs/concepts/multiple-environments/">Environments</a>
-(<strong>since v2.6.0 - 16. April 2018</strong>)</p>
-</li></ul>
-<h2 id="label-Getting+started">Getting started</h2>
-<p>In order to get started with the Contentful Ruby SDK you&#39;ll need not
-only to install it, but also to get credentials which will allow you to
-have access to your content in Contentful.</p>
-<ul><li>
-<p><a href="#installation">Installation</a></p>
-</li><li>
-<p><a href="#your-first-request">Your first request</a></p>
-</li><li>
-<p><a href="#using-this-sdk-with-the-preview-api">Using this SDK with the
-Preview API</a></p>
-</li><li>
-<p><a href="#authentication">Authentication</a></p>
-</li><li>
-<p><a href="#documentation--references">Documentation & References</a></p>
-</li></ul>
-<h3 id="label-Installation">Installation</h3>
-<p>Add to your Gemfile and bundle:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>contentful</span><span class='tstring_end'>&#39;</span></span>
-</code></pre>
-<p>Or install it directly from your console:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_i'>i</span> <span class='id identifier rubyid_contentful'>contentful</span>
-</code></pre>
-<h3 id="label-Your+first+request">Your first request</h3>
-<p>The following code snippet is the most basic one you can use to get some
-content from Contentful with this SDK:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>contentful</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>  <span class='comment'># This is the space ID. A space is like a project folder in Contentful terms
-</span>  <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span>  <span class='comment'># This is the access token for this space. Normally you get both ID and the token in the Contentful web app
-</span><span class='rparen'>)</span>
-<span class='comment'># This API call will request an entry with the specified ID from the space defined at the top, using a space-specific access token.
-</span><span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entry'>entry</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nyancat</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-</code></pre>
-<h3 id="label-Using+this+SDK+with+the+Preview+API">Using this SDK with the Preview API</h3>
-<p>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:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>contentful</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>api_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>preview.contentful.com</span><span class='tstring_end'>&#39;</span></span>
-<span class='rparen'>)</span>
-</code></pre>
-<p>You can query for entries, assets, etc. very similar as described in the <a
-href="https://www.contentful.com/developers/docs/references/content-delivery-api/">Delivery
-API Documentation</a>. Please note, that <strong>all methods of the Ruby
-client library are snake_cased, instead of JavaScript&#39;s
-camelCase</strong>:</p>
-<h3 id="label-Authentication">Authentication</h3>
-<p>To get your own content from Contentful, an app should authenticate with an
-OAuth bearer token.</p>
-<p>You can create API keys using the <a
-href="https://app.contentful.com">Contentful web interface</a>. Go to the
-app, open the space that you want to access (top left corner lists all the
-spaces), and navigate to the APIs area. Open the API Keys section and
-create your first token. Done.</p>
-<p>Don&#39;t forget to also get your Space ID.</p>
-<p>For more information, check the <a
-href="https://www.contentful.com/developers/docs/references/authentication/">Contentful
-REST API reference on Authentication</a>.</p>
-<h2 id="label-Documentation+-26+References">Documentation &amp; References</h2>
-<ul><li>
-<p><a href="#configuration">Configuration</a></p>
-</li><li>
-<p><a href="#reference-documentation">Reference documentation</a></p>
-</li><li>
-<p><a href="#tutorials--other-resources">Tutorials & other resources</a></p>
-</li><li>
-<p><a href="#advanced-concepts">Advanced Concepts</a></p>
-</li><li>
-<p><a href="#migrating-to-2x">Migrating to 2.x</a></p>
-</li></ul>
-<p>To help you get the most out of this SDK, we&#39;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.</p>
-<h3 id="label-Configuration">Configuration</h3>
-<p>The client constructor supports several options you may set to achieve the
-expected behavior:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='comment'># ... your options here ...
-</span><span class='rparen'>)</span>
-</code></pre>
-<table>
-  <thead>
-    <tr>
-      <th>Name</th>
-      <th>Default</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><code>access_token</code></td>
-      <td></td>
-      <td><strong>Required</strong>. Your access token.</td>
-    </tr>
-    <tr>
-      <td><code>space</code></td>
-      <td></td>
-      <td><strong>Required</strong>. Your space ID.</td>
-    </tr>
-    <tr>
-      <td><code>environment</code></td>
-      <td>'master'</td>
-      <td>Your environment ID.</td>
-    </tr>
-    <tr>
-      <td><code>api_url</code></td>
-      <td><code>'cdn.contentful.com'</code></td>
-      <td>Set the host used to build the request URIs.</td>
-    </tr>
-    <tr>
-      <td><code>default_locale</code></td>
-      <td><code>'en-US'</code></td>
-      <td>Defines default locale for the client.</td>
-    </tr>
-    <tr>
-      <td><code>secure</code></td>
-      <td><code>true</code></td>
-      <td>Defines whether to use HTTPS or HTTP. By default we use HTTPS.</td>
-    </tr>
-    <tr>
-      <td><code>authentication_mechanism</code></td>
-      <td><code>:header</code></td>
-      <td>Sets the authentication mechanisms, valid options are <code>:header</code> or <code>:query_string</code></td>
-    </tr>
-    <tr>
-      <td><code>raise_errors</code></td>
-      <td><code>true</code></td>
-      <td>Determines whether errors are raised or returned.</td>
-    </tr>
-    <tr>
-      <td><code>raise_for_empty_fields</code></td>
-      <td><code>true</code></td>
-      <td>Determines whether <code>EmptyFieldError</code> is raised when empty fields are requested on an entry or <code>nil</code> is returned.</td>
-    </tr>
-    <tr>
-      <td><code>dynamic_entries</code></td>
-      <td><code>:manual</code></td>
-      <td>
-        Determines if content type caching is enabled automatically or not,
-        allowing for accessing of fields even when they are not present on the response.
-        Valid options are <code>:auto</code> and <code>:manual</code>.
-      </td>
-    </tr>
-    <tr>
-      <td><code>raw_mode</code></td>
-      <td><code>false</code></td>
-      <td>If enabled, API responses are not parsed and the raw response object is returned instead.</td>
-    </tr>
-    <tr>
-      <td><code>resource_mapping</code></td>
-      <td><code>{}</code></td>
-      <td>Allows for overriding default resource classes with custom ones.</td>
-    </tr>
-    <tr>
-      <td><code>entry_mapping</code></td>
-      <td><code>{}</code></td>
-      <td>Allows for overriding of specific entry classes by content type.</td>
-    </tr>
-    <tr>
-      <td><code>gzip_encoded</code></td>
-      <td><code>true</code></td>
-      <td>Enables gzip response content encoding.</td>
-    </tr>
-    <tr>
-      <td><code>max_rate_limit_retries</code></td>
-      <td><code>1</code></td>
-      <td>
-        To increase or decrease the retry attempts after a 429 Rate Limit error. Default value is 1. Using 0 will disable retry behaviour.
-        Each retry will be attempted after the value (in seconds) of the <code>X-Contentful-RateLimit-Reset</code> header,
-        which contains the amount of seconds until the next non rate limited request is available, has passed.
-        This is blocking per execution thread.
-      </td>
-    </tr>
-    <tr>
-      <td><code>max_rate_limit_wait</code></td>
-      <td><code>60</code></td>
-      <td>
-        Maximum time to wait for next available request (in seconds). Default value is 60 seconds.
-        Keep in mind that if you hit the hourly rate limit maximum, you can have up to 60 minutes of blocked requests.
-        It is set to a default of 60 seconds in order to avoid blocking processes for too long, as rate limit retry behaviour
-        is blocking per execution thread.
-      </td>
-    </tr>
-    <tr>
-      <td><code>max_include_resolution_depth</code></td>
-      <td><code>20</code></td>
-      <td>
-        Maximum amount of levels to resolve includes for SDK 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.
-        <strong>Note</strong>: If you're using something like <code>Rails::cache</code> it's advisable to considerably lower this value
-        (around 5 has proven to be a good compromise - but keep it higher or equal than your maximum API-level include parameter if you need the entire tree resolution).
-        Note that when <code>reuse_entries</code> is enabled, the max include resolution depth only affects
-        deep chains of unique objects (ie, not simple circular references).
-      </td>
-    </tr>
-    <tr>
-      <td><code>reuse_entries</code></td>
-      <td><code>false</code></td>
-      <td>
-        When enabled, reuse hydrated Entry and Asset objects within the same request when possible.
-        Can result in a large speed increase and better handles cyclical object graphs.
-        This can be a good alternative to <code>max_include_resolution_depth</code> if your content model contains (or can contain) circular references.
-        <strong>Caching may break if this option is enabled, as it may generate stack errors.</strong>
-        When caching, deactivate this option and opt for a conservative <code>max_include_resolution_depth</code> value.
-      </td>
-    </tr>
-    <tr>
-      <td><code>use_camel_case</code></td>
-      <td><code>false</code></td>
-      <td>
-        When doing the v2 upgrade, all keys and accessors were changed to always use <code>snake_case</code>.
-        This option introduces the ability to use <code>camelCase</code> for keys and method accessors.
-        This is very useful for isomorphic applications.
-      </td>
-    </tr>
-    <tr>
-      <td><code>proxy_host</code></td>
-      <td><code>nil</code></td>
-      <td>To be able to perform a request behind a proxy, this needs to be set. It can be a domain or IP address of the proxy server.</td>
-    </tr>
-    <tr>
-      <td><code>proxy_port</code></td>
-      <td><code>nil</code></td>
-      <td>Specify the port number that is used by the proxy server for client connections.</td>
-    </tr>
-    <tr>
-      <td><code>proxy_username</code></td>
-      <td><code>nil</code></td>
-      <td>Username for proxy authentication.</td>
-    </tr>
-    <tr>
-      <td><code>proxy_password</code></td>
-      <td><code>nil</code></td>
-      <td>Password for proxy authentication.</td>
-    </tr>
-    <tr>
-      <td><code>timeout_read</code></td>
-      <td><code>nil</code></td>
-      <td>Number of seconds the request waits to read from the server before timing out.</td>
-    </tr>
-    <tr>
-      <td><code>timeout_write</code></td>
-      <td><code>nil</code></td>
-      <td>Number of seconds the request waits when writing to the server before timing out.</td>
-    </tr>
-    <tr>
-      <td><code>timeout_connect</code></td>
-      <td><code>nil</code></td>
-      <td>Number of seconds the request waits to connect to the server before timing out.</td>
-    </tr>
-    <tr>
-      <td><code>logger</code></td>
-      <td><code>nil</code></td>
-      <td>To enable logging pass a logger instance compatible with <code>::Logger</code>.</td>
-    </tr>
-    <tr>
-      <td><code>log_level</code></td>
-      <td><code>::Logger::INFO</code></td>
-      <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.
-      </td>
-    </tr>
-  </tbody>
-</table>
-<h3 id="label-Reference+documentation">Reference documentation</h3>
-<h4 id="label-Basic+queries">Basic queries</h4>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_content_types'>content_types</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_content_types'>content_types</span>
-<span class='id identifier rubyid_cat_content_type'>cat_content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_content_type'>content_type</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cat</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_nyancat'>nyancat</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entry'>entry</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nyancat</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span>
-<span class='id identifier rubyid_assets'>assets</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_assets'>assets</span>
-<span class='id identifier rubyid_nyancat_asset'>nyancat_asset</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_asset'>asset</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nyancat</span><span class='tstring_end'>&#39;</span></span>
-</code></pre>
-<h4 id="label-Filtering+options">Filtering options</h4>
-<p>You can pass the usual filter options to the query:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='label'>content_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cat</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># query for a content-type by its ID (not name)
-</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sys.id[ne]</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nyancat</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># query for all entries except &#39;nyancat&#39;
-</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='label'>include:</span> <span class='int'>1</span><span class='rparen'>)</span> <span class='comment'># include one level of linked resources
-</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='label'>content_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cat</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>include:</span> <span class='int'>1</span><span class='rparen'>)</span> <span class='comment'># you can also combine multiple parameters
-</span></code></pre>
-<p>To read more about filtering options you can check our <a
-href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">search
-parameters documentation</a>.</p>
-<p>The results are returned as <code>Contentful::BaseResource</code> objects.
-Multiple results will be returned as <code>Contentful::Array</code>. The
-properties of a resource can be accessed through Ruby methods.</p>
-<h4 id="label-Accessing+fields+and+sys+properties">Accessing fields and sys properties</h4>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_content_type'>content_type</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cat</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_content_type'>content_type</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span> <span class='comment'># &quot;Meow.&quot;
-</span></code></pre>
-<p>System Properties behave the same and can be accessed via the
-<code>#sys</code> method.</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_content_type'>content_type</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='comment'># =&gt; &#39;cat&#39;
-</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='comment'># =&gt; &#39;Entry&#39;
-</span><span class='id identifier rubyid_asset'>asset</span><span class='period'>.</span><span class='id identifier rubyid_sys'>sys</span> <span class='comment'># { id: &#39;...&#39;, type: &#39;...&#39; }
-</span></code></pre>
-<p>Entry fields also have direct accessors and will be coerced to the type
-defined in it&#39;s content type. However, if using <code>dynamic_entries:
-:manual</code>, coercion will not be done.</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entry'>entry</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nyancat</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_fields'>fields</span><span class='lbracket'>[</span><span class='symbol'>:color</span><span class='rbracket'>]</span> <span class='comment'># &#39;rainbow&#39;
-</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_color'>color</span> <span class='comment'># &#39;rainbow&#39;
-</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_birthday'>birthday</span> <span class='comment'># #&lt;DateTime: 2011-04-04T22:00:00+00:00 ((2455656j,79200s,0n),+0s,2299161j)&gt;
-</span></code></pre>
-<h4 id="label-Dynamic+entries">Dynamic entries</h4>
-<p>However, you can (and should) set <code>:dynamic_entries</code> to
-<code>:auto</code> in your client configuration. When using this option,
-the client will cache all available content types and use them to hydrate
-entries when fields are missing in the response and coerce fields to their
-proper types.</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>dynamic_entries:</span> <span class='symbol'>:auto</span>
-<span class='rparen'>)</span>
-<span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entry'>entry</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nyancat</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># =&gt; #&lt;Contentful::Entry[cat]: ...&gt;
-</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_color'>color</span> <span class='comment'># =&gt; &#39;rainbow&#39;
-</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_birthday'>birthday</span> <span class='comment'># #&lt;DateTime: 2011-04-04T22:00:00+00:00 ((2455656j,79200s,0n),+0s,2299161j)&gt;
-</span></code></pre>
-<p>Dynamic entries will have getter classes for the fields and do type
-conversions properly.</p>
-<p>The <code>:auto</code> mode will fetch all content types on initialization.
-If you want to do it by hand later, you will need to set the option to
-<code>:manual</code> and call
-<code>client.update_dynamic_entry_cache!</code> to initialize the cache.</p>
-<h4 id="label-Using+different+locales">Using different locales</h4>
-<p>Entries can have multiple locales, by default, the client only fetches the
-entry with only its default locale. If you want to fetch a different locale
-you can do the following:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='label'>locale:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>de-DE</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-</code></pre>
-<p>Then all the fields will be fetched for the requested locale.</p>
-<p>Contentful Delivery API also allows to fetch all locales, you can do so by
-doing:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='label'>content_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cat</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>locale:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>*</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-<span class='comment'># assuming the entry has a field called name
-</span><span class='id identifier rubyid_my_spanish_name'>my_spanish_name</span> <span class='op'>=</span> <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_fields'>fields</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>es-AR</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span>
-</code></pre>
-<p>When requesting multiple locales, the object accessor shortcuts only work
-for the default locale.</p>
-<h4 id="label-Arrays">Arrays</h4>
-<p>Contentful::Array has an <code>#each</code> method that delegates to its
-items. It also includes Ruby&#39;s Enumerable module, providing methods
-like <code>#min</code> or <code>#first</code>. See the Ruby core
-documentation for further details.</p>
-<p>Arrays also have a <code>#next_page</code> URL, which will rerun the
-request with a increased skip parameter, as described in <a
-href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/skip">the
-documentation</a>.</p>
-<h4 id="label-Links">Links</h4>
-<p>You can easily request a resource that is represented by a link by calling
-<code>#resolve</code>:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_happycat'>happycat</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entry'>entry</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>happycat</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_happycat'>happycat</span><span class='period'>.</span><span class='id identifier rubyid_image'>image</span>
-<span class='comment'># =&gt; #&lt;Contentful::Link: @sys={:type=&gt;&quot;Link&quot;, :linkType=&gt;&quot;Asset&quot;, :id=&gt;&quot;happycat&quot;}&gt;
-</span><span class='id identifier rubyid_happycat'>happycat</span><span class='period'>.</span><span class='id identifier rubyid_image'>image</span><span class='period'>.</span><span class='id identifier rubyid_resolve'>resolve</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span> <span class='comment'># =&gt; #&lt;Contentful::Asset: @fields={ ...
-</span></code></pre>
-<h3 id="label-Assets">Assets</h3>
-<p>There is a helpful method to add image resize options for an asset image:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_asset'>asset</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>happycat</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
-<span class='comment'># =&gt; &quot;//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
-</span><span class='comment'>#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg&quot;
-</span>
-<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_asset'>asset</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>happycat</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='lparen'>(</span><span class='label'>width:</span> <span class='int'>300</span><span class='comma'>,</span> <span class='label'>height:</span> <span class='int'>200</span><span class='comma'>,</span> <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>jpg</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>quality:</span> <span class='int'>100</span><span class='rparen'>)</span>
-<span class='comment'># =&gt; &quot;//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
-</span><span class='comment'>#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg?w=300&amp;h=200&amp;fm=jpg&amp;q=100&quot;
-</span></code></pre>
-<h4 id="label-Resource+options">Resource options</h4>
-<p>Resources, that have been requested directly (i.e. no child resources), can
-be fetched from the server again by calling <code>#reload</code>:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span>
-<span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_reload'>reload</span> <span class='comment'># Fetches the array of entries again
-</span></code></pre>
-<h4 id="label-Field+type+Object">Field type <code>Object</code></h4>
-<p>While for known field types, the field data is accessible using methods or
-the <code>#fields</code> hash with symbol keys, it behaves differently for
-nested data of the type “Object”. The client will treat them as arbitrary
-hashes and will not parse the data inside.</p>
-<h3 id="label-Advanced+concepts">Advanced concepts</h3>
-<h4 id="label-Proxy+example">Proxy example</h4>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>proxy_host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>proxy_port:</span> <span class='int'>8080</span><span class='comma'>,</span>
-  <span class='label'>proxy_username:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>username</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>proxy_password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>secret_password</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-<span class='rparen'>)</span>
-</code></pre>
-<h4 id="label-Custom+resource+classes">Custom resource classes</h4>
-<p>You can define your own classes that will be returned instead of the
-predefined ones. Consider, you want to build a better Asset class. One way
-to do this is:</p>
-<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>MyBetterAsset</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Asset.html" title="Contentful::Asset (class)">Asset</a></span></span>
-  <span class='kw'>def</span> <span class='id identifier rubyid_https_image_url'>https_image_url</span>
-    <span class='id identifier rubyid_image_url'>image_url</span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span> <span class='tstring'><span class='regexp_beg'>%r&lt;</span><span class='tstring_content'>\A//</span><span class='regexp_end'>&gt;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://</span><span class='tstring_end'>&#39;</span></span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span>
-</code></pre>
-<p>You can register your custom class on client initialization:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>resource_mapping:</span> <span class='lbrace'>{</span>
-    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Asset</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>MyBetterAsset</span>
-  <span class='rbrace'>}</span>
-<span class='rparen'>)</span>
-</code></pre>
-<p>More information on <code>:resource_mapping</code> can be found in <a
-href="./examples/resource_mapping.rb">examples/resource_mapping.rb</a> and
-more on custom classes in <a
-href="./examples/custom_classes.rb">examples/custom_classes.rb</a>.</p>
-<p>You can also register custom entry classes to be used based on the
-entry&#39;s content_type using the <code>:entry_mapping</code>
-configuration:</p>
-<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Cat</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Entry.html" title="Contentful::Entry (class)">Entry</a></span></span>
-  <span class='comment'># define methods based on :fields, etc
-</span><span class='kw'>end</span>
-<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>entry_mapping:</span> <span class='lbrace'>{</span>
-    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cat</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>Cat</span>
-  <span class='rbrace'>}</span>
-<span class='rparen'>)</span>
-<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_entry'>entry</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nyancat</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># is instance of Cat
-</span></code></pre>
-<h4 id="label-Synchronization">Synchronization</h4>
-<p>The client also includes a wrapper for the synchronization endpoint. You
-can initialize it with the options described in the <a
-href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization">Delivery
-API Documentation</a> or an URL you received from a previous sync:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Contentful.html" title="Contentful (module)">Contentful</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Contentful/Client.html#initialize-instance_method" title="Contentful::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-  <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
-  <span class='label'>default_locale:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>en-US</span><span class='tstring_end'>&#39;</span></span>
-<span class='rparen'>)</span>
-<span class='id identifier rubyid_sync'>sync</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sync'>sync</span><span class='lparen'>(</span><span class='label'>initial:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Deletion</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># Only returns deleted entries and assets
-</span><span class='id identifier rubyid_sync'>sync</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sync'>sync</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4gr...sGPg</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># Continues a sync
-</span></code></pre>
-<p>You can access the results either wrapped in
-<code>Contentful::SyncPage</code> objects:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sync'>sync</span><span class='period'>.</span><span class='id identifier rubyid_each_page'>each_page</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_page'>page</span><span class='op'>|</span>
-  <span class='comment'># Find resources at: page.items
-</span><span class='kw'>end</span>
-<span class='comment'># More explicit version:
-</span><span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_sync'>sync</span><span class='period'>.</span><span class='id identifier rubyid_first_page'>first_page</span>
-<span class='kw'>until</span> <span class='id identifier rubyid_sync'>sync</span><span class='period'>.</span><span class='id identifier rubyid_completed?'>completed?</span>
-  <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_sync'>sync</span><span class='period'>.</span><span class='id identifier rubyid_next_page'>next_page</span>
-<span class='kw'>end</span>
-</code></pre>
-<p>Or directly iterative over all resources:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sync'>sync</span><span class='period'>.</span><span class='id identifier rubyid_each_item'>each_item</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
-  <span class='comment'># ...
-</span><span class='kw'>end</span>
-</code></pre>
-<p>When a sync is completed, the next sync url can be read from the Sync or
-SyncPage object:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sync'>sync</span><span class='period'>.</span><span class='id identifier rubyid_next_sync_url'>next_sync_url</span>
-</code></pre>
-<p><strong>Please note</strong> that synchronization entries come in all
-locales, so make sure, you supply a :default_locale property to the client
-configuration, when using the sync feature. This locale will be returned by
-default, when you call <code>Entry#fields</code>. The other localized data
-will also be saved and can be accessed by calling the fields method with a
-locale parameter:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_first_entry'>first_entry</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sync'>sync</span><span class='lparen'>(</span><span class='label'>initial:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Entry</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first_page'>first_page</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
-<span class='id identifier rubyid_first_entry'>first_entry</span><span class='period'>.</span><span class='id identifier rubyid_fields'>fields</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>de-DE</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># Returns German localizations
-</span></code></pre>
-<h3 id="label-Migrating+to+2.x">Migrating to 2.x</h3>
-<p>If you&#39;re a <code>0.x</code> or a <code>1.x</code> user of this gem,
-and are planning to migrate to the current <code>2.x</code> branch. There
-are a few breaking changes you have to take into account:</p>
-<ul><li>
-<p><code>Contentful::Link#resolve</code> and
-<code>Contentful::Array#next_page</code> now require a
-<code>Contentful::Client</code> instance as a parameter.</p>
-</li><li>
-<p><code>Contentful::CustomResource</code> does no longer exist, custom entry
-classes can now inherit from <code>Contentful::Entry</code> and have proper
-marshalling working.</p>
-</li><li>
-<p><code>Contentful::Resource</code> does no longer exist, all resource
-classes now inherit from <code>Contentful::BaseResource</code>.
-<code>Contentful::Entry</code> and <code>Contentful::Asset</code> inherit
-from <code>Contentful::FieldsResource</code> which is a subclass of
-<code>Contentful::BaseResource</code>.</p>
-</li><li>
-<p><code>Contentful::DynamicEntry</code> does no longer exist, if code checked
-against that base class, it should now check against
-<code>Contentful::Entry</code> instead.</p>
-</li><li>
-<p><code>Contentful::Client#dynamic_entry_cache</code> <em>(private)</em> has
-been extracted to it&#39;s own class, and can be now manually cleared by
-using <code>Contentful::ContentTypeCache::clear</code>.</p>
-</li><li>
-<p><code>Contentful::BaseResource#sys</code> and
-<code>Contentful::FieldsResource#fields</code> internal representation for
-keys are now snake cased to match the instance accessors. E.g.
-<code>entry.fields[:myField]</code> previously had the accessor
-<code>entry.my_field</code>, now it is
-<code>entry.fields[:my_field]</code>. The value in both cases would
-correspond to the same field, only change is to unify the style. If code
-accessed the values through the <code>#sys</code> or <code>#fields</code>
-methods, keys now need to be snake cased.</p>
-</li><li>
-<p>Circular references are handled as individual objects to simplify
-marshalling and reduce stack errors, this introduces a performance hit on
-extremely interconnected content. Therefore, to limit the impact of
-circular references, an additional configuration flag
-<code>max_include_resolution_depth</code> has been added. It is set to 20
-by default (which corresponds to the maximum include level value * 2). This
-allows for non-circular but highly connected content to resolve properly.
-In very interconnected content, it also allows to reduce this number to
-improve performance. For a more in depth look into this you can read <a
-href="https://github.com/contentful/contentful.rb/issues/124#issuecomment-287002469">this
-issue</a>.</p>
-</li><li>
-<p><code>#inspect</code> now offers a clearer and better output for all
-resources. If your code had assertions based on the string representation
-of the resources, update to the new format
-<code>&lt;Contentful::#{RESOURCE_CLASS}#{additional_info}
-id=&quot;#{RESOURCE_ID}&quot;&gt;</code>.</p>
-</li></ul>
-<p>For more information on the internal changes present in the 2.x release,
-please read the <a href="CHANGELOG.md">CHANGELOG</a></p>
-<h3 id="label-Tutorials+-26+other+resources">Tutorials &amp; other resources</h3>
-<ul><li>
-<p>This library is a wrapper around our Contentful Delivery REST API. Some
-more specific details such as search parameters and pagination are better
-explained on the <a
-href="https://www.contentful.com/developers/docs/references/content-delivery-api/">REST
-API reference</a>, and you can also get a better understanding of how the
-requests look under the hood.</p>
-</li><li>
-<p>Check the <a
-href="https://www.contentful.com/developers/docs/ruby/">Contentful for
-Ruby</a> page for Tutorials, Demo Apps, and more information on other ways
-of using Ruby with Contentful</p>
-</li></ul>
-<h2 id="label-Reach+out+to+us">Reach out to us</h2>
-<h3 id="label-You+have+questions+about+how+to+use+this+library-3F">You have questions about how to use this library?</h3>
-<ul><li>
-<p>Reach out to our community forum: <a
-href="https://support.contentful.com/"><img
-src="https://img.shields.io/badge/-Join%20Community%20Forum-3AB2E6.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MiA1OSI+CiAgPHBhdGggZmlsbD0iI0Y4RTQxOCIgZD0iTTE4IDQxYTE2IDE2IDAgMCAxIDAtMjMgNiA2IDAgMCAwLTktOSAyOSAyOSAwIDAgMCAwIDQxIDYgNiAwIDEgMCA5LTkiIG1hc2s9InVybCgjYikiLz4KICA8cGF0aCBmaWxsPSIjNTZBRUQyIiBkPSJNMTggMThhMTYgMTYgMCAwIDEgMjMgMCA2IDYgMCAxIDAgOS05QTI5IDI5IDAgMCAwIDkgOWE2IDYgMCAwIDAgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0UwNTM0RSIgZD0iTTQxIDQxYTE2IDE2IDAgMCAxLTIzIDAgNiA2IDAgMSAwLTkgOSAyOSAyOSAwIDAgMCA0MSAwIDYgNiAwIDAgMC05LTkiLz4KICA8cGF0aCBmaWxsPSIjMUQ3OEE0IiBkPSJNMTggMThhNiA2IDAgMSAxLTktOSA2IDYgMCAwIDEgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0JFNDMzQiIgZD0iTTE4IDUwYTYgNiAwIDEgMS05LTkgNiA2IDAgMCAxIDkgOSIvPgo8L3N2Zz4K&maxAge=31557600"></a></p>
-</li><li>
-<p>Jump into our community slack channel: <a
-href="https://www.contentful.com/slack/"><img
-src="https://img.shields.io/badge/-Join%20Community%20Slack-2AB27B.svg?logo=slack&maxAge=31557600"></a></p>
-</li></ul>
-<h3 id="label-You+found+a+bug+or+want+to+propose+a+feature-3F">You found a bug or want to propose a feature?</h3>
-<ul><li>
-<p>File an issue here on GitHub: <a
-href="https://github.com/contentful/contentful.rb/issues/new"><img
-src="https://img.shields.io/badge/-Create%20Issue-6cc644.svg?logo=github&maxAge=31557600"></a>.
-Make sure to remove any credential from your code before sharing it.</p>
-</li></ul>
-<h3 id="label-You+need+to+share+confidential+information+or+have+other+questions-3F">You need to share confidential information or have other questions?</h3>
-<ul><li>
-<p>File a support ticket at our Contentful Customer Support: <a
-href="https://www.contentful.com/support/"><img
-src="https://img.shields.io/badge/-Submit%20Support%20Ticket-3AB2E6.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MiA1OSI+CiAgPHBhdGggZmlsbD0iI0Y4RTQxOCIgZD0iTTE4IDQxYTE2IDE2IDAgMCAxIDAtMjMgNiA2IDAgMCAwLTktOSAyOSAyOSAwIDAgMCAwIDQxIDYgNiAwIDEgMCA5LTkiIG1hc2s9InVybCgjYikiLz4KICA8cGF0aCBmaWxsPSIjNTZBRUQyIiBkPSJNMTggMThhMTYgMTYgMCAwIDEgMjMgMCA2IDYgMCAxIDAgOS05QTI5IDI5IDAgMCAwIDkgOWE2IDYgMCAwIDAgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0UwNTM0RSIgZD0iTTQxIDQxYTE2IDE2IDAgMCAxLTIzIDAgNiA2IDAgMSAwLTkgOSAyOSAyOSAwIDAgMCA0MSAwIDYgNiAwIDAgMC05LTkiLz4KICA8cGF0aCBmaWxsPSIjMUQ3OEE0IiBkPSJNMTggMThhNiA2IDAgMSAxLTktOSA2IDYgMCAwIDEgOSA5Ii8+CiAgPHBhdGggZmlsbD0iI0JFNDMzQiIgZD0iTTE4IDUwYTYgNiAwIDEgMS05LTkgNiA2IDAgMCAxIDkgOSIvPgo8L3N2Zz4K&maxAge=31557600"></a></p>
-</li></ul>
-<h2 id="label-Get+involved">Get involved</h2>
-<p><a href="http://makeapullrequest.com"><img
-src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?maxAge=31557600"></a></p>
-<p>We appreciate any help on our repositories. For more details about how to
-contribute see our <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> document.</p>
-<h2 id="label-License">License</h2>
-<p>This repository is published under the <a href="LICENSE.txt">MIT</a>
-license.</p>
-<h2 id="label-Code+of+Conduct">Code of Conduct</h2>
-<p>We want to provide a safe, inclusive, welcoming, and harassment-free space
-and experience for all participants, regardless of gender identity and
-expression, sexual orientation, disability, physical appearance,
-socioeconomic status, body size, ethnicity, nationality, level of
-experience, age, religion (or lack thereof), or other identity markers.</p>
-<p><a
-href="https://github.com/contentful-developer-relations/community-code-of-conduct">Read
-our full Code of Conduct</a>.</p>
-</div></div>
-      <div id="footer">
-  Generated on Tue Apr  9 10:49:54 2019 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.18 (ruby-2.5.3).
-</div>
-    </div>
-  </body>
-</html>