opentok 2.2.2 → 2.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.travis.yml +7 -4
- data/README.md +12 -2
- data/doc/OpenTok.html +2 -2
- data/doc/OpenTok/Archive.html +63 -58
- data/doc/OpenTok/ArchiveList.html +1 -1
- data/doc/OpenTok/Archives.html +19 -18
- data/doc/OpenTok/OpenTok.html +9 -17
- data/doc/OpenTok/OpenTokArchiveError.html +1 -1
- data/doc/OpenTok/OpenTokAuthenticationError.html +1 -1
- data/doc/OpenTok/OpenTokError.html +1 -1
- data/doc/OpenTok/Session.html +2 -2
- data/doc/_index.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/top-level-namespace.html +1 -1
- data/lib/opentok/archive.rb +3 -1
- data/lib/opentok/archives.rb +2 -1
- data/lib/opentok/opentok.rb +0 -4
- data/lib/opentok/version.rb +1 -1
- data/opentok.gemspec +1 -1
- data/sample/Archiving/README.md +1 -1
- data/spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml +3 -2
- data/spec/cassettes/OpenTok_Archives/should_find_archives_with_unknown_properties.yml +46 -0
- data/spec/cassettes/OpenTok_Archives/should_find_expired_archives.yml +46 -0
- data/spec/opentok/archives_spec.rb +11 -0
- metadata +8 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: dffed69e7386516ebc1f8d614cb08d0446796b8b
|
|
4
|
+
data.tar.gz: 273669ac8cfd0b3f6115e555ef4e94628d208261
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8bac951b35a12efa2458bb9e0678fb1bf5dd2a71be575796a94b9c65d60cc9b57d460c38bedf1295152db81d1c3789fd5557b0da05ba9c0d9daf53dc0af6d5f5
|
|
7
|
+
data.tar.gz: d03cae5de75bb2aa2934c7cc735fbba4a8ed23acf59222d2689efd921a3707c876e95376b744b974ea22384e91cd0584a7fc1f478e4379a193264f06efd27da2
|
data/.travis.yml
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
language: ruby
|
|
2
2
|
rvm:
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
- 1.9.3
|
|
4
|
+
- 2.0.0
|
|
5
|
+
- 2.1.0
|
|
6
|
+
- rbx-2
|
|
7
|
+
notifications:
|
|
8
|
+
slack:
|
|
9
|
+
secure: agVll2R9PTPvJMcUgbvOh9eGt60zGDc8kPUwEsiQr828rCgXh/ZxD5irYDyKQg3ZsS8+f3MjFCwzU7uQALkia2pDrie9d8g8m1dt4Q5U7Qm6QecshvE0U9JwbB5Ngxaftbqyf0XEFrE7CKs7RI1BzFRpe8m+fdZgfwccX8Gb7pc=
|
data/README.md
CHANGED
|
@@ -9,7 +9,7 @@ The OpenTok Ruby SDK lets you generate
|
|
|
9
9
|
[archive](http://www.tokbox.com/platform/archiving) OpenTok 2.0 sessions.
|
|
10
10
|
|
|
11
11
|
If you are updating from a previous version of this SDK, see
|
|
12
|
-
[Important changes
|
|
12
|
+
[Important changes since v2.2.0](#important-changes-since-v220).
|
|
13
13
|
|
|
14
14
|
# Installation
|
|
15
15
|
|
|
@@ -172,7 +172,17 @@ The OpenTok Ruby SDK requires Ruby 1.9.3 or greater.
|
|
|
172
172
|
See the [Releases](https://github.com/opentok/opentok-ruby-sdk/releases) page for details
|
|
173
173
|
about each release.
|
|
174
174
|
|
|
175
|
-
## Important changes
|
|
175
|
+
## Important changes since v2.2.0
|
|
176
|
+
|
|
177
|
+
**Changes in v2.2.2:**
|
|
178
|
+
|
|
179
|
+
The default setting for the `create_session()` method is to create a session with the media mode set
|
|
180
|
+
to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router
|
|
181
|
+
(media mode set to routed). In a relayed session, clients will attempt to send streams directly
|
|
182
|
+
between each other (peer-to-peer); if clients cannot connect due to firewall restrictions, the
|
|
183
|
+
session uses the OpenTok TURN server to relay audio-video streams.
|
|
184
|
+
|
|
185
|
+
**Changes in v2.2.0:**
|
|
176
186
|
|
|
177
187
|
This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
|
|
178
188
|
work with OpenTok 1.0 archives.)
|
data/doc/OpenTok.html
CHANGED
|
@@ -384,7 +384,7 @@ cannot be updated once it is set.</p>
|
|
|
384
384
|
<span class='comment'># @private
|
|
385
385
|
</span> <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_session_id'>session_id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
386
386
|
<span class='ivar'>@api_key</span><span class='comma'>,</span> <span class='ivar'>@api_secret</span><span class='comma'>,</span> <span class='ivar'>@session_id</span> <span class='op'>=</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_session_id'>session_id</span>
|
|
387
|
-
<span class='ivar'>@media_mode</span><span class='comma'>,</span> <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:
|
|
387
|
+
<span class='ivar'>@media_mode</span><span class='comma'>,</span> <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:relayed</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:location</span><span class='rbracket'>]</span>
|
|
388
388
|
<span class='kw'>end</span>
|
|
389
389
|
|
|
390
390
|
<span class='comment'># @private
|
|
@@ -402,7 +402,7 @@ cannot be updated once it is set.</p>
|
|
|
402
402
|
</div>
|
|
403
403
|
|
|
404
404
|
<div id="footer">
|
|
405
|
-
Generated on
|
|
405
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
406
406
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
407
407
|
0.8.7.4 (ruby-1.9.3).
|
|
408
408
|
</div>
|
data/doc/OpenTok/Archive.html
CHANGED
|
@@ -499,18 +499,18 @@ exceeded", "failure", "session ended", or "user initiated".</p>
|
|
|
499
499
|
<pre class="lines">
|
|
500
500
|
|
|
501
501
|
|
|
502
|
-
82
|
|
503
|
-
83
|
|
504
502
|
84
|
|
505
503
|
85
|
|
506
504
|
86
|
|
507
505
|
87
|
|
508
506
|
88
|
|
509
507
|
89
|
|
510
|
-
90
|
|
508
|
+
90
|
|
509
|
+
91
|
|
510
|
+
92</pre>
|
|
511
511
|
</td>
|
|
512
512
|
<td>
|
|
513
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
513
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 84</span>
|
|
514
514
|
|
|
515
515
|
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
516
516
|
<span class='id identifier rubyid_camelized_method'>camelized_method</span> <span class='op'>=</span> <span class='id identifier rubyid_method'>method</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='symbol'>:lower</span><span class='rparen'>)</span>
|
|
@@ -578,12 +578,12 @@ epoch.</p>
|
|
|
578
578
|
<pre class="lines">
|
|
579
579
|
|
|
580
580
|
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
581
|
+
50
|
|
582
|
+
51
|
|
583
|
+
52</pre>
|
|
584
584
|
</td>
|
|
585
585
|
<td>
|
|
586
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
586
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
587
587
|
|
|
588
588
|
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
|
589
589
|
<span class='ivar'>@created_at</span>
|
|
@@ -639,12 +639,12 @@ epoch.</p>
|
|
|
639
639
|
<pre class="lines">
|
|
640
640
|
|
|
641
641
|
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
642
|
+
50
|
|
643
|
+
51
|
|
644
|
+
52</pre>
|
|
645
645
|
</td>
|
|
646
646
|
<td>
|
|
647
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
647
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
648
648
|
|
|
649
649
|
<span class='kw'>def</span> <span class='id identifier rubyid_duration'>duration</span>
|
|
650
650
|
<span class='ivar'>@duration</span>
|
|
@@ -700,12 +700,12 @@ epoch.</p>
|
|
|
700
700
|
<pre class="lines">
|
|
701
701
|
|
|
702
702
|
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
703
|
+
50
|
|
704
|
+
51
|
|
705
|
+
52</pre>
|
|
706
706
|
</td>
|
|
707
707
|
<td>
|
|
708
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
708
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
709
709
|
|
|
710
710
|
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
|
|
711
711
|
<span class='ivar'>@id</span>
|
|
@@ -762,12 +762,12 @@ created, this is set to null.</p>
|
|
|
762
762
|
<pre class="lines">
|
|
763
763
|
|
|
764
764
|
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
765
|
+
50
|
|
766
|
+
51
|
|
767
|
+
52</pre>
|
|
768
768
|
</td>
|
|
769
769
|
<td>
|
|
770
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
770
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
771
771
|
|
|
772
772
|
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
|
773
773
|
<span class='ivar'>@name</span>
|
|
@@ -823,12 +823,12 @@ created, this is set to null.</p>
|
|
|
823
823
|
<pre class="lines">
|
|
824
824
|
|
|
825
825
|
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
826
|
+
50
|
|
827
|
+
51
|
|
828
|
+
52</pre>
|
|
829
829
|
</td>
|
|
830
830
|
<td>
|
|
831
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
831
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
832
832
|
|
|
833
833
|
<span class='kw'>def</span> <span class='id identifier rubyid_partner_id'>partner_id</span>
|
|
834
834
|
<span class='ivar'>@partner_id</span>
|
|
@@ -886,12 +886,12 @@ with the status "failed", this can be set to "system failure".</p>
|
|
|
886
886
|
<pre class="lines">
|
|
887
887
|
|
|
888
888
|
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
889
|
+
50
|
|
890
|
+
51
|
|
891
|
+
52</pre>
|
|
892
892
|
</td>
|
|
893
893
|
<td>
|
|
894
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
894
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
895
895
|
|
|
896
896
|
<span class='kw'>def</span> <span class='id identifier rubyid_reason'>reason</span>
|
|
897
897
|
<span class='ivar'>@reason</span>
|
|
@@ -947,12 +947,12 @@ with the status "failed", this can be set to "system failure".</p>
|
|
|
947
947
|
<pre class="lines">
|
|
948
948
|
|
|
949
949
|
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
950
|
+
50
|
|
951
|
+
51
|
|
952
|
+
52</pre>
|
|
953
953
|
</td>
|
|
954
954
|
<td>
|
|
955
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
955
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
956
956
|
|
|
957
957
|
<span class='kw'>def</span> <span class='id identifier rubyid_session_id'>session_id</span>
|
|
958
958
|
<span class='ivar'>@session_id</span>
|
|
@@ -1009,12 +1009,12 @@ value is set to 0.</p>
|
|
|
1009
1009
|
<pre class="lines">
|
|
1010
1010
|
|
|
1011
1011
|
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1012
|
+
50
|
|
1013
|
+
51
|
|
1014
|
+
52</pre>
|
|
1015
1015
|
</td>
|
|
1016
1016
|
<td>
|
|
1017
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
1017
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
1018
1018
|
|
|
1019
1019
|
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
|
|
1020
1020
|
<span class='ivar'>@size</span>
|
|
@@ -1043,6 +1043,9 @@ value is set to 0.</p>
|
|
|
1043
1043
|
<p>"available" -- The archive is available for download from the OpenTok
|
|
1044
1044
|
cloud.</p>
|
|
1045
1045
|
</li><li>
|
|
1046
|
+
<p>"expired" -- The archive is no longer available for download from the
|
|
1047
|
+
OpenTok cloud.</p>
|
|
1048
|
+
</li><li>
|
|
1046
1049
|
<p>"failed" -- The archive recording failed.</p>
|
|
1047
1050
|
</li><li>
|
|
1048
1051
|
<p>"started" -- The archive started and is in the process of being recorded.</p>
|
|
@@ -1050,7 +1053,9 @@ cloud.</p>
|
|
|
1050
1053
|
<p>"stopped" -- The archive stopped recording.</p>
|
|
1051
1054
|
</li><li>
|
|
1052
1055
|
<p>"uploaded" -- The archive is available for download from the the upload
|
|
1053
|
-
target S3 bucket
|
|
1056
|
+
target Amazon S3 bucket or Windows Azure container you set at the OpenTok
|
|
1057
|
+
dashboard (<a
|
|
1058
|
+
href="https://dashboard.tokbox.com">dashboard.tokbox.com</a>).</p>
|
|
1054
1059
|
</li></ul>
|
|
1055
1060
|
|
|
1056
1061
|
|
|
@@ -1083,12 +1088,12 @@ target S3 bucket.</p>
|
|
|
1083
1088
|
<pre class="lines">
|
|
1084
1089
|
|
|
1085
1090
|
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1091
|
+
50
|
|
1092
|
+
51
|
|
1093
|
+
52</pre>
|
|
1089
1094
|
</td>
|
|
1090
1095
|
<td>
|
|
1091
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
1096
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
1092
1097
|
|
|
1093
1098
|
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
|
|
1094
1099
|
<span class='ivar'>@status</span>
|
|
@@ -1149,12 +1154,12 @@ OpenTok.getArchive() method.</p>
|
|
|
1149
1154
|
<pre class="lines">
|
|
1150
1155
|
|
|
1151
1156
|
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1157
|
+
50
|
|
1158
|
+
51
|
|
1159
|
+
52</pre>
|
|
1155
1160
|
</td>
|
|
1156
1161
|
<td>
|
|
1157
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
1162
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
|
|
1158
1163
|
|
|
1159
1164
|
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
|
|
1160
1165
|
<span class='ivar'>@url</span>
|
|
@@ -1202,13 +1207,13 @@ making it unavailable for download.</p>
|
|
|
1202
1207
|
<pre class="lines">
|
|
1203
1208
|
|
|
1204
1209
|
|
|
1205
|
-
76
|
|
1206
|
-
77
|
|
1207
1210
|
78
|
|
1208
|
-
79
|
|
1211
|
+
79
|
|
1212
|
+
80
|
|
1213
|
+
81</pre>
|
|
1209
1214
|
</td>
|
|
1210
1215
|
<td>
|
|
1211
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
1216
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 78</span>
|
|
1212
1217
|
|
|
1213
1218
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
|
|
1214
1219
|
<span class='comment'># TODO: validate returned json fits schema
|
|
@@ -1248,13 +1253,13 @@ have disconnected from the session being archived.</p>
|
|
|
1248
1253
|
<pre class="lines">
|
|
1249
1254
|
|
|
1250
1255
|
|
|
1251
|
-
66
|
|
1252
|
-
67
|
|
1253
1256
|
68
|
|
1254
|
-
69
|
|
1257
|
+
69
|
|
1258
|
+
70
|
|
1259
|
+
71</pre>
|
|
1255
1260
|
</td>
|
|
1256
1261
|
<td>
|
|
1257
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
1262
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 68</span>
|
|
1258
1263
|
|
|
1259
1264
|
<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span>
|
|
1260
1265
|
<span class='comment'># TODO: validate returned json fits schema
|
|
@@ -1291,12 +1296,12 @@ have disconnected from the session being archived.</p>
|
|
|
1291
1296
|
<pre class="lines">
|
|
1292
1297
|
|
|
1293
1298
|
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1299
|
+
60
|
|
1300
|
+
61
|
|
1301
|
+
62</pre>
|
|
1297
1302
|
</td>
|
|
1298
1303
|
<td>
|
|
1299
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line
|
|
1304
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 60</span>
|
|
1300
1305
|
|
|
1301
1306
|
<span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span>
|
|
1302
1307
|
<span class='ivar'>@json</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
|
@@ -1311,7 +1316,7 @@ have disconnected from the session being archived.</p>
|
|
|
1311
1316
|
</div>
|
|
1312
1317
|
|
|
1313
1318
|
<div id="footer">
|
|
1314
|
-
Generated on
|
|
1319
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
1315
1320
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1316
1321
|
0.8.7.4 (ruby-1.9.3).
|
|
1317
1322
|
</div>
|
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
</div>
|
|
208
208
|
|
|
209
209
|
<div id="footer">
|
|
210
|
-
Generated on
|
|
210
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
211
211
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
212
212
|
0.8.7.4 (ruby-1.9.3).
|
|
213
213
|
</div>
|
data/doc/OpenTok/Archives.html
CHANGED
|
@@ -373,14 +373,14 @@ archives returned is 1000.</p>
|
|
|
373
373
|
<pre class="lines">
|
|
374
374
|
|
|
375
375
|
|
|
376
|
-
73
|
|
377
376
|
74
|
|
378
377
|
75
|
|
379
378
|
76
|
|
380
|
-
77
|
|
379
|
+
77
|
|
380
|
+
78</pre>
|
|
381
381
|
</td>
|
|
382
382
|
<td>
|
|
383
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line
|
|
383
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line 74</span>
|
|
384
384
|
|
|
385
385
|
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
386
386
|
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Limit is invalid</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:count</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='lparen'>(</span><span class='int'>0</span><span class='op'>..</span><span class='int'>100</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:count</span><span class='rbracket'>]</span>
|
|
@@ -410,8 +410,9 @@ archives returned is 1000.</p>
|
|
|
410
410
|
successfully start recording an archive.</p>
|
|
411
411
|
|
|
412
412
|
<p>You can only record one archive at a time for a given session. You can only
|
|
413
|
-
record archives of
|
|
414
|
-
|
|
413
|
+
record archives of sessions that use the OpenTok Media Router (sessions
|
|
414
|
+
with the media mode set to routed); you cannot archive sessions with the
|
|
415
|
+
media mode set to relayed.</p>
|
|
415
416
|
|
|
416
417
|
|
|
417
418
|
</div>
|
|
@@ -584,16 +585,16 @@ session is already being recorded.</p>
|
|
|
584
585
|
<pre class="lines">
|
|
585
586
|
|
|
586
587
|
|
|
587
|
-
39
|
|
588
588
|
40
|
|
589
589
|
41
|
|
590
590
|
42
|
|
591
591
|
43
|
|
592
592
|
44
|
|
593
|
-
45
|
|
593
|
+
45
|
|
594
|
+
46</pre>
|
|
594
595
|
</td>
|
|
595
596
|
<td>
|
|
596
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line
|
|
597
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line 40</span>
|
|
597
598
|
|
|
598
599
|
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_session_id'>session_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
599
600
|
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>session_id not provided</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_session_id'>session_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
@@ -706,14 +707,14 @@ archive remains deleted.</p>
|
|
|
706
707
|
<pre class="lines">
|
|
707
708
|
|
|
708
709
|
|
|
709
|
-
113
|
|
710
710
|
114
|
|
711
711
|
115
|
|
712
712
|
116
|
|
713
|
-
117
|
|
713
|
+
117
|
|
714
|
+
118</pre>
|
|
714
715
|
</td>
|
|
715
716
|
<td>
|
|
716
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line
|
|
717
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line 114</span>
|
|
717
718
|
|
|
718
719
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete_by_id'>delete_by_id</span><span class='lparen'>(</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rparen'>)</span>
|
|
719
720
|
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>archive_id not provided</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_archive_id'>archive_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
@@ -835,14 +836,14 @@ archive remains deleted.</p>
|
|
|
835
836
|
<pre class="lines">
|
|
836
837
|
|
|
837
838
|
|
|
838
|
-
56
|
|
839
839
|
57
|
|
840
840
|
58
|
|
841
841
|
59
|
|
842
|
-
60
|
|
842
|
+
60
|
|
843
|
+
61</pre>
|
|
843
844
|
</td>
|
|
844
845
|
<td>
|
|
845
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line
|
|
846
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line 57</span>
|
|
846
847
|
|
|
847
848
|
<span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rparen'>)</span>
|
|
848
849
|
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>archive_id not provided</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_archive_id'>archive_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
@@ -995,14 +996,14 @@ have disconnected from the session being archived.</p>
|
|
|
995
996
|
<pre class="lines">
|
|
996
997
|
|
|
997
998
|
|
|
998
|
-
94
|
|
999
999
|
95
|
|
1000
1000
|
96
|
|
1001
1001
|
97
|
|
1002
|
-
98
|
|
1002
|
+
98
|
|
1003
|
+
99</pre>
|
|
1003
1004
|
</td>
|
|
1004
1005
|
<td>
|
|
1005
|
-
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line
|
|
1006
|
+
<pre class="code"><span class="info file"># File 'lib/opentok/archives.rb', line 95</span>
|
|
1006
1007
|
|
|
1007
1008
|
<span class='kw'>def</span> <span class='id identifier rubyid_stop_by_id'>stop_by_id</span><span class='lparen'>(</span><span class='id identifier rubyid_archive_id'>archive_id</span><span class='rparen'>)</span>
|
|
1008
1009
|
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>archive_id not provided</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_archive_id'>archive_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
@@ -1019,7 +1020,7 @@ have disconnected from the session being archived.</p>
|
|
|
1019
1020
|
</div>
|
|
1020
1021
|
|
|
1021
1022
|
<div id="footer">
|
|
1022
|
-
Generated on
|
|
1023
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
1023
1024
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1024
1025
|
0.8.7.4 (ruby-1.9.3).
|
|
1025
1026
|
</div>
|
data/doc/OpenTok/OpenTok.html
CHANGED
|
@@ -501,10 +501,6 @@ video returns.</p>
|
|
|
501
501
|
<p>The OpenTok Media Router supports the <a href="http://tokbox.com/platform/archiving" target="_parent" title="archiving">archiving</a> feature, which lets you record, save, and retrieve OpenTok
|
|
502
502
|
sessions.</p>
|
|
503
503
|
</li></ul>
|
|
504
|
-
|
|
505
|
-
<p>You will be billed for streamed minutes if you use the OpenTok Media Router
|
|
506
|
-
or if the session uses the OpenTok TURN server to relay streams. For
|
|
507
|
-
information on pricing, see the <a href="http://www.tokbox.com/pricing" target="_parent" title="OpenTok pricing page">OpenTok pricing page</a>.</p>
|
|
508
504
|
</div>
|
|
509
505
|
|
|
510
506
|
</li>
|
|
@@ -605,11 +601,11 @@ ID.</p>
|
|
|
605
601
|
<span class='comment'># anything other than :relayed sets the REST param to "disabled", in which case we force
|
|
606
602
|
</span> <span class='comment'># opts to be :routed. if we were more strict we could raise an error when the value isn't
|
|
607
603
|
</span> <span class='comment'># either :relayed or :routed
|
|
608
|
-
</span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='symbol'>:
|
|
609
|
-
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>p2p.preference</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enabled</span><span class='tstring_end'>"</span></span>
|
|
610
|
-
<span class='kw'>else</span>
|
|
604
|
+
</span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='symbol'>:routed</span>
|
|
611
605
|
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>p2p.preference</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>disabled</span><span class='tstring_end'>"</span></span>
|
|
612
|
-
|
|
606
|
+
<span class='kw'>else</span>
|
|
607
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>p2p.preference</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enabled</span><span class='tstring_end'>"</span></span>
|
|
608
|
+
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:media_mode</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:relayed</span>
|
|
613
609
|
<span class='kw'>end</span>
|
|
614
610
|
<span class='comment'># location is optional, but it has to be an IP address if specified at all
|
|
615
611
|
</span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:location</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
@@ -974,10 +970,6 @@ cannot be updated once it is set.</p>
|
|
|
974
970
|
</span> <span class='comment'># * The OpenTok Media Router supports the {http://tokbox.com/platform/archiving archiving}
|
|
975
971
|
</span> <span class='comment'># feature, which lets you record, save, and retrieve OpenTok sessions.
|
|
976
972
|
</span> <span class='comment'>#
|
|
977
|
-
</span> <span class='comment'># You will be billed for streamed minutes if you use the OpenTok Media Router or if the
|
|
978
|
-
</span> <span class='comment'># session uses the OpenTok TURN server to relay streams. For information on pricing, see the
|
|
979
|
-
</span> <span class='comment'># {http://www.tokbox.com/pricing OpenTok pricing page}.
|
|
980
|
-
</span> <span class='comment'>#
|
|
981
973
|
</span> <span class='comment'># @option opts [String] :location An IP address that the OpenTok servers will use to
|
|
982
974
|
</span> <span class='comment'># situate the session in its global network. If you do not set a location hint,
|
|
983
975
|
</span> <span class='comment'># the OpenTok servers will be based on the first client connecting to the session.
|
|
@@ -1000,11 +992,11 @@ cannot be updated once it is set.</p>
|
|
|
1000
992
|
<span class='comment'># anything other than :relayed sets the REST param to "disabled", in which case we force
|
|
1001
993
|
</span> <span class='comment'># opts to be :routed. if we were more strict we could raise an error when the value isn't
|
|
1002
994
|
</span> <span class='comment'># either :relayed or :routed
|
|
1003
|
-
</span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='symbol'>:
|
|
1004
|
-
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>p2p.preference</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enabled</span><span class='tstring_end'>"</span></span>
|
|
1005
|
-
<span class='kw'>else</span>
|
|
995
|
+
</span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='symbol'>:routed</span>
|
|
1006
996
|
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>p2p.preference</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>disabled</span><span class='tstring_end'>"</span></span>
|
|
1007
|
-
|
|
997
|
+
<span class='kw'>else</span>
|
|
998
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>p2p.preference</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enabled</span><span class='tstring_end'>"</span></span>
|
|
999
|
+
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:media_mode</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:relayed</span>
|
|
1008
1000
|
<span class='kw'>end</span>
|
|
1009
1001
|
<span class='comment'># location is optional, but it has to be an IP address if specified at all
|
|
1010
1002
|
</span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:location</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
@@ -1037,7 +1029,7 @@ cannot be updated once it is set.</p>
|
|
|
1037
1029
|
</div>
|
|
1038
1030
|
|
|
1039
1031
|
<div id="footer">
|
|
1040
|
-
Generated on
|
|
1032
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
1041
1033
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1042
1034
|
0.8.7.4 (ruby-1.9.3).
|
|
1043
1035
|
</div>
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
</div>
|
|
134
134
|
|
|
135
135
|
<div id="footer">
|
|
136
|
-
Generated on
|
|
136
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
137
137
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
138
138
|
0.8.7.4 (ruby-1.9.3).
|
|
139
139
|
</div>
|
|
@@ -134,7 +134,7 @@ OpenTok API key or secret.</p>
|
|
|
134
134
|
</div>
|
|
135
135
|
|
|
136
136
|
<div id="footer">
|
|
137
|
-
Generated on
|
|
137
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
138
138
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
139
139
|
0.8.7.4 (ruby-1.9.3).
|
|
140
140
|
</div>
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
</div>
|
|
130
130
|
|
|
131
131
|
<div id="footer">
|
|
132
|
-
Generated on
|
|
132
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
133
133
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
134
134
|
0.8.7.4 (ruby-1.9.3).
|
|
135
135
|
</div>
|
data/doc/OpenTok/Session.html
CHANGED
|
@@ -638,7 +638,7 @@ cannot be updated once it is set.</p>
|
|
|
638
638
|
<span class='comment'># @private
|
|
639
639
|
</span> <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_session_id'>session_id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
640
640
|
<span class='ivar'>@api_key</span><span class='comma'>,</span> <span class='ivar'>@api_secret</span><span class='comma'>,</span> <span class='ivar'>@session_id</span> <span class='op'>=</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_session_id'>session_id</span>
|
|
641
|
-
<span class='ivar'>@media_mode</span><span class='comma'>,</span> <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:
|
|
641
|
+
<span class='ivar'>@media_mode</span><span class='comma'>,</span> <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:relayed</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:location</span><span class='rbracket'>]</span>
|
|
642
642
|
<span class='kw'>end</span>
|
|
643
643
|
|
|
644
644
|
<span class='comment'># @private
|
|
@@ -656,7 +656,7 @@ cannot be updated once it is set.</p>
|
|
|
656
656
|
</div>
|
|
657
657
|
|
|
658
658
|
<div id="footer">
|
|
659
|
-
Generated on
|
|
659
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
660
660
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
661
661
|
0.8.7.4 (ruby-1.9.3).
|
|
662
662
|
</div>
|
data/doc/_index.html
CHANGED
|
@@ -173,7 +173,7 @@
|
|
|
173
173
|
</div>
|
|
174
174
|
|
|
175
175
|
<div id="footer">
|
|
176
|
-
Generated on
|
|
176
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
177
177
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
178
178
|
0.8.7.4 (ruby-1.9.3).
|
|
179
179
|
</div>
|
data/doc/file.README.html
CHANGED
data/doc/index.html
CHANGED
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
</div>
|
|
104
104
|
|
|
105
105
|
<div id="footer">
|
|
106
|
-
Generated on
|
|
106
|
+
Generated on Fri Jun 20 12:49:10 2014 by
|
|
107
107
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
108
108
|
0.8.7.4 (ruby-1.9.3).
|
|
109
109
|
</div>
|
data/lib/opentok/archive.rb
CHANGED
|
@@ -34,11 +34,13 @@ module OpenTok
|
|
|
34
34
|
# The status of the archive, which can be one of the following:
|
|
35
35
|
#
|
|
36
36
|
# * "available" -- The archive is available for download from the OpenTok cloud.
|
|
37
|
+
# * "expired" -- The archive is no longer available for download from the OpenTok cloud.
|
|
37
38
|
# * "failed" -- The archive recording failed.
|
|
38
39
|
# * "started" -- The archive started and is in the process of being recorded.
|
|
39
40
|
# * "stopped" -- The archive stopped recording.
|
|
40
41
|
# * "uploaded" -- The archive is available for download from the the upload target
|
|
41
|
-
# S3 bucket
|
|
42
|
+
# Amazon S3 bucket or Windows Azure container you set at the OpenTok dashboard
|
|
43
|
+
# (https://dashboard.tokbox.com).
|
|
42
44
|
#
|
|
43
45
|
# @attr [string] url
|
|
44
46
|
# The download URL of the available MP4 file. This is only set for an archive with the status set to
|
data/lib/opentok/archives.rb
CHANGED
|
@@ -17,7 +17,8 @@ module OpenTok
|
|
|
17
17
|
# recording an archive.
|
|
18
18
|
#
|
|
19
19
|
# You can only record one archive at a time for a given session. You can only record archives
|
|
20
|
-
# of OpenTok
|
|
20
|
+
# of sessions that use the OpenTok Media Router (sessions with the media mode set to routed);
|
|
21
|
+
# you cannot archive sessions with the media mode set to relayed.
|
|
21
22
|
#
|
|
22
23
|
# @param [String] session_id The session ID of the OpenTok session to archive.
|
|
23
24
|
# @param [Hash] options A hash with the key 'name' or :name.
|
data/lib/opentok/opentok.rb
CHANGED
|
@@ -118,10 +118,6 @@ module OpenTok
|
|
|
118
118
|
# * The OpenTok Media Router supports the {http://tokbox.com/platform/archiving archiving}
|
|
119
119
|
# feature, which lets you record, save, and retrieve OpenTok sessions.
|
|
120
120
|
#
|
|
121
|
-
# You will be billed for streamed minutes if you use the OpenTok Media Router or if the
|
|
122
|
-
# session uses the OpenTok TURN server to relay streams. For information on pricing, see the
|
|
123
|
-
# {http://www.tokbox.com/pricing OpenTok pricing page}.
|
|
124
|
-
#
|
|
125
121
|
# @option opts [String] :location An IP address that the OpenTok servers will use to
|
|
126
122
|
# situate the session in its global network. If you do not set a location hint,
|
|
127
123
|
# the OpenTok servers will be based on the first client connecting to the session.
|
data/lib/opentok/version.rb
CHANGED
data/opentok.gemspec
CHANGED
|
@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
|
|
|
29
29
|
# spec.add_development_dependency "debugger", "~> 1.6.6"
|
|
30
30
|
|
|
31
31
|
spec.add_dependency "addressable", "~> 2.3" # 2.3.0 <= version < 3.0.0
|
|
32
|
-
spec.add_dependency "httparty", "~> 0.
|
|
32
|
+
spec.add_dependency "httparty", "~> 0.13.1"
|
|
33
33
|
spec.add_dependency "activesupport", ">= 2.0"
|
|
34
34
|
end
|
data/sample/Archiving/README.md
CHANGED
|
@@ -22,7 +22,7 @@ $ export API_SECRET=abcdef1234567890abcdef01234567890abcdef
|
|
|
22
22
|
Finally, start the server using Bundler to handle dependencies
|
|
23
23
|
|
|
24
24
|
```
|
|
25
|
-
$ bundle exec ruby
|
|
25
|
+
$ bundle exec ruby archiving_sample.rb
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
Visit <http://localhost:9393> in your browser. You can now create new archives (either as a host or
|
|
@@ -39,8 +39,9 @@ http_interactions:
|
|
|
39
39
|
"sessionId" : "SESSIONID",
|
|
40
40
|
"size" : 8347554,
|
|
41
41
|
"status" : "available",
|
|
42
|
-
"url" : "http://tokbox.com.archive2.s3.amazonaws.com/123456%2Ff6e7ee58-d6cf-4a59-896b-6d56b158ec71%2Farchive.mp4?Expires=1395194362&AWSAccessKeyId=AKIAI6LQCPIXYVWCQV6Q&Signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
42
|
+
"url" : "http://tokbox.com.archive2.s3.amazonaws.com/123456%2Ff6e7ee58-d6cf-4a59-896b-6d56b158ec71%2Farchive.mp4?Expires=1395194362&AWSAccessKeyId=AKIAI6LQCPIXYVWCQV6Q&Signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
43
|
+
"notarealproperty" : "not a real value"
|
|
43
44
|
}
|
|
44
|
-
http_version:
|
|
45
|
+
http_version:
|
|
45
46
|
recorded_at: Wed, 19 Mar 2014 01:49:22 GMT
|
|
46
47
|
recorded_with: VCR 2.8.0
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
http_interactions:
|
|
3
|
+
- request:
|
|
4
|
+
method: get
|
|
5
|
+
uri: https://api.opentok.com/v2/partner/123456/archive/f6e7ee58-d6cf-4a59-896b-6d56b158ec71
|
|
6
|
+
body:
|
|
7
|
+
encoding: US-ASCII
|
|
8
|
+
string: ''
|
|
9
|
+
headers:
|
|
10
|
+
X-Tb-Partner-Auth:
|
|
11
|
+
- 123456:1234567890abcdef1234567890abcdef1234567890
|
|
12
|
+
User-Agent:
|
|
13
|
+
- OpenTok-Ruby-SDK/<%= version %>
|
|
14
|
+
response:
|
|
15
|
+
status:
|
|
16
|
+
code: 200
|
|
17
|
+
message: OK
|
|
18
|
+
headers:
|
|
19
|
+
Server:
|
|
20
|
+
- nginx
|
|
21
|
+
Date:
|
|
22
|
+
- Wed, 19 Mar 2014 01:49:22 GMT
|
|
23
|
+
Content-Type:
|
|
24
|
+
- application/json
|
|
25
|
+
Transfer-Encoding:
|
|
26
|
+
- chunked
|
|
27
|
+
Connection:
|
|
28
|
+
- keep-alive
|
|
29
|
+
body:
|
|
30
|
+
encoding: UTF-8
|
|
31
|
+
string: |-
|
|
32
|
+
{
|
|
33
|
+
"createdAt" : 1395187836000,
|
|
34
|
+
"duration" : 62,
|
|
35
|
+
"id" : "f6e7ee58-d6cf-4a59-896b-6d56b158ec71",
|
|
36
|
+
"name" : "",
|
|
37
|
+
"partnerId" : 123456,
|
|
38
|
+
"reason" : "",
|
|
39
|
+
"sessionId" : "SESSIONID",
|
|
40
|
+
"size" : 8347554,
|
|
41
|
+
"status" : "available",
|
|
42
|
+
"url" : "http://tokbox.com.archive2.s3.amazonaws.com/123456%2Ff6e7ee58-d6cf-4a59-896b-6d56b158ec71%2Farchive.mp4?Expires=1395194362&AWSAccessKeyId=AKIAI6LQCPIXYVWCQV6Q&Signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
43
|
+
}
|
|
44
|
+
http_version:
|
|
45
|
+
recorded_at: Wed, 19 Mar 2014 01:49:22 GMT
|
|
46
|
+
recorded_with: VCR 2.8.0
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
http_interactions:
|
|
3
|
+
- request:
|
|
4
|
+
method: get
|
|
5
|
+
uri: https://api.opentok.com/v2/partner/123456/archive/f6e7ee58-d6cf-4a59-896b-6d56b158ec71
|
|
6
|
+
body:
|
|
7
|
+
encoding: US-ASCII
|
|
8
|
+
string: ''
|
|
9
|
+
headers:
|
|
10
|
+
X-Tb-Partner-Auth:
|
|
11
|
+
- 123456:1234567890abcdef1234567890abcdef1234567890
|
|
12
|
+
User-Agent:
|
|
13
|
+
- OpenTok-Ruby-SDK/<%= version %>
|
|
14
|
+
response:
|
|
15
|
+
status:
|
|
16
|
+
code: 200
|
|
17
|
+
message: OK
|
|
18
|
+
headers:
|
|
19
|
+
Server:
|
|
20
|
+
- nginx
|
|
21
|
+
Date:
|
|
22
|
+
- Wed, 19 Mar 2014 01:49:22 GMT
|
|
23
|
+
Content-Type:
|
|
24
|
+
- application/json
|
|
25
|
+
Transfer-Encoding:
|
|
26
|
+
- chunked
|
|
27
|
+
Connection:
|
|
28
|
+
- keep-alive
|
|
29
|
+
body:
|
|
30
|
+
encoding: UTF-8
|
|
31
|
+
string: |-
|
|
32
|
+
{
|
|
33
|
+
"createdAt" : 1395187836000,
|
|
34
|
+
"duration" : 62,
|
|
35
|
+
"id" : "f6e7ee58-d6cf-4a59-896b-6d56b158ec71",
|
|
36
|
+
"name" : "",
|
|
37
|
+
"partnerId" : 123456,
|
|
38
|
+
"reason" : "",
|
|
39
|
+
"sessionId" : "SESSIONID",
|
|
40
|
+
"size" : 8347554,
|
|
41
|
+
"status" : "expired",
|
|
42
|
+
"url" : null
|
|
43
|
+
}
|
|
44
|
+
http_version:
|
|
45
|
+
recorded_at: Wed, 19 Mar 2014 01:49:22 GMT
|
|
46
|
+
recorded_with: VCR 2.8.0
|
|
@@ -55,6 +55,17 @@ describe OpenTok::Archives do
|
|
|
55
55
|
# expect(archive.status).to eq ""
|
|
56
56
|
end
|
|
57
57
|
|
|
58
|
+
it "should find expired archives", :vcr => { :erb => { :version => OpenTok::VERSION } } do
|
|
59
|
+
archive = archives.find findable_archive_id
|
|
60
|
+
expect(archive).to be_an_instance_of OpenTok::Archive
|
|
61
|
+
expect(archive.status).to eq "expired"
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
it "should find archives with unknown properties", :vcr => { :erb => { :version => OpenTok::VERSION } } do
|
|
65
|
+
archive = archives.find findable_archive_id
|
|
66
|
+
expect(archive).to be_an_instance_of OpenTok::Archive
|
|
67
|
+
end
|
|
68
|
+
|
|
58
69
|
# TODO: context "with a session that has no participants" do
|
|
59
70
|
# let(:session_id) { "" }
|
|
60
71
|
# it "should refuse to create archives with appropriate error" do
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: opentok
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.2.
|
|
4
|
+
version: 2.2.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Stijn Mathysen
|
|
@@ -12,7 +12,7 @@ authors:
|
|
|
12
12
|
autorequire:
|
|
13
13
|
bindir: bin
|
|
14
14
|
cert_chain: []
|
|
15
|
-
date: 2014-
|
|
15
|
+
date: 2014-09-23 00:00:00.000000000 Z
|
|
16
16
|
dependencies:
|
|
17
17
|
- !ruby/object:Gem::Dependency
|
|
18
18
|
name: bundler
|
|
@@ -118,14 +118,14 @@ dependencies:
|
|
|
118
118
|
requirements:
|
|
119
119
|
- - ~>
|
|
120
120
|
- !ruby/object:Gem::Version
|
|
121
|
-
version:
|
|
121
|
+
version: 0.13.1
|
|
122
122
|
type: :runtime
|
|
123
123
|
prerelease: false
|
|
124
124
|
version_requirements: !ruby/object:Gem::Requirement
|
|
125
125
|
requirements:
|
|
126
126
|
- - ~>
|
|
127
127
|
- !ruby/object:Gem::Version
|
|
128
|
-
version:
|
|
128
|
+
version: 0.13.1
|
|
129
129
|
- !ruby/object:Gem::Dependency
|
|
130
130
|
name: activesupport
|
|
131
131
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -227,6 +227,8 @@ files:
|
|
|
227
227
|
- spec/cassettes/OpenTok_Archives/should_create_named_archives.yml
|
|
228
228
|
- spec/cassettes/OpenTok_Archives/should_delete_an_archive_by_id.yml
|
|
229
229
|
- spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml
|
|
230
|
+
- spec/cassettes/OpenTok_Archives/should_find_archives_with_unknown_properties.yml
|
|
231
|
+
- spec/cassettes/OpenTok_Archives/should_find_expired_archives.yml
|
|
230
232
|
- spec/cassettes/OpenTok_Archives/should_stop_archives.yml
|
|
231
233
|
- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_all_archives.yml
|
|
232
234
|
- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_archives_with_an_offset.yml
|
|
@@ -275,6 +277,8 @@ test_files:
|
|
|
275
277
|
- spec/cassettes/OpenTok_Archives/should_create_named_archives.yml
|
|
276
278
|
- spec/cassettes/OpenTok_Archives/should_delete_an_archive_by_id.yml
|
|
277
279
|
- spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml
|
|
280
|
+
- spec/cassettes/OpenTok_Archives/should_find_archives_with_unknown_properties.yml
|
|
281
|
+
- spec/cassettes/OpenTok_Archives/should_find_expired_archives.yml
|
|
278
282
|
- spec/cassettes/OpenTok_Archives/should_stop_archives.yml
|
|
279
283
|
- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_all_archives.yml
|
|
280
284
|
- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_archives_with_an_offset.yml
|