goncalossilva_kaltura-ruby 0.4.8

data/lib/kaltura/kaltura_client_base.rb

@@ -0,0 +1,300 @@
+module Kaltura
+	class ClientBase
+		attr_accessor 	:config
+		attr_accessor 	:ks
+		attr_reader 	:is_multirequest
+	
+		def initialize(config)
+			@should_log = false
+			@config = config
+			@calls_queue = []
+	
+			if @config.logger != nil
+				@should_log = true
+			end
+		end
+		
+		def queue_service_action_call(service, action, params = {})
+			# in start session partner id is optional (default -1). if partner id was not set, use the one in the config
+			if (!params.key?('partnerId') || params['partnerId'] == -1)
+				params['partnerId'] = config.partner_id;
+			end	
+			
+			add_param(params, 'ks', @ks);
+			
+			call = ServiceActionCall.new(service, action, params);
+			@calls_queue.push(call);
+		end
+	
+		def do_queue()
+			start_time = Time.now
+			
+			if @calls_queue.length == 0
+				@is_multirequest = false
+				return nil
+			end
+					
+			log('service url: [' + @config.service_url + ']')
+			# append the basic params
+			params = {}
+			add_param(params, "format", @config.format)
+			add_param(params, "clientTag", @config.client_tag)
+			
+			url = @config.service_url+"/api_v3/index.php?service="
+			if (@is_multirequest)
+				url += "multirequest"
+				i = 1
+				@calls_queue.each_value do |call|
+					call_params = call.get_params_for_multirequest(i.next)
+					params.merge!(call_params)
+				end
+			else
+				call = @calls_queue[0]
+				url += call.service + "&action=" + call.action
+				params.merge!(call.params)
+			end
+			
+			# reset
+			@calls_queue = []
+			@is_multirequest = false
+			
+			signature = signature(params)
+			add_param(params, "kalsig", signature)
+			
+			log("url: " + url)
+			log("params: " + params.to_yaml)
+			result = do_http_request(url, params)
+			
+			result_object = parse_to_objects(result.body)
+
+			log("result (object yaml dump): " + result_object.to_yaml)
+			
+			end_time = Time.now
+			log("execution time for [#{url}]: [#{end_time - start_time}]")
+			
+			return result_object			
+		end
+		
+		def do_http_request(url, params)
+			res = RestClient.post url , params
+			return res
+		end
+		
+		def parse_to_objects(data)
+			parse_xml_to_objects(data)
+		end
+		
+		def parse_xml_to_objects(xml)
+			doc = REXML::Document.new(xml)
+			raise_exception_if_error(doc)
+			doc.elements.each('xml/result') do | element |
+				return ClassFactory.object_from_xml(element)
+			end
+		end
+		
+    def raise_exception_if_error(doc)
+      if is_error(doc)
+        code = doc.elements["xml/result/error/code"].text
+        message = doc.elements["xml/result/error/message"].text
+        raise APIError.new(code,message)
+      end
+    end
+    
+    def is_error(doc)
+      doc.elements["xml/result/error/message"] && doc.elements["xml/result/error/code"]
+    end
+		
+		def start_multirequest()
+			@is_multirequest = true
+		end
+	
+		def do_multirequest()
+			return do_queue()
+		end
+
+		def signature(params)
+			str = params.keys.map {|key| key.to_s }.sort.map {|key|
+				"#{escape(key)}#{escape(params[key])}"
+			}.join("")
+			
+			Digest::MD5.hexdigest(str)
+		end
+		
+		def add_param(params, name, value)
+			if value == nil
+				return
+			elsif value.is_a? Hash
+				value.each do |sub_name, sub_value|
+					add_param(params, "#{name}:#{sub_name}", sub_value);
+				end
+			elsif value.is_a? ObjectBase
+				add_param(params, name, value.to_params)
+			else
+				params[name] = value
+			end
+		end
+	
+		# Escapes a query parameter. Stolen from RFuzz
+		def escape(s)
+			s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+				'%' + $1.unpack('H2'*$1.size).join('%').upcase
+			}.tr(' ', '+')
+		end
+		
+		def log(msg)
+			if @should_log
+				config.logger.log(msg)
+			end
+		end
+	end
+	
+	class ServiceActionCall
+		attr_accessor :service
+		attr_accessor :action
+		attr_accessor :params
+	
+		def initialize(service, action, params = array())
+			@service = service
+			@action = action
+			@params = parse_params(params)
+		end
+	
+		def parse_params(params)
+			new_params = {}
+			params.each do |key, val| 
+				if val.kind_of? Hash
+					new_params[key] = parse_params(val)
+				else
+					new_params[key] = val
+				end
+			end
+			return new_params
+		end
+	
+		def get_params_for_multirequest(multirequest_index)
+			multirequest_params = {}
+			multirequest_params[multirequest_index+":service"] = @service
+			multirequest_params[multirequest_index+":action"] = @action
+			@params.each do |key|
+				multirequest_params[multirequest_index+":"+key] = @params[key]
+			end
+			return multirequest_params
+		end
+	end
+
+	class ObjectBase
+		attr_accessor :object_type
+		
+		def to_params
+			params = {};
+			params["objectType"] = self.class.name.split('::').last 
+			instance_variables.each do |var|
+				value = instance_variable_get(var)
+				var = var.to_s.sub('@', '')
+				kvar = camelcase(var)
+				if (value != nil)
+					if (value.is_a? ObjectBase)
+						params[kvar] = value.to_params;
+					else
+						params[kvar] = value;
+					end
+				end
+			end
+			return params;
+		end
+		
+		def to_b(val)
+			return [true, 'true', 1, '1'].include?(val.is_a?(String) ? val.downcase : val)
+		end
+		
+		def camelcase(val)
+			val = val.split('_').map { |e| e.capitalize }.join()
+			val[0,1].downcase + val[1,val.length]
+		end
+	end
+	
+	class Configuration
+		attr_accessor :logger
+		attr_accessor :service_url
+		attr_accessor :format
+		attr_accessor :client_tag
+		attr_accessor :timeout
+		attr_accessor :partner_id
+	
+		def initialize(partner_id = -1)
+			@service_url 	= "http://www.kaltura.com"
+			@format 		= 2 # xml
+			@client_tag 	= "ruby"
+			@timeout 		= 10
+			@partner_id 	= partner_id
+		end
+		
+		def service_url=(url)
+			@service_url = url.chomp('/')
+		end
+	end
+	
+	class ClassFactory
+		def self.object_from_xml(xml_element)
+			instance = nil
+	        if xml_element.elements.size > 0
+				if xml_element.elements[1].name == 'item' # array	
+					instance = []
+					xml_element.elements.each('item') do | element |
+						instance.push(ClassFactory.object_from_xml(element))
+					end
+				else # object
+					object_type_element = xml_element.get_text('objectType')
+					if (object_type_element != nil)
+						object_class = xml_element.get_text('objectType').value
+						instance = ClassFactory.set_instance(object_class)
+						xml_element.elements.each do | element |
+							value = ClassFactory.object_from_xml(element)
+							instance.send(self.underscore(element.name) + "=", value);
+						end
+					end
+				end
+			else # simple type
+	        	return xml_element.text
+	       	end
+	
+	       	return instance;
+		end
+		
+		def self.underscore(val)
+			val.gsub(/(.)([A-Z])/,'\1_\2').downcase
+		end
+		
+		def self.set_instance(object_request_class)
+		  string_object_class = object_request_class.to_s
+		  instance = nil
+		  stripped_request = ClassFactory.strip_kaltura_from_request(string_object_class)
+		  instance = Module.const_get("Kaltura")
+		  unless ClassFactory.request_is_response?(string_object_class)
+		    instance = instance.const_get("Response").const_get(stripped_request).new
+	    else
+	      instance = instance.const_get(stripped_request).new
+      end		  
+      instance
+	  end
+	  
+	  def self.strip_kaltura_from_request(request)
+	    request.gsub("Kaltura","")
+    end
+	  def self.request_is_response?(request)
+	    request_array = []
+	    request_array << request
+	    request_array == request.split("Response",0)
+    end
+	end
+	
+	class APIError < RuntimeError
+	  attr_reader :code
+	  attr_reader :message
+	  
+	  def initialize(code,message)
+	    @code = code
+	    @message = message
+    end
+  end
+end

