opentok 0.1.3 → 2.2.0

metadata

@@ -1,132 +1,254 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Stijn Mathysen
 - Karmen Blake
 - Song Zheng
+- Patrick Quinn-Graham
+- Ankur Oberoi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.4
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.0
   type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 description: OpenTok is an API from TokBox that enables websites to weave live group
   video communication into their online experience. With OpenTok you have the freedom
-  and flexibility to create the most engaging web experience for your users. OpenTok
-  is currently available as a JavaScript and ActionScript 3.0 library. This gem allows
-  you to connect to the API from within Ruby (and Rails)
+  and flexibility to create the most engaging web experience for your users. This
+  gem lets you generate sessions and tokens for OpenTok applications. It also includes
+  support for working with OpenTok 2.0 archives. See <http://tokbox.com/opentok/platform>
+  for more details.
 email:
 - stijn@skylight.be
 - karmenblake@gmail.com
 - song@tokbox.com
+- pqg@tokbox.com
+- ankur@tokbox.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
-- CHANGES
+- .travis.yml
+- .yardopts
+- CONTRIBUTING.md
+- DEVELOPING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- doc/reference.md
-- lib/open_tok/archive.rb
-- lib/open_tok/archive_timeline_event.rb
-- lib/open_tok/archive_video_resource.rb
-- lib/open_tok/exception.rb
-- lib/open_tok/open_tok_sdk.rb
-- lib/open_tok/request.rb
-- lib/open_tok/role_constants.rb
-- lib/open_tok/session.rb
-- lib/open_tok/session_property_constants.rb
-- lib/open_tok/utils.rb
-- lib/open_tok/version.rb
+- doc/OpenTok.html
+- doc/OpenTok/Archive.html
+- doc/OpenTok/ArchiveList.html
+- doc/OpenTok/Archives.html
+- doc/OpenTok/Client.html
+- doc/OpenTok/OpenTok.html
+- doc/OpenTok/OpenTokArchiveError.html
+- doc/OpenTok/OpenTokAuthenticationError.html
+- doc/OpenTok/OpenTokError.html
+- doc/OpenTok/Session.html
+- doc/OpenTok/TokenGenerator.html
+- doc/OpenTok/TokenGenerator/ClassMethods.html
+- doc/README.md
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/opentok.rb
+- lib/opentok/archive.rb
+- lib/opentok/archive_list.rb
+- lib/opentok/archives.rb
+- lib/opentok/client.rb
+- lib/opentok/constants.rb
+- lib/opentok/exceptions.rb
+- lib/opentok/opentok.rb
+- lib/opentok/session.rb
+- lib/opentok/token_generator.rb
+- lib/opentok/version.rb
 - opentok.gemspec
-- sample/sample.rb
-- spec/cassettes/archives.yml
-- spec/cassettes/deleteArchive.yml
-- spec/cassettes/invalidSession.yml
-- spec/cassettes/session.yml
-- spec/cassettes/stitchArchive.yml
-- spec/opentok_exception_spec.rb
-- spec/opentok_spec.rb
+- sample/Archiving/Gemfile
+- sample/Archiving/README.md
+- sample/Archiving/archiving_sample.rb
+- sample/Archiving/public/css/sample.css
+- sample/Archiving/public/img/archiving-off.png
+- sample/Archiving/public/img/archiving-on-idle.png
+- sample/Archiving/public/img/archiving-on-message.png
+- sample/Archiving/public/js/host.js
+- sample/Archiving/public/js/participant.js
+- sample/Archiving/views/history.erb
+- sample/Archiving/views/host.erb
+- sample/Archiving/views/index.erb
+- sample/Archiving/views/layout.erb
+- sample/Archiving/views/participant.erb
+- sample/HelloWorld/Gemfile
+- sample/HelloWorld/README.md
+- sample/HelloWorld/hello_world.rb
+- sample/HelloWorld/public/js/helloworld.js
+- sample/HelloWorld/views/index.erb
+- spec/cassettes/OpenTok_Archives/should_create_archives.yml
+- spec/cassettes/OpenTok_Archives/should_create_named_archives.yml
+- spec/cassettes/OpenTok_Archives/should_delete_an_archive_by_id.yml
+- spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml
+- spec/cassettes/OpenTok_Archives/should_stop_archives.yml
+- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_all_archives.yml
+- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_archives_with_an_offset.yml
+- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_count_number_of_archives.yml
+- 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_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
+- spec/opentok/archives_spec.rb
+- spec/opentok/opentok_spec.rb
+- spec/opentok/session_spec.rb
+- spec/shared/opentok_generates_tokens.rb
+- spec/shared/session_generates_tokens.rb
 - spec/spec_helper.rb
