prismic.io 1.4.1 → 1.4.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (107) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/Gemfile.lock +1 -1
  4. data/README.md +6 -14
  5. data/docs/Prismic.html +1074 -0
  6. data/docs/Prismic/API.html +2987 -0
  7. data/docs/Prismic/API/BadPrismicResponseError.html +147 -0
  8. data/docs/Prismic/API/OAuth.html +560 -0
  9. data/docs/Prismic/API/PrismicWSAuthError.html +375 -0
  10. data/docs/Prismic/API/PrismicWSConnectionError.html +221 -0
  11. data/docs/Prismic/BasicNullCache.html +255 -0
  12. data/docs/Prismic/DefaultHTTPClient.html +350 -0
  13. data/docs/Prismic/Document.html +873 -0
  14. data/docs/Prismic/Error.html +418 -0
  15. data/docs/Prismic/Experiment.html +633 -0
  16. data/docs/Prismic/Experiments.html +633 -0
  17. data/docs/Prismic/Field.html +424 -0
  18. data/docs/Prismic/Form.html +827 -0
  19. data/docs/Prismic/Fragments.html +117 -0
  20. data/docs/Prismic/Fragments/Color.html +632 -0
  21. data/docs/Prismic/Fragments/Date.html +399 -0
  22. data/docs/Prismic/Fragments/DocumentLink.html +1048 -0
  23. data/docs/Prismic/Fragments/Embed.html +679 -0
  24. data/docs/Prismic/Fragments/FileLink.html +604 -0
  25. data/docs/Prismic/Fragments/Fragment.html +339 -0
  26. data/docs/Prismic/Fragments/GeoPoint.html +469 -0
  27. data/docs/Prismic/Fragments/Group.html +710 -0
  28. data/docs/Prismic/Fragments/GroupDocument.html +382 -0
  29. data/docs/Prismic/Fragments/Image.html +780 -0
  30. data/docs/Prismic/Fragments/Image/View.html +759 -0
  31. data/docs/Prismic/Fragments/Image/ViewDoesNotExistException.html +147 -0
  32. data/docs/Prismic/Fragments/ImageLink.html +336 -0
  33. data/docs/Prismic/Fragments/Link.html +412 -0
  34. data/docs/Prismic/Fragments/Multiple.html +513 -0
  35. data/docs/Prismic/Fragments/Number.html +401 -0
  36. data/docs/Prismic/Fragments/Select.html +349 -0
  37. data/docs/Prismic/Fragments/Separator.html +396 -0
  38. data/docs/Prismic/Fragments/Slice.html +632 -0
  39. data/docs/Prismic/Fragments/SliceZone.html +474 -0
  40. data/docs/Prismic/Fragments/StructuredText.html +664 -0
  41. data/docs/Prismic/Fragments/StructuredText/Block.html +232 -0
  42. data/docs/Prismic/Fragments/StructuredText/Block/Embed.html +367 -0
  43. data/docs/Prismic/Fragments/StructuredText/Block/Heading.html +366 -0
  44. data/docs/Prismic/Fragments/StructuredText/Block/Image.html +755 -0
  45. data/docs/Prismic/Fragments/StructuredText/Block/ListItem.html +372 -0
  46. data/docs/Prismic/Fragments/StructuredText/Block/Paragraph.html +223 -0
  47. data/docs/Prismic/Fragments/StructuredText/Block/Preformatted.html +223 -0
  48. data/docs/Prismic/Fragments/StructuredText/Block/Text.html +818 -0
  49. data/docs/Prismic/Fragments/StructuredText/BlockGroup.html +423 -0
  50. data/docs/Prismic/Fragments/StructuredText/Span.html +384 -0
  51. data/docs/Prismic/Fragments/StructuredText/Span/Em.html +213 -0
  52. data/docs/Prismic/Fragments/StructuredText/Span/Hyperlink.html +359 -0
  53. data/docs/Prismic/Fragments/StructuredText/Span/Label.html +362 -0
  54. data/docs/Prismic/Fragments/StructuredText/Span/Strong.html +213 -0
  55. data/docs/Prismic/Fragments/Text.html +396 -0
  56. data/docs/Prismic/Fragments/Timestamp.html +399 -0
  57. data/docs/Prismic/Fragments/WebLink.html +340 -0
  58. data/docs/Prismic/HtmlSerializer.html +270 -0
  59. data/docs/Prismic/JsonParser.html +1764 -0
  60. data/docs/Prismic/LinkResolver.html +399 -0
  61. data/docs/Prismic/LruCache.html +1140 -0
  62. data/docs/Prismic/Predicates.html +1630 -0
  63. data/docs/Prismic/Ref.html +643 -0
  64. data/docs/Prismic/Response.html +1159 -0
  65. data/docs/Prismic/SearchForm.html +2172 -0
  66. data/docs/Prismic/SearchForm/AuthenticationException.html +147 -0
  67. data/docs/Prismic/SearchForm/AuthorizationException.html +147 -0
  68. data/docs/Prismic/SearchForm/FormSearchException.html +147 -0
  69. data/docs/Prismic/SearchForm/NoRefSetException.html +147 -0
  70. data/docs/Prismic/SearchForm/RefNotFoundException.html +147 -0
  71. data/docs/Prismic/SearchForm/UnsupportedFormKind.html +147 -0
  72. data/docs/Prismic/Variation.html +546 -0
  73. data/docs/Prismic/WithFragments.html +1803 -0
  74. data/docs/_index.html +752 -0
  75. data/docs/class_list.html +54 -0
  76. data/docs/css/common.css +1 -0
  77. data/docs/css/full_list.css +57 -0
  78. data/docs/css/style.css +339 -0
  79. data/docs/file.README.html +180 -0
  80. data/docs/file_list.html +56 -0
  81. data/docs/frames.html +26 -0
  82. data/docs/index.html +180 -0
  83. data/docs/js/app.js +219 -0
  84. data/docs/js/full_list.js +178 -0
  85. data/docs/js/jquery.js +4 -0
  86. data/docs/method_list.html +2381 -0
  87. data/docs/top-level-namespace.html +112 -0
  88. data/lib/prismic.rb +17 -1
  89. data/lib/prismic/api.rb +31 -19
  90. data/lib/prismic/fragments/image.rb +6 -0
  91. data/lib/prismic/json_parsers.rb +2 -0
  92. data/lib/prismic/version.rb +1 -1
  93. data/spec/cache_spec.rb +12 -12
  94. data/spec/json_parsers_spec.rb +10 -5
  95. data/spec/oauth_spec.rb +3 -3
  96. data/spec/prismic_spec.rb +7 -7
  97. data/spec/responses_mocks/api.json +12 -12
  98. data/spec/responses_mocks/document.json +4 -2
  99. data/spec/responses_mocks/document_with_unknown_fragment.json +2 -0
  100. data/spec/responses_mocks/fragments.json +5 -3
  101. data/spec/responses_mocks/slices.json +2 -0
  102. data/spec/responses_mocks/structured_text_with_labels.json +2 -2
  103. data/spec/simple_search_spec.rb +55 -0
  104. metadata +103 -24
  105. data/deploy-doc.sh +0 -9
  106. data/spec/doc_spec.rb +0 -298
  107. data/spec/lesbonneschoses_spec.rb +0 -228
