kaltura-client 3.2.0 → 3.3.0

data/lib/kaltura_plugins/kaltura_quiz_client_plugin.rb

@@ -0,0 +1,365 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# This file is part of the Kaltura Collaborative Media Suite which allows users
+# to do with audio, video, and animation what Wiki platfroms allow them to do with
+# text.
+#
+# Copyright (C) 2006-2015  Kaltura Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http:#www.gnu.org/licenses/>.
+#
+# @ignore
+# ===================================================================================================
+require 'kaltura_client.rb'
+require File.dirname(__FILE__) + '/kaltura_cue_point_client_plugin.rb'
+
+module Kaltura
+
+	class KalturaAnswerCuePointOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		PARTNER_SORT_VALUE_ASC = "+partnerSortValue"
+		START_TIME_ASC = "+startTime"
+		TRIGGERED_AT_ASC = "+triggeredAt"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		PARTNER_SORT_VALUE_DESC = "-partnerSortValue"
+		START_TIME_DESC = "-startTime"
+		TRIGGERED_AT_DESC = "-triggeredAt"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	class KalturaQuestionCuePointOrderBy
+		CREATED_AT_ASC = "+createdAt"
+		PARTNER_SORT_VALUE_ASC = "+partnerSortValue"
+		START_TIME_ASC = "+startTime"
+		TRIGGERED_AT_ASC = "+triggeredAt"
+		UPDATED_AT_ASC = "+updatedAt"
+		CREATED_AT_DESC = "-createdAt"
+		PARTNER_SORT_VALUE_DESC = "-partnerSortValue"
+		START_TIME_DESC = "-startTime"
+		TRIGGERED_AT_DESC = "-triggeredAt"
+		UPDATED_AT_DESC = "-updatedAt"
+	end
+
+	# A representation of an optional answer for question cue point
+	#  
+	class KalturaOptionalAnswer < KalturaObjectBase
+		attr_accessor :key
+		attr_accessor :text
+		attr_accessor :weight
+		attr_accessor :is_correct
+
+		def weight=(val)
+			@weight = val.to_f
+		end
+		def is_correct=(val)
+			@is_correct = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			self.key = xml_element.elements['key'].text
+			self.text = xml_element.elements['text'].text
+			self.weight = xml_element.elements['weight'].text
+			self.is_correct = xml_element.elements['isCorrect'].text
+		end
+
+	end
+
+	class KalturaQuiz < KalturaObjectBase
+		attr_accessor :version
+		# Array of key value ui related objects
+		# 	 
+		attr_accessor :ui_attributes
+		attr_accessor :show_result_on_answer
+		attr_accessor :show_correct_key_on_answer
+		attr_accessor :allow_answer_update
+		attr_accessor :show_correct_after_submission
+		attr_accessor :allow_download
+		attr_accessor :show_grade_after_submission
+
+		def version=(val)
+			@version = val.to_i
+		end
+		def show_result_on_answer=(val)
+			@show_result_on_answer = val.to_i
+		end
+		def show_correct_key_on_answer=(val)
+			@show_correct_key_on_answer = val.to_i
+		end
+		def allow_answer_update=(val)
+			@allow_answer_update = val.to_i
+		end
+		def show_correct_after_submission=(val)
+			@show_correct_after_submission = val.to_i
+		end
+		def allow_download=(val)
+			@allow_download = val.to_i
+		end
+		def show_grade_after_submission=(val)
+			@show_grade_after_submission = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			self.version = xml_element.elements['version'].text
+			self.ui_attributes = KalturaClientBase.object_from_xml(xml_element.elements['uiAttributes'], 'KalturaKeyValue')
+			self.show_result_on_answer = xml_element.elements['showResultOnAnswer'].text
+			self.show_correct_key_on_answer = xml_element.elements['showCorrectKeyOnAnswer'].text
+			self.allow_answer_update = xml_element.elements['allowAnswerUpdate'].text
+			self.show_correct_after_submission = xml_element.elements['showCorrectAfterSubmission'].text
+			self.allow_download = xml_element.elements['allowDownload'].text
+			self.show_grade_after_submission = xml_element.elements['showGradeAfterSubmission'].text
+		end
+
+	end
+
+	class KalturaAnswerCuePoint < KalturaCuePoint
+		attr_accessor :parent_id
+		attr_accessor :quiz_user_entry_id
+		attr_accessor :answer_key
+		attr_accessor :is_correct
+		# Array of string
+		# 	 
+		attr_accessor :correct_answer_keys
+		attr_accessor :explanation
+
+		def is_correct=(val)
+			@is_correct = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			self.parent_id = xml_element.elements['parentId'].text
+			self.quiz_user_entry_id = xml_element.elements['quizUserEntryId'].text
+			self.answer_key = xml_element.elements['answerKey'].text
+			self.is_correct = xml_element.elements['isCorrect'].text
+			self.correct_answer_keys = KalturaClientBase.object_from_xml(xml_element.elements['correctAnswerKeys'], 'KalturaString')
+			self.explanation = xml_element.elements['explanation'].text
+		end
+
+	end
+
+	class KalturaQuestionCuePoint < KalturaCuePoint
+		# Array of key value answerKey->optionAnswer objects
+		# 	 
+		attr_accessor :optional_answers
+		attr_accessor :hint
+		attr_accessor :question
+		attr_accessor :explanation
+
+
+		def from_xml(xml_element)
+			super
+			self.optional_answers = KalturaClientBase.object_from_xml(xml_element.elements['optionalAnswers'], 'KalturaOptionalAnswer')
+			self.hint = xml_element.elements['hint'].text
+			self.question = xml_element.elements['question'].text
+			self.explanation = xml_element.elements['explanation'].text
+		end
+
+	end
+
+	class KalturaQuizAdvancedFilter < KalturaSearchItem
+		attr_accessor :is_quiz
+
+		def is_quiz=(val)
+			@is_quiz = val.to_i
+		end
+
+		def from_xml(xml_element)
+			super
+			self.is_quiz = xml_element.elements['isQuiz'].text
+		end
+
+	end
+
+	class KalturaQuizListResponse < KalturaListResponse
+		attr_accessor :objects
+
+
+		def from_xml(xml_element)
+			super
+			self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaQuiz')
+		end
+
+	end
+
+	class KalturaQuizFilter < KalturaRelatedFilter
+		# This filter should be in use for retrieving only a specific quiz entry (identified by its entryId).
+		# 	 
+		attr_accessor :entry_id_equal
+		# This filter should be in use for retrieving few specific quiz entries (string should include comma separated list of entryId strings).
+		# 	 
+		attr_accessor :entry_id_in
+
+
+		def from_xml(xml_element)
+			super
+			self.entry_id_equal = xml_element.elements['entryIdEqual'].text
+			self.entry_id_in = xml_element.elements['entryIdIn'].text
+		end
+
+	end
+
+	class KalturaAnswerCuePointBaseFilter < KalturaCuePointFilter
+		attr_accessor :parent_id_equal
+		attr_accessor :parent_id_in
+		attr_accessor :quiz_user_entry_id_equal
+		attr_accessor :quiz_user_entry_id_in
+
+
+		def from_xml(xml_element)
+			super
+			self.parent_id_equal = xml_element.elements['parentIdEqual'].text
+			self.parent_id_in = xml_element.elements['parentIdIn'].text
+			self.quiz_user_entry_id_equal = xml_element.elements['quizUserEntryIdEqual'].text
+			self.quiz_user_entry_id_in = xml_element.elements['quizUserEntryIdIn'].text
+		end
+
+	end
+
+	class KalturaQuestionCuePointBaseFilter < KalturaCuePointFilter
+		attr_accessor :question_like
+		attr_accessor :question_multi_like_or
+		attr_accessor :question_multi_like_and
+
+
+		def from_xml(xml_element)
+			super
+			self.question_like = xml_element.elements['questionLike'].text
+			self.question_multi_like_or = xml_element.elements['questionMultiLikeOr'].text
+			self.question_multi_like_and = xml_element.elements['questionMultiLikeAnd'].text
+		end
+
+	end
+
+	class KalturaAnswerCuePointFilter < KalturaAnswerCuePointBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+	class KalturaQuestionCuePointFilter < KalturaQuestionCuePointBaseFilter
+
+
+		def from_xml(xml_element)
+			super
+		end
+
+	end
+
+
+	# Allows user to handle quizzes
+	#  
+	class KalturaQuizService < KalturaServiceBase
+		def initialize(client)
+			super(client)
+		end
+
+		# Allows to add a quiz to an entry
+		# 	 
+		def add(entry_id, quiz)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'quiz', quiz)
+			client.queue_service_action_call('quiz_quiz', 'add', 'KalturaQuiz', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Allows to update a quiz
+		# 	 
+		def update(entry_id, quiz)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'quiz', quiz)
+			client.queue_service_action_call('quiz_quiz', 'update', 'KalturaQuiz', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# Allows to get a quiz
+		# 	 
+		def get(entry_id)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.queue_service_action_call('quiz_quiz', 'get', 'KalturaQuiz', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# List quiz objects by filter and pager
+		# 	 
+		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
+			kparams = {}
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'pager', pager)
+			client.queue_service_action_call('quiz_quiz', 'list', 'KalturaQuizListResponse', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+
+		# creates a pdf from quiz object
+		# 	 The Output type defines the file format in which the quiz will be generated
+		# 	 Currently only PDF files are supported
+		# 	 
+		def serve(entry_id, quiz_output_type)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'quizOutputType', quiz_output_type)
+			client.queue_service_action_call('quiz_quiz', 'serve', 'file', kparams)
+			return client.get_serve_url()
+		end
+
+		# sends a with an api request for pdf from quiz object
+		# 	 
+		def get_url(entry_id, quiz_output_type)
+			kparams = {}
+			client.add_param(kparams, 'entryId', entry_id)
+			client.add_param(kparams, 'quizOutputType', quiz_output_type)
+			client.queue_service_action_call('quiz_quiz', 'getUrl', 'string', kparams)
+			if (client.is_multirequest)
+				return nil
+			end
+			return client.do_queue()
+		end
+	end
+
+	class KalturaClient < KalturaClientBase
+		attr_reader :quiz_service
+		def quiz_service
+			if (@quiz_service == nil)
+				@quiz_service = KalturaQuizService.new(self)
+			end
+			return @quiz_service
+		end
+		
+	end
+
+end

data/lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb

@@ -82,6 +82,13 @@ module Kaltura
 		def stop_processing_on_error=(val)
 			@stop_processing_on_error = to_b(val)
 		end
+
+		def from_xml(xml_element)
+			super
+			self.type = xml_element.elements['type'].text
+			self.stop_processing_on_error = xml_element.elements['stopProcessingOnError'].text
+		end
+
 	end
 
 	class KalturaScheduledTaskProfile < KalturaObjectBase
@@ -128,6 +135,24 @@ module Kaltura
 		def max_total_count_allowed=(val)
 			@max_total_count_allowed = val.to_i
 		end
+
+		def from_xml(xml_element)
+			super
+			self.id = xml_element.elements['id'].text
+			self.partner_id = xml_element.elements['partnerId'].text
+			self.name = xml_element.elements['name'].text
+			self.system_name = xml_element.elements['systemName'].text
+			self.description = xml_element.elements['description'].text
+			self.status = xml_element.elements['status'].text
+			self.object_filter_engine_type = xml_element.elements['objectFilterEngineType'].text
+			self.object_filter = KalturaClientBase.object_from_xml(xml_element.elements['objectFilter'], 'KalturaFilter')
+			self.object_tasks = KalturaClientBase.object_from_xml(xml_element.elements['objectTasks'], 'KalturaObjectTask')
+			self.created_at = xml_element.elements['createdAt'].text
+			self.updated_at = xml_element.elements['updatedAt'].text
+			self.last_execution_started_at = xml_element.elements['lastExecutionStartedAt'].text
+			self.max_total_count_allowed = xml_element.elements['maxTotalCountAllowed'].text
+		end
+
 	end
 
 	class KalturaConvertEntryFlavorsObjectTask < KalturaObjectTask
@@ -141,6 +166,13 @@ module Kaltura
 		def reconvert=(val)
 			@reconvert = to_b(val)
 		end
+
+		def from_xml(xml_element)
+			super
+			self.flavor_params_ids = xml_element.elements['flavorParamsIds'].text
+			self.reconvert = xml_element.elements['reconvert'].text
+		end
+
 	end
 
 	class KalturaDeleteEntryFlavorsObjectTask < KalturaObjectTask
@@ -154,14 +186,31 @@ module Kaltura
 		def delete_type=(val)
 			@delete_type = val.to_i
 		end
+
+		def from_xml(xml_element)
+			super
+			self.delete_type = xml_element.elements['deleteType'].text
+			self.flavor_params_ids = xml_element.elements['flavorParamsIds'].text
+		end
+
 	end
 
 	class KalturaDeleteEntryObjectTask < KalturaObjectTask
 
+
+		def from_xml(xml_element)
+			super
+		end
+
 	end
 
 	class KalturaDeleteLocalContentObjectTask < KalturaObjectTask
 
+
+		def from_xml(xml_element)
+			super
+		end
+
 	end
 
 	class KalturaModifyCategoriesObjectTask < KalturaObjectTask
@@ -175,6 +224,13 @@ module Kaltura
 		def add_remove_type=(val)
 			@add_remove_type = val.to_i
 		end
+
+		def from_xml(xml_element)
+			super
+			self.add_remove_type = xml_element.elements['addRemoveType'].text
+			self.category_ids = KalturaClientBase.object_from_xml(xml_element.elements['categoryIds'], 'KalturaIntegerValue')
+		end
+
 	end
 
 	class KalturaScheduledTaskJobData < KalturaJobData
@@ -188,6 +244,14 @@ module Kaltura
 		def reference_time=(val)
 			@reference_time = val.to_i
 		end
+
+		def from_xml(xml_element)
+			super
+			self.max_results = xml_element.elements['maxResults'].text
+			self.results_file_path = xml_element.elements['resultsFilePath'].text
+			self.reference_time = xml_element.elements['referenceTime'].text
+		end
+
 	end
 
 	class KalturaScheduledTaskProfileBaseFilter < KalturaFilter
@@ -233,11 +297,36 @@ module Kaltura
 		def last_execution_started_at_less_than_or_equal=(val)
 			@last_execution_started_at_less_than_or_equal = val.to_i
 		end
+
+		def from_xml(xml_element)
+			super
+			self.id_equal = xml_element.elements['idEqual'].text
+			self.id_in = xml_element.elements['idIn'].text
+			self.partner_id_equal = xml_element.elements['partnerIdEqual'].text
+			self.partner_id_in = xml_element.elements['partnerIdIn'].text
+			self.system_name_equal = xml_element.elements['systemNameEqual'].text
+			self.system_name_in = xml_element.elements['systemNameIn'].text
+			self.status_equal = xml_element.elements['statusEqual'].text
+			self.status_in = xml_element.elements['statusIn'].text
+			self.created_at_greater_than_or_equal = xml_element.elements['createdAtGreaterThanOrEqual'].text
+			self.created_at_less_than_or_equal = xml_element.elements['createdAtLessThanOrEqual'].text
+			self.updated_at_greater_than_or_equal = xml_element.elements['updatedAtGreaterThanOrEqual'].text
+			self.updated_at_less_than_or_equal = xml_element.elements['updatedAtLessThanOrEqual'].text
+			self.last_execution_started_at_greater_than_or_equal = xml_element.elements['lastExecutionStartedAtGreaterThanOrEqual'].text
+			self.last_execution_started_at_less_than_or_equal = xml_element.elements['lastExecutionStartedAtLessThanOrEqual'].text
+		end
+
 	end
 
 	class KalturaScheduledTaskProfileListResponse < KalturaListResponse
 		attr_accessor :objects
 
+
+		def from_xml(xml_element)
+			super
+			self.objects = KalturaClientBase.object_from_xml(xml_element.elements['objects'], 'KalturaScheduledTaskProfile')
+		end
+
 	end
 
 	class KalturaStorageExportObjectTask < KalturaObjectTask
@@ -245,10 +334,21 @@ module Kaltura
 		# 	 
 		attr_accessor :storage_id
 
+
+		def from_xml(xml_element)
+			super
+			self.storage_id = xml_element.elements['storageId'].text
+		end
+
 	end
 
 	class KalturaScheduledTaskProfileFilter < KalturaScheduledTaskProfileBaseFilter
 
+
+		def from_xml(xml_element)
+			super
+		end
+
 	end
 
 
@@ -263,83 +363,83 @@ module Kaltura
 		# 	 
 		def add(scheduled_task_profile)
 			kparams = {}
-			client.add_param(kparams, 'scheduledTaskProfile', scheduled_task_profile);
-			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'add', kparams);
+			client.add_param(kparams, 'scheduledTaskProfile', scheduled_task_profile)
+			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'add', 'KalturaScheduledTaskProfile', kparams)
 			if (client.is_multirequest)
