opentok 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2ce0a896ef93fac779a7a0772acb81daeca3b82
-  data.tar.gz: 76c29f78298726db9ccad7f4d9913ee39090c024
+  metadata.gz: f35fe580541ec8e9d7e973564f1f694aa9db2f95
+  data.tar.gz: 91c5359e1e171ced0b1fb9bf3462ef7dc752ea76
 SHA512:
-  metadata.gz: ab5aab9c444ba3e8d34bac8008f14311aca71b9946c4261a85c6b9a11f629620c0b4ef35308be2e2acb3a016638841f1758b0fae4c16ccadefeea06a80e5033f
-  data.tar.gz: 6764f9f49a31380a2f3ada27c8c5c4baded6502831673248c394857f46c90770f0f06418ba4e50a3b1fab13e8e7fe5c816591aa8af572ca62a0a2874c9b71e1f
+  metadata.gz: 8b2f5014c9569169af71b3ae7c5ac60c05a9471cc98b178769ec3f1d2617c9db488fdcd36699984c7afa2213f7b947afe9faf43d3411a1d708d4951e7cf19081
+  data.tar.gz: 1fb580dc6f65cb050311c2f7dd7743851f3472f517714614c5643030b2b386f8f07ed4a8ebb59614d28d9827824b7f0c77cf8fb3239471945f6dbdfb88f95706

data/README.md

@@ -32,7 +32,7 @@ $ bundle install
 ## RubyGems:
 
 ```
-$ gem install opentok -v 2.2.1
+$ gem install opentok -v 2.2.2
 ```
 
 # Usage
@@ -56,14 +56,14 @@ and specifying a location hint. The `session_id` method of the returned `OpenTok
 instance is useful to get a sessionId that can be saved to a persistent store (e.g. database).
 
 ```ruby
-# Just a plain Session:
+# Create a session that will attempt to transmit streams directly between clients.
+# If clients cannot connect, the session uses the OpenTok TURN server:
 session = opentok.create_session
 
-# The session will attempt to transmit streams directly between clients.
-# If clients cannot connect, the session uses the OpenTok TURN server:
-session = opentok.create_session :media_mode => :relayed
+# A session that will use the OpenTok Media Server:
+session = opentok.create_session :media_mode => :routed
 
-# A Session with a location hint:
+# A session with a location hint:
 session = opentok.create_session :location => '12.34.56.78'
 
 # Store this sessionId in the database for later use:

data/doc/OpenTok.html

@@ -402,7 +402,7 @@ cannot be updated once it is set.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/Archive.html

@@ -1311,7 +1311,7 @@ have disconnected from the session being archived.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/ArchiveList.html

@@ -207,7 +207,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/Archives.html

@@ -1019,7 +1019,7 @@ have disconnected from the session being archived.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/OpenTok.html

@@ -474,7 +474,12 @@ href="https://dashboard.tokbox.com/projects">dashboard.tokbox.com/projects</a>).
             &mdash; <div class='inline'>
 <p>Determines whether the session will transmit streams the using OpenTok
 Media Router (<tt>:routed</tt>) or not (<tt>:relayed</tt>). By default,
-sessions use the OpenTok Media Router.</p>
+this property is set to <tt>:relayed</tt>.</p>
+
+<p>With the <tt>mediaMode</tt> property set to <tt>:relayed</tt>, the session
+will attempt to transmit streams directly between clients. If clients
+cannot connect due to firewall restrictions, the session uses the OpenTok
+TURN server to relay audio-video streams.</p>
 
 <p>With the <tt>mediaMode</tt> property set to <tt>:routed</tt>, the session
 will use the <a href="http://tokbox.com/#multiparty" target="_parent" title="OpenTok Media Router">OpenTok Media Router</a>. The
@@ -497,11 +502,6 @@ video returns.</p>
 sessions.</p>
 </li></ul>
 
