opentok 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 455afd0fc38abc68b137c7bf8e5da6ccea11d7c1
-  data.tar.gz: b39ad5d10c8716cd862919d1c093c960c5163839
+  metadata.gz: 3da4263a70740969567f3f290b37bcfdc32b47a4
+  data.tar.gz: 1ece7e923d07c65332e2e6de269f9ab185558dce
 SHA512:
-  metadata.gz: 6419fea755f1cb4ec45c103a38ca00776b099a7aaa32bac5ea653ff4e64222bdea78bbafa89497f66247b9c6c065d2ef6e8951cfdb3b0e41e0abcf6162b19f67
-  data.tar.gz: b7dbdc094d7bcf2d60f751182fac654e908fc7b1844de8bf0a18e63ca3353d9d4a5c24dda3b2421747e04c1069dbebd6be1677c9d8e49953ca73713e9f9cb56c
+  metadata.gz: 7bc776d61daa44560cb43dd9c861ebe7c2056c03ffe6699e1d922139d44f610349b0220014d9d2bd0084c77712ada4a336b2ac96663a140bb554f56c300f4419
+  data.tar.gz: 6bacbf9f661e13d092b708006b297e9b13dbe9447a6c1b1016a030d529fcf29c48e2fa87848a7dd47f335ac1dc827d5cbcf1ce81c6416a7453923a17590113e3

data/lib/opentok/client.rb

@@ -14,11 +14,11 @@ module OpenTok
     # TODO: expose a setting for http debugging for developers
     # debug_output $stdout
 
-    def initialize(api_key, api_secret, api_url)
+    def initialize(api_key, api_secret, api_url, ua_addendum="")
       self.class.base_uri api_url
       self.class.headers({
         "X-TB-PARTNER-AUTH" => "#{api_key}:#{api_secret}",
-        "User-Agent" => "OpenTok-Ruby-SDK/#{VERSION}"
+        "User-Agent" => "OpenTok-Ruby-SDK/#{VERSION}" + (ua_addendum ? " #{ua_addendum}" : "")
       })
       @api_key = api_key
     end

data/lib/opentok/opentok.rb

@@ -56,7 +56,7 @@ module OpenTok
     # @private
     # don't want these to be mutable, may cause bugs related to inconsistency since these values are
     # cached in objects that this can create
-    attr_reader :api_key, :api_secret, :api_url
+    attr_reader :api_key, :api_secret, :api_url, :ua_addendum
 
     ##
     # Create a new OpenTok object.
@@ -64,13 +64,13 @@ module OpenTok
     # @param [String] api_key Your OpenTok API key. See the OpenTok dashboard
     #   (https://dashboard.tokbox.com).
     # @param [String] api_secret Your OpenTok API key.
-    # @param [String] api_url Do not set this parameter. It is for internal use by TokBox.
-    def initialize(api_key, api_secret, api_url=::OpenTok::API_URL)
+    # @option opts [Symbol] :api_url Do not set this parameter. It is for internal use by TokBox.
+    # @option opts [Symbol] :ua_addendum Do not set this parameter. It is for internal use by TokBox.
+    def initialize(api_key, api_secret, opts={})
       @api_key = api_key.to_s()
       @api_secret = api_secret
-      # TODO: do we really need a copy of this in the instance or should we overwrite the module
-      # constant so that other objects can access the same copy?
-      @api_url = api_url
+      @api_url = opts[:api_url] || API_URL
+      @ua_addendum = opts[:ua_addendum]
     end
 
     # Creates a new OpenTok session and returns the session ID, which uniquely identifies
@@ -175,7 +175,7 @@ module OpenTok
     protected
 
     def client
-      @client ||= Client.new api_key, api_secret, api_url
+      @client ||= Client.new api_key, api_secret, api_url, ua_addendum
     end
 
   end

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '2.3.2'
+  VERSION = '2.3.3'
 end

data/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

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/session/create
+    body:
+      encoding: UTF-8
+      string: p2p.preference=enabled
+    headers:
+      X-Tb-Partner-Auth:
+      - 123456:1234567890abcdef1234567890abcdef1234567890
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %> BOOYAH
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 Mar 2014 07:41:31 GMT
+      Content-Type:
+      - text/xml
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Tb-Host:
+      - fms503-nyc.tokbox.com
+      Content-Length:
+      - '282'
+    body:
+      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:
+  recorded_at: Thu, 06 Aug 2015 02:09:13 GMT
+recorded_with: VCR 2.8.0

data/spec/opentok/opentok_spec.rb

@@ -122,7 +122,7 @@ describe OpenTok::OpenTok do
 
     context "with an additional api_url" do
       let(:api_url) { "http://example.opentok.com" }
-      let(:opentok) { OpenTok::OpenTok.new api_key, api_secret, api_url }
+      let(:opentok) { OpenTok::OpenTok.new api_key, api_secret, :api_url => api_url }
 
       it { should be_an_instance_of(OpenTok::OpenTok) }
 
@@ -133,6 +133,23 @@ describe OpenTok::OpenTok do
       # TODO: i don't need to run all the tests, just a set that checks for the URL's effect
       # include_examples "generates tokens"
     end
+
+    context "with an addendum to the user agent string" do
+      let(:opentok) { OpenTok::OpenTok.new api_key, api_secret, :ua_addendum => ua_addendum }
+      let(:ua_addendum) { "BOOYAH"}
+
+      it { should be_an_instance_of(OpenTok::OpenTok) }
+
+      it "should have a ua_addendum property" do
+        expect(opentok.ua_addendum).to eq ua_addendum
+      end
+
+      # NOTE: ua_addendum is hardcoded into cassette
+      it "should append the addendum to the user agent header", :vcr => { :erb => { :version => OpenTok::VERSION } } do
+        session = opentok.create_session
+        expect(session).to be_an_instance_of OpenTok::Session
+      end
+    end
   end
 
   context "http client errors" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -247,6 +247,7 @@ files:
 - 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_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/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/opentok_spec.rb
@@ -301,6 +302,7 @@ test_files:
 - 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_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/matchers/token.rb
 - spec/opentok/archives_spec.rb
 - spec/opentok/opentok_spec.rb