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
@@ -1,765 +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::Array
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::Array";
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 (A)</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">Array</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::Array
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::Array</li>
80
-
81
- </ul>
82
- <a href="#" class="inheritanceTree">show all</a>
83
-
84
- </dd>
85
- </dl>
86
-
87
-
88
-
89
-
90
-
91
-
92
- <dl>
93
- <dt>Includes:</dt>
94
- <dd><span class='object_link'><a href="ArrayLike.html" title="Contentful::ArrayLike (module)">ArrayLike</a></span></dd>
95
- </dl>
96
-
97
-
98
-
99
-
100
-
101
-
102
- <dl>
103
- <dt>Defined in:</dt>
104
- <dd>lib/contentful/array.rb</dd>
105
- </dl>
106
-
107
- </div>
108
-
109
- <h2>Overview</h2><div class="docstring">
110
- <div class="discussion">
111
-
112
- <div class="note notetag">
113
- <strong>Note:</strong>
114
- <div class='inline'>
115
- <p>It also provides an #each method and includes Ruby&#39;s Enumerable module
116
- (gives you methods like #min, #first, etc)</p>
117
- </div>
118
- </div>
119
-
120
-
121
- <p>Resource Class for Arrays (e.g. search results)</p>
122
-
123
-
124
- </div>
125
- </div>
126
- <div class="tags">
127
-
128
-
129
- <p class="tag_title">See Also:</p>
130
- <ul class="see">
131
-
132
- <li>https://www.contentful.com/developers/documentation/content-delivery-api/#arrays</li>
133
-
134
- </ul>
135
-
136
- </div>
137
-
138
-
139
-
140
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
141
- <ul class="summary">
142
-
143
- <li class="public ">
144
- <span class="summary_signature">
145
-
146
- <a href="#endpoint-instance_method" title="#endpoint (instance method)">#<strong>endpoint</strong> &#x21d2; Object </a>
147
-
148
-
149
-
150
- </span>
151
-
152
-
153
-
154
-
155
- <span class="note title readonly">readonly</span>
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
- <span class="summary_desc"><div class='inline'>
166
- <p>Returns the value of attribute endpoint.</p>
167
- </div></span>
168
-
169
- </li>
170
-
171
-
172
- <li class="public ">
173
- <span class="summary_signature">
174
-
175
- <a href="#items-instance_method" title="#items (instance method)">#<strong>items</strong> &#x21d2; Object </a>
176
-
177
-
178
-
179
- </span>
180
-
181
-
182
-
183
-
184
- <span class="note title readonly">readonly</span>
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
- <span class="summary_desc"><div class='inline'>
195
- <p>Returns the value of attribute items.</p>
196
- </div></span>
197
-
198
- </li>
199
-
200
-
201
- <li class="public ">
202
- <span class="summary_signature">
203
-
204
- <a href="#limit-instance_method" title="#limit (instance method)">#<strong>limit</strong> &#x21d2; Object </a>
205
-
206
-
207
-
208
- </span>
209
-
210
-
211
-
212
-
213
- <span class="note title readonly">readonly</span>
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
- <span class="summary_desc"><div class='inline'>
224
- <p>Returns the value of attribute limit.</p>
225
- </div></span>
226
-
227
- </li>
228
-
229
-
230
- <li class="public ">
231
- <span class="summary_signature">
232
-
233
- <a href="#skip-instance_method" title="#skip (instance method)">#<strong>skip</strong> &#x21d2; Object </a>
234
-
235
-
236
-
237
- </span>
238
-
239
-
240
-
241
-
242
- <span class="note title readonly">readonly</span>
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
- <span class="summary_desc"><div class='inline'>
253
- <p>Returns the value of attribute skip.</p>
254
- </div></span>
255
-
256
- </li>
257
-
258
-
259
- <li class="public ">
260
- <span class="summary_signature">
261
-
262
- <a href="#total-instance_method" title="#total (instance method)">#<strong>total</strong> &#x21d2; Object </a>
263
-
264
-
265
-
266
- </span>
267
-
268
-
269
-
270
-
271
- <span class="note title readonly">readonly</span>
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
- <span class="summary_desc"><div class='inline'>
282
- <p>Returns the value of attribute total.</p>
283
- </div></span>
284
-
285
- </li>
286
-
287
-
288
- </ul>
289
-
290
-
291
-
292
-
293
-
294
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
295
- <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>
296
-
297
-
298
-
299
- <h2>
300
- Instance Method Summary
301
- <small><a href="#" class="summary_toggle">collapse</a></small>
302
- </h2>
303
-
304
- <ul class="summary">
305
-
306
- <li class="public ">
307
- <span class="summary_signature">
308
-
309
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(item = nil, configuration = { default_locale: Contentful::Client::DEFAULT_CONFIGURATION[:default_locale] }, endpoint = &#39;&#39;) &#x21d2; Array </a>
310
-
311
-
312
-
313
- </span>
314
-
315
-
316
- <span class="note title constructor">constructor</span>
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
- <span class="summary_desc"><div class='inline'>
326
- <p>A new instance of Array.</p>
327
- </div></span>
328
-
329
- </li>
330
-
331
-
332
- <li class="public ">
333
- <span class="summary_signature">
334
-
335
- <a href="#next_page-instance_method" title="#next_page (instance method)">#<strong>next_page</strong>(client = nil) &#x21d2; Contentful::Array, false </a>
336
-
337
-
338
-
339
- </span>
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
- <span class="summary_desc"><div class='inline'>
350
- <p>Simplifies pagination.</p>
351
- </div></span>
352
-
353
- </li>
354
-
355
-
356
- </ul>
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
- <h3 class="inherited">Methods included from <span class='object_link'><a href="ArrayLike.html" title="Contentful::ArrayLike (module)">ArrayLike</a></span></h3>
369
- <p class="inherited"><span class='object_link'><a href="ArrayLike.html#[]-instance_method" title="Contentful::ArrayLike#[] (method)">#[]</a></span>, <span class='object_link'><a href="ArrayLike.html#array%3F-instance_method" title="Contentful::ArrayLike#array? (method)">#array?</a></span>, <span class='object_link'><a href="ArrayLike.html#each_item-instance_method" title="Contentful::ArrayLike#each_item (method)">#each_item</a></span>, <span class='object_link'><a href="ArrayLike.html#empty%3F-instance_method" title="Contentful::ArrayLike#empty? (method)">#empty?</a></span>, <span class='object_link'><a href="ArrayLike.html#last-instance_method" title="Contentful::ArrayLike#last (method)">#last</a></span>, <span class='object_link'><a href="ArrayLike.html#size-instance_method" title="Contentful::ArrayLike#size (method)">#size</a></span></p>
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
381
- <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>
382
- <div id="constructor_details" class="method_details_list">
383
- <h2>Constructor Details</h2>
384
-
385
- <div class="method_details first">
386
- <h3 class="signature first" id="initialize-instance_method">
387
-
388
- #<strong>initialize</strong>(item = nil, configuration = {
389
- default_locale: Contentful::Client::DEFAULT_CONFIGURATION[:default_locale]
390
- }, endpoint = &#39;&#39;) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::Array (class)">Array</a></span></tt>
391
-
392
-
393
-
394
-
395
-
396
- </h3><div class="docstring">
397
- <div class="discussion">
398
-
399
- <p>Returns a new instance of Array</p>
400
-
401
-
402
- </div>
403
- </div>
404
- <div class="tags">
405
-
406
-
407
- </div><table class="source_code">
408
- <tr>
409
- <td>
410
- <pre class="lines">
411
-
412
-
413
- 16
414
- 17
415
- 18
416
- 19
417
- 20
418
- 21
419
- 22
420
- 23
421
- 24
422
- 25
423
- 26
424
- 27
425
- 28</pre>
426
- </td>
427
- <td>
428
- <pre class="code"><span class="info file"># File 'lib/contentful/array.rb', line 16</span>
429
-
430
- <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='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span>
431
- <span class='id identifier rubyid_configuration'>configuration</span> <span class='op'>=</span> <span class='lbrace'>{</span>
432
- <span class='label'>default_locale:</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="Client.html" title="Contentful::Client (class)">Client</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Client.html#DEFAULT_CONFIGURATION-constant" title="Contentful::Client::DEFAULT_CONFIGURATION (constant)">DEFAULT_CONFIGURATION</a></span></span><span class='lbracket'>[</span><span class='symbol'>:default_locale</span><span class='rbracket'>]</span>
433
- <span class='rbrace'>}</span><span class='comma'>,</span>
434
- <span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='rparen'>)</span>
435
- <span class='kw'>super</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='rparen'>)</span>
436
-
437
- <span class='ivar'>@endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
438
- <span class='ivar'>@total</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>total</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
439
- <span class='ivar'>@limit</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>limit</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
440
- <span class='ivar'>@skip</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>skip</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
441
- <span class='ivar'>@items</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>items</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
442
- <span class='kw'>end</span></pre>
443
- </td>
444
- </tr>
445
- </table>
446
- </div>
447
-
448
- </div>
449
-
450
- <div id="instance_attr_details" class="attr_details">
451
- <h2>Instance Attribute Details</h2>
452
-
453
-
454
- <span id=""></span>
455
- <div class="method_details first">
456
- <h3 class="signature first" id="endpoint-instance_method">
457
-
458
- #<strong>endpoint</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
459
-
460
-
461
-
462
-
463
-
464
- </h3><div class="docstring">
465
- <div class="discussion">
466
-
467
- <p>Returns the value of attribute endpoint</p>
468
-
469
-
470
- </div>
471
- </div>
472
- <div class="tags">
473
-
474
-
475
- </div><table class="source_code">
476
- <tr>
477
- <td>
478
- <pre class="lines">
479
-
480
-
481
- 14
482
- 15
483
- 16</pre>
484
- </td>
485
- <td>
486
- <pre class="code"><span class="info file"># File 'lib/contentful/array.rb', line 14</span>
487
-
488
- <span class='kw'>def</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
489
- <span class='ivar'>@endpoint</span>
490
- <span class='kw'>end</span></pre>
491
- </td>
492
- </tr>
493
- </table>
494
- </div>
495
-
496
-
497
- <span id=""></span>
498
- <div class="method_details ">
499
- <h3 class="signature " id="items-instance_method">
500
-
501
- #<strong>items</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
502
-
503
-
504
-
505
-
506
-
507
- </h3><div class="docstring">
508
- <div class="discussion">
509
-
510
- <p>Returns the value of attribute items</p>
511
-
512
-
513
- </div>
514
- </div>
515
- <div class="tags">
516
-
517
-
518
- </div><table class="source_code">
519
- <tr>
520
- <td>
521
- <pre class="lines">
522
-
523
-
524
- 14
525
- 15
526
- 16</pre>
527
- </td>
528
- <td>
529
- <pre class="code"><span class="info file"># File 'lib/contentful/array.rb', line 14</span>
530
-
531
- <span class='kw'>def</span> <span class='id identifier rubyid_items'>items</span>
532
- <span class='ivar'>@items</span>
533
- <span class='kw'>end</span></pre>
534
- </td>
535
- </tr>
536
- </table>
537
- </div>
538
-
539
-
540
- <span id=""></span>
541
- <div class="method_details ">
542
- <h3 class="signature " id="limit-instance_method">
543
-
544
- #<strong>limit</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
545
-
546
-
547
-
548
-
549
-
550
- </h3><div class="docstring">
551
- <div class="discussion">
552
-
553
- <p>Returns the value of attribute limit</p>
554
-
555
-
556
- </div>
557
- </div>
558
- <div class="tags">
559
-
560
-
561
- </div><table class="source_code">
562
- <tr>
563
- <td>
564
- <pre class="lines">
565
-
566
-
567
- 14
568
- 15
569
- 16</pre>
570
- </td>
571
- <td>
572
- <pre class="code"><span class="info file"># File 'lib/contentful/array.rb', line 14</span>
573
-
574
- <span class='kw'>def</span> <span class='id identifier rubyid_limit'>limit</span>
575
- <span class='ivar'>@limit</span>
576
- <span class='kw'>end</span></pre>
577
- </td>
578
- </tr>
579
- </table>
580
- </div>
581
-
582
-
583
- <span id=""></span>
584
- <div class="method_details ">
585
- <h3 class="signature " id="skip-instance_method">
586
-
587
- #<strong>skip</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
588
-
589
-
590
-
591
-
592
-
593
- </h3><div class="docstring">
594
- <div class="discussion">
595
-
596
- <p>Returns the value of attribute skip</p>
597
-
598
-
599
- </div>
600
- </div>
601
- <div class="tags">
602
-
603
-
604
- </div><table class="source_code">
605
- <tr>
606
- <td>
607
- <pre class="lines">
608
-
609
-
610
- 14
611
- 15
612
- 16</pre>
613
- </td>
614
- <td>
615
- <pre class="code"><span class="info file"># File 'lib/contentful/array.rb', line 14</span>
616
-
617
- <span class='kw'>def</span> <span class='id identifier rubyid_skip'>skip</span>
618
- <span class='ivar'>@skip</span>
619
- <span class='kw'>end</span></pre>
620
- </td>
621
- </tr>
622
- </table>
623
- </div>
624
-
625
-
626
- <span id=""></span>
627
- <div class="method_details ">
628
- <h3 class="signature " id="total-instance_method">
629
-
630
- #<strong>total</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
631
-
632
-
633
-
634
-
635
-
636
- </h3><div class="docstring">
637
- <div class="discussion">
638
-
639
- <p>Returns the value of attribute total</p>
640
-
641
-
642
- </div>
643
- </div>
644
- <div class="tags">
645
-
646
-
647
- </div><table class="source_code">
648
- <tr>
649
- <td>
650
- <pre class="lines">
651
-
652
-
653
- 14
654
- 15
655
- 16</pre>
656
- </td>
657
- <td>
658
- <pre class="code"><span class="info file"># File 'lib/contentful/array.rb', line 14</span>
659
-
660
- <span class='kw'>def</span> <span class='id identifier rubyid_total'>total</span>
661
- <span class='ivar'>@total</span>
662
- <span class='kw'>end</span></pre>
663
- </td>
664
- </tr>
665
- </table>
666
- </div>
667
-
668
- </div>
669
-
670
-
671
- <div id="instance_method_details" class="method_details_list">
672
- <h2>Instance Method Details</h2>
673
-
674
-
675
- <div class="method_details first">
676
- <h3 class="signature first" id="next_page-instance_method">
677
-
678
- #<strong>next_page</strong>(client = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::Array (class)">Contentful::Array</a></span></tt>, <tt>false</tt>
679
-
680
-
681
-
682
-
683
-
684
- </h3><div class="docstring">
685
- <div class="discussion">
686
-
687
- <p>Simplifies pagination</p>
688
-
689
-
690
- </div>
691
- </div>
692
- <div class="tags">
693
-
694
- <p class="tag_title">Returns:</p>
695
- <ul class="return">
696
-
697
- <li>
698
-
699
-
700
- <span class='type'>(<tt><span class='object_link'><a href="" title="Contentful::Array (class)">Contentful::Array</a></span></tt>, <tt>false</tt>)</span>
701
-
702
-
703
-
704
- </li>
705
-
706
- </ul>
707
-
708
- </div><table class="source_code">
709
- <tr>
710
- <td>
711
- <pre class="lines">
712
-
713
-
714
- 60
715
- 61
716
- 62
717
- 63
718
- 64
719
- 65
720
- 66
721
- 67
722
- 68
723
- 69
724
- 70
725
- 71
726
- 72
727
- 73
728
- 74</pre>
729
- </td>
730
- <td>
731
- <pre class="code"><span class="info file"># File 'lib/contentful/array.rb', line 60</span>
732
-
733
- <span class='kw'>def</span> <span class='id identifier rubyid_next_page'>next_page</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
734
- <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
735
- <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
736
-
737
- <span class='id identifier rubyid_new_skip'>new_skip</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_skip'>skip</span> <span class='op'>||</span> <span class='int'>0</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='lparen'>(</span><span class='id identifier rubyid_limit'>limit</span> <span class='op'>||</span> <span class='const'>DEFAULT_LIMIT</span><span class='rparen'>)</span>
738
-
739
- <span class='id identifier rubyid_plurals'>plurals</span> <span class='op'>=</span> <span class='lbrace'>{</span>
740
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Space</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'>spaces</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
741
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ContentType</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'>content_types</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
742
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Entry</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'>entries</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
743
- <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='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>assets</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
744
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Locale</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'>locales</span><span class='tstring_end'>&#39;</span></span>
745
- <span class='rbrace'>}</span>
746
- <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='id identifier rubyid_plurals'>plurals</span><span class='lbracket'>[</span><span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> <span class='label'>skip:</span> <span class='id identifier rubyid_new_skip'>new_skip</span><span class='rparen'>)</span>
747
- <span class='kw'>end</span></pre>
748
- </td>
749
- </tr>
750
- </table>
751
- </div>
752
-
753
- </div>
754
-
755
- </div>
756
-
757
- <div id="footer">
758
- Generated on Tue Apr 9 10:49:56 2019 by
759
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
760
- 0.9.18 (ruby-2.5.3).
761
- </div>
762
-
763
- </div>
764
- </body>
765
- </html>