-				return nil;
+				return nil
 			end
-			return client.do_queue();
+			return client.do_queue()
 		end
 
 		# Retrieve a scheduled task profile by id
 		# 	 
 		def get(id)
 			kparams = {}
-			client.add_param(kparams, 'id', id);
-			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'get', kparams);
+			client.add_param(kparams, 'id', id)
+			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'get', 'KalturaScheduledTaskProfile', kparams)
 			if (client.is_multirequest)
-				return nil;
+				return nil
 			end
-			return client.do_queue();
+			return client.do_queue()
 		end
 
 		# Update an existing scheduled task profile
 		# 	 
 		def update(id, scheduled_task_profile)
 			kparams = {}
-			client.add_param(kparams, 'id', id);
-			client.add_param(kparams, 'scheduledTaskProfile', scheduled_task_profile);
-			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'update', kparams);
+			client.add_param(kparams, 'id', id)
+			client.add_param(kparams, 'scheduledTaskProfile', scheduled_task_profile)
+			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'update', 'KalturaScheduledTaskProfile', kparams)
 			if (client.is_multirequest)
-				return nil;
+				return nil
 			end
-			return client.do_queue();
+			return client.do_queue()
 		end
 
 		# Delete a scheduled task profile
 		# 	 
 		def delete(id)
 			kparams = {}
