opentok 0.1.3 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +16 -2
  3. data/.travis.yml +6 -0
  4. data/.yardopts +1 -0
  5. data/CONTRIBUTING.md +47 -0
  6. data/DEVELOPING.md +91 -0
  7. data/LICENSE +19 -5
  8. data/README.md +170 -53
  9. data/Rakefile +10 -5
  10. data/doc/OpenTok.html +411 -0
  11. data/doc/OpenTok/Archive.html +1320 -0
  12. data/doc/OpenTok/ArchiveList.html +216 -0
  13. data/doc/OpenTok/Archives.html +1028 -0
  14. data/doc/OpenTok/Client.html +695 -0
  15. data/doc/OpenTok/OpenTok.html +1046 -0
  16. data/doc/OpenTok/OpenTokArchiveError.html +142 -0
  17. data/doc/OpenTok/OpenTokAuthenticationError.html +143 -0
  18. data/doc/OpenTok/OpenTokError.html +138 -0
  19. data/doc/OpenTok/Session.html +665 -0
  20. data/doc/OpenTok/TokenGenerator.html +204 -0
  21. data/doc/OpenTok/TokenGenerator/ClassMethods.html +187 -0
  22. data/doc/README.md +15 -0
  23. data/doc/_index.html +182 -0
  24. data/doc/class_list.html +54 -0
  25. data/doc/css/common.css +1 -0
  26. data/doc/css/full_list.css +57 -0
  27. data/doc/css/style.css +339 -0
  28. data/doc/file.README.html +87 -0
  29. data/doc/file_list.html +56 -0
  30. data/doc/frames.html +26 -0
  31. data/doc/index.html +87 -0
  32. data/doc/js/app.js +219 -0
  33. data/doc/js/full_list.js +178 -0
  34. data/doc/js/jquery.js +4 -0
  35. data/doc/method_list.html +227 -0
  36. data/doc/top-level-namespace.html +112 -0
  37. data/lib/opentok.rb +3 -14
  38. data/lib/opentok/archive.rb +92 -0
  39. data/lib/opentok/archive_list.rb +17 -0
  40. data/lib/opentok/archives.rb +120 -0
  41. data/lib/opentok/client.rb +125 -0
  42. data/lib/opentok/constants.rb +5 -0
  43. data/lib/opentok/exceptions.rb +10 -0
  44. data/lib/opentok/opentok.rb +174 -0
  45. data/lib/opentok/session.rb +76 -0
  46. data/lib/opentok/token_generator.rb +101 -0
  47. data/lib/opentok/version.rb +4 -0
  48. data/opentok.gemspec +29 -22
  49. data/sample/Archiving/Gemfile +4 -0
  50. data/sample/Archiving/README.md +212 -0
  51. data/sample/Archiving/archiving_sample.rb +80 -0
  52. data/sample/Archiving/public/css/sample.css +22 -0
  53. data/sample/Archiving/public/img/archiving-off.png +0 -0
  54. data/sample/Archiving/public/img/archiving-on-idle.png +0 -0
  55. data/sample/Archiving/public/img/archiving-on-message.png +0 -0
  56. data/sample/Archiving/public/js/host.js +37 -0
  57. data/sample/Archiving/public/js/participant.js +13 -0
  58. data/sample/Archiving/views/history.erb +65 -0
  59. data/sample/Archiving/views/host.erb +69 -0
  60. data/sample/Archiving/views/index.erb +48 -0
  61. data/sample/Archiving/views/layout.erb +29 -0
  62. data/sample/Archiving/views/participant.erb +55 -0
  63. data/sample/HelloWorld/Gemfile +4 -0
  64. data/sample/HelloWorld/README.md +123 -0
  65. data/sample/HelloWorld/hello_world.rb +27 -0
  66. data/sample/HelloWorld/public/js/helloworld.js +32 -0
  67. data/sample/HelloWorld/views/index.erb +21 -0
  68. data/spec/cassettes/OpenTok_Archives/should_create_archives.yml +48 -0
  69. data/spec/cassettes/OpenTok_Archives/should_create_named_archives.yml +49 -0
  70. data/spec/cassettes/OpenTok_Archives/should_delete_an_archive_by_id.yml +32 -0
  71. data/spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml +46 -0
  72. data/spec/cassettes/OpenTok_Archives/should_stop_archives.yml +48 -0
  73. data/spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_all_archives.yml +104 -0
  74. data/spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_archives_with_an_offset.yml +71 -0
  75. data/spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_count_number_of_archives.yml +60 -0
  76. data/spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_part_of_the_archives_when_using_offset_and_count.yml +82 -0
  77. data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_default_sessions.yml +39 -0
  78. data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions.yml +39 -0
  79. data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_with_a_location_hint.yml +39 -0
  80. data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions.yml +39 -0
  81. data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions_for_invalid_media_modes.yml +39 -0
  82. data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions_with_a_location_hint.yml +39 -0
  83. data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_sessions_with_a_location_hint.yml +39 -0
  84. data/spec/matchers/token.rb +48 -0
  85. data/spec/opentok/archives_spec.rb +91 -0
  86. data/spec/opentok/opentok_spec.rb +144 -0
  87. data/spec/opentok/session_spec.rb +71 -0
  88. data/spec/shared/opentok_generates_tokens.rb +62 -0
  89. data/spec/shared/session_generates_tokens.rb +63 -0
  90. data/spec/spec_helper.rb +6 -7
  91. metadata +197 -59
  92. data/.rspec +0 -3
  93. data/CHANGES +0 -33
  94. data/doc/reference.md +0 -122
  95. data/lib/open_tok/archive.rb +0 -53
  96. data/lib/open_tok/archive_timeline_event.rb +0 -22
  97. data/lib/open_tok/archive_video_resource.rb +0 -28
  98. data/lib/open_tok/exception.rb +0 -50
  99. data/lib/open_tok/open_tok_sdk.rb +0 -198
  100. data/lib/open_tok/request.rb +0 -63
  101. data/lib/open_tok/role_constants.rb +0 -18
  102. data/lib/open_tok/session.rb +0 -25
  103. data/lib/open_tok/session_property_constants.rb +0 -30
  104. data/lib/open_tok/utils.rb +0 -10
  105. data/lib/open_tok/version.rb +0 -5
  106. data/sample/sample.rb +0 -26
  107. data/spec/cassettes/archives.yml +0 -83
  108. data/spec/cassettes/deleteArchive.yml +0 -91
  109. data/spec/cassettes/invalidSession.yml +0 -41
  110. data/spec/cassettes/session.yml +0 -46
  111. data/spec/cassettes/stitchArchive.yml +0 -42
  112. data/spec/opentok_exception_spec.rb +0 -38
  113. data/spec/opentok_spec.rb +0 -135
