opentok 3.0.3 → 3.1.0

data/spec/cassettes/OpenTok_Signals/receives_a_valid_response_for_all_connections.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/session/SESSIONID/signal
+    body:
+      encoding: UTF-8
+      string: '{"type":"chat","data":"Hello"}'
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImlzdCI6InByb2plY3QifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.Oh_JHhtEUKK1pPV4s6neXJj_RXI8EcEpJRRpG_2c9U0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 28 Aug 2018 21:31:02 GMT
+      Content-Type:
+      - application/xml
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '177'
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><errorPayload><code>-1</code><message>Issuer
+        not found</message><description>Issuer not found</description></errorPayload>
+    http_version: 
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/OpenTok_Streams/get_all_streams_information.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.opentok.com/v2/project/123456/session/SESSIONID/stream
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImlzdCI6InByb2plY3QifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.Oh_JHhtEUKK1pPV4s6neXJj_RXI8EcEpJRRpG_2c9U0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Sep 2018 20:41:24 GMT
+      Content-Type:
+      - application/json
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '73'
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "count": 2,
+          "items": [
+            {
+              "id": "1234356-0a06-46a2-8ea8-074e64d43422",
+              "videoType": "camera",
+              "name": "",
+              "layoutClassList": ["full", "focus"]
+            },
+            {
+              "id": "8b732909-0a06-46a2-8ea8-074e64d43422",
+              "videoType": "screen",
+               "name": "",
+              "layoutClassList": ["full"]
+            }
+            ]
+        }
+    http_version: 
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/OpenTok_Streams/get_specific_stream_information.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.opentok.com/v2/project/123456/session/SESSIONID/stream/STREAMID
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImlzdCI6InByb2plY3QifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.Oh_JHhtEUKK1pPV4s6neXJj_RXI8EcEpJRRpG_2c9U0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Sep 2018 20:41:24 GMT
+      Content-Type:
+      - application/json
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '0'
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+        "id": "8b732909-0a06-46a2-8ea8-074e64d43422",
+        "videoType": "camera",
+        "name": "",
+        "layoutClassList": ["full"]
+        }
+    http_version: 
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/OpenTok_Streams/layout_working_on_two_stream_list.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://api.opentok.com/v2/project/123456/session/SESSIONID/stream
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"id":"8b732909-0a06-46a2-8ea8-074e64d43422","layoutClassList":["full"]},{"id":"8b732909-0a06-46a2-8ea8-074e64d43423","layoutClassList":["full","focus"]}]}'
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImlzdCI6InByb2plY3QifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.Oh_JHhtEUKK1pPV4s6neXJj_RXI8EcEpJRRpG_2c9U0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Wed, 26 Sep 2018 22:48:29 GMT
+      Content-Type:
+      - application/json
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '73'
+    body:
+      encoding: UTF-8
+      string: '{"code":-1,"message":"Issuer not found","description":"Issuer not found"}'
+    http_version: 
+  recorded_at: Tue, 18 Apr 2017 10:17:40 GMT
+recorded_with: VCR 2.8.0

data/spec/opentok/archives_spec.rb

@@ -93,6 +93,79 @@ describe OpenTok::Archives do
     expect(archive).to be_an_instance_of OpenTok::Archive
   end
 