-homepage: https://github.com/opentok/Opentok-Ruby-SDK
-licenses: []
+homepage: https://opentok.github.io/opentok-ruby-sdk
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -143,17 +265,33 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: opentok
+rubyforge_project: 
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: OpenTok gem
+summary: Ruby gem for the OpenTok API
 test_files:
-- spec/cassettes/archives.yml
-- spec/cassettes/deleteArchive.yml
-- spec/cassettes/invalidSession.yml
-- spec/cassettes/session.yml
-- spec/cassettes/stitchArchive.yml
-- spec/opentok_exception_spec.rb
-- spec/opentok_spec.rb
+- spec/cassettes/OpenTok_Archives/should_create_archives.yml
+- spec/cassettes/OpenTok_Archives/should_create_named_archives.yml
+- spec/cassettes/OpenTok_Archives/should_delete_an_archive_by_id.yml
+- spec/cassettes/OpenTok_Archives/should_find_archives_by_id.yml
+- spec/cassettes/OpenTok_Archives/should_stop_archives.yml
+- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_all_archives.yml
+- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_archives_with_an_offset.yml
+- spec/cassettes/OpenTok_Archives/when_many_archives_are_created/should_return_count_number_of_archives.yml
+- 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_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
+- spec/opentok/archives_spec.rb
+- spec/opentok/opentok_spec.rb
+- spec/opentok/session_spec.rb
+- spec/shared/opentok_generates_tokens.rb
+- spec/shared/session_generates_tokens.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---colour
---tty

data/CHANGES

