contentful 2.15.3 → 2.16.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (247) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +22 -11
  4. data/lib/contentful/array_like.rb +11 -2
  5. data/lib/contentful/asset.rb +4 -0
  6. data/lib/contentful/base_resource.rb +14 -2
  7. data/lib/contentful/client.rb +1 -2
  8. data/lib/contentful/fields_resource.rb +1 -0
  9. data/lib/contentful/version.rb +1 -1
  10. metadata +4 -367
  11. data/.gitignore +0 -7
  12. data/.rspec +0 -1
  13. data/.rubocop.yml +0 -31
  14. data/.rubocop_todo.yml +0 -35
  15. data/.travis.yml +0 -15
  16. data/.yardopts +0 -4
  17. data/Gemfile +0 -9
  18. data/Gemfile.lock +0 -166
  19. data/Guardfile +0 -24
  20. data/RELEASE.md +0 -8
  21. data/Rakefile +0 -33
  22. data/contentful.gemspec +0 -44
  23. data/coverage/.last_run.json +0 -5
  24. data/coverage/.resultset.json +0 -5086
  25. data/coverage/.resultset.json.lock +0 -0
  26. data/coverage/assets/0.10.2/application.css +0 -799
  27. data/coverage/assets/0.10.2/application.js +0 -1707
  28. data/coverage/assets/0.10.2/colorbox/border.png +0 -0
  29. data/coverage/assets/0.10.2/colorbox/controls.png +0 -0
  30. data/coverage/assets/0.10.2/colorbox/loading.gif +0 -0
  31. data/coverage/assets/0.10.2/colorbox/loading_background.png +0 -0
  32. data/coverage/assets/0.10.2/favicon_green.png +0 -0
  33. data/coverage/assets/0.10.2/favicon_red.png +0 -0
  34. data/coverage/assets/0.10.2/favicon_yellow.png +0 -0
  35. data/coverage/assets/0.10.2/loading.gif +0 -0
  36. data/coverage/assets/0.10.2/magnify.png +0 -0
  37. data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
  38. data/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
  39. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
  40. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
  41. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
  42. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
  43. data/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
  44. data/coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
  45. data/coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png +0 -0
  46. data/coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
  47. data/coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png +0 -0
  48. data/coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png +0 -0
  49. data/coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
  50. data/coverage/index.html +0 -0
  51. data/doc/Contentful/AccessDenied.html +0 -159
  52. data/doc/Contentful/Array.html +0 -844
  53. data/doc/Contentful/ArrayCoercion.html +0 -242
  54. data/doc/Contentful/ArrayLike.html +0 -624
  55. data/doc/Contentful/Asset.html +0 -486
  56. data/doc/Contentful/BadGateway.html +0 -159
  57. data/doc/Contentful/BadRequest.html +0 -159
  58. data/doc/Contentful/BaseCoercion.html +0 -445
  59. data/doc/Contentful/BaseResource.html +0 -598
  60. data/doc/Contentful/BooleanCoercion.html +0 -242
  61. data/doc/Contentful/Client.html +0 -1738
  62. data/doc/Contentful/ContentType.html +0 -617
  63. data/doc/Contentful/ContentTypeCache.html +0 -428
  64. data/doc/Contentful/DateCoercion.html +0 -244
  65. data/doc/Contentful/DeletedAsset.html +0 -156
  66. data/doc/Contentful/DeletedEntry.html +0 -156
  67. data/doc/Contentful/EmptyFieldError.html +0 -217
  68. data/doc/Contentful/Entry.html +0 -334
  69. data/doc/Contentful/Error.html +0 -407
  70. data/doc/Contentful/Field.html +0 -935
  71. data/doc/Contentful/FieldsResource.html +0 -583
  72. data/doc/Contentful/File.html +0 -218
  73. data/doc/Contentful/FloatCoercion.html +0 -238
  74. data/doc/Contentful/IntegerCoercion.html +0 -238
  75. data/doc/Contentful/Link.html +0 -246
  76. data/doc/Contentful/LinkCoercion.html +0 -156
  77. data/doc/Contentful/Locale.html +0 -536
  78. data/doc/Contentful/Location.html +0 -382
  79. data/doc/Contentful/LocationCoercion.html +0 -238
  80. data/doc/Contentful/NotFound.html +0 -159
  81. data/doc/Contentful/ObjectCoercion.html +0 -238
  82. data/doc/Contentful/RateLimitExceeded.html +0 -346
  83. data/doc/Contentful/Request.html +0 -895
  84. data/doc/Contentful/ResourceBuilder.html +0 -1067
  85. data/doc/Contentful/ResourceReferences.html +0 -254
  86. data/doc/Contentful/Response.html +0 -708
  87. data/doc/Contentful/RichTextCoercion.html +0 -238
  88. data/doc/Contentful/ServerError.html +0 -159
  89. data/doc/Contentful/ServiceUnavailable.html +0 -159
  90. data/doc/Contentful/Space.html +0 -392
  91. data/doc/Contentful/StringCoercion.html +0 -242
  92. data/doc/Contentful/StructuredTextCoercion.html +0 -238
  93. data/doc/Contentful/Support.html +0 -788
  94. data/doc/Contentful/SymbolCoercion.html +0 -169
  95. data/doc/Contentful/Sync.html +0 -653
  96. data/doc/Contentful/SyncPage.html +0 -807
  97. data/doc/Contentful/TextCoercion.html +0 -169
  98. data/doc/Contentful/Unauthorized.html +0 -159
  99. data/doc/Contentful/UnparsableJson.html +0 -159
  100. data/doc/Contentful/UnparsableResource.html +0 -135
  101. data/doc/Contentful.html +0 -157
  102. data/doc/_index.html +0 -563
  103. data/doc/class_list.html +0 -51
  104. data/doc/css/common.css +0 -1
  105. data/doc/css/full_list.css +0 -58
  106. data/doc/css/style.css +0 -496
  107. data/doc/file.CHANGELOG.html +0 -708
  108. data/doc/file.LICENSE.html +0 -70
  109. data/doc/file.README.html +0 -758
  110. data/doc/file_list.html +0 -66
  111. data/doc/frames.html +0 -17
  112. data/doc/index.html +0 -758
  113. data/doc/js/app.js +0 -303
  114. data/doc/js/full_list.js +0 -216
  115. data/doc/js/jquery.js +0 -4
  116. data/doc/method_list.html +0 -1187
  117. data/doc/top-level-namespace.html +0 -110
  118. data/examples/custom_classes.rb +0 -39
  119. data/examples/example_queries.rb +0 -26
  120. data/examples/raise_errors.rb +0 -20
  121. data/examples/raw_mode.rb +0 -14
  122. data/spec/array_spec.rb +0 -167
  123. data/spec/asset_spec.rb +0 -192
  124. data/spec/auto_includes_spec.rb +0 -12
  125. data/spec/client_class_spec.rb +0 -86
  126. data/spec/client_configuration_spec.rb +0 -377
  127. data/spec/content_type_spec.rb +0 -49
  128. data/spec/deleted_asset_spec.rb +0 -38
  129. data/spec/deleted_entry_spec.rb +0 -38
  130. data/spec/entry_spec.rb +0 -777
  131. data/spec/error_class_spec.rb +0 -327
  132. data/spec/error_requests_spec.rb +0 -87
  133. data/spec/field_spec.rb +0 -95
  134. data/spec/file_spec.rb +0 -33
  135. data/spec/fixtures/json_responses/400_details_errors_object.json +0 -14
  136. data/spec/fixtures/json_responses/400_details_errors_string.json +0 -12
  137. data/spec/fixtures/json_responses/400_details_string.json +0 -8
  138. data/spec/fixtures/json_responses/403_reasons.json +0 -13
  139. data/spec/fixtures/json_responses/404_details_string.json +0 -8
  140. data/spec/fixtures/json_responses/404_id.json +0 -11
  141. data/spec/fixtures/json_responses/404_sys_type.json +0 -12
  142. data/spec/fixtures/json_responses/404_type.json +0 -10
  143. data/spec/fixtures/json_responses/content_type.json +0 -83
  144. data/spec/fixtures/json_responses/default_400.json +0 -7
  145. data/spec/fixtures/json_responses/default_401.json +0 -7
  146. data/spec/fixtures/json_responses/default_403.json +0 -7
  147. data/spec/fixtures/json_responses/default_404.json +0 -7
  148. data/spec/fixtures/json_responses/default_429.json +0 -7
  149. data/spec/fixtures/json_responses/default_500.json +0 -7
  150. data/spec/fixtures/json_responses/default_502.json +0 -7
  151. data/spec/fixtures/json_responses/default_503.json +0 -7
  152. data/spec/fixtures/json_responses/includes.json +0 -111
  153. data/spec/fixtures/json_responses/link_array.json +0 -43
  154. data/spec/fixtures/json_responses/not_found.json +0 -13
  155. data/spec/fixtures/json_responses/nyancat.json +0 -48
  156. data/spec/fixtures/json_responses/other_error.json +0 -9
  157. data/spec/fixtures/json_responses/other_error_no_details.json +0 -8
  158. data/spec/fixtures/json_responses/other_error_no_message.json +0 -8
  159. data/spec/fixtures/json_responses/other_error_no_request_id.json +0 -8
  160. data/spec/fixtures/json_responses/other_error_nothing.json +0 -6
  161. data/spec/fixtures/json_responses/self_link.json +0 -82
  162. data/spec/fixtures/json_responses/unparsable.json +0 -13
  163. data/spec/fixtures/vcr_cassettes/array/marshal_custom_classes.yml +0 -159
  164. data/spec/fixtures/vcr_cassettes/array/marshal_unpublished.yml +0 -315
  165. data/spec/fixtures/vcr_cassettes/array/nested_resources.yml +0 -159
  166. data/spec/fixtures/vcr_cassettes/array.yml +0 -288
  167. data/spec/fixtures/vcr_cassettes/arrayField.yml +0 -87
  168. data/spec/fixtures/vcr_cassettes/array_page_1.yml +0 -106
  169. data/spec/fixtures/vcr_cassettes/array_page_2.yml +0 -73
  170. data/spec/fixtures/vcr_cassettes/asset/select_empty_array.yml +0 -104
  171. data/spec/fixtures/vcr_cassettes/asset/select_no_sys.yml +0 -119
  172. data/spec/fixtures/vcr_cassettes/asset/select_one_field.yml +0 -97
  173. data/spec/fixtures/vcr_cassettes/asset/select_only_sys.yml +0 -88
  174. data/spec/fixtures/vcr_cassettes/asset.yml +0 -96
  175. data/spec/fixtures/vcr_cassettes/assets/issues_129.yml +0 -90
  176. data/spec/fixtures/vcr_cassettes/assets/issues_jekyll_46.yml +0 -115
  177. data/spec/fixtures/vcr_cassettes/bad_request.yml +0 -76
  178. data/spec/fixtures/vcr_cassettes/content_type.yml +0 -147
  179. data/spec/fixtures/vcr_cassettes/entries/empty_fields.yml +0 -246
  180. data/spec/fixtures/vcr_cassettes/entries/issue_117.yml +0 -201
  181. data/spec/fixtures/vcr_cassettes/entries/issue_125.yml +0 -198
  182. data/spec/fixtures/vcr_cassettes/entries/rich_text.yml +0 -1707
  183. data/spec/fixtures/vcr_cassettes/entries/rich_text_hydration_issue.yml +0 -460
  184. data/spec/fixtures/vcr_cassettes/entries/rich_text_nested_fields.yml +0 -653
  185. data/spec/fixtures/vcr_cassettes/entries/rich_text_unresolved_relationships.yml +0 -983
  186. data/spec/fixtures/vcr_cassettes/entries/unresolvable_assets.yml +0 -89
  187. data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter.yml +0 -159
  188. data/spec/fixtures/vcr_cassettes/entries/unresolvable_filter_deeply_nested.yml +0 -167
  189. data/spec/fixtures/vcr_cassettes/entries.yml +0 -561
  190. data/spec/fixtures/vcr_cassettes/entry/custom_resource.yml +0 -168
  191. data/spec/fixtures/vcr_cassettes/entry/include_resolution.yml +0 -101
  192. data/spec/fixtures/vcr_cassettes/entry/include_resolution_uniques.yml +0 -81
  193. data/spec/fixtures/vcr_cassettes/entry/json_objects.yml +0 -88
  194. data/spec/fixtures/vcr_cassettes/entry/json_objects_client.yml +0 -86
  195. data/spec/fixtures/vcr_cassettes/entry/marshal_138.yml +0 -159
  196. data/spec/fixtures/vcr_cassettes/entry/marshal_unpublished.yml +0 -303
  197. data/spec/fixtures/vcr_cassettes/entry/marshall.yml +0 -293
  198. data/spec/fixtures/vcr_cassettes/entry/raw.yml +0 -201
  199. data/spec/fixtures/vcr_cassettes/entry/search_link_to_asset.yml +0 -81
  200. data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry.yml +0 -81
  201. data/spec/fixtures/vcr_cassettes/entry/search_link_to_entry_with_custom_query.yml +0 -115
  202. data/spec/fixtures/vcr_cassettes/entry/select_empty_array.yml +0 -111
  203. data/spec/fixtures/vcr_cassettes/entry/select_no_sys.yml +0 -102
  204. data/spec/fixtures/vcr_cassettes/entry/select_one_field.yml +0 -76
  205. data/spec/fixtures/vcr_cassettes/entry/select_one_field_proper.yml +0 -114
  206. data/spec/fixtures/vcr_cassettes/entry/select_only_sys.yml +0 -111
  207. data/spec/fixtures/vcr_cassettes/entry.yml +0 -102
  208. data/spec/fixtures/vcr_cassettes/entry_cache.yml +0 -288
  209. data/spec/fixtures/vcr_cassettes/entry_locales.yml +0 -104
  210. data/spec/fixtures/vcr_cassettes/field.yml +0 -147
  211. data/spec/fixtures/vcr_cassettes/human.yml +0 -118
  212. data/spec/fixtures/vcr_cassettes/linkField.yml +0 -83
  213. data/spec/fixtures/vcr_cassettes/locale.yml +0 -83
  214. data/spec/fixtures/vcr_cassettes/locale_from_environment.yml +0 -121
  215. data/spec/fixtures/vcr_cassettes/location.yml +0 -193
  216. data/spec/fixtures/vcr_cassettes/multi_locale_array_reference.yml +0 -196
  217. data/spec/fixtures/vcr_cassettes/multi_locale_reference.yml +0 -214
  218. data/spec/fixtures/vcr_cassettes/not_found.yml +0 -76
  219. data/spec/fixtures/vcr_cassettes/nyancat.yml +0 -102
  220. data/spec/fixtures/vcr_cassettes/query_array_1.yml +0 -89
  221. data/spec/fixtures/vcr_cassettes/query_array_2.yml +0 -89
  222. data/spec/fixtures/vcr_cassettes/ratelimit.yml +0 -64
  223. data/spec/fixtures/vcr_cassettes/ratelimit_retry.yml +0 -294
  224. data/spec/fixtures/vcr_cassettes/reloaded_entry.yml +0 -102
  225. data/spec/fixtures/vcr_cassettes/space.yml +0 -83
  226. data/spec/fixtures/vcr_cassettes/sync_deleted_asset.yml +0 -174
  227. data/spec/fixtures/vcr_cassettes/sync_deleted_entry.yml +0 -89
  228. data/spec/fixtures/vcr_cassettes/sync_deletion.yml +0 -191
  229. data/spec/fixtures/vcr_cassettes/sync_environment.yml +0 -81
  230. data/spec/fixtures/vcr_cassettes/sync_page.yml +0 -637
  231. data/spec/fixtures/vcr_cassettes/sync_page_2.yml +0 -71
  232. data/spec/fixtures/vcr_cassettes/sync_page_short.yml +0 -106
  233. data/spec/fixtures/vcr_cassettes/unauthorized.yml +0 -64
  234. data/spec/fixtures/vcr_cassettes/unavailable.yml +0 -76
  235. data/spec/link_spec.rb +0 -50
  236. data/spec/locale_spec.rb +0 -37
  237. data/spec/location_spec.rb +0 -25
  238. data/spec/request_spec.rb +0 -57
  239. data/spec/resource_building_spec.rb +0 -31
  240. data/spec/response_spec.rb +0 -62
  241. data/spec/space_spec.rb +0 -31
  242. data/spec/spec_helper.rb +0 -14
  243. data/spec/support/client.rb +0 -6
  244. data/spec/support/json_responses.rb +0 -18
  245. data/spec/support/vcr.rb +0 -16
  246. data/spec/sync_page_spec.rb +0 -103
  247. data/spec/sync_spec.rb +0 -180