data/lib/kaltura/response.rb

@@ -0,0 +1,112 @@
+module Kaltura
+  module Response
+    
+    class BaseResponse < ObjectBase
+      attr_accessor :objects
+      attr_accessor :total_count
+      
+      def total_count=(val)
+        @total_count = val.to_i
+      end
+    end
+    
+    class AccessControlListResponse < BaseResponse
+  	end
+    
+    class BaseEntryListResponse < BaseResponse
+  	end
+  	
+  	class ModerationFlagListResponse < BaseResponse
+  	end
+  	
+  	class BulkUploadListResponse < BaseResponse
+  	end
+  	
+  	class CategoryListResponse < BaseResponse
+  	end
+  	
+  	class ConversionProfileListResponse < BaseResponse
+  	end
+  	
+  	class DataListResponse < BaseResponse
+  	end
+  	
+  	class FlavorParamsListResponse < BaseResponse
+  	end
+  	
+  	class LiveStreamListResponse < BaseResponse
+  	end
+  	
+  	class MediaListResponse < BaseResponse
+  	end
+  	
+  	class MixListResponse < BaseResponse
+  	end
+  	
+  	class PlaylistListResponse < BaseResponse
+  	end
+  	
+  	class SearchResultResponse < ObjectBase
+  		attr_accessor :objects
+  		attr_accessor :need_media_info
+
+  		def need_media_info=(val)
+  			@need_media_info = to_b(val)
+  		end
+  	end
+  	
+  	class StartWidgetSessionResponse < ObjectBase
+  		attr_accessor :partner_id
+  		attr_accessor :ks
+  		attr_accessor :user_id
+
+  		def partner_id=(val)
+  			@partner_id = val.to_i
+  		end
+  	end
+  	
+  	class BaseSyndicationFeedListResponse < BaseResponse
+  	end
+  	
+  	class UiConfListResponse < BaseResponse
+  	end
+
+  	class UploadResponse < ObjectBase
+  		attr_accessor :upload_token_id
+  		attr_accessor :file_size
+  		attr_accessor :error_code
+  		attr_accessor :error_description
+
+  		def file_size=(val)
+  			@file_size = val.to_i
+  		end
+  		def error_code=(val)
+  			@error_code = val.to_i
+  		end
+  	end
+  	
+  	class UserListResponse < BaseResponse
+  	end
+  	
+  	class WidgetListResponse < BaseResponse
+  	end
+  	
+  	class SystemUserListResponse < BaseResponse
+  	end
+  	
+  	class SystemPartnerUsageListResponse < BaseResponse
+  	end
+  	
+  	class PartnerListResponse < BaseResponse
+  	end
+  	
+  	class FileSyncListResponse < BaseResponse
+  	end
+  	
+  	class FlavorParamsOutputListResponse < BaseResponse
+  	end
+  	
+  	class MediaInfoListResponse < BaseResponse
+  	end	  	
+  end #module Response
+end #module Kaltura