@@ -1,33 +0,0 @@
-= Change Log
-
-== Version 0.0.8
-
-* Removed references to the staging environment as it no longer exists
-
-== Version 0.0.73
-
-* Added stitchArchive functionality
-* Updated Test Cases ( thanks to https://github.com/rlivsey )
-* Download Archive duplication and error catching ( thanks to https://github.com/muescha )
-
-== Version 0.0.5
-
-* Added connection_data to generate token method (thanks to https://github.com/jonmumm)
-
-== Version 0.0.4
-
-* Thanks to Ruslan Doroshenko (https://github.com/rdoroshenko) for adding the P2P constant to the SDK.
-
-== Version 0.0.3
-
-* minor fixes to the documentation
-
-== Version 0.0.2
-
-* Code cleanup
-* Included missing files
-* adding basic tests and documentation
-
-== Version 0.0.1
-
-Initial version

data/doc/reference.md

@@ -1,122 +0,0 @@
-OpenTok Ruby SDK reference
-==========================
-
-You need to instantiate an OpenTokSDK object before calling any of its methods.
-To create a new OpenTokSDK object, call the OpenTokSDK constructor with the API key
-and the API secret TokBox issued you. (You get an API key when you
-<a href="https://dashboard.tokbox.com/users/sign_in">sign up</a> for an OpenTok account.) Do not reveal
-your API secret string. You use it with the OpenTokSDK constructor (only on your web
-server) to create OpenTok sessions.
-
-    API_KEY = ''               # should be a string
-    API_SECRET = ''            # should be a string
-    OTSDK = OpenTok::OpenTokSDK.new API_KEY, API_SECRET
-
-create_session() method
------------------------
-The `create_session()` method of the OpenTokSDK object to create a new OpenTok
-session and obtain a session ID.
-
-The `create_session()` method has the following parameters:
-
-* `location` (String) &mdash; An IP address that TokBox will use to situate the session in its global network.
-  In general, you should not pass in a location hint (or pass in nil); if no location hint is passed in, the session
-uses a media server based on the location of the first client connecting to the session. Pass a location hint in only
-if you know the general geographic region (and a representative IP address) and you think the first client connecting
-may not be in that region.
-
-* `properties` (Object) &mdash; Optional. An object used to define
-peer-to-peer preferences for the session. The `properties` option includes one property &mdash;
-`p2p.preference` (a string). This property determines whether the session's streams will
-be transmitted directly between peers. You can set the following possible values:
-
-  * "disabled" (the default) &mdash; The session's streams will all be relayed using the OpenTok media server.
-    <br><br>
-    **In OpenTok v2:** The <a href="http://www.tokbox.com/blog/mantis-next-generation-cloud-technology-for-webrtc/">OpenTok
-media server</a> provides benefits not available in peer-to-peer sessions. For example, the OpenTok media server can
-decrease bandwidth usage in multiparty sessions. Also, the OpenTok server can improve the quality of the user experience
-through <a href="http://www.tokbox.com/blog/quality-of-experience-and-traffic-shaping-the-next-step-with-mantis/">dynamic
-traffic shaping</a>. For information on pricing, see the <a href="http://www.tokbox.com/pricing">OpenTok pricing page</a>.
-
-  * "enabled" &mdash; The session will attempt to transmit streams directly between clients.
-    <br><br>
-    **In OpenTok v1:** Peer-to-peer streaming decreases latency and improves quality. If peer-to-peer streaming
-fails (either when streams are initially published or during the course of a session), the session falls back to using
-the OpenTok media server to relaying streams. (Peer-to-peer streaming uses UDP, which may be blocked by a firewall.)
-For a session created with peer-to-peer streaming enabled, only two clients can connect to the session at a time.
-If an additional client attempts to connect, the TB object on the client dispatches an exception event.
-
-
-The `create_session` method returns a Session object. This
-object includes a `sessionID` property, which is the session ID for the
-new session. For example, when using the OpenTok JavaScript library, use this
-session ID in JavaScript on the page that you serve to the client.
-The JavaScript will use this value when calling the `connect()`
-method of the Session object (to connect a user to an OpenTok session).
-
-OpenTok sessions do not expire. However, authentication tokens do expire (see the next section on the
-generate_token() method.) Also note that sessions cannot explicitly be destroyed.
-
-Calling the `create_session()` method results in an `OpenTokException`
-in the event of an error. Check the error message for details.
-
-Here is a simple that creates a OpenTok server-enabled session:
-
-    sessionId = OTSDK.createSession().to_s
-
-Here is an example that creates a peer-to-peer session:
-
-    sessionProperties = {OpenTok::SessionPropertyConstants::P2P_PREFERENCE => "enabled"}
-    sessionId = OTSDK.createSession( nil, sessionProperties ).to_s
-
-You can also create a session using the <a href="http://www.tokbox.com/opentok/api/#session_id_production">OpenTok
-REST API</a> or the <a href="https://dashboard.tokbox.com/projects">OpenTok dashboard</a>.
-
-
-generate_token() method
------------------------
-
-In order to authenticate a user connecting to a OpenTok
-session, a user must pass an authentication token along with the API key.
-
-The method has the following parameters:
-
-* `session_id` (String) &mdash; The session ID corresponding to the session to which the user will connect.
-
-* `role` (String) &mdash; Optional. Each role defines a set of permissions granted to the token.
-Valid values are defined in the RoleConstants class in the server-side SDKs:
-
-  * `SUBSCRIBER` &mdash; A subscriber can only subscribe to streams.</li>
-  
-  * `PUBLISHER` &mdash; A publisher can publish streams, subscribe to streams, and signal.
-    (This is the default value if you do not specify a value for the `role` parameter.)</li>
-   
-  * `MODERATOR` &mdash; In addition to the privileges granted to a publisher, a moderator
-    can call the `forceUnpublish()` and `forceDisconnect()` method of the
-    Session object.</li>
-
-* `expire_time` (int) &mdash; Optional. The time when the token
-will expire, defined as an integer value for a Unix timestamp (in seconds).
-If you do not specify this value, tokens expire in 24 hours after being created.
-The `expiration_time` value, if specified, must be within 30 days
-of the creation time.
-
-* `connection_data` (String) &mdash; Optional. A string containing metadata describing the connection.
-For example, you can pass the user ID, name, or other data describing the connection.
-The length of the string is limited to 1000 characters.
-
-Calling the `generate_token()` method returns the token string.
-
-The following code example shows how to obtain a publisher token:
-
-    token = OTSDK.generateToken :session_id => sessionId
-
-The following PHP code example shows how to obtain a token that has a role of "moderator" and that has
-a connection metadata string:
-
-    role = OpenTok::RoleConstants::MODERATOR
-    connection_data = "username=Bob,level=4"
-    token = OTSDK.generateToken :session_id => sessionId, :role => role, :connection_data => connection_data
-
-For testing, you can also use the <a href="https://dashboard.tokbox.com/projects">OpenTok dashboard</a>
-page to generate test tokens.