@@ -1,895 +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.20
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 the client with domain specific logic. The client later uses the Request&#39;s #url and #query methods to execute the HTTP request.</p>
106
-
107
-
108
- </div>
109
- </div>
110
- <div class="tags">
111
-
112
-
113
- </div>
114
-
115
-
116
-
117
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
- <ul class="summary">
119
-
120
- <li class="public ">
121
- <span class="summary_signature">
122
-
123
- <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
124
-
125
-
126
-
127
- </span>
128
-
129
-
130
-
131
-
132
- <span class="note title readonly">readonly</span>
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
- <span class="summary_desc"><div class='inline'>
143
- <p>Returns the value of attribute client.</p>
144
- </div></span>
145
-
146
- </li>
147
-
148
-
149
- <li class="public ">
150
- <span class="summary_signature">
151
-
152
- <a href="#endpoint-instance_method" title="#endpoint (instance method)">#<strong>endpoint</strong> &#x21d2; Object </a>
153
-
154
-
155
-
156
- </span>
157
-
158
-
159
-
160
-
161
- <span class="note title readonly">readonly</span>
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
- <span class="summary_desc"><div class='inline'>
172
- <p>Returns the value of attribute endpoint.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- <li class="public ">
179
- <span class="summary_signature">
180
-
181
- <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
182
-
183
-
184
-
185
- </span>
186
-
187
-
188
-
189
-
190
- <span class="note title readonly">readonly</span>
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
- <span class="summary_desc"><div class='inline'>
201
- <p>Returns the value of attribute id.</p>
202
- </div></span>
203
-
204
- </li>
205
-
206
-
207
- <li class="public ">
208
- <span class="summary_signature">
209
-
210
- <a href="#query-instance_method" title="#query (instance method)">#<strong>query</strong> &#x21d2; Object </a>
211
-
212
-
213
-
214
- </span>
215
-
216
-
217
-
218
-
219
- <span class="note title readonly">readonly</span>
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
- <span class="summary_desc"><div class='inline'>
230
- <p>Returns the value of attribute query.</p>
231
- </div></span>
232
-
233
- </li>
234
-
235
-
236
- <li class="public ">
237
- <span class="summary_signature">
238
-
239
- <a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; Object </a>
240
-
241
-
242
-
243
- </span>
244
-
245
-
246
-
247
-
248
- <span class="note title readonly">readonly</span>
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
- <span class="summary_desc"><div class='inline'>
259
- <p>Returns the value of attribute type.</p>
260
- </div></span>
261
-
262
- </li>
263
-
264
-
265
- </ul>
266
-
267
-
268
-
269
-
270
-
271
- <h2>
272
- Instance Method Summary
273
- <small><a href="#" class="summary_toggle">collapse</a></small>
274
- </h2>
275
-
276
- <ul class="summary">
277
-
278
- <li class="public ">
279
- <span class="summary_signature">
280
-
281
- <a href="#absolute%3F-instance_method" title="#absolute? (instance method)">#<strong>absolute?</strong> &#x21d2; Boolean </a>
282
-
283
-
284
-
285
- </span>
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
- <span class="summary_desc"><div class='inline'>
296
- <p>Returns true if endpoint is an absolute url.</p>
297
- </div></span>
298
-
299
- </li>
300
-
301
-
302
- <li class="public ">
303
- <span class="summary_signature">
304
-
305
- <a href="#copy-instance_method" title="#copy (instance method)">#<strong>copy</strong> &#x21d2; Object </a>
306
-
307
-
308
-
309
- </span>
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
- <span class="summary_desc"><div class='inline'>
320
- <p>Returns a new Request object with the same data.</p>
321
- </div></span>
322
-
323
- </li>
324
-
325
-
326
- <li class="public ">
327
- <span class="summary_signature">
328
-
329
- <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong> &#x21d2; Object </a>
330
-
331
-
332
-
333
- </span>
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
- <span class="summary_desc"><div class='inline'>
344
- <p>Delegates the actual HTTP work to the client.</p>
345
- </div></span>
346
-
347
- </li>
348
-
349
-
350
- <li class="public ">
351
- <span class="summary_signature">
352
-
353
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client, endpoint, query = {}, id = nil) &#x21d2; Request </a>
354
-
355
-
356
-
357
- </span>
358
-
359
-
360
- <span class="note title constructor">constructor</span>
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
- <span class="summary_desc"><div class='inline'>
370
- <p>A new instance of Request.</p>
371
- </div></span>
372
-
373
- </li>
374
-
375
-
376
- <li class="public ">
377
- <span class="summary_signature">
378
-
379
- <a href="#url-instance_method" title="#url (instance method)">#<strong>url</strong> &#x21d2; Object </a>
380
-
381
-
382
-
383
- </span>
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
- <span class="summary_desc"><div class='inline'>
394
- <p>Returns the final URL, relative to a contentful space.</p>
395
- </div></span>
396
-
397
- </li>
398
-
399
-
400
- </ul>
401
-
402
-
403
- <div id="constructor_details" class="method_details_list">
404
- <h2>Constructor Details</h2>
405
-
406
- <div class="method_details first">
407
- <h3 class="signature first" id="initialize-instance_method">
408
-
409
- #<strong>initialize</strong>(client, endpoint, query = {}, id = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::Request (class)">Request</a></span></tt>
410
-
411
-
412
-
413
-
414
-
415
- </h3><div class="docstring">
416
- <div class="discussion">
417
-
418
- <p>Returns a new instance of Request</p>
419
-
420
-
421
- </div>
422
- </div>
423
- <div class="tags">
424
-
425
-
426
- </div><table class="source_code">
427
- <tr>
428
- <td>
429
- <pre class="lines">
430
-
431
-
432
- 8
433
- 9
434
- 10
435
- 11
436
- 12
437
- 13
438
- 14
439
- 15
440
- 16
441
- 17
442
- 18
443
- 19
444
- 20
445
- 21
446
- 22
447
- 23
448
- 24
449
- 25
450
- 26</pre>
451
- </td>
452
- <td>
453
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 8</span>
454
-
455
- <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>
456
- <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
457
- <span class='ivar'>@endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
458
-
459
- <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>
460
-
461
- <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span>
462
- <span class='ivar'>@type</span> <span class='op'>=</span> <span class='symbol'>:single</span>
463
- <span class='comment'># Given the deprecation of `URI::escape` and `URI::encode`
464
- </span> <span class='comment'># it is needed to replace it with `URI::encode_www_form_component`.
465
- </span> <span class='comment'># This method, does replace spaces with `+` instead of `%20`.
466
- </span> <span class='comment'># Therefore, to keep backwards compatibility, we&#39;re replacing the resulting `+`
467
- </span> <span class='comment'># back with `%20`.
468
- </span> <span class='ivar'>@id</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form_component'>encode_www_form_component</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>+</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%20</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
469
- <span class='kw'>else</span>
470
- <span class='ivar'>@type</span> <span class='op'>=</span> <span class='symbol'>:multi</span>
471
- <span class='ivar'>@id</span> <span class='op'>=</span> <span class='kw'>nil</span>
472
- <span class='kw'>end</span>
473
- <span class='kw'>end</span></pre>
474
- </td>
475
- </tr>
476
- </table>
477
- </div>
478
-
479
- </div>
480
-
481
- <div id="instance_attr_details" class="attr_details">
482
- <h2>Instance Attribute Details</h2>
483
-
484
-
485
- <span id=""></span>
486
- <div class="method_details first">
487
- <h3 class="signature first" id="client-instance_method">
488
-
489
- #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
490
-
491
-
492
-
493
-
494
-
495
- </h3><div class="docstring">
496
- <div class="discussion">
497
-
498
- <p>Returns the value of attribute client</p>
499
-
500
-
501
- </div>
502
- </div>
503
- <div class="tags">
504
-
505
-
506
- </div><table class="source_code">
507
- <tr>
508
- <td>
509
- <pre class="lines">
510
-
511
-
512
- 6
513
- 7
514
- 8</pre>
515
- </td>
516
- <td>
517
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
518
-
519
- <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
520
- <span class='ivar'>@client</span>
521
- <span class='kw'>end</span></pre>
522
- </td>
523
- </tr>
524
- </table>
525
- </div>
526
-
527
-
528
- <span id=""></span>
529
- <div class="method_details ">
530
- <h3 class="signature " id="endpoint-instance_method">
531
-
532
- #<strong>endpoint</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
533
-
534
-
535
-
536
-
537
-
538
- </h3><div class="docstring">
539
- <div class="discussion">
540
-
541
- <p>Returns the value of attribute endpoint</p>
542
-
543
-
544
- </div>
545
- </div>
546
- <div class="tags">
547
-
548
-
549
- </div><table class="source_code">
550
- <tr>
551
- <td>
552
- <pre class="lines">
553
-
554
-
555
- 6
556
- 7
557
- 8</pre>
558
- </td>
559
- <td>
560
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
561
-
562
- <span class='kw'>def</span> <span class='id identifier rubyid_endpoint'>endpoint</span>
563
- <span class='ivar'>@endpoint</span>
564
- <span class='kw'>end</span></pre>
565
- </td>
566
- </tr>
567
- </table>
568
- </div>
569
-
570
-
571
- <span id=""></span>
572
- <div class="method_details ">
573
- <h3 class="signature " id="id-instance_method">
574
-
575
- #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
576
-
577
-
578
-
579
-
580
-
581
- </h3><div class="docstring">
582
- <div class="discussion">
583
-
584
- <p>Returns the value of attribute id</p>
585
-
586
-
587
- </div>
588
- </div>
589
- <div class="tags">
590
-
591
-
592
- </div><table class="source_code">
593
- <tr>
594
- <td>
595
- <pre class="lines">
596
-
597
-
598
- 6
599
- 7
600
- 8</pre>
601
- </td>
602
- <td>
603
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
604
-
605
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
606
- <span class='ivar'>@id</span>
607
- <span class='kw'>end</span></pre>
608
- </td>
609
- </tr>
610
- </table>
611
- </div>
612
-
613
-
614
- <span id=""></span>
615
- <div class="method_details ">
616
- <h3 class="signature " id="query-instance_method">
617
-
618
- #<strong>query</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
619
-
620
-
621
-
622
-
623
-
624
- </h3><div class="docstring">
625
- <div class="discussion">
626
-
627
- <p>Returns the value of attribute query</p>
628
-
629
-
630
- </div>
631
- </div>
632
- <div class="tags">
633
-
634
-
635
- </div><table class="source_code">
636
- <tr>
637
- <td>
638
- <pre class="lines">
639
-
640
-
641
- 6
642
- 7
643
- 8</pre>
644
- </td>
645
- <td>
646
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
647
-
648
- <span class='kw'>def</span> <span class='id identifier rubyid_query'>query</span>
649
- <span class='ivar'>@query</span>
650
- <span class='kw'>end</span></pre>
651
- </td>
652
- </tr>
653
- </table>
654
- </div>
655
-
656
-
657
- <span id=""></span>
658
- <div class="method_details ">
659
- <h3 class="signature " id="type-instance_method">
660
-
661
- #<strong>type</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
662
-
663
-
664
-
665
-
666
-
667
- </h3><div class="docstring">
668
- <div class="discussion">
669
-
670
- <p>Returns the value of attribute type</p>
671
-
672
-
673
- </div>
674
- </div>
675
- <div class="tags">
676
-
677
-
678
- </div><table class="source_code">
679
- <tr>
680
- <td>
681
- <pre class="lines">
682
-
683
-
684
- 6
685
- 7
686
- 8</pre>
687
- </td>
688
- <td>
689
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 6</span>
690
-
691
- <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
692
- <span class='ivar'>@type</span>
693
- <span class='kw'>end</span></pre>
694
- </td>
695
- </tr>
696
- </table>
697
- </div>
698
-
699
- </div>
700
-
701
-
702
- <div id="instance_method_details" class="method_details_list">
703
- <h2>Instance Method Details</h2>
704
-
705
-
706
- <div class="method_details first">
707
- <h3 class="signature first" id="absolute?-instance_method">
708
-
709
- #<strong>absolute?</strong> &#x21d2; <tt>Boolean</tt>
710
-
711
-
712
-
713
-
714
-
715
- </h3><div class="docstring">
716
- <div class="discussion">
717
-
718
- <p>Returns true if endpoint is an absolute url</p>
719
-
720
-
721
- </div>
722
- </div>
723
- <div class="tags">
724
-
725
- <p class="tag_title">Returns:</p>
726
- <ul class="return">
727
-
728
- <li>
729
-
730
-
731
- <span class='type'>(<tt>Boolean</tt>)</span>
732
-
733
-
734
-
735
- </li>
736
-
737
- </ul>
738
-
739
- </div><table class="source_code">
740
- <tr>
741
- <td>
742
- <pre class="lines">
743
-
744
-
745
- 39
746
- 40
747
- 41</pre>
748
- </td>
749
- <td>
750
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 39</span>
751
-
752
- <span class='kw'>def</span> <span class='id identifier rubyid_absolute?'>absolute?</span>
753
- <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>
754
- <span class='kw'>end</span></pre>
755
- </td>
756
- </tr>
757
- </table>
758
- </div>
759
-
760
- <div class="method_details ">
761
- <h3 class="signature " id="copy-instance_method">
762
-
763
- #<strong>copy</strong> &#x21d2; <tt>Object</tt>
764
-
765
-
766
-
767
-
768
-
769
- </h3><div class="docstring">
770
- <div class="discussion">
771
-
772
- <p>Returns a new Request object with the same data</p>
773
-
774
-
775
- </div>
776
- </div>
777
- <div class="tags">
778
-
779
-
780
- </div><table class="source_code">
781
- <tr>
782
- <td>
783
- <pre class="lines">
784
-
785
-
786
- 44
787
- 45
788
- 46</pre>
789
- </td>
790
- <td>
791
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 44</span>
792
-
793
- <span class='kw'>def</span> <span class='id identifier rubyid_copy'>copy</span>
794
- <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>
795
- <span class='kw'>end</span></pre>
796
- </td>
797
- </tr>
798
- </table>
799
- </div>
800
-
801
- <div class="method_details ">
802
- <h3 class="signature " id="get-instance_method">
803
-
804
- #<strong>get</strong> &#x21d2; <tt>Object</tt>
805
-
806
-
807
-
808
-
809
-
810
- </h3><div class="docstring">
811
- <div class="discussion">
812
-
813
- <p>Delegates the actual HTTP work to the client</p>
814
-
815
-
816
- </div>
817
- </div>
818
- <div class="tags">
819
-
820
-
821
- </div><table class="source_code">
822
- <tr>
823
- <td>
824
- <pre class="lines">
825
-
826
-
827
- 34
828
- 35
829
- 36</pre>
830
- </td>
831
- <td>
832
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 34</span>
833
-
834
- <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span>
835
- <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>
836
- <span class='kw'>end</span></pre>
837
- </td>
838
- </tr>
839
- </table>
840
- </div>
841
-
842
- <div class="method_details ">
843
- <h3 class="signature " id="url-instance_method">
844
-
845
- #<strong>url</strong> &#x21d2; <tt>Object</tt>
846
-
847
-
848
-
849
-
850
-
851
- </h3><div class="docstring">
852
- <div class="discussion">
853
-
854
- <p>Returns the final URL, relative to a contentful space</p>
855
-
856
-
857
- </div>
858
- </div>
859
- <div class="tags">
860
-
861
-
862
- </div><table class="source_code">
863
- <tr>
864
- <td>
865
- <pre class="lines">
866
-
867
-
868
- 29
869
- 30
870
- 31</pre>
871
- </td>
872
- <td>
873
- <pre class="code"><span class="info file"># File 'lib/contentful/request.rb', line 29</span>
874
-
875
- <span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
876
- <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>
877
- <span class='kw'>end</span></pre>
878
- </td>
879
- </tr>
880
- </table>
881
- </div>
882
-
883
- </div>
884
-
885
- </div>
886
-
887
- <div id="footer">
888
- Generated on Wed Apr 15 13:47:03 2020 by
889
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
890
- 0.9.20 (ruby-2.6.3).
891
- </div>
892
-
893
- </div>
894
- </body>
895
- </html>