-			client.add_param(kparams, 'id', id);
-			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'delete', kparams);
+			client.add_param(kparams, 'id', id)
+			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'delete', '', kparams)
 			if (client.is_multirequest)
-				return nil;
+				return nil
 			end
-			return client.do_queue();
+			return client.do_queue()
 		end
 
 		# List scheduled task profiles
 		# 	 
 		def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
 			kparams = {}
-			client.add_param(kparams, 'filter', filter);
-			client.add_param(kparams, 'pager', pager);
-			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'list', kparams);
+			client.add_param(kparams, 'filter', filter)
+			client.add_param(kparams, 'pager', pager)
+			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'list', 'KalturaScheduledTaskProfileListResponse', kparams)
 			if (client.is_multirequest)
-				return nil;
+				return nil
 			end
-			return client.do_queue();
+			return client.do_queue()
 		end
 
 		def request_dry_run(scheduled_task_profile_id, max_results=500)
 			kparams = {}
-			client.add_param(kparams, 'scheduledTaskProfileId', scheduled_task_profile_id);
-			client.add_param(kparams, 'maxResults', max_results);
-			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'requestDryRun', kparams);
+			client.add_param(kparams, 'scheduledTaskProfileId', scheduled_task_profile_id)
+			client.add_param(kparams, 'maxResults', max_results)
+			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'requestDryRun', 'int', kparams)
 			if (client.is_multirequest)
-				return nil;
+				return nil
 			end
-			return client.do_queue();
+			return client.do_queue()
 		end
 
 		def get_dry_run_results(request_id)
 			kparams = {}
-			client.add_param(kparams, 'requestId', request_id);
-			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'getDryRunResults', kparams);
+			client.add_param(kparams, 'requestId', request_id)
+			client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'getDryRunResults', 'KalturaObjectListResponse', kparams)
 			if (client.is_multirequest)
-				return nil;
+				return nil
 			end
-			return client.do_queue();
+			return client.do_queue()
 		end
 	end
 
@@ -351,6 +451,7 @@ module Kaltura
 			end
 			return @scheduled_task_profile_service
 		end
+		
 	end
 
 end