contentful 2.12.0 → 2.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (250) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +69 -1
  3. data/README.md +24 -13
  4. data/lib/contentful/array.rb +14 -6
  5. data/lib/contentful/array_like.rb +11 -2
  6. data/lib/contentful/asset.rb +10 -4
  7. data/lib/contentful/base_resource.rb +29 -6
  8. data/lib/contentful/client.rb +4 -3
  9. data/lib/contentful/coercions.rb +1 -4
  10. data/lib/contentful/entry.rb +9 -5
  11. data/lib/contentful/fields_resource.rb +7 -11
  12. data/lib/contentful/includes.rb +74 -0
  13. data/lib/contentful/request.rb +6 -1
  14. data/lib/contentful/resource_builder.rb +15 -12
  15. data/lib/contentful/support.rb +0 -35
  16. data/lib/contentful/version.rb +1 -1
  17. metadata +15 -370
  18. data/.gitignore +0 -7
  19. data/.rspec +0 -1
  20. data/.rubocop.yml +0 -28
  21. data/.rubocop_todo.yml +0 -35
  22. data/.travis.yml +0 -13
  23. data/.yardopts +0 -4
  24. data/Gemfile +0 -9
  25. data/Gemfile.lock +0 -152
  26. data/Guardfile +0 -24
  27. data/RELEASE.md +0 -8
  28. data/Rakefile +0 -33
  29. data/contentful.gemspec +0 -44
  30. data/coverage/.last_run.json +0 -5
  31. data/coverage/.resultset.json +0 -2419
  32. data/coverage/.resultset.json.lock +0 -0
  33. data/coverage/assets/0.10.2/application.css +0 -799
  34. data/coverage/assets/0.10.2/application.js +0 -1707
  35. data/coverage/assets/0.10.2/colorbox/border.png +0 -0
  36. data/coverage/assets/0.10.2/colorbox/controls.png +0 -0
  37. data/coverage/assets/0.10.2/colorbox/loading.gif +0 -0
  38. data/coverage/assets/0.10.2/colorbox/loading_background.png +0 -0
  39. data/coverage/assets/0.10.2/favicon_green.png +0 -0
  40. data/coverage/assets/0.10.2/favicon_red.png +0 -0
  41. data/coverage/assets/0.10.2/favicon_yellow.png +0 -0
  42. data/coverage/assets/0.10.2/loading.gif +0 -0
  43. data/coverage/assets/0.10.2/magnify.png +0 -0
  44. data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
  45. data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
  46. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
  47. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
  48. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
  49. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
  50. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
  51. data/coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
  52. data/coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png +0 -0
  53. data/coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
  54. data/coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png +0 -0
  55. data/coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png +0 -0
  56. data/coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
  57. data/coverage/index.html +0 -15071
  58. data/doc/Contentful/AccessDenied.html +0 -159
  59. data/doc/Contentful/Array.html +0 -765
  60. data/doc/Contentful/ArrayCoercion.html +0 -242
  61. data/doc/Contentful/ArrayLike.html +0 -625
  62. data/doc/Contentful/Asset.html +0 -487
  63. data/doc/Contentful/BadGateway.html +0 -159
  64. data/doc/Contentful/BadRequest.html +0 -159
  65. data/doc/Contentful/BaseCoercion.html +0 -445
  66. data/doc/Contentful/BaseResource.html +0 -599
  67. data/doc/Contentful/BooleanCoercion.html +0 -242
  68. data/doc/Contentful/Client.html +0 -1740
  69. data/doc/Contentful/ContentType.html +0 -618
  70. data/doc/Contentful/ContentTypeCache.html +0 -428
  71. data/doc/Contentful/DateCoercion.html +0 -244
  72. data/doc/Contentful/DeletedAsset.html +0 -157
  73. data/doc/Contentful/DeletedEntry.html +0 -157
  74. data/doc/Contentful/EmptyFieldError.html +0 -217
  75. data/doc/Contentful/Entry.html +0 -334
  76. data/doc/Contentful/Error.html +0 -410
  77. data/doc/Contentful/Field.html +0 -936
  78. data/doc/Contentful/FieldsResource.html +0 -583
  79. data/doc/Contentful/File.html +0 -218
  80. data/doc/Contentful/FloatCoercion.html +0 -238
  81. data/doc/Contentful/IntegerCoercion.html +0 -238
  82. data/doc/Contentful/Link.html +0 -249
  83. data/doc/Contentful/LinkCoercion.html +0 -158
  84. data/doc/Contentful/Locale.html +0 -537
  85. data/doc/Contentful/Location.html +0 -383
  86. data/doc/Contentful/LocationCoercion.html +0 -238
  87. data/doc/Contentful/NotFound.html +0 -159
  88. data/doc/Contentful/ObjectCoercion.html +0 -238
  89. data/doc/Contentful/RateLimitExceeded.html +0 -346
  90. data/doc/Contentful/Request.html +0 -887
  91. data/doc/Contentful/ResourceBuilder.html +0 -978
  92. data/doc/Contentful/ResourceReferences.html +0 -254
  93. data/doc/Contentful/Response.html +0 -710
  94. data/doc/Contentful/RichTextCoercion.html +0 -238
  95. data/doc/Contentful/ServerError.html +0 -159
  96. data/doc/Contentful/ServiceUnavailable.html +0 -159
  97. data/doc/Contentful/Space.html +0 -393
  98. data/doc/Contentful/StringCoercion.html +0 -242
  99. data/doc/Contentful/StructuredTextCoercion.html +0 -238
  100. data/doc/Contentful/Support.html +0 -788
  101. data/doc/Contentful/SymbolCoercion.html +0 -169
  102. data/doc/Contentful/Sync.html +0 -653
  103. data/doc/Contentful/SyncPage.html +0 -807
  104. data/doc/Contentful/TextCoercion.html +0 -169
  105. data/doc/Contentful/Unauthorized.html +0 -159
  106. data/doc/Contentful/UnparsableJson.html +0 -159
  107. data/doc/Contentful/UnparsableResource.html +0 -135
  108. data/doc/Contentful.html +0 -157
  109. data/doc/_index.html +0 -563
  110. data/doc/class_list.html +0 -51
  111. data/doc/css/common.css +0 -1
  112. data/doc/css/full_list.css +0 -58
  113. data/doc/css/style.css +0 -496
  114. data/doc/file.CHANGELOG.html +0 -729
  115. data/doc/file.LICENSE.html +0 -70
  116. data/doc/file.README.html +0 -925
  117. data/doc/file_list.html +0 -66
  118. data/doc/frames.html +0 -17
  119. data/doc/index.html +0 -925
  120. data/doc/js/app.js +0 -292
  121. data/doc/js/full_list.js +0 -216
  122. data/doc/js/jquery.js +0 -4
  123. data/doc/method_list.html +0 -1171
  124. data/doc/top-level-namespace.html +0 -110
  125. data/examples/custom_classes.rb +0 -39
  126. data/examples/example_queries.rb +0 -26
  127. data/examples/raise_errors.rb +0 -20
  128. data/examples/raw_mode.rb +0 -14
  129. data/spec/array_spec.rb +0 -122
  130. data/spec/asset_spec.rb +0 -192
  131. data/spec/auto_includes_spec.rb +0 -12
  132. data/spec/client_class_spec.rb +0 -86
  133. data/spec/client_configuration_spec.rb +0 -377
  134. data/spec/content_type_spec.rb +0 -49
  135. data/spec/deleted_asset_spec.rb +0 -38
  136. data/spec/deleted_entry_spec.rb +0 -38
  137. data/spec/entry_spec.rb +0 -688
  138. data/spec/error_class_spec.rb +0 -327
  139. data/spec/error_requests_spec.rb +0 -87
  140. data/spec/field_spec.rb +0 -95
  141. data/spec/file_spec.rb +0 -33
  142. data/spec/fixtures/json_responses/400_details_errors_object.json +0 -14
  143. data/spec/fixtures/json_responses/400_details_errors_string.json +0 -12
  144. data/spec/fixtures/json_responses/400_details_string.json +0 -8
  145. data/spec/fixtures/json_responses/403_reasons.json +0 -13
  146. data/spec/fixtures/json_responses/404_details_string.json +0 -8
  147. data/spec/fixtures/json_responses/404_id.json +0 -11
  148. data/spec/fixtures/json_responses/404_sys_type.json +0 -12
  149. data/spec/fixtures/json_responses/404_type.json +0 -10
  150. data/spec/fixtures/json_responses/content_type.json +0 -83
  151. data/spec/fixtures/json_responses/default_400.json +0 -7
  152. data/spec/fixtures/json_responses/default_401.json +0 -7
  153. data/spec/fixtures/json_responses/default_403.json +0 -7
  154. data/spec/fixtures/json_responses/default_404.json +0 -7
  155. data/spec/fixtures/json_responses/default_429.json +0 -7
  156. data/spec/fixtures/json_responses/default_500.json +0 -7
  157. data/spec/fixtures/json_responses/default_502.json +0 -7
  158. data/spec/fixtures/json_responses/default_503.json +0 -7
  159. data/spec/fixtures/json_responses/includes.json +0 -111
  160. data/spec/fixtures/json_responses/link_array.json +0 -43
  161. data/spec/fixtures/json_responses/not_found.json +0 -13
  162. data/spec/fixtures/json_responses/nyancat.json +0 -48
  163. data/spec/fixtures/json_responses/other_error.json +0 -9
  164. data/spec/fixtures/json_responses/other_error_no_details.json +0 -8
  165. data/spec/fixtures/json_responses/other_error_no_message.json +0 -8
  166. data/spec/fixtures/json_responses/other_error_no_request_id.json +0 -8
  167. data/spec/fixtures/json_responses/other_error_nothing.json +0 -6
  168. data/spec/fixtures/json_responses/self_link.json +0 -82
  169. data/spec/fixtures/json_responses/unparsable.json +0 -13
  170. data/spec/fixtures/vcr_cassettes/array/marshal_custom_classes.yml +0 -159
  171. data/spec/fixtures/vcr_cassettes/array/nested_resources.yml +0 -159
  172. data/spec/fixtures/vcr_cassettes/array.yml +0 -288
  173. data/spec/fixtures/vcr_cassettes/arrayField.yml +0 -87
  174. data/spec/fixtures/vcr_cassettes/array_page_1.yml +0 -106
  175. data/spec/fixtures/vcr_cassettes/array_page_2.yml +0 -73
  176. data/spec/fixtures/vcr_cassettes/asset/select_empty_array.yml +0 -104
  177. data/spec/fixtures/vcr_cassettes/asset/select_no_sys.yml +0 -119
  178. data/spec/fixtures/vcr_cassettes/asset/select_one_field.yml +0 -97
  179. data/spec/fixtures/vcr_cassettes/asset/select_only_sys.yml +0 -88
  180. data/spec/fixtures/vcr_cassettes/asset.yml +0 -96
  181. data/spec/fixtures/vcr_cassettes/assets/issues_129.yml +0 -90
  182. data/spec/fixtures/vcr_cassettes/assets/issues_jekyll_46.yml +0 -115
  183. data/spec/fixtures/vcr_cassettes/bad_request.yml +0 -76
  184. data/spec/fixtures/vcr_cassettes/content_type.yml +0 -147
  185. data/spec/fixtures/vcr_cassettes/entries/empty_fields.yml +0 -246
  186. data/spec/fixtures/vcr_cassettes/entries/issue_117.yml +0 -201
  187. data/spec/fixtures/vcr_cassettes/entries/issue_125.yml +0 -198
  188. data/spec/fixtures/vcr_cassettes/entries/rich_text.yml +0 -1707
  189. data/spec/fixtures/vcr_cassettes/entries/rich_text_hydration_issue.yml +0 -460
  190. data/spec/fixtures/vcr_cassettes/entries/rich_text_nested_fields.yml +0 -653
  191. data/spec/fixtures/vcr_cassettes/entries/rich_text_unresolved_relationships.yml +0 -983
  192. data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter.yml +0 -159
  193. data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter_deeply_nested.yml +0 -167
  194. data/spec/fixtures/vcr_cassettes/entries.yml +0 -561
  195. data/spec/fixtures/vcr_cassettes/entry/custom_resource.yml +0 -168
  196. data/spec/fixtures/vcr_cassettes/entry/include_resolution.yml +0 -101
  197. data/spec/fixtures/vcr_cassettes/entry/include_resolution_uniques.yml +0 -81
  198. data/spec/fixtures/vcr_cassettes/entry/json_objects.yml +0 -88
  199. data/spec/fixtures/vcr_cassettes/entry/json_objects_client.yml +0 -86
  200. data/spec/fixtures/vcr_cassettes/entry/marshal_138.yml +0 -159
  201. data/spec/fixtures/vcr_cassettes/entry/marshal_unpublished.yml +0 -303
  202. data/spec/fixtures/vcr_cassettes/entry/marshall.yml +0 -293
  203. data/spec/fixtures/vcr_cassettes/entry/raw.yml +0 -201
  204. data/spec/fixtures/vcr_cassettes/entry/search_link_to_asset.yml +0 -81
  205. data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry.yml +0 -81
  206. data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry_with_custom_query.yml +0 -115
  207. data/spec/fixtures/vcr_cassettes/entry/select_empty_array.yml +0 -111
  208. data/spec/fixtures/vcr_cassettes/entry/select_no_sys.yml +0 -102
  209. data/spec/fixtures/vcr_cassettes/entry/select_one_field.yml +0 -76
  210. data/spec/fixtures/vcr_cassettes/entry/select_one_field_proper.yml +0 -114
  211. data/spec/fixtures/vcr_cassettes/entry/select_only_sys.yml +0 -111
  212. data/spec/fixtures/vcr_cassettes/entry.yml +0 -102
  213. data/spec/fixtures/vcr_cassettes/entry_cache.yml +0 -288
  214. data/spec/fixtures/vcr_cassettes/entry_locales.yml +0 -104
  215. data/spec/fixtures/vcr_cassettes/field.yml +0 -147
  216. data/spec/fixtures/vcr_cassettes/human.yml +0 -118
  217. data/spec/fixtures/vcr_cassettes/linkField.yml +0 -83
  218. data/spec/fixtures/vcr_cassettes/locale.yml +0 -83
  219. data/spec/fixtures/vcr_cassettes/locale_from_environment.yml +0 -121
  220. data/spec/fixtures/vcr_cassettes/location.yml +0 -193
  221. data/spec/fixtures/vcr_cassettes/multi_locale_array_reference.yml +0 -196
  222. data/spec/fixtures/vcr_cassettes/multi_locale_reference.yml +0 -214
  223. data/spec/fixtures/vcr_cassettes/not_found.yml +0 -76
  224. data/spec/fixtures/vcr_cassettes/nyancat.yml +0 -102
  225. data/spec/fixtures/vcr_cassettes/ratelimit.yml +0 -64
  226. data/spec/fixtures/vcr_cassettes/ratelimit_retry.yml +0 -294
  227. data/spec/fixtures/vcr_cassettes/reloaded_entry.yml +0 -102
  228. data/spec/fixtures/vcr_cassettes/space.yml +0 -83
  229. data/spec/fixtures/vcr_cassettes/sync_deleted_asset.yml +0 -174
  230. data/spec/fixtures/vcr_cassettes/sync_deleted_entry.yml +0 -89
  231. data/spec/fixtures/vcr_cassettes/sync_deletion.yml +0 -191
  232. data/spec/fixtures/vcr_cassettes/sync_environment.yml +0 -81
  233. data/spec/fixtures/vcr_cassettes/sync_page.yml +0 -637
  234. data/spec/fixtures/vcr_cassettes/sync_page_2.yml +0 -71
  235. data/spec/fixtures/vcr_cassettes/sync_page_short.yml +0 -106
  236. data/spec/fixtures/vcr_cassettes/unauthorized.yml +0 -64
  237. data/spec/fixtures/vcr_cassettes/unavailable.yml +0 -76
  238. data/spec/link_spec.rb +0 -50
  239. data/spec/locale_spec.rb +0 -37
  240. data/spec/location_spec.rb +0 -25
  241. data/spec/request_spec.rb +0 -57
  242. data/spec/resource_building_spec.rb +0 -31
  243. data/spec/response_spec.rb +0 -62
  244. data/spec/space_spec.rb +0 -31
  245. data/spec/spec_helper.rb +0 -14
  246. data/spec/support/client.rb +0 -6
  247. data/spec/support/json_responses.rb +0 -18
  248. data/spec/support/vcr.rb +0 -16
  249. data/spec/sync_page_spec.rb +0 -103
  250. data/spec/sync_spec.rb +0 -180
