opentok 0.1.3 → 2.2.0

data/lib/open_tok/archive.rb

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

data/lib/open_tok/archive_timeline_event.rb

@@ -1,22 +0,0 @@
-=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

@@ -1,28 +0,0 @@
-=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 getId
-      return @id
-    end
-
-    def self.parseXML(video_resource_item)
-      ArchiveVideoResource.new video_resource_item.attributes['id'], video_resource_item.attributes['length']
-    end
-  end
-
-end

data/lib/open_tok/exception.rb

@@ -1,50 +0,0 @@
-=begin
- OpenTok Ruby Library
- http://www.tokbox.com/
-
- Copyright 2010 - 2011, TokBox, Inc.
-
-=end
-
-module OpenTok
-
-  # The exception that gets thrown when an invalid api-key and/or secret is given.
-  class OpenTokException < RuntimeError
-
-    def initialize(message)
-      @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]
-        exception ||= self
-        message = child.children.empty? ? '' : child.children[0].attributes['message']
-        exception.new 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

@@ -1,198 +0,0 @@
-=begin
- OpenTok Ruby Library
- http://www.tokbox.com/
-
- Copyright 2010 - 2011, TokBox, Inc.
-
-=end
-
-require 'openssl'
-require 'base64'
-require 'rexml/document'
-
-DIGEST  = OpenSSL::Digest::Digest.new 'sha1'
-
-module OpenTok
-
-  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_reader :api_url
-
-    TOKEN_SENTINEL = "T1=="
-
-    ##
-    # Create a new OpenTok REST API client
-    #
-    # @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.to_s()
-      @partner_secret = partner_secret
-      @api_url = api_url
-    end
-
-    ##
-    # 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 = {})
-      create_time = opts.fetch(:create_time, Time.now)
-      session_id = opts.fetch(:session_id, '').to_s
-
-      # check validity of session_id
-      if !session_id || session_id.to_s.length == ""
-        raise "Null or empty session ID is not valid"
-      end
-
-      begin
-        subSessionId = session_id[2..session_id.length]
-        subSessionId = 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.is_a?(Session) ? session_id.session_id : session_id,
-        :create_time => create_time.to_i,
-        :nonce => rand
-      }
-
-      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
-
-      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 = Utils.urlencode_hash(data_params)
-
-      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", '')
-    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@.
-    #
-    # 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!({: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
-      Session.new doc.root.get_elements('Session')[0].get_elements('session_id')[0].children[0].to_s
-    end
-
-    alias_method :createSession, :create_session
-
-    ##
-    # 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 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
-    end
-
-    alias_method :getArchiveManifest, :get_archive_manifest
-
-    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?
-        true
-      else
-        raise OpenTokException.from_error doc
-      end
-    end
-
-    alias_method :deleteArchive, :delete_archive
-
-    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"]}
-      when '202'
-        return {:code=>202, :message=>"Processing"}
-      when '403'
-        return {:code=>403, :message=>"Invalid Credentials"}
-      when '404'
-        return {:code=>404, :message=>"Archive Does Not Exist"}
-      else
-        return {:code=>500, :message=>"Server Error"}
-      end
-    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 = 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

@@ -1,63 +0,0 @@
-require 'uri'
-require 'net/http'
-require 'net/https'
-
-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)
-      @api_host       = api_host
-      @token          = token
-      @partner_id     = partner_id
-      @partner_secret = partner_secret
-    end
-
-    def sendRequest(path, params)
-      url = URI.parse(@api_host + path)
-
-      if params.nil? || params.empty?
-        req = Net::HTTP::Get.new url.path
-      else
-        req = Net::HTTP::Post.new url.path
-        req.set_form_data(params)
-      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_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
-
-      http.start {|h| h.request(req) }
-    end
-
-    def fetch(path, params={})
-      res = sendRequest path, params
-
-      case res
-      when Net::HTTPSuccess, Net::HTTPRedirection
-        return res.read_body
-      else
-        res.error!
-      end
-
-    rescue Net::HTTPExceptions => e
-      raise OpenTokException.new "Unable to create fufill request: #{e}"
-    rescue NoMethodError => e
-      raise OpenTokException.new "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

@@ -1,18 +0,0 @@
-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

@@ -1,25 +0,0 @@
-=begin
- OpenTok Ruby Library v0.90.0
- http://www.tokbox.com/
-
- Copyright 2010 - 2011, TokBox, Inc.
-=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, create_dt=nil)
-      @session_id = session_id
-      @created_at = create_dt
-    end
-
-    def to_s
-      @session_id
-    end
-  end
-end