data/doc/OpenTok/Client.html ADDED
@@ -0,0 +1,695 @@
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: OpenTok::Client
8
+
9
+ &mdash; Documentation by YARD 0.8.7.3
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#!" + escape(window.location.href);
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 (C)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../OpenTok.html" title="OpenTok (module)">OpenTok</a></span></span>
36
+ &raquo;
37
+ <span class="title">Client</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: OpenTok::Client
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">OpenTok::Client</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">HTTParty</dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/opentok/client.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+ <h2>
115
+ Instance Method Summary
116
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
117
+ </h2>
118
+
119
+ <ul class="summary">
120
+
121
+ <li class="public ">
122
+ <span class="summary_signature">
123
+
124
+ <a href="#create_session-instance_method" title="#create_session (instance method)">- (Object) <strong>create_session</strong>(opts) </a>
125
+
126
+
127
+
128
+ </span>
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <span class="summary_desc"><div class='inline'></div></span>
139
+
140
+ </li>
141
+
142
+
143
+ <li class="public ">
144
+ <span class="summary_signature">
145
+
146
+ <a href="#delete_archive-instance_method" title="#delete_archive (instance method)">- (Object) <strong>delete_archive</strong>(archive_id) </a>
147
+
148
+
149
+
150
+ </span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'></div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#get_archive-instance_method" title="#get_archive (instance method)">- (Object) <strong>get_archive</strong>(archive_id) </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'></div></span>
183
+
184
+ </li>
185
+
186
+
187
+ <li class="public ">
188
+ <span class="summary_signature">
189
+
190
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Client) <strong>initialize</strong>(api_key, api_secret, api_url) </a>
191
+
192
+
193
+
194
+ </span>
195
+
196
+
197
+ <span class="note title constructor">constructor</span>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'>
207
+ <p>TODO: expose a setting for http debugging for developers debug_output
208
+ $stdout.</p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#list_archives-instance_method" title="#list_archives (instance method)">- (Object) <strong>list_archives</strong>(offset, count) </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'></div></span>
232
+
233
+ </li>
234
+
235
+
236
+ <li class="public ">
237
+ <span class="summary_signature">
238
+
239
+ <a href="#start_archive-instance_method" title="#start_archive (instance method)">- (Object) <strong>start_archive</strong>(session_id, opts) </a>
240
+
241
+
242
+
243
+ </span>
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+ <span class="summary_desc"><div class='inline'></div></span>
254
+
255
+ </li>
256
+
257
+
258
+ <li class="public ">
259
+ <span class="summary_signature">
260
+
261
+ <a href="#stop_archive-instance_method" title="#stop_archive (instance method)">- (Object) <strong>stop_archive</strong>(archive_id) </a>
262
+
263
+
264
+
265
+ </span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <span class="summary_desc"><div class='inline'></div></span>
276
+
277
+ </li>
278
+
279
+
280
+ </ul>
281
+
282
+
283
+
284
+ <div id="constructor_details" class="method_details_list">
285
+ <h2>Constructor Details</h2>
286
+
287
+ <div class="method_details first">
288
+ <h3 class="signature first" id="initialize-instance_method">
289
+
290
+ - (<tt><span class='object_link'><a href="" title="OpenTok::Client (class)">Client</a></span></tt>) <strong>initialize</strong>(api_key, api_secret, api_url)
291
+
292
+
293
+
294
+
295
+
296
+ </h3><div class="docstring">
297
+ <div class="discussion">
298
+
299
+ <p>TODO: expose a setting for http debugging for developers debug_output
300
+ $stdout</p>
301
+
302
+
303
+ </div>
304
+ </div>
305
+ <div class="tags">
306
+
307
+
308
+ </div><table class="source_code">
309
+ <tr>
310
+ <td>
311
+ <pre class="lines">
312
+
313
+
314
+ 11
315
+ 12
316
+ 13
317
+ 14
318
+ 15
319
+ 16
320
+ 17
321
+ 18</pre>
322
+ </td>
323
+ <td>
324
+ <pre class="code"><span class="info file"># File 'lib/opentok/client.rb', line 11</span>
325
+
326
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_api_secret'>api_secret</span><span class='comma'>,</span> <span class='id identifier rubyid_api_url'>api_url</span><span class='rparen'>)</span>
327
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_uri'>base_uri</span> <span class='id identifier rubyid_api_url'>api_url</span>
328
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lparen'>(</span><span class='lbrace'>{</span>
329
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>X-TB-PARTNER-AUTH</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_api_secret'>api_secret</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
330
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>OpenTok-Ruby-SDK/</span><span class='embexpr_beg'>#{</span><span class='const'>VERSION</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
331
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
332
+ <span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
333
+ <span class='kw'>end</span></pre>
334
+ </td>
335
+ </tr>
336
+ </table>
337
+ </div>
338
+
339
+ </div>
340
+
341
+
342
+ <div id="instance_method_details" class="method_details_list">
343
+ <h2>Instance Method Details</h2>
344
+
345
+
346
+ <div class="method_details first">
347
+ <h3 class="signature first" id="create_session-instance_method">
348
+
349
+ - (<tt>Object</tt>) <strong>create_session</strong>(opts)
350
+
351
+
352
+
353
+
354
+
355
+ </h3><table class="source_code">
356
+ <tr>
357
+ <td>
358
+ <pre class="lines">
359
+
360
+
361
+ 20
362
+ 21
363
+ 22
364
+ 23
365
+ 24
366
+ 25
367
+ 26
368
+ 27
369
+ 28
370
+ 29
371
+ 30</pre>
372
+ </td>
373
+ <td>
374
+ <pre class="code"><span class="info file"># File 'lib/opentok/client.rb', line 20</span>
375
+
376
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_session'>create_session</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
377
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/session/create</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
378
+ <span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
379
+ <span class='kw'>when</span> <span class='lparen'>(</span><span class='int'>200</span><span class='op'>..</span><span class='int'>300</span><span class='rparen'>)</span>
380
+ <span class='id identifier rubyid_response'>response</span>
381
+ <span class='kw'>when</span> <span class='int'>403</span>
382
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokAuthenticationError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Authentication failed while creating a session. API Key: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
383
+ <span class='kw'>else</span>
384
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Failed to create session. Response code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
385
+ <span class='kw'>end</span>
386
+ <span class='kw'>end</span></pre>
387
+ </td>
388
+ </tr>
389
+ </table>
390
+ </div>
391
+
392
+ <div class="method_details ">
393
+ <h3 class="signature " id="delete_archive-instance_method">
394
+
395
+ - (<tt>Object</tt>) <strong>delete_archive</strong>(archive_id)
396
+
397
+
398
+
399
+
400
+
401
+ </h3><table class="source_code">
402
+ <tr>
403
+ <td>
404
+ <pre class="lines">
405
+
406
+
407
+ 107
408
+ 108
409
+ 109
410
+ 110
411
+ 111
412
+ 112
413
+ 113
414
+ 114
415
+ 115
416
+ 116
417
+ 117
418
+ 118
419
+ 119
420
+ 120
421
+ 121</pre>
422
+ </td>
423
+ <td>
424
+ <pre class="code"><span class="info file"># File 'lib/opentok/client.rb', line 107</span>
425
+
426
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_archive'>delete_archive</span><span class='lparen'>(</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rparen'>)</span>
427
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v2/partner/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_content'>/archive/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
428
+ <span class='symbol'>:headers</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
429
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
430
+ <span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
431
+ <span class='kw'>when</span> <span class='int'>204</span>
432
+ <span class='id identifier rubyid_response'>response</span>
433
+ <span class='kw'>when</span> <span class='int'>403</span>
434
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokAuthenticationError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Authentication failed or an invalid Archive ID was given while deleting an archive. API Key: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_content'>, Archive ID: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
435
+ <span class='kw'>when</span> <span class='int'>409</span>
436
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be deleted. The status must be 'available', 'deleted', or 'uploaded'. Archive ID: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
437
+ <span class='kw'>else</span>
438
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be deleted.</span><span class='tstring_end'>&quot;</span></span>
439
+ <span class='kw'>end</span>
440
+ <span class='kw'>end</span></pre>
441
+ </td>
442
+ </tr>
443
+ </table>
444
+ </div>
445
+
446
+ <div class="method_details ">
447
+ <h3 class="signature " id="get_archive-instance_method">
448
+
449
+ - (<tt>Object</tt>) <strong>get_archive</strong>(archive_id)
450
+
451
+
452
+
453
+
454
+
455
+ </h3><table class="source_code">
456
+ <tr>
457
+ <td>
458
+ <pre class="lines">
459
+
460
+
461
+ 55
462
+ 56
463
+ 57
464
+ 58
465
+ 59
466
+ 60
467
+ 61
468
+ 62
469
+ 63
470
+ 64
471
+ 65
472
+ 66
473
+ 67</pre>
474
+ </td>
475
+ <td>
476
+ <pre class="code"><span class="info file"># File 'lib/opentok/client.rb', line 55</span>
477
+
478
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_archive'>get_archive</span><span class='lparen'>(</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rparen'>)</span>
479
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v2/partner/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_content'>/archive/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
480
+ <span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
481
+ <span class='kw'>when</span> <span class='int'>200</span>
482
+ <span class='id identifier rubyid_response'>response</span>
483
+ <span class='kw'>when</span> <span class='int'>400</span>
484
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be retrieved. The Archive ID was invalid: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
485
+ <span class='kw'>when</span> <span class='int'>403</span>
486
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokAuthenticationError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Authentication failed while retrieving an archive. API Key: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
487
+ <span class='kw'>else</span>
488
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be retrieved.</span><span class='tstring_end'>&quot;</span></span>
489
+ <span class='kw'>end</span>
490
+ <span class='kw'>end</span></pre>
491
+ </td>
492
+ </tr>
493
+ </table>
494
+ </div>
495
+
496
+ <div class="method_details ">
497
+ <h3 class="signature " id="list_archives-instance_method">
498
+
499
+ - (<tt>Object</tt>) <strong>list_archives</strong>(offset, count)
500
+
501
+
502
+
503
+
504
+
505
+ </h3><table class="source_code">
506
+ <tr>
507
+ <td>
508
+ <pre class="lines">
509
+
510
+
511
+ 69
512
+ 70
513
+ 71
514
+ 72
515
+ 73
516
+ 74
517
+ 75
518
+ 76
519
+ 77
520
+ 78
521
+ 79
522
+ 80
523
+ 81
524
+ 82
525
+ 83
526
+ 84</pre>
527
+ </td>
528
+ <td>
529
+ <pre class="code"><span class="info file"># File 'lib/opentok/client.rb', line 69</span>
530
+
531
+ <span class='kw'>def</span> <span class='id identifier rubyid_list_archives'>list_archives</span><span class='lparen'>(</span><span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='id identifier rubyid_count'>count</span><span class='rparen'>)</span>
532
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
533
+ <span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:offset</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_offset'>offset</span> <span class='kw'>unless</span> <span class='id identifier rubyid_offset'>offset</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
534
+ <span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:count</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_count'>count</span> <span class='kw'>unless</span> <span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
535
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v2/partner/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_content'>/archive</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
536
+ <span class='symbol'>:query</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_query'>query</span>
537
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
538
+ <span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
539
+ <span class='kw'>when</span> <span class='int'>200</span>
540
+ <span class='id identifier rubyid_response'>response</span>
541
+ <span class='kw'>when</span> <span class='int'>403</span>
542
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokAuthenticationError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Authentication failed while retrieving archives. API Key: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
543
+ <span class='kw'>else</span>
544
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archives could not be retrieved.</span><span class='tstring_end'>&quot;</span></span>
545
+ <span class='kw'>end</span>
546
+ <span class='kw'>end</span></pre>
547
+ </td>
548
+ </tr>
549
+ </table>
550
+ </div>
551
+
552
+ <div class="method_details ">
553
+ <h3 class="signature " id="start_archive-instance_method">
554
+
555
+ - (<tt>Object</tt>) <strong>start_archive</strong>(session_id, opts)
556
+
557
+
558
+
559
+
560
+
561
+ </h3><table class="source_code">
562
+ <tr>
563
+ <td>
564
+ <pre class="lines">
565
+
566
+
567
+ 32
568
+ 33
569
+ 34
570
+ 35
571
+ 36
572
+ 37
573
+ 38
574
+ 39
575
+ 40
576
+ 41
577
+ 42
578
+ 43
579
+ 44
580
+ 45
581
+ 46
582
+ 47
583
+ 48
584
+ 49
585
+ 50
586
+ 51
587
+ 52
588
+ 53</pre>
589
+ </td>
590
+ <td>
591
+ <pre class="code"><span class="info file"># File 'lib/opentok/client.rb', line 32</span>
592
+
593
+ <span class='kw'>def</span> <span class='id identifier rubyid_start_archive'>start_archive</span><span class='lparen'>(</span><span class='id identifier rubyid_session_id'>session_id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
594
+ <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>sessionId</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_session_id'>session_id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>action</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>start</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
595
+ <span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>name</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
596
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v2/partner/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_content'>/archive</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
597
+ <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='comma'>,</span>
598
+ <span class='symbol'>:headers</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
599
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
600
+ <span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
601
+ <span class='kw'>when</span> <span class='int'>200</span>
602
+ <span class='id identifier rubyid_response'>response</span>
603
+ <span class='kw'>when</span> <span class='int'>400</span>
604
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be started. The request was invalid or the session has no connected clients.</span><span class='tstring_end'>&quot;</span></span>
605
+ <span class='kw'>when</span> <span class='int'>403</span>
606
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokAuthenticationError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Authentication failed while starting an archive. API Key: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
607
+ <span class='kw'>when</span> <span class='int'>404</span>
608
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be started. The Session ID does not exist: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_session_id'>session_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
609
+ <span class='kw'>when</span> <span class='int'>409</span>
610
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be started. The session could be peer-to-peer or the session is already being recorded.</span><span class='tstring_end'>&quot;</span></span>
611
+ <span class='kw'>else</span>
612
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be started</span><span class='tstring_end'>&quot;</span></span>
613
+ <span class='kw'>end</span>
614
+ <span class='kw'>end</span></pre>
615
+ </td>
616
+ </tr>
617
+ </table>
618
+ </div>
619
+
620
+ <div class="method_details ">
621
+ <h3 class="signature " id="stop_archive-instance_method">
622
+
623
+ - (<tt>Object</tt>) <strong>stop_archive</strong>(archive_id)
624
+
625
+
626
+
627
+
628
+
629
+ </h3><table class="source_code">
630
+ <tr>
631
+ <td>
632
+ <pre class="lines">
633
+
634
+
635
+ 86
636
+ 87
637
+ 88
638
+ 89
639
+ 90
640
+ 91
641
+ 92
642
+ 93
643
+ 94
644
+ 95
645
+ 96
646
+ 97
647
+ 98
648
+ 99
649
+ 100
650
+ 101
651
+ 102
652
+ 103
653
+ 104
654
+ 105</pre>
655
+ </td>
656
+ <td>
657
+ <pre class="code"><span class="info file"># File 'lib/opentok/client.rb', line 86</span>
658
+
659
+ <span class='kw'>def</span> <span class='id identifier rubyid_stop_archive'>stop_archive</span><span class='lparen'>(</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rparen'>)</span>
660
+ <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/v2/partner/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_content'>/archive/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
661
+ <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>action</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>stop</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='comma'>,</span>
662
+ <span class='symbol'>:headers</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
663
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
664
+ <span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
665
+ <span class='kw'>when</span> <span class='int'>200</span>
666
+ <span class='id identifier rubyid_response'>response</span>
667
+ <span class='kw'>when</span> <span class='int'>400</span>
668
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be stopped. The request was invalid.</span><span class='tstring_end'>&quot;</span></span>
669
+ <span class='kw'>when</span> <span class='int'>403</span>
670
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokAuthenticationError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Authentication failed while stopping an archive. API Key: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
671
+ <span class='kw'>when</span> <span class='int'>404</span>
672
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be stopped. The Archive ID does not exist: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
673
+ <span class='kw'>when</span> <span class='int'>409</span>
674
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be stopped. The archive is not currently recording.</span><span class='tstring_end'>&quot;</span></span>
675
+ <span class='kw'>else</span>
676
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>OpenTokArchiveError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The archive could not be started.</span><span class='tstring_end'>&quot;</span></span>
677
+ <span class='kw'>end</span>
678
+ <span class='kw'>end</span></pre>
679
+ </td>
680
+ </tr>
681
+ </table>
682
+ </div>
683
+
684
+ </div>
685
+
686
+ </div>
687
+
688
+ <div id="footer">
689
+ Generated on Wed May 14 18:26:56 2014 by
690
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
691
+ 0.8.7.3 (ruby-1.9.3).
692
+ </div>
693
+
694
+ </body>
695
+ </html>