data/doc/Contentful/FieldsResource.html DELETED
@@ -1,583 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: Contentful::FieldsResource
8
-
9
- &mdash; Documentation by YARD 0.9.18
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "Contentful::FieldsResource";
19
- relpath = '../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../_index.html">Index (F)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span>
41
- &raquo;
42
- <span class="title">FieldsResource</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: Contentful::FieldsResource
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName"><span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next"><span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></li>
78
-
79
- <li class="next">Contentful::FieldsResource</li>
80
-
81
- </ul>
82
- <a href="#" class="inheritanceTree">show all</a>
83
-
84
- </dd>
85
- </dl>
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
- <dl>
98
- <dt>Defined in:</dt>
99
- <dd>lib/contentful/fields_resource.rb</dd>
100
- </dl>
101
-
102
- </div>
103
-
104
- <h2>Overview</h2><div class="docstring">
105
- <div class="discussion">
106
-
107
- <p>Base definition of a Contentful Resource containing Field properties</p>
108
-
109
-
110
- </div>
111
- </div>
112
- <div class="tags">
113
-
114
-
115
- </div><div id="subclasses">
116
- <h2>Direct Known Subclasses</h2>
117
- <p class="children"><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Asset</a></span>, <span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Entry</a></span></p>
118
- </div>
119
-
120
-
121
-
122
-
123
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
124
- <ul class="summary">
125
-
126
- <li class="public ">
127
- <span class="summary_signature">
128
-
129
- <a href="#localized-instance_method" title="#localized (instance method)">#<strong>localized</strong> &#x21d2; Object </a>
130
-
131
-
132
-
133
- </span>
134
-
135
-
136
-
137
-
138
- <span class="note title readonly">readonly</span>
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
- <span class="summary_desc"><div class='inline'>
149
- <p>Returns the value of attribute localized.</p>
150
- </div></span>
151
-
152
- </li>
153
-
154
-
155
- </ul>
156
-
157
-
158
-
159
-
160
-
161
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
162
- <p class="inherited"><span class='object_link'><a href="BaseResource.html#default_locale-instance_method" title="Contentful::BaseResource#default_locale (method)">#default_locale</a></span>, <span class='object_link'><a href="BaseResource.html#raw-instance_method" title="Contentful::BaseResource#raw (method)">#raw</a></span>, <span class='object_link'><a href="BaseResource.html#sys-instance_method" title="Contentful::BaseResource#sys (method)">#sys</a></span></p>
163
-
164
-
165
-
166
- <h2>
167
- Instance Method Summary
168
- <small><a href="#" class="summary_toggle">collapse</a></small>
169
- </h2>
170
-
171
- <ul class="summary">
172
-
173
- <li class="public ">
174
- <span class="summary_signature">
175
-
176
- <a href="#fields-instance_method" title="#fields (instance method)">#<strong>fields</strong>(wanted_locale = nil) &#x21d2; Hash </a>
177
-
178
-
179
-
180
- </span>
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
- <span class="summary_desc"><div class='inline'>
191
- <p>Returns all fields of the asset.</p>
192
- </div></span>
193
-
194
- </li>
195
-
196
-
197
- <li class="public ">
198
- <span class="summary_signature">
199
-
200
- <a href="#fields_with_locales-instance_method" title="#fields_with_locales (instance method)">#<strong>fields_with_locales</strong> &#x21d2; Hash </a>
201
-
202
-
203
-
204
- </span>
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
- <span class="summary_desc"><div class='inline'>
215
- <p>Returns all fields of the asset with locales nested by field.</p>
216
- </div></span>
217
-
218
- </li>
219
-
220
-
221
- <li class="public ">
222
- <span class="summary_signature">
223
-
224
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(item, _configuration, localized = false, includes = [], entries = {}, depth = 0, errors = []) &#x21d2; FieldsResource </a>
225
-
226
-
227
-
228
- </span>
229
-
230
-
231
- <span class="note title constructor">constructor</span>
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
- <span class="summary_desc"><div class='inline'>
241
- <p>rubocop:disable Metrics/ParameterLists.</p>
242
- </div></span>
243
-
244
- </li>
245
-
246
-
247
- <li class="public ">
248
- <span class="summary_signature">
249
-
250
- <a href="#locales-instance_method" title="#locales (instance method)">#<strong>locales</strong> &#x21d2; Object </a>
251
-
252
-
253
-
254
- </span>
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
- <span class="summary_desc"><div class='inline'>
265
- <p>Provides a list of the available locales for a Resource.</p>
266
- </div></span>
267
-
268
- </li>
269
-
270
-
271
- </ul>
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
284
- <p class="inherited"><span class='object_link'><a href="BaseResource.html#==-instance_method" title="Contentful::BaseResource#== (method)">#==</a></span>, <span class='object_link'><a href="BaseResource.html#reload-instance_method" title="Contentful::BaseResource#reload (method)">#reload</a></span></p>
285
- <div id="constructor_details" class="method_details_list">
286
- <h2>Constructor Details</h2>
287
-
288
- <div class="method_details first">
289
- <h3 class="signature first" id="initialize-instance_method">
290
-
291
- #<strong>initialize</strong>(item, _configuration, localized = false, includes = [], entries = {}, depth = 0, errors = []) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::FieldsResource (class)">FieldsResource</a></span></tt>
292
-
293
-
294
-
295
-
296
-
297
- </h3><div class="docstring">
298
- <div class="discussion">
299
-
300
- <p>rubocop:disable Metrics/ParameterLists</p>
301
-
302
-
303
- </div>
304
- </div>
305
- <div class="tags">
306
-
307
-
308
- </div><table class="source_code">
309
- <tr>
310
- <td>
311
- <pre class="lines">
312
-
313
-
314
- 12
315
- 13
316
- 14
317
- 15
318
- 16
319
- 17
320
- 18
321
- 19</pre>
322
- </td>
323
- <td>
324
- <pre class="code"><span class="info file"># File 'lib/contentful/fields_resource.rb', line 12</span>
325
-
326
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid__configuration'>_configuration</span><span class='comma'>,</span> <span class='id identifier rubyid_localized'>localized</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_includes'>includes</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_depth'>depth</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
327
- <span class='kw'>super</span>
328
-
329
- <span class='ivar'>@configuration</span><span class='lbracket'>[</span><span class='symbol'>:errors</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_errors'>errors</span>
330
- <span class='ivar'>@localized</span> <span class='op'>=</span> <span class='id identifier rubyid_localized'>localized</span>
331
- <span class='ivar'>@fields</span> <span class='op'>=</span> <span class='id identifier rubyid_hydrate_fields'>hydrate_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_includes'>includes</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</span>
332
- <span class='id identifier rubyid_define_fields_methods!'>define_fields_methods!</span>
333
- <span class='kw'>end</span></pre>
334
- </td>
335
- </tr>
336
- </table>
337
- </div>
338
-
339
- </div>
340
-
341
- <div id="instance_attr_details" class="attr_details">
342
- <h2>Instance Attribute Details</h2>
343
-
344
-
345
- <span id=""></span>
346
- <div class="method_details first">
347
- <h3 class="signature first" id="localized-instance_method">
348
-
349
- #<strong>localized</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
350
-
351
-
352
-
353
-
354
-
355
- </h3><div class="docstring">
356
- <div class="discussion">
357
-
358
- <p>Returns the value of attribute localized</p>
359
-
360
-
361
- </div>
362
- </div>
363
- <div class="tags">
364
-
365
-
366
- </div><table class="source_code">
367
- <tr>
368
- <td>
369
- <pre class="lines">
370
-
371
-
372
- 9
373
- 10
374
- 11</pre>
375
- </td>
376
- <td>
377
- <pre class="code"><span class="info file"># File 'lib/contentful/fields_resource.rb', line 9</span>
378
-
379
- <span class='kw'>def</span> <span class='id identifier rubyid_localized'>localized</span>
380
- <span class='ivar'>@localized</span>
381
- <span class='kw'>end</span></pre>
382
- </td>
383
- </tr>
384
- </table>
385
- </div>
386
-
387
- </div>
388
-
389
-
390
- <div id="instance_method_details" class="method_details_list">
391
- <h2>Instance Method Details</h2>
392
-
393
-
394
- <div class="method_details first">
395
- <h3 class="signature first" id="fields-instance_method">
396
-
397
- #<strong>fields</strong>(wanted_locale = nil) &#x21d2; <tt>Hash</tt>
398
-
399
-
400
-
401
-
402
-
403
- </h3><div class="docstring">
404
- <div class="discussion">
405
-
406
- <p>Returns all fields of the asset</p>
407
-
408
-
409
- </div>
410
- </div>
411
- <div class="tags">
412
-
413
- <p class="tag_title">Returns:</p>
414
- <ul class="return">
415
-
416
- <li>
417
-
418
-
419
- <span class='type'>(<tt>Hash</tt>)</span>
420
-
421
-
422
-
423
- &mdash;
424
- <div class='inline'>
425
- <p>fields for Resource on selected locale</p>
426
- </div>
427
-
428
- </li>
429
-
430
- </ul>
431
-
432
- </div><table class="source_code">
433
- <tr>
434
- <td>
435
- <pre class="lines">
436
-
437
-
438
- 24
439
- 25
440
- 26
441
- 27</pre>
442
- </td>
443
- <td>
444
- <pre class="code"><span class="info file"># File 'lib/contentful/fields_resource.rb', line 24</span>
445
-
446
- <span class='kw'>def</span> <span class='id identifier rubyid_fields'>fields</span><span class='lparen'>(</span><span class='id identifier rubyid_wanted_locale'>wanted_locale</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
447
- <span class='id identifier rubyid_wanted_locale'>wanted_locale</span> <span class='op'>=</span> <span class='id identifier rubyid_internal_resource_locale'>internal_resource_locale</span> <span class='kw'>if</span> <span class='id identifier rubyid_wanted_locale'>wanted_locale</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
448
- <span class='ivar'>@fields</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_wanted_locale'>wanted_locale</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
449
- <span class='kw'>end</span></pre>
450
- </td>
451
- </tr>
452
- </table>
453
- </div>
454
-
455
- <div class="method_details ">
456
- <h3 class="signature " id="fields_with_locales-instance_method">
457
-
458
- #<strong>fields_with_locales</strong> &#x21d2; <tt>Hash</tt>
459
-
460
-
461
-
462
-
463
-
464
- </h3><div class="docstring">
465
- <div class="discussion">
466
-
467
- <p>Returns all fields of the asset with locales nested by field</p>
468
-
469
-
470
- </div>
471
- </div>
472
- <div class="tags">
473
-
474
- <p class="tag_title">Returns:</p>
475
- <ul class="return">
476
-
477
- <li>
478
-
479
-
480
- <span class='type'>(<tt>Hash</tt>)</span>
481
-
482
-
483
-
484
- &mdash;
485
- <div class='inline'>
486
- <p>fields for Resource grouped by field name</p>
487
- </div>
488
-
489
- </li>
490
-
491
- </ul>
492
-
493
- </div><table class="source_code">
494
- <tr>
495
- <td>
496
- <pre class="lines">
497
-
498
-
499
- 32
500
- 33
501
- 34
502
- 35
503
- 36
504
- 37
505
- 38
506
- 39
507
- 40
508
- 41
509
- 42</pre>
510
- </td>
511
- <td>
512
- <pre class="code"><span class="info file"># File 'lib/contentful/fields_resource.rb', line 32</span>
513
-
514
- <span class='kw'>def</span> <span class='id identifier rubyid_fields_with_locales'>fields_with_locales</span>
515
- <span class='id identifier rubyid_remapped_fields'>remapped_fields</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
516
- <span class='id identifier rubyid_locales'>locales</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_locale'>locale</span><span class='op'>|</span>
517
- <span class='id identifier rubyid_fields'>fields</span><span class='lparen'>(</span><span class='id identifier rubyid_locale'>locale</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
518
- <span class='id identifier rubyid_remapped_fields'>remapped_fields</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
519
- <span class='id identifier rubyid_remapped_fields'>remapped_fields</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
520
- <span class='kw'>end</span>
521
- <span class='kw'>end</span>
522
-
523
- <span class='id identifier rubyid_remapped_fields'>remapped_fields</span>
524
- <span class='kw'>end</span></pre>
525
- </td>
526
- </tr>
527
- </table>
528
- </div>
529
-
530
- <div class="method_details ">
531
- <h3 class="signature " id="locales-instance_method">
532
-
533
- #<strong>locales</strong> &#x21d2; <tt>Object</tt>
534
-
535
-
536
-
537
-
538
-
539
- </h3><div class="docstring">
540
- <div class="discussion">
541
-
542
- <p>Provides a list of the available locales for a Resource</p>
543
-
544
-
545
- </div>
546
- </div>
547
- <div class="tags">
548
-
549
-
550
- </div><table class="source_code">
551
- <tr>
552
- <td>
553
- <pre class="lines">
554
-
555
-
556
- 45
557
- 46
558
- 47</pre>
559
- </td>
560
- <td>
561
- <pre class="code"><span class="info file"># File 'lib/contentful/fields_resource.rb', line 45</span>
562
-
563
- <span class='kw'>def</span> <span class='id identifier rubyid_locales'>locales</span>
564
- <span class='ivar'>@fields</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
565
- <span class='kw'>end</span></pre>
566
- </td>
567
- </tr>
568
- </table>
569
- </div>
570
-
571
- </div>
572
-
573
- </div>
574
-
575
- <div id="footer">
576
- Generated on Tue Apr 9 10:49:57 2019 by
577
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
578
- 0.9.18 (ruby-2.5.3).
579
- </div>
580
-
581
- </div>
582
- </body>
583
- </html>