data/lib/kaltura/service.rb

@@ -0,0 +1,142 @@
+require 'kaltura/service/base_service'
+
+require 'kaltura/service/access_control_service'
+require 'kaltura/service/admin_user_service'
+require 'kaltura/service/base_entry_service'
+require 'kaltura/service/bulk_upload_service'
+require 'kaltura/service/category_service'
+require 'kaltura/service/conversion_profile_service'
+require 'kaltura/service/data_service'
+require 'kaltura/service/email_ingestion_profile_service'
+require 'kaltura/service/flavor_asset_service'
+require 'kaltura/service/flavor_params_service'
+require 'kaltura/service/live_stream_service'
+require 'kaltura/service/media_service'
+require 'kaltura/service/mixing_service'
+require 'kaltura/service/notification_service'
+require 'kaltura/service/partner_service'
+require 'kaltura/service/playlist_service'
+require 'kaltura/service/report_service'
+require 'kaltura/service/search_service'
+require 'kaltura/service/session_service'
+require 'kaltura/service/stats_service'
+require 'kaltura/service/syndication_feed_service'
+require 'kaltura/service/system_service'
+require 'kaltura/service/ui_conf_service'
+require 'kaltura/service/upload_service'
+require 'kaltura/service/user_service'
+require 'kaltura/service/widget_service'
+require 'kaltura/service/x_internal_service'
+require 'kaltura/service/system_user_service'
+require 'kaltura/service/system_partner_service'
+
+module Kaltura
+  ##
+  # The service module provides instance methods to the Kaltura::Client class.  This is the bulk of API actions.
+  ##
+  module Service
+      
+    ##
+    # FileSyncService is a system user service.
+    #
+    # @example List up to 100 file sync objects with an error status:
+    #    client = Kaltura::Client.new
+    #    filter = Kaltura::Filter::FileSyncFilter.new
+    #    filter.status_equal = Kaltura::Constants::FileSync::Status::ERROR
+    #    pager = Kaltura::FilterPager.new
+    #    pager.page_size = 100
+    #    client.file_sync_service.list(filter,pager)
+    #
+    ##      	  		  		  			  			  		  		  	  	  		  	
+  	class FileSyncService < BaseService
+      
+      ##
+      # Lists file sync objects by a filter and a pager.
+      #
+      # @param [Kaltura::Filter::FileSyncFilter] filter The filter to apply to the list.
+      # @param [Kaltura::FilterPager] pager The default pager to apply to large lists.
+      #
+      # @return [Kaltura::Response::FileSyncListResponse] FileSyncListResponse is equivalent to Kaltura::Response::BaseResponse
+      #
+      # @raise [Kaltura::APIError] raises default Kaltura errors.
+      ##
+  		def list(filter=nil, pager=nil)
+  			kparams = {}
+  			client.add_param(kparams, 'filter', filter)
+  			client.add_param(kparams, 'pager', pager)
+  			perform_request('fileSync','list',kparams,false)
+  		end
+  	end #class FileSyncService
+  	
+  	##
+  	# FlavorParamsOutputService is not documented by Kaltura.  Probably best to not play with this.
+  	# This is likely just used internally by the KMC.
+  	##
+  	class FlavorParamsOutputService < BaseService
+
+      ##
+      # Lists file sync objects by a filter and a pager.
+      #
+      # @param [Kaltura::Filter::FlavorParamsOutputFilter] filter The filter to apply to the list action.
+      # @param [Kaltura::FilterPager] pager The default pager to apply to large lists.
+      # 
+      # @return [Kaltura::Response::FlavorParamsOutputListResponse] This is equivalent to the BaseResponse class.
+      # 
+      # @raise [Kaltura::APIError] raises default Kaltura errors.
+      ##
+  		def list(filter=nil, pager=nil)
+  			kparams = {}
+  			client.add_param(kparams, 'filter', filter)
+  			client.add_param(kparams, 'pager', pager)
+  			perform_request('flavorParamsOutput','list',kparams,false)
+  		end
+  	end #class FlavorParamsOutputService
+  	
+  	##
+  	# MediaInfoService is not documented by Kaltura.  Probably best to not play with this.
+  	# This is likely just used internally by the KMC.
+  	##
+  	class MediaInfoService < BaseService
+      ##
+      # Lists media info objects by a filter and a pager.
+      #
+      # @param [Kaltura::Filter::MediaInfoFilter] filter The filter to apply to the list action.
+      # @param [Kaltura::FilterPager] pager The default pager to apply to large lists.
+      #
+      # @return [Kaltura::Response::MediaInfoListResponse] This is equivalent to the BaseResponse class.
+      #
+      # @raise [Kaltura::APIError] raises default Kaltura errors.
+      ##
+  		def list(filter=nil, pager=nil)
+  			kparams = {}
+  			client.add_param(kparams, 'filter', filter)
+  			client.add_param(kparams, 'pager', pager)
+  			perform_request('mediaInfo','list',kparams,false)
+  		end
+  	end #class MediaInfoService
+  	
+  	##
+  	# EntryAdminService is not documented by Kaltura.  Probably best not to play with this.
+  	# This is likely just used internally by the KMC.
+  	##
+  	class EntryAdminService < BaseService
+
+      ##
+      # Gets an EntryAdmin object by entry_id.
+      #
+      # @param [String] entry_id Media entry id
+      # @param [Integer] version Desired version of the data.
+      #
+      # @return [Object] Not entirely sure what this returns.  
+      # 
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
+  		def get(entry_id, version=-1)
+  			kparams = {}
+  			client.add_param(kparams, 'entryId', entry_id)
+  			client.add_param(kparams, 'version', version)
+  			perform_request('entryAdmin','get',kparams,false)
+  		end
+  	end #class EntryAdminService
+  end #module Service
+end #module Kaltura