+  it "should create hd archives", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    archive = archives.create session_id, { :output_mode => :composed, :resolution => "1280x720" }
+    expect(archive).to be_an_instance_of OpenTok::Archive
+    expect(archive.session_id).to eq session_id
+    expect(archive.output_mode).to eq :composed
+    expect(archive.resolution).to eq "1280x720"
+  end
+
+  it "should create archives throws exception", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    opts = {
+      :output_mode => :individual,
+      :resolution => "1280x720"
+    }
+
+    expect { archives.create session_id, opts }.to raise_exception
+  end
+
+  it "raise an error if layout options are empty" do
+    expect {
+      archives.layout(started_archive_id, {})
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if archive id is not provided" do
+    expect {
+      archives.layout("", {
+          type: "custom",
+          stylesheet: "the layout stylesheet (only used with type == custom)"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if custom type has no style sheet" do
+    expect {
+      archives.layout(started_archive_id, {
+          type: "custom",
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if non-custom type has style sheet" do
+    expect {
+      archives.layout(started_archive_id, {
+          type: "pip",
+          stylesheet: "the layout stylesheet (only used with type == custom)"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if invalid layout type" do
+    expect {
+      archives.layout(started_archive_id, {
+          type: "pip1"
+      })
+    }.to raise_error(ArgumentError)
+  end
+  it "calls layout on archive object", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    archive = archives.find findable_archive_id
+    expect(archive).to be_an_instance_of OpenTok::Archive
+    expect(archive.id).to eq findable_archive_id
+    expect {
+      archive.layout(
+          type: 'pip1',
+      )
+    }.to raise_error(ArgumentError)
+  end
+  it "changes the layout of an archive", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+     response = archives.layout(started_archive_id, {
+          type: "pip"
+      })
+     expect(response).not_to be_nil
+  end
+
   # TODO: context "with a session that has no participants" do
   #   let(:session_id) { "" }
   #   it "should refuse to create archives with appropriate error" do

data/spec/opentok/broadcasts_spec.rb

@@ -0,0 +1,171 @@
+require "opentok/broadcast"
+require "opentok/broadcasts"
+require "opentok/opentok"
+require "opentok/version"
+require "spec_helper"
+
+describe OpenTok::Broadcasts do
+  before(:each) do
+    now = Time.parse("2017-04-18 20:17:40 +1000")
+    allow(Time).to receive(:now) { now }
+  end
+
+  let(:api_key) { "123456" }
+  let(:api_secret) { "1234567890abcdef1234567890abcdef1234567890" }
+  let(:session_id) { "SESSIONID" }
+  let(:broadcast_id) { "BROADCASTID" }
+  let(:started_broadcast_id) { "13dbcc23-af92-4862-9184-74b21815a814" }
+  let(:opentok) { OpenTok::OpenTok.new api_key, api_secret }
+  let(:broadcast) { opentok.broadcasts }
+
+  subject { broadcast }
+
+  it 'raise an error on empty sessionId' do
+    opts = {
+        :outputs => {
+            :hls => {}
+        }
+    }
+    expect {
+      broadcast.create('', opts)
+    }.to raise_error(ArgumentError)
+  end
+  it 'raise an error on nil sessionId' do
+    opts = {
+        :outputs => {
+            :hls => {}
+        }
+    }
+    expect {
+      broadcast.create(nil, opts)
+    }.to raise_error(ArgumentError)
+  end
+  it 'raise an error on empty options' do
+    expect {
+      broadcast.create(nil, {})
+    }.to raise_error(ArgumentError)
+  end
+  it 'fetches a hls broadcast url', :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    opts = {
+        :outputs => {
+            :hls => {}
+        }
+    }
+    b_hls = broadcast.create(session_id, opts)
+    expect(b_hls).to be_an_instance_of OpenTok::Broadcast
+    expect(b_hls.id).to eq broadcast_id
+    expect(b_hls.broadcastUrls['hls']).to eq "https://cdn-broadcast001-pdx.tokbox.com/14787/14787_b930bf08-1c9f-4c55-ab04-7d192578c057.smil/playlist.m3u8"
+  end
+
+  it 'starts a rtmp broadcast', :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    opts = {
+        :outputs => {
+            :hls => {},
+            :rtmp => [
+                {
+                    :id => "rubyTestStream",
+                    :serverUrl => "rtmp://x.rtmp.youtube.com/live2",
+                    :streamName => "66c9-jwuh-pquf-9x18"
+                }
+            ]
+        }
+    }
+    b_rtmp = broadcast.create(session_id, opts)
+    expect(b_rtmp).to be_an_instance_of OpenTok::Broadcast
+    expect(b_rtmp.id).to eq broadcast_id
+    expect(b_rtmp.broadcastUrls["rtmp"][0]["serverUrl"]).to eq "rtmp://x.rtmp.youtube.com/live2"
+    expect(b_rtmp.broadcastUrls["rtmp"].count).to eq 1
+  end
+
+  it 'finds a broadcast', :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    b = broadcast.find started_broadcast_id
+    expect(b).to be_an_instance_of OpenTok::Broadcast
+    expect(b.id).to eq started_broadcast_id
+    expect(b.broadcastUrls["rtmp"][0]["serverUrl"]).to eq "rtmp://x.rtmp.youtube.com/live2"
+    expect(b.broadcastUrls["rtmp"].count).to eq 1
+  end
+  it 'raise an error on empty broadcastId in find' do
+    expect {
+      broadcast.find("")
+    }.to raise_error(ArgumentError)
+  end
+  it 'raise an error on nil broadcastId in find' do
+    expect {
+      broadcast.find(nil)
+    }.to raise_error(ArgumentError)
+  end
+  it 'raise an error on empty broadcastId stop' do
+    expect {
+      broadcast.stop("")
+    }.to raise_error(ArgumentError)
+  end
+  it 'raise an error on nil broadcastId stop' do
+    expect {
+      broadcast.stop(nil)
+    }.to raise_error(ArgumentError)
+  end
+  it 'stops a broadcast', :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    b = broadcast.stop(started_broadcast_id)
+    expect(b).to be_an_instance_of OpenTok::Broadcast
+    expect(b.id).to eq started_broadcast_id
+    expect(b.broadcastUrls).to be_nil
+    expect(b.status).to eq "stopped"
+  end
+
+  it "raise an error if layout options are empty" do
+    expect {
+      broadcast.layout(started_broadcast_id, {})
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if broadcast id is not provided" do
+    expect {
+      broadcast.layout("", {
+          type: "custom",
+          stylesheet: "the layout stylesheet (only used with type == custom)"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if custom type has no style sheet" do
+    expect {
+      broadcast.layout(started_broadcast_id, {
+          type: "custom",
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if non-custom type has style sheet" do
+    expect {
+      broadcast.layout(started_broadcast_id, {
+          type: "pip",
+          stylesheet: "the layout stylesheet (only used with type == custom)"
+      })
+    }.to raise_error(ArgumentError)
+  end
+
+  it "raise an error if invalid layout type" do
+    expect {
+      broadcast.layout(started_broadcast_id, {
+          type: "pip1"
+      })
+    }.to raise_error(ArgumentError)
+  end
+  it "calls layout on broadcast object", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    b = broadcast.find started_broadcast_id
+    expect(b).to be_an_instance_of OpenTok::Broadcast
+    expect(b.id).to eq started_broadcast_id
+    expect {
+      b.layout(
+          :type => 'pip1',
+          )
+    }.to raise_error(ArgumentError)
+  end
+  it "changes the layout of a broadcast", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    response = broadcast.layout(started_broadcast_id, {
+        :type => "verticalPresentation"
+    })
+    expect(response).not_to be_nil
+  end
+
+end

data/spec/opentok/connection_spec.rb

@@ -0,0 +1,38 @@
+require "opentok/opentok"
+require "opentok/version"
+require "opentok/connections"
+require "spec_helper"
+
+describe OpenTok::Connections do
+  before(:each) do
+    now = Time.parse("2017-04-18 20:17:40 +1000")
+    allow(Time).to receive(:now) { now }
+  end
+
+  let(:api_key) { "123456" }
+  let(:api_secret) { "1234567890abcdef1234567890abcdef1234567890" }
+  let(:session_id) { "SESSIONID" }
+  let(:connection_id) { "CONNID" }
+  let(:opentok) { OpenTok::OpenTok.new api_key, api_secret }
+  let(:connection) { opentok.connections }
+
+  subject { connection }
+
+
+  it 'raise an error on nil session_id' do
+    expect {
+      connection.forceDisconnect(nil,connection_id)
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'raise an error on nil connection_id' do
+    expect {
+      connection.forceDisconnect(session_id,nil)
+    }.to raise_error(ArgumentError)
+  end
+
+  it "forces a connection to be terminated", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"} } do
+    response = connection.forceDisconnect(session_id, connection_id)
+    expect(response).not_to be_nil
+  end
+end