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,887 +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::Request
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::Request";
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 (R)</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">Request</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::Request
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::Request</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/request.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
-
105
- <p>This object represents a request that is to be made. It gets initialized by
106
- the client with domain specific logic. The client later uses the
107
- Request&#39;s #url and #query methods to execute the HTTP request.</p>
108
-
109
-
110
- </div>
111
- </div>
112
- <div class="tags">
113
-
114
-
115
- </div>
116
-
117
-
118
-
119
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
120
- <ul class="summary">
121
-
122
- <li class="public ">
123
- <span class="summary_signature">
124
-
125
- <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
126
-
127
-
128
-
129
- </span>
130
-
131
-
132
-
133
-
134
- <span class="note title readonly">readonly</span>
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
- <span class="summary_desc"><div class='inline'>
145
- <p>Returns the value of attribute client.</p>
146
- </div></span>
147
-
148
- </li>
149
-
150
-
151
- <li class="public ">
152
- <span class="summary_signature">
153
-
154
- <a href="#endpoint-instance_method" title="#endpoint (instance method)">#<strong>endpoint</strong> &#x21d2; Object </a>
155
-
156
-
157
-
158
- </span>
159
-
160
-
161
-
162
-
163
- <span class="note title readonly">readonly</span>
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- <span class="summary_desc"><div class='inline'>
174
- <p>Returns the value of attribute endpoint.</p>
175
- </div></span>
176
-
177
- </li>
178
-
179
-
180
- <li class="public ">
181
- <span class="summary_signature">
182
-
183
- <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
184
-
185
-
186
-
187
- </span>
188
-
189
-
190
-
191
-
192
- <span class="note title readonly">readonly</span>
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
- <span class="summary_desc"><div class='inline'>
203
- <p>Returns the value of attribute id.</p>
204
- </div></span>
205
-
206
- </li>
207
-
208
-
209
- <li class="public ">
210
- <span class="summary_signature">
211
-
212
- <a href="#query-instance_method" title="#query (instance method)">#<strong>query</strong> &#x21d2; Object </a>
213
-
214
-
215
-
216
- </span>
217
-
218
-
219
-
220
-
221
- <span class="note title readonly">readonly</span>
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
- <span class="summary_desc"><div class='inline'>
232
- <p>Returns the value of attribute query.</p>
233
- </div></span>
234
-
235
- </li>
236
-
237
-
238
- <li class="public ">
239
- <span class="summary_signature">
240
-
241
- <a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; Object </a>
242
-
243
-
244
-
245
- </span>
246
-
247
-
248
-
249
-
250
- <span class="note title readonly">readonly</span>
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
- <span class="summary_desc"><div class='inline'>
261
- <p>Returns the value of attribute type.</p>
262
- </div></span>
263
-
264
- </li>
265
-
266
-
267
- </ul>
268
-
269
-
270
-
271
-
272
-
273
- <h2>
274
- Instance Method Summary
275
- <small><a href="#" class="summary_toggle">collapse</a></small>
276
- </h2>
277
-
278
- <ul class="summary">
279
-
280
- <li class="public ">
281
- <span class="summary_signature">
282
-
283
- <a href="#absolute%3F-instance_method" title="#absolute? (instance method)">#<strong>absolute?</strong> &#x21d2; Boolean </a>
284
-
285
-
286
-
287
- </span>
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
- <span class="summary_desc"><div class='inline'>
298
- <p>Returns true if endpoint is an absolute url.</p>
299
- </div></span>
300
-
301
- </li>
302
-
303
-
304
- <li class="public ">
305
- <span class="summary_signature">
306
-
307
- <a href="#copy-instance_method" title="#copy (instance method)">#<strong>copy</strong> &#x21d2; Object </a>
308
-
309
-
310
-
311
- </span>
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
- <span class="summary_desc"><div class='inline'>
322
- <p>Returns a new Request object with the same data.</p>
323
- </div></span>
324
-
325
- </li>
326
-
327
-
328
- <li class="public ">
329
- <span class="summary_signature">
330
-
331
- <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong> &#x21d2; Object </a>
332
-
333
-
334
-
335
- </span>
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
- <span class="summary_desc"><div class='inline'>
346
- <p>Delegates the actual HTTP work to the client.</p>
347
- </div></span>
348
-
349
- </li>
350
-
351
-
352
- <li class="public ">
353
- <span class="summary_signature">
354
-
355
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client, endpoint, query = {}, id = nil) &#x21d2; Request </a>
356
-
357
-
358
-
359
- </span>
360
-
361
-
362
- <span class="note title constructor">constructor</span>
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
- <span class="summary_desc"><div class='inline'>
372
- <p>A new instance of Request.</p>
373
- </div></span>
374
-
375
- </li>
376
-
377
-
378
- <li class="public ">
379
- <span class="summary_signature">
380
-
381
- <a href="#url-instance_method" title="#url (instance method)">#<strong>url</strong> &#x21d2; Object </a>
382
-
383
-
384
-
385
- </span>
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
- <span class="summary_desc"><div class='inline'>
396
- <p>Returns the final URL, relative to a contentful space.</p>
397
- </div></span>
398
-
399
- </li>
400
-
401
-
402
- </ul>
403
-
404
-
405
- <div id="constructor_details" class="method_details_list">
406
- <h2>Constructor Details</h2>
407
-
408
- <div class="method_details first">
409
- <h3 class="signature first" id="initialize-instance_method">
410
-
411
- #<strong>initialize</strong>(client, endpoint, query = {}, id = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::Request (class)">Request</a></span></tt>
412
-
413
-
414
-
415
-
416
-
417
- </h3><div class="docstring">
418
- <div class="discussion">
419
-
420
- <p>Returns a new instance of Request</p>
421
-
422
-
423
- </div>
424
- </div>
425
- <div class="tags">
426
-
427
-
428
- </div><table class="source_code">
429
- <tr>
430
- <td>
431
- <pre class="lines">
432
-
433
-
434
- 8
435
- 9
436
- 10
437
- 11
438
- 12
439
- 13
440
- 14
441
- 15
442
- 16
443
- 17
444
- 18
445
- 19
446
- 20
447
- 21</pre>
448
- </td>
449
- <td>
450
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 8</span>
451
-
452
- <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_endpoint'>endpoint</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
453
- <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
454
- <span class='ivar'>@endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
455
-
456
- <span class='ivar'>@query</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_normalize_query'>normalize_query</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_query'>query</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span><span class='rparen'>)</span>
457
-
458
- <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span>
459
- <span class='ivar'>@type</span> <span class='op'>=</span> <span class='symbol'>:single</span>
460
- <span class='ivar'>@id</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
461
- <span class='kw'>else</span>
462
- <span class='ivar'>@type</span> <span class='op'>=</span> <span class='symbol'>:multi</span>
463
- <span class='ivar'>@id</span> <span class='op'>=</span> <span class='kw'>nil</span>
464
- <span class='kw'>end</span>
465
- <span class='kw'>end</span></pre>
466
- </td>
467
- </tr>
468
- </table>
469
- </div>
470
-
471
- </div>
472
-
473
- <div id="instance_attr_details" class="attr_details">
474
- <h2>Instance Attribute Details</h2>
475
-
476
-
477
- <span id=""></span>
478
- <div class="method_details first">
479
- <h3 class="signature first" id="client-instance_method">
480
-
481
- #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
482
-
483
-
484
-
485
-
486
-
487
- </h3><div class="docstring">
488
- <div class="discussion">
489
-
490
- <p>Returns the value of attribute client</p>
491
-
492
-
493
- </div>
494
- </div>
495
- <div class="tags">
496
-
497
-
498
- </div><table class="source_code">
499
- <tr>
500
- <td>
501
- <pre class="lines">
502
-
503
-
504
- 6
505
- 7
506
- 8</pre>
507
- </td>
508
- <td>
509
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
510
-
511
- <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
512
- <span class='ivar'>@client</span>
513
- <span class='kw'>end</span></pre>
514
- </td>
515
- </tr>
516
- </table>
517
- </div>
518
-
519
-
520
- <span id=""></span>
521
- <div class="method_details ">
522
- <h3 class="signature " id="endpoint-instance_method">
523
-
524
- #<strong>endpoint</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
525
-
526
-
527
-
528
-
529
-
530
- </h3><div class="docstring">
531
- <div class="discussion">
532
-
533
- <p>Returns the value of attribute endpoint</p>
534
-
535
-
536
- </div>
537
- </div>
538
- <div class="tags">
539
-
540
-
541
- </div><table class="source_code">
542
- <tr>
543
- <td>
544
- <pre class="lines">
545
-
546
-
547
- 6
548
- 7
549
- 8</pre>
550
- </td>
551
- <td>
552
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
553
-
554
- <span class='kw'>def</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
555
- <span class='ivar'>@endpoint</span>
556
- <span class='kw'>end</span></pre>
557
- </td>
558
- </tr>
559
- </table>
560
- </div>
561
-
562
-
563
- <span id=""></span>
564
- <div class="method_details ">
565
- <h3 class="signature " id="id-instance_method">
566
-
567
- #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
568
-
569
-
570
-
571
-
572
-
573
- </h3><div class="docstring">
574
- <div class="discussion">
575
-
576
- <p>Returns the value of attribute id</p>
577
-
578
-
579
- </div>
580
- </div>
581
- <div class="tags">
582
-
583
-
584
- </div><table class="source_code">
585
- <tr>
586
- <td>
587
- <pre class="lines">
588
-
589
-
590
- 6
591
- 7
592
- 8</pre>
593
- </td>
594
- <td>
595
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
596
-
597
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
598
- <span class='ivar'>@id</span>
599
- <span class='kw'>end</span></pre>
600
- </td>
601
- </tr>
602
- </table>
603
- </div>
604
-
605
-
606
- <span id=""></span>
607
- <div class="method_details ">
608
- <h3 class="signature " id="query-instance_method">
609
-
610
- #<strong>query</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
611
-
612
-
613
-
614
-
615
-
616
- </h3><div class="docstring">
617
- <div class="discussion">
618
-
619
- <p>Returns the value of attribute query</p>
620
-
621
-
622
- </div>
623
- </div>
624
- <div class="tags">
625
-
626
-
627
- </div><table class="source_code">
628
- <tr>
629
- <td>
630
- <pre class="lines">
631
-
632
-
633
- 6
634
- 7
635
- 8</pre>
636
- </td>
637
- <td>
638
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
639
-
640
- <span class='kw'>def</span> <span class='id identifier rubyid_query'>query</span>
641
- <span class='ivar'>@query</span>
642
- <span class='kw'>end</span></pre>
643
- </td>
644
- </tr>
645
- </table>
646
- </div>
647
-
648
-
649
- <span id=""></span>
650
- <div class="method_details ">
651
- <h3 class="signature " id="type-instance_method">
652
-
653
- #<strong>type</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
654
-
655
-
656
-
657
-
658
-
659
- </h3><div class="docstring">
660
- <div class="discussion">
661
-
662
- <p>Returns the value of attribute type</p>
663
-
664
-
665
- </div>
666
- </div>
667
- <div class="tags">
668
-
669
-
670
- </div><table class="source_code">
671
- <tr>
672
- <td>
673
- <pre class="lines">
674
-
675
-
676
- 6
677
- 7
678
- 8</pre>
679
- </td>
680
- <td>
681
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
682
-
683
- <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
684
- <span class='ivar'>@type</span>
685
- <span class='kw'>end</span></pre>
686
- </td>
687
- </tr>
688
- </table>
689
- </div>
690
-
691
- </div>
692
-
693
-
694
- <div id="instance_method_details" class="method_details_list">
695
- <h2>Instance Method Details</h2>
696
-
697
-
698
- <div class="method_details first">
699
- <h3 class="signature first" id="absolute?-instance_method">
700
-
701
- #<strong>absolute?</strong> &#x21d2; <tt>Boolean</tt>
702
-
703
-
704
-
705
-
706
-
707
- </h3><div class="docstring">
708
- <div class="discussion">
709
-
710
- <p>Returns true if endpoint is an absolute url</p>
711
-
712
-
713
- </div>
714
- </div>
715
- <div class="tags">
716
-
717
- <p class="tag_title">Returns:</p>
718
- <ul class="return">
719
-
720
- <li>
721
-
722
-
723
- <span class='type'>(<tt>Boolean</tt>)</span>
724
-
725
-
726
-
727
- </li>
728
-
729
- </ul>
730
-
731
- </div><table class="source_code">
732
- <tr>
733
- <td>
734
- <pre class="lines">
735
-
736
-
737
- 34
738
- 35
739
- 36</pre>
740
- </td>
741
- <td>
742
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 34</span>
743
-
744
- <span class='kw'>def</span> <span class='id identifier rubyid_absolute?'>absolute?</span>
745
- <span class='ivar'>@endpoint</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
746
- <span class='kw'>end</span></pre>
747
- </td>
748
- </tr>
749
- </table>
750
- </div>
751
-
752
- <div class="method_details ">
753
- <h3 class="signature " id="copy-instance_method">
754
-
755
- #<strong>copy</strong> &#x21d2; <tt>Object</tt>
756
-
757
-
758
-
759
-
760
-
761
- </h3><div class="docstring">
762
- <div class="discussion">
763
-
764
- <p>Returns a new Request object with the same data</p>
765
-
766
-
767
- </div>
768
- </div>
769
- <div class="tags">
770
-
771
-
772
- </div><table class="source_code">
773
- <tr>
774
- <td>
775
- <pre class="lines">
776
-
777
-
778
- 39
779
- 40
780
- 41</pre>
781
- </td>
782
- <td>
783
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 39</span>
784
-
785
- <span class='kw'>def</span> <span class='id identifier rubyid_copy'>copy</span>
786
- <span class='const'>Marshal</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='const'>Marshal</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span><span class='rparen'>)</span>
787
- <span class='kw'>end</span></pre>
788
- </td>
789
- </tr>
790
- </table>
791
- </div>
792
-
793
- <div class="method_details ">
794
- <h3 class="signature " id="get-instance_method">
795
-
796
- #<strong>get</strong> &#x21d2; <tt>Object</tt>
797
-
798
-
799
-
800
-
801
-
802
- </h3><div class="docstring">
803
- <div class="discussion">
804
-
805
- <p>Delegates the actual HTTP work to the client</p>
806
-
807
-
808
- </div>
809
- </div>
810
- <div class="tags">
811
-
812
-
813
- </div><table class="source_code">
814
- <tr>
815
- <td>
816
- <pre class="lines">
817
-
818
-
819
- 29
820
- 30
821
- 31</pre>
822
- </td>
823
- <td>
824
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 29</span>
825
-
826
- <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span>
827
- <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
828
- <span class='kw'>end</span></pre>
829
- </td>
830
- </tr>
831
- </table>
832
- </div>
833
-
834
- <div class="method_details ">
835
- <h3 class="signature " id="url-instance_method">
836
-
837
- #<strong>url</strong> &#x21d2; <tt>Object</tt>
838
-
839
-
840
-
841
-
842
-
843
- </h3><div class="docstring">
844
- <div class="discussion">
845
-
846
- <p>Returns the final URL, relative to a contentful space</p>
847
-
848
-
849
- </div>
850
- </div>
851
- <div class="tags">
852
-
853
-
854
- </div><table class="source_code">
855
- <tr>
856
- <td>
857
- <pre class="lines">
858
-
859
-
860
- 24
861
- 25
862
- 26</pre>
863
- </td>
864
- <td>
865
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 24</span>
866
-
867
- <span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
868
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@endpoint</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@type</span> <span class='op'>==</span> <span class='symbol'>:single</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
869
- <span class='kw'>end</span></pre>
870
- </td>
871
- </tr>
872
- </table>
873
- </div>
874
-
875
- </div>
876
-
877
- </div>
878
-
879
- <div id="footer">
880
- Generated on Tue Apr 9 10:49:56 2019 by
881
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
882
- 0.9.18 (ruby-2.5.3).
883
- </div>
884
-
885
- </div>
886
- </body>
887
- </html>