opentok 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25c2985a61c6db455329b4cb491d573660acb9d0
-  data.tar.gz: e123cf51b9921306d2abec19a15a4dc6d1ce802c
+  metadata.gz: 1052af9a1320e87a85a196abc070ae11e2787b46
+  data.tar.gz: e9cc897d05cd2a4ec6bbba1f6051977c4038ed2c
 SHA512:
-  metadata.gz: e3e879ddd1f69bb0e03806fe0e2e594daadb8b11a964b3cd46ed26d7be161ab21df7d43af8d63803b8d0fe4aed9344f0eae2ae32245e144c99e0df00dddab51e
-  data.tar.gz: 7703872a8a0c651cab4cb92a15c0d5ba83b0b26a0ddac8843e6cd6ae0fe164446752361fb868c6cbd7a3cbd5475502af11c8124b9224c691d5d6ddecee200e43
+  metadata.gz: be8e2df42f9d64cd0541b9c0a631743ed03bcafe58a096deb2e47d2897d9b999a9e7062e1ca1f1a3f23294b9431e781cbe28653b6f25c945117638ff7874a31d
+  data.tar.gz: d64e401d965f0ca415ed34704abe17fbed51c82240da918ca2d5660adad8dc4911731a84e334f5f3d00dd1671f1134bd4be0e50df45bc4ca70ff5ca1acd32a68

data/.travis.yml

@@ -6,11 +6,11 @@ cache: bundler
 before_install: gem update bundler
 rvm:
 - 1.9.3
-- 2.0.0
-- 2.1.0
-- 2.2.0
-- 2.3.0
-- 2.4.0
+- 2.0
+- 2.1
+- 2.2
+- 2.3
+- 2.4
 notifications:
   slack:
     secure: agVll2R9PTPvJMcUgbvOh9eGt60zGDc8kPUwEsiQr828rCgXh/ZxD5irYDyKQg3ZsS8+f3MjFCwzU7uQALkia2pDrie9d8g8m1dt4Q5U7Qm6QecshvE0U9JwbB5Ngxaftbqyf0XEFrE7CKs7RI1BzFRpe8m+fdZgfwccX8Gb7pc=

data/README.md

@@ -17,7 +17,7 @@ Bundler helps manage dependencies for Ruby projects. Find more info here: <http:
 Add this gem to your `Gemfile`:
 
 ```ruby
-gem "opentok", "~> 2.4.1"
+gem "opentok", "~> 2.5.0"
 ```
 
 Allow bundler to install the change.
