opentok 0.0.5 → 0.0.6

data/CHANGES

@@ -1,5 +1,9 @@
 = Change Log
 
+== Version 0.0.6
+
+* Thanks to Song Zheng for doing the following updates; Updated README for clarification. Also added test case to validate token parameters
+
 == Version 0.0.5
 
 * Added connection_data to generate token method (thanks to https://github.com/jonmumm)

data/README.md

@@ -0,0 +1,85 @@
+# Opentok
+
+OpenTok is a free set of APIs 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. Check out <http://www.tokbox.com/> and <http://www.tokbox.com/opentok/tools/js/gettingstarted> for more information.
+
+This is the official Opentok rubygem.
+
+## Installation
+
+To install using bundler, add Opentok to your `gemfile` and run `bundle install`:
+<pre>
+gem 'opentok'
+</pre>
+
+To install as a regular gem just type `gem install opentok`
+
+## How to use
+
+### API-key and secret
+
+Request your api-key and secret at <http://www.tokbox.com/opentok/tools/js/apikey>. You can use the staging environment for testing. The gem uses this staging environment by default.
+
+### OpenTokSDK
+
+In order to use any of the server side functions, you must first create an `OpenTokSDK` object with your developer credentials.  
+You must pass in your *Key* and *Secret*. If your app is in production, you must also pass in a hash containing `api_url`  
+For more information about production apps, check out <http://www.tokbox.com/opentok/api/tools/js/launch>
+
+Example: ( Staging )
+<pre>
+@api_key = ''                # should be a string
+@api_secret = ''            # should be a string
+@opentok = OpenTok::OpenTokSDK.new @api_key, @api_secret
+</pre>
+
+Example: ( Production )
+<pre>
+@opentok = OpenTok::OpenTokSDK.new @api_key, @api_secret, :api_url => 'https://api.opentok.com/hl'
+</pre>
+
+### Creating Sessions
+Use your `OpenTokSDK` object to create `session_id`  
+`create_session` takes 1-2 parameters:
+> location (string) -  give Opentok a hint on where you are running your application  
+> properties (object) - OPTIONAL. Set peer to peer as `enabled` or `disabled`
+
+Example: P2P disabled by default
+<pre>
+@location = 'localhost'
+session_id = @opentok.create_session(@location)
+</pre>
+
+Example: P2P enabled
+<pre>
+session_properties = {OpenTok::SessionPropertyConstants::P2P_PREFERENCE => "enabled"}    # or disabled
+session_id = @opentok.create_session( @location, session_properties )
+</pre>
+
+### Generating Token
+With the generated session_id, you can start generating tokens for each user.
+`generate_token` takes in hash with 1-4 properties:
+> session_id (string) - required  
+> role (string) - OPTIONAL. subscriber, publisher, or moderator  
+> expire_time (int) - OPTIONAL. Time when token will expire in unix timestamp  
+> connection_data (string) - OPTIONAL. Metadata to store data (names, user id, etc)
+
+Example:
+<pre>
+token = @opentok.generate_token :session_id => session, :role => OpenTok::RoleConstants::PUBLISHER, :connection_data => "username=Bob,level=4"
+</pre>
+
+### Downloading Archive Videos
+To Download archives, first you must first create a token that has a **moderator** role
+
+### Get Archive Manifest
+`get_archive_manifest()` takes in 2 parameters: **archiveId** and **moderator token**  
+> **returns** an `OpenTokArchive`. The *resources* property of this object is array of `OpenTokArchiveVideoResource`, and each `OpenTokArchiveVideoResource` object represents a video in the archive.
+
+### Get video ID
+With your `OpenTokArchive` object, call `getId()`
+`getId()` will return the video ID (a String)
+
+### Get Download Url
+`downloadArchiveURL` takes 1 parameters: `video ID` and returns download URL for the video 
+ 
+

data/lib/monkey_patches.rb

@@ -2,7 +2,7 @@
  OpenTok Ruby Library
  http://www.tokbox.com/
 
- Copyright 2010, TokBox, Inc.
+ Copyright 2010 - 2011, TokBox, Inc.
 
  Last modified: 2011-02-17
 =end

data/lib/open_tok/archive.rb

@@ -0,0 +1,40 @@
+=begin
+ OpenTok Ruby Library v0.90.0
+ http://www.tokbox.com/
+
+ Copyright 2010 - 2011, TokBox, Inc.
+=end
+
+module OpenTok
+  class Archive
+    attr_accessor :archive_id, :archive_title, :resources, :timeline
+
+    def initialize(archive_id, archive_title, resources, timeline)
+      @archive_id = archive_id
+      @archive_title = archive_title
+      @resources = resources
+      @timeline = timeline
+    end
+
+    def download_archive_url(video_id)
+      "#{API_URL}/archive/url/#{@archive_id}/#{video_id}" 
+    end
+
+    def self.parse_manifest(manifest)
+      archive_id = manifest.attributes['archiveid']
+      archive_title = manifest.attributes['title']
+
+      resources = []
+      manifest.get_elements("resources")[0].get_elements("video").each do |video|
+        resources << OpenTok::ArchiveVideoResource.parseXML(video)
+      end
+
+      timeline = []
+      manifest.get_elements("timeline")[0].get_elements("event").each do |event|
+        timeline << OpenTok::ArchiveTimelineEvent.parseXML(event)
+      end
+
+      OpenTok::Archive.new(archive_id, archive_title, resources, timeline)
+    end
+  end
+end

data/lib/open_tok/archive_timeline_event.rb

@@ -0,0 +1,22 @@
+=begin
+ OpenTok Ruby Library v0.90.0
+ http://www.tokbox.com/
+
+ Copyright 2010 - 2011, TokBox, Inc.
+=end
+
+module OpenTok
+  class ArchiveTimelineEvent
+    attr_accessor :event_type, :resource_id, :offset
+    
+    def initialize(event_type, resource_id, offset)
+      @event_type = event_type
+      @resource_id = resource_id
+      @offset = offset
+    end
+
+    def self.parseXML(timeline_item)
+      OpenTok::ArchiveTimelineEvent.new(timeline_item.attributes['type'], timeline_item.attributes['id'], timeline_item.attributes['offset'])
+    end
+  end  
+end

data/lib/open_tok/archive_video_resource.rb

@@ -0,0 +1,24 @@
+=begin
+ OpenTok Ruby Library v0.90.0
+ http://www.tokbox.com/
+
+ Copyright 2010 - 2011, TokBox, Inc.
+=end
+
+module OpenTok
+  class ArchiveVideoResource
+    attr_reader :type
+    attr_accessor :id, :length
+
+    def initialize(id, length)
+      @id = id
+      @type = "video"
+      @length = length
+    end
+
+    def self.parseXML(video_resource_item)
+      OpenTok::ArchiveVideoResource.new(video_resource_item.attributes['id'], video_resource_item.attributes['length'])
+    end
+  end
+  
+end

data/lib/open_tok/{exceptions.rb → exception.rb}

@@ -2,7 +2,7 @@
  OpenTok Ruby Library
  http://www.tokbox.com/
 
- Copyright 2010, TokBox, Inc.
+ Copyright 2010 - 2011, TokBox, Inc.
 
 =end
 
@@ -12,5 +12,4 @@ module OpenTok
   class OpenTokException < RuntimeError
   end
 
-end
-
+end

data/lib/open_tok/open_tok_sdk.rb

@@ -2,7 +2,7 @@
  OpenTok Ruby Library
  http://www.tokbox.com/
 
- Copyright 2010, TokBox, Inc.
+ Copyright 2010 - 2011, TokBox, Inc.
 
 =end
 
@@ -17,25 +17,36 @@ DIGEST  = OpenSSL::Digest::Digest.new('sha1')
 
 module OpenTok
 
+  # SessionPropertyConstants
+  #
+  # * +ECHOSUPPRESSION_ENABLED+ boolean
+  # * +MULTIPLEXER_NUMOUTPUTSTREAMS+ integer
+  # * +MULTIPLEXER_SWITCHTYPE+ integer
+  # * +MULTIPLEXER_SWITCHTIMEOUT+ integer
+  # * +P2P_PREFERENCE+ string
   class SessionPropertyConstants
-    ECHOSUPPRESSION_ENABLED = "echoSuppression.enabled"; #Boolean
-    MULTIPLEXER_NUMOUTPUTSTREAMS = "multiplexer.numOutputStreams"; #Integer
-    MULTIPLEXER_SWITCHTYPE = "multiplexer.switchType"; #Integer
-    MULTIPLEXER_SWITCHTIMEOUT = "multiplexer.switchTimeout"; #Integer
-    P2P_PREFERENCE = "p2p.preference"; #String
+    ECHOSUPPRESSION_ENABLED = "echoSuppression.enabled" #Boolean
+    MULTIPLEXER_NUMOUTPUTSTREAMS = "multiplexer.numOutputStreams" #Integer
+    MULTIPLEXER_SWITCHTYPE = "multiplexer.switchType" #Integer
+    MULTIPLEXER_SWITCHTIMEOUT = "multiplexer.switchTimeout" #Integer
+    P2P_PREFERENCE = "p2p.preference" #String
   end
 
+  # RoleConstants
+  #
+  # * +SUBSCRIBER+ Can only subscribe
+  # * +PUBLISHER+ Can publish, subscribe, and signal
+  # * +MODERATOR+ Can do the above along with forceDisconnect and forceUnpublish
   class RoleConstants
     SUBSCRIBER = "subscriber" #Can only subscribe
-    PUBLISHER = "publisher"   #Can publish, subscribe, and signal
-    MODERATOR = "moderator"   #Can do the above along with  forceDisconnect and forceUnpublish
+    PUBLISHER = "publisher" #Can publish, subscribe, and signal
+    MODERATOR = "moderator" #Can do the above along with  forceDisconnect and forceUnpublish
   end
 
   class OpenTokSDK
     attr_accessor :api_url
 
     @@TOKEN_SENTINEL = "T1=="
-    @@SDK_VERSION = "tbruby-%s" % [ VERSION ]
 
     # Create a new OpenTokSDK object.
     #
@@ -66,12 +77,16 @@ module OpenTok
     #
     # See http://www.tokbox.com/opentok/tools/documentation/overview/token_creation.html for more information on all options.
     def generate_token(opts = {})
-      {:session_id=>nil, :create_time=>nil, :expire_time=>nil, :role=>nil, :connection_data=>nil}.merge!(opts)
+      { :session_id => nil, :create_time => nil, :expire_time => nil, :role => nil, :connection_data => nil }.merge!(opts)
 
-      create_time = opts[:create_time].nil? ? Time.now  :  opts[:create_time]
+      create_time = opts[:create_time].nil? ? Time.now : opts[:create_time]
       session_id = opts[:session_id].nil? ? '' : opts[:session_id]
       role = opts[:role].nil? ? RoleConstants::PUBLISHER : opts[:role]
 
+      if role != RoleConstants::SUBSCRIBER && role != RoleConstants::PUBLISHER && role != RoleConstants::MODERATOR
+        raise OpenTokException.new "'#{role}' is not a recognized role"
+      end
+
       data_params = {
         :role => role,
         :session_id => session_id,
@@ -80,6 +95,9 @@ module OpenTok
       }
 
       if not opts[:expire_time].nil?
+        raise OpenTokException.new 'Expire time must be a number' if not opts[:expire_time].is_a?(Numeric)
+        raise OpenTokException.new 'Expire time must be in the future' if opts[:expire_time] < Time.now.to_i
+        raise OpenTokException.new 'Expire time must be in the next 7 days' if opts[:expire_time] > (Time.now.to_i + 604800)
         data_params[:expire_time] = opts[:expire_time].to_i
       end
 
@@ -93,11 +111,10 @@ module OpenTok
       sig = sign_string(data_string, @partner_secret)
       meta_string = {
         :partner_id => @partner_id,
-        :sdk_version => @@SDK_VERSION,
         :sig => sig
       }.urlencode
 
-      @@TOKEN_SENTINEL + Base64.encode64(meta_string + ":" + data_string).gsub("\n","")
+      @@TOKEN_SENTINEL + Base64.encode64(meta_string + ":" + data_string).gsub("\n", '')
     end
 
     # Generates a new OpenTok::Session and set it's session_id, situating it in TokBox's global network near the IP of the specified @location@.
@@ -112,6 +129,16 @@ module OpenTok
       OpenTok::Session.new(doc.root.get_elements('Session')[0].get_elements('session_id')[0].children[0].to_s)
     end
 
+    # This method takes two parameters. The first parameter is the +archive_id+ of the archive that contains the video (a String). The second parameter is the +token+ (a String)
+    # The method returns an +OpenTok::Archive+ object. The resources property of this object is an array of OpenTok::ArchiveVideoResource objects. Each OpenTok::ArchiveVideoResource object represents a video in the archive.
+    def get_archive_manifest(archive_id, token)
+      doc = do_request("/archive/getmanifest/#{archive_id}", {}, token)
+      if not doc.get_elements('Errors').empty?
+        raise OpenTokException.new doc.get_elements('Errors')[0].get_elements('error')[0].children.to_s
+      end
+      OpenTok::Archive.parse_manifest(doc.get_elements('manifest')[0])
+    end
+
     protected
     def sign_string(data, secret)
       OpenSSL::HMAC.hexdigest(DIGEST, secret, data)

data/lib/open_tok/session.rb

@@ -2,9 +2,7 @@
  OpenTok Ruby Library v0.90.0
  http://www.tokbox.com/
 
- Copyright 2010, TokBox, Inc.
-
- Date: November 05 14:50:00 2010
+ Copyright 2010 - 2011, TokBox, Inc.
 =end
 
 module OpenTok
@@ -22,4 +20,3 @@ module OpenTok
     end
   end
 end
-

data/lib/open_tok/version.rb

@@ -1,3 +1,3 @@
 module Opentok
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/opentok.rb

@@ -2,7 +2,7 @@
  OpenTok Ruby Library
  http://www.tokbox.com/
 
- Copyright 2010, TokBox, Inc.
+ Copyright 2010 - 2011, TokBox, Inc.
 
  Last modified: 2011-02-17
 =end
@@ -21,7 +21,10 @@ module OpenTok
   API_URL = "https://staging.tokbox.com/hl"
   
   require 'monkey_patches'
-  require 'open_tok/exceptions'
+  require 'open_tok/exception'
   require 'open_tok/open_tok_sdk'
   require 'open_tok/session'
+  require 'open_tok/archive'
+  require 'open_tok/archive_video_resource'
+  require 'open_tok/archive_timeline_event'
 end

data/spec/opentok_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe OpenTok do
   
   before :all do
-    @api_key = 459782
+    @api_key = '459782'
     @api_secret = 'b44c3baa32b6476d9d88e8194d0eb1c6b777f76b'
     @api_staging_url = 'https://staging.tokbox.com/hl'
     @api_production_url = 'https://api.opentok.com/hl'
@@ -60,5 +60,21 @@ describe OpenTok do
       
       token.should match(/\A[0-9A-z=]+\Z/)
     end
+
+    it "should be able to set parameters in token" do
+      token = @opentok.generate_token :session_id => @valid_session.to_s, :role=> OpenTok::RoleConstants::PUBLISHER, :connection_data => "username=Bob,level=4"
+
+      str = token[4..token.length]
+      decoded = Base64.decode64(str)
+
+      decoded.should match(/publisher.*username.*Bob.*level.*4/)
+    end
+  end
+
+  describe "Archive Download" do
+    before :all do
+      @opentok = OpenTok::OpenTokSDK.new @api_key, @api_secret
+      @valid_session = @opentok.create_session(@host).to_s
+    end
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: opentok
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Stijn Mathysen
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-30 00:00:00 Z
+date: 2012-04-27 00:00:00 Z
 dependencies: []
 
 description: OpenTok is a free set of APIs 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)