-<p>With the <tt>mediaMode</tt> property set to <tt>:relayed</tt>, the session
-will attempt to transmit streams directly between clients. If clients
-cannot connect due to firewall restrictions, the session uses the OpenTok
-TURN server to relay audio-video streams.</p>
-
 <p>You will be billed for streamed minutes if you use the OpenTok Media Router
 or if the session uses the OpenTok TURN server to relay streams. For
 information on pricing, see the <a href="http://www.tokbox.com/pricing" target="_parent" title="OpenTok pricing page">OpenTok pricing page</a>.</p>
@@ -950,7 +950,12 @@ cannot be updated once it is set.</p>
 </span>  <span class='comment'>#
 </span>  <span class='comment'># @option opts [String] :media_mode Determines whether the session will transmit streams the
 </span>  <span class='comment'>#   using OpenTok Media Router (&lt;code&gt;:routed&lt;/code&gt;) or not (&lt;code&gt;:relayed&lt;/code&gt;).
-</span>  <span class='comment'>#   By default, sessions use the OpenTok Media Router.
+</span>  <span class='comment'>#   By default, this property is set to &lt;code&gt;:relayed&lt;/code&gt;.
+</span>  <span class='comment'>#
+</span>  <span class='comment'>#   With the &lt;code&gt;mediaMode&lt;/code&gt; property set to &lt;code&gt;:relayed&lt;/code&gt;, the session
+</span>  <span class='comment'>#   will attempt to transmit streams directly between clients. If clients cannot connect due to
+</span>  <span class='comment'>#   firewall restrictions, the session uses the OpenTok TURN server to relay audio-video
+</span>  <span class='comment'>#   streams.
 </span>  <span class='comment'>#
 </span>  <span class='comment'>#   With the &lt;code&gt;mediaMode&lt;/code&gt; property set to &lt;code&gt;:routed&lt;/code&gt;, the session
 </span>  <span class='comment'>#   will use the {http://tokbox.com/#multiparty OpenTok Media Router}.
@@ -969,11 +974,6 @@ cannot be updated once it is set.</p>
 </span>  <span class='comment'>#   * The OpenTok Media Router supports the {http://tokbox.com/platform/archiving archiving}
 </span>  <span class='comment'>#     feature, which lets you record, save, and retrieve OpenTok sessions.
 </span>  <span class='comment'>#
-</span>  <span class='comment'>#   With the &lt;code&gt;mediaMode&lt;/code&gt; property set to &lt;code&gt;:relayed&lt;/code&gt;, the session
-</span>  <span class='comment'>#   will attempt to transmit streams directly between clients. If clients cannot connect due to
-</span>  <span class='comment'>#   firewall restrictions, the session uses the OpenTok TURN server to relay audio-video
-</span>  <span class='comment'>#   streams.
-</span>  <span class='comment'>#
 </span>  <span class='comment'>#   You will be billed for streamed minutes if you use the OpenTok Media Router or if the
 </span>  <span class='comment'>#   session uses the OpenTok TURN server to relay streams. For information on pricing, see the
 </span>  <span class='comment'>#   {http://www.tokbox.com/pricing OpenTok pricing page}.
@@ -1037,7 +1037,7 @@ cannot be updated once it is set.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/OpenTokArchiveError.html

@@ -133,7 +133,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/OpenTokAuthenticationError.html

@@ -134,7 +134,7 @@ OpenTok API key or secret.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/OpenTokError.html

@@ -129,7 +129,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/OpenTok/Session.html

@@ -656,7 +656,7 @@ cannot be updated once it is set.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/_index.html

@@ -173,7 +173,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/file.README.html

@@ -78,7 +78,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -78,7 +78,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May 27 13:24:51 2014 by
+  Generated on Mon Jun 16 23:06:55 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-1.9.3).
 </div>

data/lib/opentok/opentok.rb

@@ -94,7 +94,12 @@ module OpenTok
     #
     # @option opts [String] :media_mode Determines whether the session will transmit streams the
     #   using OpenTok Media Router (<code>:routed</code>) or not (<code>:relayed</code>).
