opentok 0.0.92 → 0.1.0

data/.rspec

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

data/README.md

@@ -14,12 +14,12 @@ To install as a regular gem just type `gem install opentok`
 
 ## Requirements
 
-You need an api-key and secret. Request them at <http://www.tokbox.com/opentok/tools/js/apikey>.
+You need an api-key and secret. Sign up at <http://www.tokbox.com/opentok/tools/js/apikey>.
 
 # OpenTokSDK
 
 In order to use any of the server side functions, you must first create an `OpenTokSDK` object with your developer credentials.  
-`OpenTokSDK` takes 2-3 parameters:
+`OpenTokSDK` takes 2 parameters:
 > key (string) - Given to you when you register  
 > secret (string) - Given to you when you register  
 
@@ -31,22 +31,25 @@ OTSDK = OpenTok::OpenTokSDK.new API_KEY, API_SECRET
 </pre>
 
 
-# Creating Sessions
+## Creating Sessions
 Use your `OpenTokSDK` object to create `session_id`  
 `createSession` 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`. Disabled by default
+> location (string) -  OPTIONAL. a location so OpenTok can stream through the closest server  
+> properties (object) - OPTIONAL. Set peer to peer as `enabled` or `disabled`. Disabled by default  
 
 <pre>
+# creating a simple session: closest streaming server will be automatically determined when user connects to session
+sessionId = OTSDK.createSession().to_s
+
 # Creating Session object, passing request IP address to determine closest production server
-session_id = OTSDK.createSession( request.ip )
+sessionId = OTSDK.createSession( request.remote_ip ).to_s
 
 # Creating Session object with p2p enabled
 sessionProperties = {OpenTok::SessionPropertyConstants::P2P_PREFERENCE => "enabled"}    # or disabled
-sessionId = OTSDK.createSession( @location, sessionProperties )
+sessionId = OTSDK.createSession( @location, sessionProperties ).to_s
 </pre>
 
-# Generating Token
+## Generating Tokens
 With the generated sessionId, you can start generating tokens for each user.
 `generate_token` takes in hash with 1-4 properties:
 > session_id (string) - REQUIRED  
@@ -59,10 +62,14 @@ With the generated sessionId, you can start generating tokens for each user.
 token = OTSDK.generateToken :session_id => session, :role => OpenTok::RoleConstants::PUBLISHER, :connection_data => "username=Bob,level=4"
 </pre>
 
-# Manipulating Archive Videos
+Possible Errors:
+> "Null or empty session ID are not valid"  
+> "An invalid session ID was passed"
+
+## Manipulating Archive Videos
 To Download or delete archived video, you must have an Archive ID which you get from the javascript library. If you are unfamiliar with archiving concepts, please visit our [archiving tutorial](http://www.tokbox.com/opentok/api/documentation/gettingstartedarchiving)  
 
-# Delete Archives
+## Delete Archives
 OpenTok SDK has a function `deleteArchive` that lets you delete videos in a recorded archive. 
 Use your `OpenTokSDK` object to call `deleteArchive`
 `deleteArchive` takes in 2 parameters and returns a true or false boolean representing the success of the delete request

data/lib/open_tok/archive.rb

@@ -19,35 +19,35 @@ module OpenTok
     end
 
     def do_request(path, token)
-      OpenTok::Request.new(@api_url, token).fetch(path)
+      Request.new(@api_url, token).fetch(path)
     end
 
     def download_archive_url(video_id, token="")
-      if token==""
+      if token.empty?
         # this token check supports previous implementation of download_archive_url
-        return "#{@api_url}/archive/url/#{@archive_id}/#{video_id}"
+        "#{@api_url}/archive/url/#{@archive_id}/#{video_id}"
       else
-        doc = do_request "/archive/url/#{@archive_id}/#{video_id}", token
-        return doc
+        do_request "/archive/url/#{@archive_id}/#{video_id}", token
       end
     end
+
     alias_method :downloadArchiveURL, :download_archive_url
 
-    def self.parse_manifest(manifest, apiUrl, token)
+    def self.parse_manifest(manifest, api_url, token)
       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)
+      manifest.get_elements('resources')[0].get_elements('video').each do |video|
+        resources << ArchiveVideoResource.parseXML(video)
       end
 
       timeline = []
-      manifest.get_elements("timeline")[0].get_elements("event").each do |event|
-        timeline << OpenTok::ArchiveTimelineEvent.parseXML(event)
+      manifest.get_elements('timeline')[0].get_elements('event').each do |event|
+        timeline << ArchiveTimelineEvent.parseXML(event)
       end
 
-      OpenTok::Archive.new(archive_id, archive_title, resources, timeline, apiUrl, token)
+      Archive.new archive_id, archive_title, resources, timeline, api_url, token
     end
   end
 end

data/lib/open_tok/archive_timeline_event.rb

@@ -8,7 +8,7 @@
 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
@@ -16,7 +16,7 @@ module OpenTok
     end
 
     def self.parseXML(timeline_item)
-      OpenTok::ArchiveTimelineEvent.new(timeline_item.attributes['type'], timeline_item.attributes['id'], timeline_item.attributes['offset'])
+      OpenTok::ArchiveTimelineEvent.new timeline_item.attributes['type'], timeline_item.attributes['id'], timeline_item.attributes['offset']
     end
-  end  
+  end
 end

data/lib/open_tok/archive_video_resource.rb

@@ -21,8 +21,8 @@ module OpenTok
     end
 
     def self.parseXML(video_resource_item)
-      OpenTok::ArchiveVideoResource.new(video_resource_item.attributes['id'], video_resource_item.attributes['length'])
+      ArchiveVideoResource.new video_resource_item.attributes['id'], video_resource_item.attributes['length']
     end
   end
-  
+
 end

data/lib/open_tok/exception.rb

@@ -10,6 +10,44 @@ module OpenTok
 
   # The exception that gets thrown when an invalid api-key and/or secret is given.
   class OpenTokException < RuntimeError
+
+    def initialize(code, message)
+      @code = code
+      @mesasge = message
+    end
+
+    class << self
+      def inherited(subclass)
+        exceptions << subclass
+      end
+
+      def exceptions
+        @exceptions ||= []
+      end
+
+      ##
+      # Generates the relevant exception instance based on the XML error data received
+      def from_error(error)
+        child = error.get_elements('Errors')[0].get_elements('error')[0]
+        code = child.attributes['code']
+        exception = exceptions.find{|exc| exc.http_code == code }
+        exception ||= self
+        message = child.children.empty? ? '' : child.children[0].attributes['message']
+        exception.new code, message
+      end
+
+      # To be overriden by subclasses
+      def http_code
+        '000'
+      end
+    end
+
+  end
+
+  class OpenTokNotFound < OpenTokException
+    def self.http_code
+      '404'
+    end
   end
 
 end

data/lib/open_tok/open_tok_sdk.rb

@@ -10,142 +10,163 @@ require 'openssl'
 require 'base64'
 require 'rexml/document'
 
-DIGEST  = OpenSSL::Digest::Digest.new('sha1')
+DIGEST  = OpenSSL::Digest::Digest.new 'sha1'
 
 module OpenTok
 
-  # SessionPropertyConstants
-  #
-  # * +ECHOSUPPRESSION_ENABLED+ boolean
-  # * +MULTIPLEXER_NUMOUTPUTSTREAMS+ integer
-  # * +MULTIPLEXER_SWITCHTYPE+ integer
-  # * +MULTIPLEXER_SWITCHTIMEOUT+ integer
-  # * +P2P_PREFERENCE+ string
-  module 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
-  end
-
-  # RoleConstants
-  #
-  # * +SUBSCRIBER+ Can only subscribe
-  # * +PUBLISHER+ Can publish, subscribe, and signal
-  # * +MODERATOR+ Can do the above along with forceDisconnect and forceUnpublish
-  module RoleConstants
-    SUBSCRIBER = "subscriber" #Can only subscribe
-    PUBLISHER = "publisher" #Can publish, subscribe, and signal
-    MODERATOR = "moderator" #Can do the above along with  forceDisconnect and forceUnpublish
-  end
+  autoload :Archive                 , 'open_tok/archive'
+  autoload :ArchiveVideoResource    , 'open_tok/archive_video_resource'
+  autoload :ArchiveTimelineEvent    , 'open_tok/archive_timeline_event'
+  autoload :OpenTokException        , 'open_tok/exception'
+  autoload :Request                 , 'open_tok/request'
+  autoload :RoleConstants           , 'open_tok/role_constants'
+  autoload :Session                 , 'open_tok/session'
+  autoload :SessionPropertyConstants, 'open_tok/session_property_constants'
+  autoload :Utils                   , 'open_tok/utils'
 
   class OpenTokSDK
-    attr_accessor :api_url
+    attr_reader :api_url
 
-    @@TOKEN_SENTINEL = "T1=="
+    TOKEN_SENTINEL = "T1=="
 
-    # Create a new OpenTokSDK object.
+    ##
+    # Create a new OpenTok REST API client
     #
-    # The first two attributes are required; +parnter_id+ and +partner_secret+ are the api-key and secret
-    # that are provided to you.
-    def initialize(partner_id, partner_secret, backSupport="")
+    # @param [String] API Key, developer identifier
+    # @param [String] API Secret, developer identifier
+    # @param [String] back_support @deprecated
+    # @param [String] OpenTok endpoint, production by default
+    def initialize(partner_id, partner_secret, back_support = '', api_url = OpenTok::API_URL)
       @partner_id = partner_id
       @partner_secret = partner_secret
-      @api_url = API_URL
+      @api_url = api_url
     end
 
-    # Generate token for the given session_id. The options you can provide are;
-    # * +:session_id+ (required) generate a token for the provided session
-    # * +:create_time+
-    # * +:expire_time+ (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.
-    # * +:role+ (optional) Added in OpenTok v0.91.5. This defines the role the user will have. There are three roles: subscriber, publisher, and moderator.
-    # * +:connection_data+ (optional) Added in OpenTok v0.91.20. A string containing metadata describing the connection.
+    ##
+    # Generate token for the given session_id
     #
+    # @param [Hash] opts the options to create a token with.
+    # @option opts [String] :session_id (mandatory) generate a token for the provided session
+    # @option opts [String] :create_time (optional)
+    # @option opts [String] :expire_time (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.
+    # @option opts [String] :role (optional) Added in OpenTok v0.91.5. This defines the role the user will have. There are three roles: subscriber, publisher, and moderator.
+    # @option opts [String] :connection_data (optional) Added in OpenTok v0.91.20. A string containing metadata describing the connection.
     # 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)
+      create_time = opts.fetch(:create_time, Time.now)
+      session_id = opts.fetch(:session_id, '').to_s
 
-      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]
+      # check validity of session_id
+      if !session_id || session_id.to_s.length == ""
+        raise "Null or empty session ID are not valid"
+      end
 
-      if role != RoleConstants::SUBSCRIBER && role != RoleConstants::PUBLISHER && role != RoleConstants::MODERATOR
-        raise OpenTokException.new "'#{role}' is not a recognized role"
+      begin
+        subSessionId = session_id[2..session_id.length]
+        subSessionId.sub!("-","+").sub!("_","/")
+        decodedSessionId = Base64.decode64(subSessionId).split("~")
+        (0..4).each do |n|
+          if decodedSessionId and decodedSessionId.length > 1
+            break
+          end
+          subSessionId = subSessionId+"="
+        end
+        unless decodedSessionId[1] == @partner_id
+          raise "An invalid session ID was passed"
+        end
+      rescue Exception => e
+        raise "An invalid session ID was passed"
       end
 
+
+      role = opts.fetch(:role, RoleConstants::PUBLISHER)
+
+      RoleConstants.is_valid?(role) or raise OpenTokException.new "'#{role}' is not a recognized role"
+
       data_params = {
         :role => role,
-        :session_id => session_id,
+        :session_id => session_id.is_a?(Session) ? session_id.session_id : session_id,
         :create_time => create_time.to_i,
         :nonce => rand
       }
 
-      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 30 days' if opts[:expire_time] > (Time.now.to_i + 2592000)
+      unless opts[:expire_time].nil?
+        opts[:expire_time].is_a?(Numeric) or raise OpenTokException.new 'Expire time must be a number'
+        opts[:expire_time] < Time.now.to_i and raise OpenTokException.new 'Expire time must be in the future'
+        opts[:expire_time] > (Time.now.to_i + 2592000) and raise OpenTokException.new 'Expire time must be in the next 30 days'
         data_params[:expire_time] = opts[:expire_time].to_i
       end
 
-      if not opts[:connection_data].nil?
-        raise OpenTokException.new 'Connection data must be less than 1000 characters' if opts[:connection_data].length > 1000
+      unless opts[:connection_data].nil?
+        opts[:connection_data].length > 1000 and raise OpenTokException.new 'Connection data must be less than 1000 characters'
         data_params[:connection_data] = opts[:connection_data]
       end
 
-      data_string = OpenTok::Utils.urlencode_hash(data_params)
+      data_string = Utils.urlencode_hash(data_params)
 
-      sig = sign_string(data_string, @partner_secret)
-      meta_string = OpenTok::Utils.urlencode_hash(:partner_id => @partner_id, :sig => sig)
+      sig = sign_string data_string, @partner_secret
+      meta_string = Utils.urlencode_hash(:partner_id => @partner_id, :sig => sig)
 
-      @@TOKEN_SENTINEL + Base64.encode64(meta_string + ":" + data_string).gsub("\n", '')
+      TOKEN_SENTINEL + Base64.encode64(meta_string + ":" + data_string).gsub("\n", '')
     end
+
     alias_method :generateToken, :generate_token
 
-    # 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@.
+    ##
+    # 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@.
+    #
+    # param: location
+    # param: opts: valid
     #
     # See http://www.tokbox.com/opentok/tools/documentation/overview/session_creation.html for more information
     def create_session(location='', opts={})
-      opts.merge!({:partner_id => @partner_id, :location=>location})
-      doc = do_request("/session/create", opts)
-      if not doc.get_elements('Errors').empty?
+      opts.merge!({:location => location})
+      doc = do_request '/session/create', opts
+
+      unless doc.get_elements('Errors').empty?
         raise OpenTokException.new doc.get_elements('Errors')[0].get_elements('error')[0].children.to_s
       end
-      OpenTok::Session.new(doc.root.get_elements('Session')[0].get_elements('session_id')[0].children[0].to_s)
+      Session.new doc.root.get_elements('Session')[0].get_elements('session_id')[0].children[0].to_s
     end
+
     alias_method :createSession, :create_session
 
-    # 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.
+    ##
+    # Download an OpenTok archive manifest.
+    # The archive manifest contains video IDs for each recorded stream in the archive.
+    #
+    # @param [String] archive identifier
+    # @param [String] token
+    #
+    # @return [OpenTok::Archive]
     def get_archive_manifest(archive_id, token)
       # TODO: verify that token is MODERATOR token
-
-      doc = do_request("/archive/getmanifest/#{archive_id}", {}, token)
-      if not doc.get_elements('Errors').empty?
+      doc = do_request "/archive/getmanifest/#{archive_id}", {}, token
+      if doc.get_elements('Errors').empty?
+        Archive.parse_manifest doc.get_elements('manifest')[0], @api_url, token
+      else
         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], @api_url, token)
     end
+
     alias_method :getArchiveManifest, :get_archive_manifest
 
-    def delete_archive( aid, token )
-      deleteURL = "/hl/archive/delete/#{aid}"
-      doc = do_request( deleteURL, {test => 'none'}, token )
+    def delete_archive(archive_id, token)
+      doc = do_request "/archive/delete/#{archive_id}", {:test => 'none'}, token
       errors = doc.get_elements('Errors')
       if doc.get_elements('Errors').empty?
-        #error = errors[0].get_elements('error')[0]
-        #errorCode = attributes['code']
-        return true
+        true
       else
-        return false
+        raise OpenTokException.from_error doc
       end
     end
+
     alias_method :deleteArchive, :delete_archive
 
-    def stitchArchive(aid)
-      stitchURL = "/hl/archive/#{aid}/stitch"
-      request = OpenTok::Request.new(@api_url, nil, @partner_id, @partner_secret)
-      response = request.sendRequest(stitchURL, {test => 'none'})
+    def stitchArchive(archive_id)
+      request = Request.new(@api_url, nil, @partner_id, @partner_secret)
+      response = request.sendRequest("/archive/#{archive_id}/stitch", {:test => 'none'})
       case response.code
       when '201'
         return {:code=>201, :message=>"Successfully Created", :location=>response["location"]}
@@ -158,19 +179,20 @@ module OpenTok
       else
         return {:code=>500, :message=>"Server Error"}
       end
-      return {}
     end
+
     alias_method :stitch, :stitchArchive
 
     protected
+
     def sign_string(data, secret)
       OpenSSL::HMAC.hexdigest(DIGEST, secret, data)
     end
 
     def do_request(path, params, token=nil)
-      request = OpenTok::Request.new(@api_url, token, @partner_id, @partner_secret)
-      body = request.fetch(path, params)
-      REXML::Document.new(body)
+      request = Request.new @api_url, token, @partner_id, @partner_secret
+      body = request.fetch path, params
+      REXML::Document.new body
     end
   end
 end

data/lib/open_tok/request.rb

@@ -7,7 +7,7 @@ Net::HTTP.version_1_2 # to make sure version 1.2 is used
 module OpenTok
   class Request
 
-    def initialize(api_host, token, partner_id=nil, partner_secret=nil)
+    def initialize(api_host, token, partner_id = nil, partner_secret = nil)
       @api_host       = api_host
       @token          = token
       @partner_id     = partner_id
@@ -17,29 +17,24 @@ module OpenTok
     def sendRequest(path, params)
       url = URI.parse(@api_host + path)
 
-      if params.empty?
-        req = Net::HTTP::Get.new(url.path)
+      if params.nil? || params.empty?
+        req = Net::HTTP::Get.new url.path
       else
-        req = Net::HTTP::Post.new(url.path)
+        req = Net::HTTP::Post.new url.path
         req.set_form_data(params)
       end
 
-      if @token
-        req.add_field 'X-TB-TOKEN-AUTH', @token
-      elsif @partner_id && @partner_secret
-        req.add_field 'X-TB-PARTNER-AUTH', "#{@partner_id}:#{@partner_secret}"
-      end
+      req = set_headers(req)
 
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = @api_host.start_with?("https")
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
 
-      res = http.start {|h| h.request(req) }
-      return res
+      http.start {|h| h.request(req) }
     end
 
     def fetch(path, params={})
-      res = sendRequest(path, params)
+      res = sendRequest path, params
 
       case res
       when Net::HTTPSuccess, Net::HTTPRedirection
@@ -49,9 +44,20 @@ module OpenTok
       end
 
     rescue Net::HTTPExceptions => e
-      raise OpenTokException.new "Unable to create fufill request: #{e}"
+      raise OpenTokException.new e.response.code, "Unable to create fufill request: #{e}"
     rescue NoMethodError => e
-      raise OpenTokException.new "Unable to create a fufill request at this time: #{e}"
+      raise OpenTokException.new e.response.code, "Unable to create a fufill request at this time: #{e}"
+    end
+
+    private
+
+    def set_headers(req)
+      if @token
+        req.add_field 'X-TB-TOKEN-AUTH', @token
+      elsif @partner_id && @partner_secret
+        req.add_field 'X-TB-PARTNER-AUTH', "#{@partner_id}:#{@partner_secret}"
+      end
+      req
     end
   end
 end

data/lib/open_tok/role_constants.rb

@@ -0,0 +1,18 @@
+module OpenTok
+
+  # * +SUBSCRIBER+ Can only subscribe
+  # * +PUBLISHER+ Can publish, subscribe, and signal
+  # * +MODERATOR+ Can do the above along with forceDisconnect and forceUnpublish
+  module RoleConstants
+    SUBSCRIBER = "subscriber" # Can only subscribe
+    PUBLISHER = "publisher"   # Can publish, subscribe, and signal
+    MODERATOR = "moderator"   # Can do the above along with  forceDisconnect and forceUnpublish
+
+    class << self
+      def is_valid?(role)
+        role == SUBSCRIBER || role == PUBLISHER || role == MODERATOR
+      end
+    end
+  end
+
+end

data/lib/open_tok/session.rb

@@ -6,17 +6,20 @@
 =end
 
 module OpenTok
-  
+
+  ##
   # The session object that contains the session_id
   class Session
     attr_reader :session_id
+    attr_reader :created_at
 
-    def initialize(session_id)
-      @session_id     = session_id
+    def initialize(session_id, create_dt=nil)
+      @session_id = session_id
+      @created_at = create_dt
     end
 
     def to_s
-      session_id
+      @session_id
     end
   end
 end

data/lib/open_tok/session_property_constants.rb

@@ -0,0 +1,30 @@
+
+module OpenTok
+
+  ##
+  # Preferences that could be defined while creating a session
+  module SessionPropertyConstants
+
+    # @deprecated (feature deleted in OpenTok v0.91.48)
+    # @param [Boolean]
+    ECHOSUPPRESSION_ENABLED = 'echoSuppression.enabled'
+
+    # @deprecated (feature deleted in OpenTok v0.91.48)
+    # @param [Integer]
+    MULTIPLEXER_NUMOUTPUTSTREAMS = 'multiplexer.numOutputStreams'
+
+    # @deprecated (feature deleted in OpenTok v0.91.48)
+    # @param [Integer]
+    MULTIPLEXER_SWITCHTYPE = 'multiplexer.switchType'
+
+    # @deprecated (feature deleted in OpenTok v0.91.48)
+    # @param [Integer]
+    MULTIPLEXER_SWITCHTIMEOUT = 'multiplexer.switchTimeout'
+
+    # Whether the session's streams will be transmitted directly between peers
+    # @param [disabled, enabled]
+    P2P_PREFERENCE = 'p2p.preference'
+
+  end
+
+end

data/lib/open_tok/utils.rb

@@ -1,19 +1,10 @@
-require 'cgi'
+require 'addressable/uri'
 
 module OpenTok
   module Utils
-    # would recommend using `addressable` gem instead
     def self.urlencode_hash(hash)
-      hash.to_a.map do |name_value|
-        if name_value[1].is_a? Array
-          name_value[0] = CGI.escape name_value[0].to_s
-          name_value[1].map { |e| CGI.escape e.to_s }
-          name_value[1] = name_value[1].join "&" + name_value[0] + "="
-          name_value.join '='
-        else
-          name_value.map { |e| CGI.escape e.to_s }.join '='
-        end
-      end.join '&'
+      uri = Addressable::URI.new :query_values => hash
+      uri.query
     end
   end
 end

data/lib/open_tok/version.rb

@@ -1,3 +1,5 @@
-module Opentok
-  VERSION = "0.0.92"
+module OpenTok
+
+  VERSION = '0.1.0'
+
 end

data/lib/opentok.rb

@@ -7,18 +7,12 @@
  Last modified: 2012-08-28
 =end
 
+require 'rubygems'
+
 module OpenTok
-  require 'rubygems'
 
-  VERSION = "tbrb-v0.91.2012-08-28"
-  API_URL = "https://api.opentok.com"
+  API_URL = 'http://api.opentok.com/hl'
+
+  autoload :OpenTokSDK, 'open_tok/open_tok_sdk'
 
-  require 'open_tok/exception'
-  require 'open_tok/utils'
-  require 'open_tok/request'
-  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/opentok.gemspec

@@ -4,7 +4,7 @@ require "open_tok/version"
 
 Gem::Specification.new do |s|
   s.name        = "opentok"
-  s.version     = Opentok::VERSION
+  s.version     = OpenTok::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Stijn Mathysen", "Karmen Blake", "Song Zheng"]
   s.email       = ["stijn@skylight.be", "karmenblake@gmail.com", "song@tokbox.com"]
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "addressable"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "webmock"

data/spec/opentok_exception_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'rexml/document'
+require 'open_tok/exception'
+
+describe OpenTok::OpenTokException do
+
+  subject { OpenTok::OpenTokException }
+
+  describe "when inhereted" do
+    it "should include the subclass in the internal structure" do
+      length = OpenTok::OpenTokException.exceptions.length
+      Foo = Class.new OpenTok::OpenTokException do
+        def self.http_code
+          1000
+        end
+      end
+      OpenTok::OpenTokException.exceptions.length.should eq length+1
+    end
+  end
+
+  describe "when creating an exception" do
+
+    let(:body_error) { "<Errors><error code='404'><itemNotFound message='Archive foo not found'/></error></Errors>"}
+
+    let(:body_unknown_error) { "<Errors><error code='100'></error></Errors>"}
+
+    it "should find the relevant child using the HTTP error code" do
+      response = REXML::Document.new body_error
+      OpenTok::OpenTokException.from_error(response).should be_instance_of OpenTok::OpenTokNotFound
+    end
+
+    it "should return the general exception if unknown HTTP error code" do
+      response = REXML::Document.new body_unknown_error
+      OpenTok::OpenTokException.from_error(response).should be_instance_of OpenTok::OpenTokException
+    end
+  end
+
+end

data/spec/opentok_spec.rb

@@ -4,26 +4,22 @@ describe OpenTok do
 
   let(:api_key) { '459782' }
   let(:api_secret) { 'b44c3baa32b6476d9d88e8194d0eb1c6b777f76b' }
-  let(:api_url) { 'https://api.opentok.com' }
+  let(:api_url) { 'http://api.opentok.com/hl' }
   let(:host) { 'localhost' }
 
-  let(:opentok) { OpenTok::OpenTokSDK.new api_key, api_secret }
+  subject { OpenTok::OpenTokSDK.new api_key, api_secret }
 
   describe "test Initializers" do
     it "should be backwards compatible if user set api URL with no effect" do
-      opentok = OpenTok::OpenTokSDK.new api_key, api_secret, {:api_url=>"bla bla"}
-      opentok.api_url.should eq api_url
-    end
-
-    it "should set api URL with no options" do
-      opentok = OpenTok::OpenTokSDK.new api_key, api_secret
+      opentok = OpenTok::OpenTokSDK.new api_key, api_secret, {:api_url => "bla bla"}
       opentok.api_url.should eq api_url
     end
 
     it "should be OpenTok SDK Object" do
-      opentok = OpenTok::OpenTokSDK.new api_key, api_secret
-      opentok.should be_instance_of OpenTok::OpenTokSDK
+      subject.should be_instance_of OpenTok::OpenTokSDK
     end
+
+    its(:api_url) { should == api_url }
   end
 
   describe "Generate Sessions" do
@@ -36,11 +32,6 @@ describe OpenTok do
       session.to_s.should match(/\A[0-9A-z_-]{40,}\Z/)
     end
 
-    it "should generate valid session camelCase" do
-      session = opentok.createSession host
-      session.to_s.should match(/\A[0-9A-z_-]{40,}\Z/)
-    end
-
     it "should generate valid p2p session" do
       # Creating Session object with p2p enabled
       sessionProperties = {OpenTok::SessionPropertyConstants::P2P_PREFERENCE => "enabled"}    # or disabled
@@ -61,21 +52,25 @@ describe OpenTok do
   end
 
   describe "Generate Tokens" do
-    let(:opentok) { OpenTok::OpenTokSDK.new api_key, api_secret }
-    let(:session) { opentok.createSession host }
+    let(:session) { subject.createSession host }
+
+    it "should raise error" do
+      expect { subject.generateToken({:role=>OpenTok::RoleConstants::MODERATOR}) }.to raise_error
+    end
     it "should generate valid token" do
-      token = opentok.generate_token({:session_id => session, :role=>OpenTok::RoleConstants::MODERATOR})
+      token = subject.generate_token({:session_id => session, :role=>OpenTok::RoleConstants::MODERATOR})
       token.should match(/(T1==)+[0-9A-z_]+/)
     end
     it "should generate valid token camelCase" do
-      token = opentok.generateToken({:session_id => session, :role=>OpenTok::RoleConstants::MODERATOR})
+      token = subject.generateToken({:session_id => session, :role=>OpenTok::RoleConstants::MODERATOR})
       token.should match(/(T1==)+[0-9A-z_]+/)
     end
     it "should be able to set parameters in token" do
-      token = opentok.generate_token :session_id => session, :role=> OpenTok::RoleConstants::PUBLISHER, :connection_data => "username=Bob,level=4"
+      token = subject.generate_token :session_id => session, :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/)
+      decoded.should match(/.*username%3DBob.*/)
+      decoded.should match(/.*level%3D4.*/)
     end
   end
 
@@ -111,14 +106,15 @@ describe OpenTok do
     use_vcr_cassette "deleteArchive"
     let(:api_key) { '459782' }
     let(:api_secret) { 'b44c3baa32b6476d9d88e8194d0eb1c6b777f76b' }
-    let(:opentok) { OpenTok::OpenTokSDK.new api_key, api_secret, {:api_url=>""} }
+    let(:opentok) { OpenTok::OpenTokSDK.new api_key, api_secret, {:api_url => ""} }
     let(:session) { '1_MX40NTk3ODJ-MTI3LjAuMC4xflR1ZSBTZXAgMDQgMTQ6NTM6MDIgUERUIDIwMTJ-MC41MjExODEzfg' }
     let(:token) { opentok.generateToken({:session_id => session, :role=>OpenTok::RoleConstants::PUBLISHER}) }
     let(:archiveId) { "200567af-0726-4e93-883b-fe0426d6310a" }
 
-    it "should return false on wrong moderator" do
-      a = opentok.deleteArchive( archiveId, token )
-      a.should eq false
+    it "should raise an Exception on item not found" do
+      expect{
+        opentok.deleteArchive archiveId, token
+      }.to raise_error OpenTok::OpenTokException
     end
   end
 
@@ -126,15 +122,13 @@ describe OpenTok do
     use_vcr_cassette "stitchArchive"
     let(:api_key) { '459782' }
     let(:api_secret) { 'b44c3baa32b6476d9d88e8194d0eb1c6b777f76b' }
-    let(:opentok) { OpenTok::OpenTokSDK.new api_key, api_secret, {:api_url=>""} }
-    let(:session) { '1_MX40NTk3ODJ-MTI3LjAuMC4xflR1ZSBTZXAgMDQgMTQ6NTM6MDIgUERUIDIwMTJ-MC41MjExODEzfg' }
-    let(:token) { opentok.generateToken({:session_id => session, :role=>OpenTok::RoleConstants::MODERATOR}) }
+    let(:opentok) { OpenTok::OpenTokSDK.new api_key, api_secret }
     let(:archiveId) { "200567af-0726-4e93-883b-fe0426d6310a" }
 
-    it "should return stich url" do
-      a = opentok.stitchArchive( archiveId )
-      a[:code].should == 201
-      a[:location].start_with?('http').should eq true
+    it "should return stitch url" do
+      a = opentok.stitchArchive archiveId
+      a[:code].should eq 201
+      a[:location].start_with?('http').should be_true
     end
   end
 

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../lib/opentok.rb'
+require 'opentok'
 
 require 'vcr'
 require 'webmock'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 0.0.92
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,8 +11,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +107,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - CHANGES
 - Gemfile
 - LICENSE
@@ -150,7 +167,9 @@ files:
 - 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
 - lib/opentok.rb
@@ -160,6 +179,7 @@ files:
 - spec/cassettes/invalidSession.yml
 - spec/cassettes/session.yml
 - spec/cassettes/stitchArchive.yml
+- spec/opentok_exception_spec.rb
 - spec/opentok_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/opentok/Opentok-Ruby-SDK
@@ -182,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: opentok
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: OpenTok gem
@@ -192,5 +212,6 @@ test_files:
 - spec/cassettes/invalidSession.yml
 - spec/cassettes/session.yml
 - spec/cassettes/stitchArchive.yml
+- spec/opentok_exception_spec.rb
 - spec/opentok_spec.rb
 - spec/spec_helper.rb