@@ -34,7 +34,7 @@ files:
 - CHANGES
 - Gemfile
 - LICENCE
-- README.textile
+- README.md
 - Rakefile
 - doc/CHANGES.html
 - doc/Gemfile.html
@@ -85,7 +85,10 @@ files:
 - doc/spec/opentok_spec_rb.html
 - doc/spec/spec_helper_rb.html
 - lib/monkey_patches.rb
-- lib/open_tok/exceptions.rb
+- 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/session.rb
 - lib/open_tok/version.rb
@@ -122,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: opentok
-rubygems_version: 1.8.3
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: OpenTok gem

data/README.textile

@@ -1,43 +0,0 @@
-h1. Opentok
-
-OpenTok is a free set of APIs 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. Check out http://www.tokbox.com/ and http://www.tokbox.com/opentok/tools/js/gettingstarted for more information.
-
-This is the official Opentok rubygem.
-
-h2. Installation
-
-To install using bundler, add Opentok to you @gemfile@ and run `bundle install`:
-
-<pre>
-gem 'opentok'
-</pre>
-
-To install as a regular gem just type `gem install opentok`
-
-h2. How it works
-
-h3. API-key and secret
-
-Request your api-key and secret at http://www.tokbox.com/opentok/tools/js/apikey. You can use the staging environment for testing. The gem uses this staging environment by default.
-
-h3. Create a session
-
-With the following code, you can generate a valid @session_id@.
-<pre>
-@api_key = 0                # should be a number
-@api_secret = ''            # should be a string
-@location = 'localhost'     # give Opentok a hint on where you are running your application
-
-@opentok = OpenTok::OpenTokSDK.new @api_key, @api_secret
-    
-@session_id = @opentok.create_session(@host)
-</pre>
-
-h3. Create tokens
-
-With the generated session_id, you can start generating tokens for each user.
-<pre>
-@opentok.generate_token :session_id => "#{@session_id}"
-</pre>
-
-Typically you would create one @session_id@ and store it (in e.g. a setting) and share that @session_id@ between all users.