-    #   By default, sessions use the OpenTok Media Router.
+    #   By default, this property is set to <code>:relayed</code>.
+    #
+    #   With the <code>mediaMode</code> property set to <code>:relayed</code>, the session
+    #   will attempt to transmit streams directly between clients. If clients cannot connect due to
+    #   firewall restrictions, the session uses the OpenTok TURN server to relay audio-video
+    #   streams.
     #
     #   With the <code>mediaMode</code> property set to <code>:routed</code>, the session
     #   will use the {http://tokbox.com/#multiparty OpenTok Media Router}.
@@ -113,11 +118,6 @@ module OpenTok
     #   * The OpenTok Media Router supports the {http://tokbox.com/platform/archiving archiving}
     #     feature, which lets you record, save, and retrieve OpenTok sessions.
     #
-    #   With the <code>mediaMode</code> property set to <code>:relayed</code>, the session
-    #   will attempt to transmit streams directly between clients. If clients cannot connect due to
-    #   firewall restrictions, the session uses the OpenTok TURN server to relay audio-video
-    #   streams.
-    #
     #   You will be billed for streamed minutes if you use the OpenTok Media Router or if the
     #   session uses the OpenTok TURN server to relay streams. For information on pricing, see the
     #   {http://www.tokbox.com/pricing OpenTok pricing page}.
@@ -144,11 +144,11 @@ module OpenTok
       # anything other than :relayed sets the REST param to "disabled", in which case we force
       # opts to be :routed. if we were more strict we could raise an error when the value isn't
       # either :relayed or :routed
-      if params.delete(:media_mode) == :relayed
-        params["p2p.preference"] = "enabled"
-      else
+      if params.delete(:media_mode) == :routed
         params["p2p.preference"] = "disabled"
-        opts[:media_mode] = :routed
+      else
+        params["p2p.preference"] = "enabled"
+        opts[:media_mode] = :relayed
       end
       # location is optional, but it has to be an IP address if specified at all
       unless params[:location].nil?

data/lib/opentok/session.rb

@@ -65,7 +65,7 @@ module OpenTok
     # @private
     def initialize(api_key, api_secret, session_id, opts={})
       @api_key, @api_secret, @session_id = api_key, api_secret, session_id
-      @media_mode, @location = opts.fetch(:media_mode, :routed), opts[:location]
+      @media_mode, @location = opts.fetch(:media_mode, :relayed), opts[:location]
     end
 
     # @private

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '2.2.1'
+  VERSION = '2.2.2'
 end

data/sample/Archiving/archiving_sample.rb

@@ -7,7 +7,7 @@ class ArchivingSample < Sinatra::Base
 
   set :api_key, ENV['API_KEY']
   set :opentok, OpenTok::OpenTok.new(api_key, ENV['API_SECRET'])
-  set :session, opentok.create_session
+  set :session, opentok.create_session :media_mode => :routed
   set :erb, :layout => :layout
 
   get '/' do

data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_default_sessions.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.opentok.com/session/create
     body:
       encoding: UTF-8
-      string: p2p.preference=disabled
+      string: p2p.preference=enabled
     headers:
       X-Tb-Partner-Auth:
       - 123456:1234567890abcdef1234567890abcdef1234567890
@@ -34,6 +34,6 @@ http_interactions:
       encoding: UTF-8
       string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><sessions><Session><session_id>1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg</session_id><partner_id>123456</partner_id><create_dt>Mon
         Mar 17 00:41:31 PDT 2014</create_dt></Session></sessions>
-    http_version: 
+    http_version:
   recorded_at: Mon, 17 Mar 2014 07:41:30 GMT
 recorded_with: VCR 2.8.0

data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/{creates_routed_media_sessions_for_invalid_media_modes.yml → creates_relayed_media_sessions_for_invalid_media_modes.yml}

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.opentok.com/session/create
     body:
       encoding: UTF-8
-      string: p2p.preference=disabled
+      string: p2p.preference=enabled
     headers:
       X-Tb-Partner-Auth:
       - 123456:1234567890abcdef1234567890abcdef1234567890