@@ -0,0 +1,873 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Prismic::Document
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!Prismic/Document.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (D)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Prismic.html" title="Prismic (module)">Prismic</a></span></span>
36
+ &raquo;
37
+ <span class="title">Document</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Prismic::Document
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Prismic::Document</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2">Includes:</dt>
94
+ <dd class="r2"><span class='object_link'><a href="WithFragments.html" title="Prismic::WithFragments (module)">WithFragments</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/prismic.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+
107
+
108
+
109
+
110
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
111
+ <ul class="summary">
112
+
113
+ <li class="public ">
114
+ <span class="summary_signature">
115
+
116
+ <a href="#fragments-instance_method" title="#fragments (instance method)">- (Array&lt;Fragment&gt;) <strong>fragments</strong> </a>
117
+
118
+
119
+
120
+ </span>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+ <span class="summary_desc"><div class='inline'></div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#href-instance_method" title="#href (instance method)">- (String) <strong>href</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'></div></span>
159
+
160
+ </li>
161
+
162
+
163
+ <li class="public ">
164
+ <span class="summary_signature">
165
+
166
+ <a href="#id-instance_method" title="#id (instance method)">- (String) <strong>id</strong> </a>
167
+
168
+
169
+
170
+ </span>
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'></div></span>
184
+
185
+ </li>
186
+
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#slugs-instance_method" title="#slugs (instance method)">- (Array&lt;String&gt;) <strong>slugs</strong> </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+ <span class="summary_desc"><div class='inline'></div></span>
209
+
210
+ </li>
211
+
212
+
213
+ <li class="public ">
214
+ <span class="summary_signature">
215
+
216
+ <a href="#tags-instance_method" title="#tags (instance method)">- (Array&lt;String&gt;) <strong>tags</strong> </a>
217
+
218
+
219
+
220
+ </span>
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'></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)">- (String) <strong>type</strong> </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'></div></span>
259
+
260
+ </li>
261
+
262
+
263
+ <li class="public ">
264
+ <span class="summary_signature">
265
+
266
+ <a href="#uid-instance_method" title="#uid (instance method)">- (String) <strong>uid</strong> </a>
267
+
268
+
269
+
270
+ </span>
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+ <span class="summary_desc"><div class='inline'></div></span>
284
+
285
+ </li>
286
+
287
+
288
+ </ul>
289
+
290
+
291
+
292
+
293
+
294
+ <h2>
295
+ Instance Method Summary
296
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
297
+ </h2>
298
+
299
+ <ul class="summary">
300
+
301
+ <li class="public ">
302
+ <span class="summary_signature">
303
+
304
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Document) <strong>initialize</strong>(id, uid, type, href, tags, slugs, fragments) </a>
305
+
306
+
307
+
308
+ </span>
309
+
310
+
311
+ <span class="note title constructor">constructor</span>
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+ <span class="summary_desc"><div class='inline'><p>A new instance of Document.</p>
321
+ </div></span>
322
+
323
+ </li>
324
+
325
+
326
+ <li class="public ">
327
+ <span class="summary_signature">
328
+
329
+ <a href="#slug-instance_method" title="#slug (instance method)">- (String) <strong>slug</strong> </a>
330
+
331
+
332
+
333
+ </span>
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+ <span class="summary_desc"><div class='inline'><p>Returns the document&#39;s slug.</p>
344
+ </div></span>
345
+
346
+ </li>
347
+
348
+
349
+ </ul>
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="WithFragments.html" title="Prismic::WithFragments (module)">WithFragments</a></span></h3>
362
+ <p class="inherited"><span class='object_link'><a href="WithFragments.html#%5B%5D-instance_method" title="Prismic::WithFragments#[] (method)">#[]</a></span>, <span class='object_link'><a href="WithFragments.html#as_html-instance_method" title="Prismic::WithFragments#as_html (method)">#as_html</a></span>, <span class='object_link'><a href="WithFragments.html#as_text-instance_method" title="Prismic::WithFragments#as_text (method)">#as_text</a></span>, <span class='object_link'><a href="WithFragments.html#each-instance_method" title="Prismic::WithFragments#each (method)">#each</a></span>, <span class='object_link'><a href="WithFragments.html#first_title-instance_method" title="Prismic::WithFragments#first_title (method)">#first_title</a></span>, <span class='object_link'><a href="WithFragments.html#get_color-instance_method" title="Prismic::WithFragments#get_color (method)">#get_color</a></span>, <span class='object_link'><a href="WithFragments.html#get_date-instance_method" title="Prismic::WithFragments#get_date (method)">#get_date</a></span>, <span class='object_link'><a href="WithFragments.html#get_embed-instance_method" title="Prismic::WithFragments#get_embed (method)">#get_embed</a></span>, <span class='object_link'><a href="WithFragments.html#get_geopoint-instance_method" title="Prismic::WithFragments#get_geopoint (method)">#get_geopoint</a></span>, <span class='object_link'><a href="WithFragments.html#get_group-instance_method" title="Prismic::WithFragments#get_group (method)">#get_group</a></span>, <span class='object_link'><a href="WithFragments.html#get_image-instance_method" title="Prismic::WithFragments#get_image (method)">#get_image</a></span>, <span class='object_link'><a href="WithFragments.html#get_link-instance_method" title="Prismic::WithFragments#get_link (method)">#get_link</a></span>, <span class='object_link'><a href="WithFragments.html#get_number-instance_method" title="Prismic::WithFragments#get_number (method)">#get_number</a></span>, <span class='object_link'><a href="WithFragments.html#get_slice_zone-instance_method" title="Prismic::WithFragments#get_slice_zone (method)">#get_slice_zone</a></span>, <span class='object_link'><a href="WithFragments.html#get_structured_text-instance_method" title="Prismic::WithFragments#get_structured_text (method)">#get_structured_text</a></span>, <span class='object_link'><a href="WithFragments.html#get_text-instance_method" title="Prismic::WithFragments#get_text (method)">#get_text</a></span>, <span class='object_link'><a href="WithFragments.html#get_timestamp-instance_method" title="Prismic::WithFragments#get_timestamp (method)">#get_timestamp</a></span>, <span class='object_link'><a href="WithFragments.html#length-instance_method" title="Prismic::WithFragments#length (method)">#length</a></span>, <span class='object_link'><a href="WithFragments.html#linked_documents-instance_method" title="Prismic::WithFragments#linked_documents (method)">#linked_documents</a></span></p>
363
+
364
+ <div id="constructor_details" class="method_details_list">
365
+ <h2>Constructor Details</h2>
366
+
367
+ <div class="method_details first">
368
+ <h3 class="signature first" id="initialize-instance_method">
369
+
370
+ - (<tt><span class='object_link'><a href="" title="Prismic::Document (class)">Document</a></span></tt>) <strong>initialize</strong>(id, uid, type, href, tags, slugs, fragments)
371
+
372
+
373
+
374
+
375
+
376
+ </h3><div class="docstring">
377
+ <div class="discussion">
378
+ <p>Returns a new instance of Document</p>
379
+
380
+
381
+ </div>
382
+ </div>
383
+ <div class="tags">
384
+
385
+
386
+ </div><table class="source_code">
387
+ <tr>
388
+ <td>
389
+ <pre class="lines">
390
+
391
+
392
+ 456
393
+ 457
394
+ 458
395
+ 459
396
+ 460
397
+ 461
398
+ 462
399
+ 463
400
+ 464</pre>
401
+ </td>
402
+ <td>
403
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 456</span>
404
+
405
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_uid'>uid</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_href'>href</span><span class='comma'>,</span> <span class='id identifier rubyid_tags'>tags</span><span class='comma'>,</span> <span class='id identifier rubyid_slugs'>slugs</span><span class='comma'>,</span> <span class='id identifier rubyid_fragments'>fragments</span><span class='rparen'>)</span>
406
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
407
+ <span class='ivar'>@uid</span> <span class='op'>=</span> <span class='id identifier rubyid_uid'>uid</span>
408
+ <span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
409
+ <span class='ivar'>@href</span> <span class='op'>=</span> <span class='id identifier rubyid_href'>href</span>
410
+ <span class='ivar'>@tags</span> <span class='op'>=</span> <span class='id identifier rubyid_tags'>tags</span>
411
+ <span class='ivar'>@slugs</span> <span class='op'>=</span> <span class='id identifier rubyid_slugs'>slugs</span>
412
+ <span class='ivar'>@fragments</span> <span class='op'>=</span> <span class='id identifier rubyid_fragments'>fragments</span>
413
+ <span class='kw'>end</span></pre>
414
+ </td>
415
+ </tr>
416
+ </table>
417
+ </div>
418
+
419
+ </div>
420
+
421
+ <div id="instance_attr_details" class="attr_details">
422
+ <h2>Instance Attribute Details</h2>
423
+
424
+
425
+ <span id="fragments=-instance_method"></span>
426
+ <div class="method_details first">
427
+ <h3 class="signature first" id="fragments-instance_method">
428
+
429
+ - (<tt>Array&lt;Fragment&gt;</tt>) <strong>fragments</strong>
430
+
431
+
432
+
433
+
434
+
435
+ </h3><div class="docstring">
436
+ <div class="discussion">
437
+
438
+
439
+ </div>
440
+ </div>
441
+ <div class="tags">
442
+
443
+ <p class="tag_title">Returns:</p>
444
+ <ul class="return">
445
+
446
+ <li>
447
+
448
+
449
+ <span class='type'>(<tt>Array&lt;Fragment&gt;</tt>)</span>
450
+
451
+
452
+
453
+ </li>
454
+
455
+ </ul>
456
+
457
+ </div><table class="source_code">
458
+ <tr>
459
+ <td>
460
+ <pre class="lines">
461
+
462
+
463
+ 454
464
+ 455
465
+ 456</pre>
466
+ </td>
467
+ <td>
468
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 454</span>
469
+
470
+ <span class='kw'>def</span> <span class='id identifier rubyid_fragments'>fragments</span>
471
+ <span class='ivar'>@fragments</span>
472
+ <span class='kw'>end</span></pre>
473
+ </td>
474
+ </tr>
475
+ </table>
476
+ </div>
477
+
478
+
479
+ <span id="href=-instance_method"></span>
480
+ <div class="method_details ">
481
+ <h3 class="signature " id="href-instance_method">
482
+
483
+ - (<tt>String</tt>) <strong>href</strong>
484
+
485
+
486
+
487
+
488
+
489
+ </h3><div class="docstring">
490
+ <div class="discussion">
491
+
492
+
493
+ </div>
494
+ </div>
495
+ <div class="tags">
496
+
497
+ <p class="tag_title">Returns:</p>
498
+ <ul class="return">
499
+
500
+ <li>
501
+
502
+
503
+ <span class='type'>(<tt>String</tt>)</span>
504
+
505
+
506
+
507
+ </li>
508
+
509
+ </ul>
510
+
511
+ </div><table class="source_code">
512
+ <tr>
513
+ <td>
514
+ <pre class="lines">
515
+
516
+
517
+ 448
518
+ 449
519
+ 450</pre>
520
+ </td>
521
+ <td>
522
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 448</span>
523
+
524
+ <span class='kw'>def</span> <span class='id identifier rubyid_href'>href</span>
525
+ <span class='ivar'>@href</span>
526
+ <span class='kw'>end</span></pre>
527
+ </td>
528
+ </tr>
529
+ </table>
530
+ </div>
531
+
532
+
533
+ <span id="id=-instance_method"></span>
534
+ <div class="method_details ">
535
+ <h3 class="signature " id="id-instance_method">
536
+
537
+ - (<tt>String</tt>) <strong>id</strong>
538
+
539
+
540
+
541
+
542
+
543
+ </h3><div class="docstring">
544
+ <div class="discussion">
545
+
546
+
547
+ </div>
548
+ </div>
549
+ <div class="tags">
550
+
551
+ <p class="tag_title">Returns:</p>
552
+ <ul class="return">
553
+
554
+ <li>
555
+
556
+
557
+ <span class='type'>(<tt>String</tt>)</span>
558
+
559
+
560
+
561
+ </li>
562
+
563
+ </ul>
564
+
565
+ </div><table class="source_code">
566
+ <tr>
567
+ <td>
568
+ <pre class="lines">
569
+
570
+
571
+ 442
572
+ 443
573
+ 444</pre>
574
+ </td>
575
+ <td>
576
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 442</span>
577
+
578
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
579
+ <span class='ivar'>@id</span>
580
+ <span class='kw'>end</span></pre>
581
+ </td>
582
+ </tr>
583
+ </table>
584
+ </div>
585
+
586
+
587
+ <span id="slugs=-instance_method"></span>
588
+ <div class="method_details ">
589
+ <h3 class="signature " id="slugs-instance_method">
590
+
591
+ - (<tt>Array&lt;String&gt;</tt>) <strong>slugs</strong>
592
+
593
+
594
+
595
+
596
+
597
+ </h3><div class="docstring">
598
+ <div class="discussion">
599
+
600
+
601
+ </div>
602
+ </div>
603
+ <div class="tags">
604
+
605
+ <p class="tag_title">Returns:</p>
606
+ <ul class="return">
607
+
608
+ <li>
609
+
610
+
611
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
612
+
613
+
614
+
615
+ </li>
616
+
617
+ </ul>
618
+
619
+ </div><table class="source_code">
620
+ <tr>
621
+ <td>
622
+ <pre class="lines">
623
+
624
+
625
+ 452
626
+ 453
627
+ 454</pre>
628
+ </td>
629
+ <td>
630
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 452</span>
631
+
632
+ <span class='kw'>def</span> <span class='id identifier rubyid_slugs'>slugs</span>
633
+ <span class='ivar'>@slugs</span>
634
+ <span class='kw'>end</span></pre>
635
+ </td>
636
+ </tr>
637
+ </table>
638
+ </div>
639
+
640
+
641
+ <span id="tags=-instance_method"></span>
642
+ <div class="method_details ">
643
+ <h3 class="signature " id="tags-instance_method">
644
+
645
+ - (<tt>Array&lt;String&gt;</tt>) <strong>tags</strong>
646
+
647
+
648
+
649
+
650
+
651
+ </h3><div class="docstring">
652
+ <div class="discussion">
653
+
654
+
655
+ </div>
656
+ </div>
657
+ <div class="tags">
658
+
659
+ <p class="tag_title">Returns:</p>
660
+ <ul class="return">
661
+
662
+ <li>
663
+
664
+
665
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
666
+
667
+
668
+
669
+ </li>
670
+
671
+ </ul>
672
+
673
+ </div><table class="source_code">
674
+ <tr>
675
+ <td>
676
+ <pre class="lines">
677
+
678
+
679
+ 450
680
+ 451
681
+ 452</pre>
682
+ </td>
683
+ <td>
684
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 450</span>
685
+
686
+ <span class='kw'>def</span> <span class='id identifier rubyid_tags'>tags</span>
687
+ <span class='ivar'>@tags</span>
688
+ <span class='kw'>end</span></pre>
689
+ </td>
690
+ </tr>
691
+ </table>
692
+ </div>
693
+
694
+
695
+ <span id="type=-instance_method"></span>
696
+ <div class="method_details ">
697
+ <h3 class="signature " id="type-instance_method">
698
+
699
+ - (<tt>String</tt>) <strong>type</strong>
700
+
701
+
702
+
703
+
704
+
705
+ </h3><div class="docstring">
706
+ <div class="discussion">
707
+
708
+
709
+ </div>
710
+ </div>
711
+ <div class="tags">
712
+
713
+ <p class="tag_title">Returns:</p>
714
+ <ul class="return">
715
+
716
+ <li>
717
+
718
+
719
+ <span class='type'>(<tt>String</tt>)</span>
720
+
721
+
722
+
723
+ </li>
724
+
725
+ </ul>
726
+
727
+ </div><table class="source_code">
728
+ <tr>
729
+ <td>
730
+ <pre class="lines">
731
+
732
+
733
+ 446
734
+ 447
735
+ 448</pre>
736
+ </td>
737
+ <td>
738
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 446</span>
739
+
740
+ <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
741
+ <span class='ivar'>@type</span>
742
+ <span class='kw'>end</span></pre>
743
+ </td>
744
+ </tr>
745
+ </table>
746
+ </div>
747
+
748
+
749
+ <span id="uid=-instance_method"></span>
750
+ <div class="method_details ">
751
+ <h3 class="signature " id="uid-instance_method">
752
+
753
+ - (<tt>String</tt>) <strong>uid</strong>
754
+
755
+
756
+
757
+
758
+
759
+ </h3><div class="docstring">
760
+ <div class="discussion">
761
+
762
+
763
+ </div>
764
+ </div>
765
+ <div class="tags">
766
+
767
+ <p class="tag_title">Returns:</p>
768
+ <ul class="return">
769
+
770
+ <li>
771
+
772
+
773
+ <span class='type'>(<tt>String</tt>)</span>
774
+
775
+
776
+
777
+ </li>
778
+
779
+ </ul>
780
+
781
+ </div><table class="source_code">
782
+ <tr>
783
+ <td>
784
+ <pre class="lines">
785
+
786
+
787
+ 444
788
+ 445
789
+ 446</pre>
790
+ </td>
791
+ <td>
792
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 444</span>
793
+
794
+ <span class='kw'>def</span> <span class='id identifier rubyid_uid'>uid</span>
795
+ <span class='ivar'>@uid</span>
796
+ <span class='kw'>end</span></pre>
797
+ </td>
798
+ </tr>
799
+ </table>
800
+ </div>
801
+
802
+ </div>
803
+
804
+
805
+ <div id="instance_method_details" class="method_details_list">
806
+ <h2>Instance Method Details</h2>
807
+
808
+
809
+ <div class="method_details first">
810
+ <h3 class="signature first" id="slug-instance_method">
811
+
812
+ - (<tt>String</tt>) <strong>slug</strong>
813
+
814
+
815
+
816
+
817
+
818
+ </h3><div class="docstring">
819
+ <div class="discussion">
820
+ <p>Returns the document&#39;s slug</p>
821
+
822
+
823
+ </div>
824
+ </div>
825
+ <div class="tags">
826
+
827
+ <p class="tag_title">Returns:</p>
828
+ <ul class="return">
829
+
830
+ <li>
831
+
832
+
833
+ <span class='type'>(<tt>String</tt>)</span>
834
+
835
+
836
+
837
+ </li>
838
+
839
+ </ul>
840
+
841
+ </div><table class="source_code">
842
+ <tr>
843
+ <td>
844
+ <pre class="lines">
845
+
846
+
847
+ 469
848
+ 470
849
+ 471</pre>
850
+ </td>
851
+ <td>
852
+ <pre class="code"><span class="info file"># File 'lib/prismic.rb', line 469</span>
853
+
854
+ <span class='kw'>def</span> <span class='id identifier rubyid_slug'>slug</span>
855
+ <span class='id identifier rubyid_slugs'>slugs</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_slugs'>slugs</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
856
+ <span class='kw'>end</span></pre>
857
+ </td>
858
+ </tr>
859
+ </table>
860
+ </div>
861
+
862
+ </div>
863
+
864
+ </div>
865
+
866
+ <div id="footer">
867
+ Generated on Tue Sep 27 10:47:06 2016 by
868
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
869
+ 0.8.7.4 (ruby-2.0.0).
870
+ </div>
871
+
872
+ </body>
873
+ </html>