@@ -178,6 +178,24 @@ as the `:archive_mode` property of the `options` parameter passed into the
 For more information on archiving, see the
 [OpenTok archiving](https://tokbox.com/opentok/tutorials/archiving/) programming guide.
 
+
+## Initiating a SIP call
+
+You can initiate a SIP call using the `opentok.sip.dial(session_id, token, sip_uri, opts)` method.  This requires a SIP url. You will often need to pass options for authenticating to the SIP provider and specifying encrypted session establishment.
+
+
+```ruby
+opts = { "auth" => { "username" => sip_username,
+                     "password" => sip_password },
+         "secure" => "true"
+}
+response = opentok.sip.dial(session_id, token, "sip:+15128675309@acme.pstn.example.com;transport=tls", opts)
+```
+
+For more information on SIP Interconnect, see the
+[OpenTok SIP Interconnect](https://tokbox.com/developer/guides/sip/) programming guide.
+
+
 # Samples
 
 There are two sample applications included in this repository. To get going as fast as possible, clone the whole

data/lib/opentok/client.rb

@@ -162,5 +162,30 @@ module OpenTok
     rescue StandardError => e
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
+
+    def dial(session_id, token, sip_uri, opts)
+      opts.extend(HashExtensions)
+      body = { "sessionId" => session_id,
+               "token" => token,
+               "sip" => { "uri" => sip_uri }.merge(opts.camelize_keys!)
+      }
+
+      response = self.class.post("/v2/project/#{@api_key}/dial", {
+        :body => body.to_json,
+        :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 200
+        response
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed while dialing a sip session. API Key: #{@api_key}"
+      when 404
+        raise OpenTokSipError, "The sip session could not be dialed. The Session ID does not exist: #{session_id}"
+      else
+        raise OpenTokSipError, "The sip session could not be dialed"
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
   end
 end

data/lib/opentok/exceptions.rb

@@ -4,6 +4,8 @@ module OpenTok
   class OpenTokError < StandardError; end
   # Defines errors raised by archive-related methods of the OpenTok Ruby SDK.
   class OpenTokArchiveError < OpenTokError; end
+  # Defines errors raised by SIP methods of the OpenTok Ruby SDK.
+  class OpenTokSipError < OpenTokError; end
   # Defines errors raised when you attempt an operation using an invalid OpenTok API key or secret.
   class OpenTokAuthenticationError < OpenTokError; end
 

data/lib/opentok/opentok.rb

@@ -3,6 +3,7 @@ require "opentok/session"
 require "opentok/client"
 require "opentok/token_generator"
 require "opentok/archives"
+require "opentok/sip"
 
 require "resolv"
 require "set"
@@ -172,6 +173,10 @@ module OpenTok
       @archives ||= Archives.new client
     end
 
+    def sip
+      @sip ||= Sip.new client
+    end
+
     protected
 
     def client

data/lib/opentok/sip.rb

@@ -0,0 +1,13 @@
+require "opentok/client"
+
+module OpenTok
+  class Sip
+    def dial(session_id, token, sip_uri, opts)
+      response = @client.dial(session_id, token, sip_uri, opts)
+    end
+
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '2.4.1'
+  VERSION = '2.5.0'
 end

data/spec/cassettes/OpenTok_Sip/receives_a_valid_response.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/dial
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","token":"TOKENID","sip":{"uri":"sip:+15128675309@acme.pstn.example.com;transport=tls","auth":{"username":"bob","password":"abc123"},"secure":"true"}}'
+    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, 17 Apr 2017 22:40:03 GMT
+      Content-Type:
+      - application/json
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '311'
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains
+    body:
+      encoding: UTF-8
+      string: '{"id":"2299ba24-a6de-417c-88f7-28da54a441cf","projectId":"123456","sessionId":"SESSIONID","connectionId":"833a7182-61a5-49d4-baae-c324b09953af","streamId":"b1963d15-537f-459a-be89-e00fc310b82b","createdAt":1492468803946,"updatedAt":1492468803946}'
+    http_version: 
+  recorded_at: Mon, 17 Apr 2017 22:40:01 GMT
+recorded_with: VCR 2.8.0

data/spec/opentok/sip_spec.rb

@@ -0,0 +1,30 @@
+require "opentok/opentok"
+require "opentok/sip"
+require "spec_helper"
+
+describe OpenTok::Sip 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(:expiring_token) { "TOKENID" }
+  let(:sip_uri) { "sip:+15128675309@acme.pstn.example.com;transport=tls" }
+  let(:sip_username) { "bob" }
+  let(:sip_password) { "abc123" }
+  let(:opentok) { OpenTok::OpenTok.new api_key, api_secret }
+  let(:sip) { opentok.sip }
+  subject { sip }
+
+  it "receives a valid response", :vcr => { :erb => { :version => OpenTok::VERSION } } do
+    opts = { "auth" => { "username" => sip_username,
+                         "password" => sip_password },
+             "secure" => "true"
+    }
+    response = sip.dial(session_id, expiring_token, sip_uri, opts)
+    expect(response).not_to be_nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,6 +189,7 @@ files:
 - lib/opentok/extensions/hash.rb
 - lib/opentok/opentok.rb
 - lib/opentok/session.rb
+- lib/opentok/sip.rb
 - lib/opentok/token_generator.rb
 - lib/opentok/version.rb
 - opentok.gemspec
@@ -235,10 +236,12 @@ files:
 - 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/cassettes/OpenTok_OpenTok/when_initialized_properly/with_an_addendum_to_the_user_agent_string/should_append_the_addendum_to_the_user_agent_header.yml
+- spec/cassettes/OpenTok_Sip/receives_a_valid_response.yml
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/opentok_spec.rb
 - spec/opentok/session_spec.rb
+- spec/opentok/sip_spec.rb
 - spec/shared/opentok_generates_tokens.rb
 - spec/shared/session_generates_tokens.rb
 - spec/spec_helper.rb
@@ -291,10 +294,12 @@ test_files:
 - 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/cassettes/OpenTok_OpenTok/when_initialized_properly/with_an_addendum_to_the_user_agent_string/should_append_the_addendum_to_the_user_agent_header.yml
+- spec/cassettes/OpenTok_Sip/receives_a_valid_response.yml
 - spec/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/opentok_spec.rb
 - spec/opentok/session_spec.rb
+- spec/opentok/sip_spec.rb
 - spec/shared/opentok_generates_tokens.rb
 - spec/shared/session_generates_tokens.rb
 - spec/spec_helper.rb