data/spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_sessions_with_a_location_hint.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.opentok.com/session/create
     body:
       encoding: UTF-8
-      string: location=12.34.56.78&p2p.preference=disabled
+      string: location=12.34.56.78&p2p.preference=enabled
     headers:
       X-Tb-Partner-Auth:
       - 123456:1234567890abcdef1234567890abcdef1234567890
@@ -34,6 +34,6 @@ http_interactions:
       encoding: UTF-8
       string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><sessions><Session><session_id>1_MX4xMjM0NTZ-MTIuMzQuNTYuNzh-TW9uIE1hciAxNyAwMTo0ODo1NSBQRFQgMjAxNH4wLjM0MTM0MzE0MDIyOTU4Mjh-</session_id><partner_id>123456</partner_id><create_dt>Mon
         Mar 17 01:48:55 PDT 2014</create_dt></Session></sessions>
-    http_version: 
+    http_version:
   recorded_at: Mon, 17 Mar 2014 08:48:54 GMT
 recorded_with: VCR 2.8.0

data/spec/opentok/opentok_spec.rb

@@ -37,7 +37,7 @@ describe OpenTok::OpenTok do
         expect(session).to be_an_instance_of OpenTok::Session
         # TODO: do we need to be any more specific about what a valid session_id looks like?
         expect(session.session_id).to be_an_instance_of String
-        expect(session.media_mode).to eq :routed
+        expect(session.media_mode).to eq :relayed
         expect(session.location).to eq nil
       end
 
@@ -61,7 +61,7 @@ describe OpenTok::OpenTok do
         session = opentok.create_session :location => location
         expect(session).to be_an_instance_of OpenTok::Session
         expect(session.session_id).to be_an_instance_of String
-        expect(session.media_mode).to eq :routed
+        expect(session.media_mode).to eq :relayed
         expect(session.location).to eq location
       end
 
@@ -81,11 +81,11 @@ describe OpenTok::OpenTok do
         expect(session.location).to eq location
       end
 
-      it "creates routed media sessions for invalid media modes", :vcr => { :erb => { :version => OpenTok::VERSION } } do
+      it "creates relayed media sessions for invalid media modes", :vcr => { :erb => { :version => OpenTok::VERSION } } do
         session = opentok.create_session :media_mode => :blah
         expect(session).to be_an_instance_of OpenTok::Session
         expect(session.session_id).to be_an_instance_of String
-        expect(session.media_mode).to eq :routed
+        expect(session.media_mode).to eq :relayed
         expect(session.location).to eq nil
       end
 

data/spec/opentok/session_spec.rb

@@ -26,8 +26,8 @@ describe OpenTok::Session do
     it "should be represented by session_id when coerced to a string" do
       expect(session.to_s).to eq session_id
     end
-    it "should have the default media mode of routed" do
-      expect(session.media_mode).to eq :routed
+    it "should have the default media mode of relayed" do
+      expect(session.media_mode).to eq :relayed
     end
     it "should not have a location value" do
       expect(session.location).to eq nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -234,9 +234,9 @@ files:
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_part_of_the_archives_when_using_offset_and_count.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_default_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_for_invalid_media_modes.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_with_a_location_hint.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions.yml
-- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions_for_invalid_media_modes.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions_with_a_location_hint.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_sessions_with_a_location_hint.yml
 - spec/matchers/token.rb
@@ -282,9 +282,9 @@ test_files:
 - spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_part_of_the_archives_when_using_offset_and_count.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_default_sessions.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions.yml
+- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_for_invalid_media_modes.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_relayed_media_sessions_with_a_location_hint.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions.yml
-- spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions_for_invalid_media_modes.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_routed_media_sessions_with_a_location_hint.yml
 - spec/cassettes/OpenTok_OpenTok/when_initialized_properly/_create_session/creates_sessions_with_a_location_hint.yml
 - spec/matchers/token.rb