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
  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,653 +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::Sync
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::Sync";
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 (S)</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">Sync</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::Sync
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">Contentful::Sync</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dl>
96
- <dt>Defined in:</dt>
97
- <dd>lib/contentful/sync.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
-
105
- <p>Resource class for Sync.</p>
106
-
107
-
108
- </div>
109
- </div>
110
- <div class="tags">
111
-
112
-
113
- <p class="tag_title">See Also:</p>
114
- <ul class="see">
115
-
116
- <li>https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization</li>
117
-
118
- </ul>
119
-
120
- </div>
121
-
122
-
123
-
124
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
125
- <ul class="summary">
126
-
127
- <li class="public ">
128
- <span class="summary_signature">
129
-
130
- <a href="#next_sync_url-instance_method" title="#next_sync_url (instance method)">#<strong>next_sync_url</strong> &#x21d2; Object </a>
131
-
132
-
133
-
134
- </span>
135
-
136
-
137
-
138
-
139
- <span class="note title readonly">readonly</span>
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
- <span class="summary_desc"><div class='inline'>
150
- <p>Returns the value of attribute next_sync_url.</p>
151
- </div></span>
152
-
153
- </li>
154
-
155
-
156
- </ul>
157
-
158
-
159
-
160
-
161
-
162
- <h2>
163
- Instance Method Summary
164
- <small><a href="#" class="summary_toggle">collapse</a></small>
165
- </h2>
166
-
167
- <ul class="summary">
168
-
169
- <li class="public ">
170
- <span class="summary_signature">
171
-
172
- <a href="#completed%3F-instance_method" title="#completed? (instance method)">#<strong>completed?</strong> &#x21d2; Boolean </a>
173
-
174
-
175
-
176
- </span>
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
- <span class="summary_desc"><div class='inline'>
187
- <p>Returns false as long as last sync page has not been reached.</p>
188
- </div></span>
189
-
190
- </li>
191
-
192
-
193
- <li class="public ">
194
- <span class="summary_signature">
195
-
196
- <a href="#each_item-instance_method" title="#each_item (instance method)">#<strong>each_item</strong> {|Contentful::Entry, Contentful::Asset| ... } &#x21d2; Object </a>
197
-
198
-
199
-
200
- </span>
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
- <span class="summary_desc"><div class='inline'>
211
- <p>Directly iterates over all resources that have changed.</p>
212
- </div></span>
213
-
214
- </li>
215
-
216
-
217
- <li class="public ">
218
- <span class="summary_signature">
219
-
220
- <a href="#each_page-instance_method" title="#each_page (instance method)">#<strong>each_page</strong> {|Contentful::SyncPage| ... } &#x21d2; Object </a>
221
-
222
-
223
-
224
- </span>
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
- <span class="summary_desc"><div class='inline'>
235
- <p>Iterates over all pages of the current sync.</p>
236
- </div></span>
237
-
238
- </li>
239
-
240
-
241
- <li class="public ">
242
- <span class="summary_signature">
243
-
244
- <a href="#first_page-instance_method" title="#first_page (instance method)">#<strong>first_page</strong> &#x21d2; Contentful::SyncPage </a>
245
-
246
-
247
-
248
- </span>
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
- <span class="summary_desc"><div class='inline'>
259
- <p>Returns the first sync result page.</p>
260
- </div></span>
261
-
262
- </li>
263
-
264
-
265
- <li class="public ">
266
- <span class="summary_signature">
267
-
268
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client, options_or_url) &#x21d2; Sync </a>
269
-
270
-
271
-
272
- </span>
273
-
274
-
275
- <span class="note title constructor">constructor</span>
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
- <span class="summary_desc"><div class='inline'>
285
- <p>A new instance of Sync.</p>
286
- </div></span>
287
-
288
- </li>
289
-
290
-
291
- </ul>
292
-
293
-
294
- <div id="constructor_details" class="method_details_list">
295
- <h2>Constructor Details</h2>
296
-
297
- <div class="method_details first">
298
- <h3 class="signature first" id="initialize-instance_method">
299
-
300
- #<strong>initialize</strong>(client, options_or_url) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::Sync (class)">Sync</a></span></tt>
301
-
302
-
303
-
304
-
305
-
306
- </h3><div class="docstring">
307
- <div class="discussion">
308
-
309
- <p>Returns a new instance of Sync</p>
310
-
311
-
312
- </div>
313
- </div>
314
- <div class="tags">
315
-
316
-
317
- </div><table class="source_code">
318
- <tr>
319
- <td>
320
- <pre class="lines">
321
-
322
-
323
- 12
324
- 13
325
- 14
326
- 15
327
- 16</pre>
328
- </td>
329
- <td>
330
- <pre class="code"><span class="info file"># File 'lib/contentful/sync.rb', line 12</span>
331
-
332
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_options_or_url'>options_or_url</span><span class='rparen'>)</span>
333
- <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
334
- <span class='ivar'>@next_sync_url</span> <span class='op'>=</span> <span class='kw'>nil</span>
335
- <span class='ivar'>@first_page_options_or_url</span> <span class='op'>=</span> <span class='id identifier rubyid_options_or_url'>options_or_url</span>
336
- <span class='kw'>end</span></pre>
337
- </td>
338
- </tr>
339
- </table>
340
- </div>
341
-
342
- </div>
343
-
344
- <div id="instance_attr_details" class="attr_details">
345
- <h2>Instance Attribute Details</h2>
346
-
347
-
348
- <span id=""></span>
349
- <div class="method_details first">
350
- <h3 class="signature first" id="next_sync_url-instance_method">
351
-
352
- #<strong>next_sync_url</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
353
-
354
-
355
-
356
-
357
-
358
- </h3><div class="docstring">
359
- <div class="discussion">
360
-
361
- <p>Returns the value of attribute next_sync_url</p>
362
-
363
-
364
- </div>
365
- </div>
366
- <div class="tags">
367
-
368
-
369
- </div><table class="source_code">
370
- <tr>
371
- <td>
372
- <pre class="lines">
373
-
374
-
375
- 10
376
- 11
377
- 12</pre>
378
- </td>
379
- <td>
380
- <pre class="code"><span class="info file"># File 'lib/contentful/sync.rb', line 10</span>
381
-
382
- <span class='kw'>def</span> <span class='id identifier rubyid_next_sync_url'>next_sync_url</span>
383
- <span class='ivar'>@next_sync_url</span>
384
- <span class='kw'>end</span></pre>
385
- </td>
386
- </tr>
387
- </table>
388
- </div>
389
-
390
- </div>
391
-
392
-
393
- <div id="instance_method_details" class="method_details_list">
394
- <h2>Instance Method Details</h2>
395
-
396
-
397
- <div class="method_details first">
398
- <h3 class="signature first" id="completed?-instance_method">
399
-
400
- #<strong>completed?</strong> &#x21d2; <tt>Boolean</tt>
401
-
402
-
403
-
404
-
405
-
406
- </h3><div class="docstring">
407
- <div class="discussion">
408
-
409
- <p>Returns false as long as last sync page has not been reached</p>
410
-
411
-
412
- </div>
413
- </div>
414
- <div class="tags">
415
-
416
- <p class="tag_title">Returns:</p>
417
- <ul class="return">
418
-
419
- <li>
420
-
421
-
422
- <span class='type'>(<tt>Boolean</tt>)</span>
423
-
424
-
425
-
426
- </li>
427
-
428
- </ul>
429
-
430
- </div><table class="source_code">
431
- <tr>
432
- <td>
433
- <pre class="lines">
434
-
435
-
436
- 43
437
- 44
438
- 45
439
- 46
440
- 47</pre>
441
- </td>
442
- <td>
443
- <pre class="code"><span class="info file"># File 'lib/contentful/sync.rb', line 43</span>
444
-
445
- <span class='kw'>def</span> <span class='id identifier rubyid_completed?'>completed?</span>
446
- <span class='comment'># rubocop:disable Style/DoubleNegation
447
- </span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_next_sync_url'>next_sync_url</span>
448
- <span class='comment'># rubocop:enable Style/DoubleNegation
449
- </span><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="each_item-instance_method">
457
-
458
- #<strong>each_item</strong> {|Contentful::Entry, Contentful::Asset| ... } &#x21d2; <tt>Object</tt>
459
-
460
-
461
-
462
-
463
-
464
- </h3><div class="docstring">
465
- <div class="discussion">
466
-
467
- <p>Directly iterates over all resources that have changed</p>
468
-
469
-
470
- </div>
471
- </div>
472
- <div class="tags">
473
-
474
- <p class="tag_title">Yields:</p>
475
- <ul class="yield">
476
-
477
- <li>
478
-
479
-
480
- <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span>
481
-
482
-
483
-
484
- </li>
485
-
486
- </ul>
487
-
488
- </div><table class="source_code">
489
- <tr>
490
- <td>
491
- <pre class="lines">
492
-
493
-
494
- 52
495
- 53
496
- 54
497
- 55
498
- 56</pre>
499
- </td>
500
- <td>
501
- <pre class="code"><span class="info file"># File 'lib/contentful/sync.rb', line 52</span>
502
-
503
- <span class='kw'>def</span> <span class='id identifier rubyid_each_item'>each_item</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
504
- <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>
505
- <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_each_item'>each_item</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
506
- <span class='kw'>end</span>
507
- <span class='kw'>end</span></pre>
508
- </td>
509
- </tr>
510
- </table>
511
- </div>
512
-
513
- <div class="method_details ">
514
- <h3 class="signature " id="each_page-instance_method">
515
-
516
- #<strong>each_page</strong> {|Contentful::SyncPage| ... } &#x21d2; <tt>Object</tt>
517
-
518
-
519
-
520
-
521
-
522
- </h3><div class="docstring">
523
- <div class="discussion">
524
-
525
- <div class="note notetag">
526
- <strong>Note:</strong>
527
- <div class='inline'>
528
- <p>Please Keep in Mind: Iterating fires a new request for each page</p>
529
- </div>
530
- </div>
531
-
532
-
533
- <p>Iterates over all pages of the current sync</p>
534
-
535
-
536
- </div>
537
- </div>
538
- <div class="tags">
539
-
540
- <p class="tag_title">Yields:</p>
541
- <ul class="yield">
542
-
543
- <li>
544
-
545
-
546
- <span class='type'>(<tt><span class='object_link'><a href="SyncPage.html" title="Contentful::SyncPage (class)">Contentful::SyncPage</a></span></tt>)</span>
547
-
548
-
549
-
550
- </li>
551
-
552
- </ul>
553
-
554
- </div><table class="source_code">
555
- <tr>
556
- <td>
557
- <pre class="lines">
558
-
559
-
560
- 23
561
- 24
562
- 25
563
- 26
564
- 27
565
- 28
566
- 29
567
- 30
568
- 31</pre>
569
- </td>
570
- <td>
571
- <pre class="code"><span class="info file"># File 'lib/contentful/sync.rb', line 23</span>
572
-
573
- <span class='kw'>def</span> <span class='id identifier rubyid_each_page'>each_page</span>
574
- <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_first_page'>first_page</span>
575
- <span class='kw'>yield</span> <span class='id identifier rubyid_page'>page</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
576
-
577
- <span class='kw'>until</span> <span class='id identifier rubyid_completed?'>completed?</span>
578
- <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_next_page'>next_page</span>
579
- <span class='kw'>yield</span> <span class='id identifier rubyid_page'>page</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
580
- <span class='kw'>end</span>
581
- <span class='kw'>end</span></pre>
582
- </td>
583
- </tr>
584
- </table>
585
- </div>
586
-
587
- <div class="method_details ">
588
- <h3 class="signature " id="first_page-instance_method">
589
-
590
- #<strong>first_page</strong> &#x21d2; <tt><span class='object_link'><a href="SyncPage.html" title="Contentful::SyncPage (class)">Contentful::SyncPage</a></span></tt>
591
-
592
-
593
-
594
-
595
-
596
- </h3><div class="docstring">
597
- <div class="discussion">
598
-
599
- <p>Returns the first sync result page</p>
600
-
601
-
602
- </div>
603
- </div>
604
- <div class="tags">
605
-
606
- <p class="tag_title">Returns:</p>
607
- <ul class="return">
608
-
609
- <li>
610
-
611
-
612
- <span class='type'>(<tt><span class='object_link'><a href="SyncPage.html" title="Contentful::SyncPage (class)">Contentful::SyncPage</a></span></tt>)</span>
613
-
614
-
615
-
616
- </li>
617
-
618
- </ul>
619
-
620
- </div><table class="source_code">
621
- <tr>
622
- <td>
623
- <pre class="lines">
624
-
625
-
626
- 36
627
- 37
628
- 38</pre>
629
- </td>
630
- <td>
631
- <pre class="code"><span class="info file"># File 'lib/contentful/sync.rb', line 36</span>
632
-
633
- <span class='kw'>def</span> <span class='id identifier rubyid_first_page'>first_page</span>
634
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='ivar'>@first_page_options_or_url</span><span class='rparen'>)</span>
635
- <span class='kw'>end</span></pre>
636
- </td>
637
- </tr>
638
- </table>
639
- </div>
640
-
641
- </div>
642
-
643
- </div>
644
-
645
- <div id="footer">
646
- Generated on Tue Apr 9 10:49:56 2019 by
647
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
648
- 0.9.18 (ruby-2.5.3).
649
- </div>
650
-
651
- </div>
652
- </body>
653
- </html>