kaltura-client 3.2.0 → 3.3.0

data/test/metadata_profile_service_test.rb

@@ -28,36 +28,34 @@
 require 'test_helper'
 
 class MetadataProfileServiceTest < Test::Unit::TestCase
-  
-  # this test adds a metadata_profile and retrieves the list of metadata_profiles to demonstrate the use of kaltura plugins.
-  should "creates a metadata_profile and get the metadata_profile list" do
-    
-    # cleaning up the list
-    metadata_profile_filter = Kaltura::KalturaMetadataProfileFilter.new
-    filter_pager = Kaltura::KalturaFilterPager.new
-    metadata_profile_list = @client.metadata_profile_service.list(metadata_profile_filter, filter_pager)
-    metadata_profile_list.objects.each do |obj|
-      @client.metadata_profile_service.delete(obj.id) rescue nil
-    end  if metadata_profile_list.objects
-      
-     # creates a metadata_profile  
-     metadata_profile = Kaltura::KalturaMetadataProfile.new
-     metadata_profile.name = "test profile"
-     metadata_profile.metadata_object_type = Kaltura::KalturaMetadataObjectType::ENTRY 
-     metadata_profile.create_mode = Kaltura::KalturaMetadataProfileCreateMode::API 
-     
-     created_metadata_profile = @client.metadata_profile_service.add(metadata_profile, "<xsd:schema></xsd:schema>", "viewsData") 
-
-     assert_not_nil created_metadata_profile.id
-
-     # list the metadata_profiles 
-     metadata_profile_filter = Kaltura::KalturaMetadataProfileFilter.new
-     filter_pager = Kaltura::KalturaFilterPager.new      
-     
-     metadata_profile_list = @client.metadata_profile_service.list(metadata_profile_filter, filter_pager)    
-     
-     assert_equal metadata_profile_list.total_count, 1
-     
-    assert_nil @client.metadata_profile_service.delete(created_metadata_profile.id)   
-  end
+
+	# this test adds a metadata_profile and retrieves the list of metadata_profiles to demonstrate the use of kaltura plugins.
+	should "creates a metadata_profile and get the metadata_profile list" do
+
+		unique_id = (0...8).map { (97 + rand(26)).chr }.join
+		
+		# creates a metadata_profile
+		metadata_profile = Kaltura::KalturaMetadataProfile.new
+		metadata_profile.name = "test profile"
+		metadata_profile.system_name = unique_id
+		metadata_profile.metadata_object_type = Kaltura::KalturaMetadataObjectType::ENTRY
+		metadata_profile.create_mode = Kaltura::KalturaMetadataProfileCreateMode::API
+
+		created_metadata_profile = @client.metadata_profile_service.add(metadata_profile, "<xsd:schema></xsd:schema>", "viewsData")
+
+		assert_not_nil created_metadata_profile.id
+
+		# list the metadata_profiles
+		metadata_profile_filter = Kaltura::KalturaMetadataProfileFilter.new
+		metadata_profile_filter.system_name_equal = unique_id
+		filter_pager = Kaltura::KalturaFilterPager.new
+		filter_pager.page_size = 1
+
+		metadata_profile_list = @client.metadata_profile_service.list(metadata_profile_filter, filter_pager)
+
+		assert_equal 1, metadata_profile_list.objects.length
+		assert_equal 1, metadata_profile_list.total_count
+
+		assert_nil @client.metadata_profile_service.delete(created_metadata_profile.id)
+	end
 end

data/test/response_profile_test.rb

@@ -0,0 +1,208 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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-2011  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 'test_helper'
+
+class ResponseProfileTest < Test::Unit::TestCase
+	def uniqid(prefix)
+		return prefix + ('a'..'z').to_a.shuffle[0,8].join
+	end
+
+	def createEntry()
+		entry = Kaltura::KalturaMediaEntry.new()
+		entry.media_type = Kaltura::KalturaMediaType::VIDEO
+		entry.name = uniqid('test_')
+		entry.description = uniqid('test ')
+		entry.tags = @uniqueTag
+
+		entry = @client.media_service.add(entry)
+
+		return entry
+	end
+
+	def createMetadata(metadataProfileId, objectType, objectId, xmlData)
+		metadata = Kaltura::KalturaMetadata.new()
+		metadata.metadata_object_type = objectType
+		metadata.object_id = objectId
+
+		metadata = @client.metadata_service.add(metadataProfileId, objectType, objectId, xmlData)
+
+		return metadata
+	end
+
+	def createMetadataProfile(objectType, xsdData)
+		metadataProfile = Kaltura::KalturaMetadataProfile.new()
+		metadataProfile.metadata_object_type = objectType
+		metadataProfile.name = uniqid('test_')
+		metadataProfile.system_name = uniqid('test_')
+
+		metadataProfile = @client.metadata_profile_service.add(metadataProfile, xsdData)
+
+		return metadataProfile
+	end
+
+	def createEntriesWithMetadataObjects(entriesCount, metadataProfileCount = 2)
+		entries = []
+		metadataProfiles = {}
+
+		for i in 1 .. metadataProfileCount
+			index = i.to_s
+			xsd = '<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+	<xsd:element name="metadata">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element name="Choice' + index + '" minOccurs="0" maxOccurs="1">
+					<xsd:annotation>
+						<xsd:documentation></xsd:documentation>
+						<xsd:appinfo>
+							<label>Example choice ' + index + '</label>
+							<key>choice' + index + '</key>
+							<searchable>true</searchable>
+							<description>Example choice ' + index + '</description>
+						</xsd:appinfo>
+					</xsd:annotation>
+					<xsd:simpleType>
+						<xsd:restriction base="listType">
+							<xsd:enumeration value="on" />
+							<xsd:enumeration value="off" />
+						</xsd:restriction>
+					</xsd:simpleType>
+				</xsd:element>
+				<xsd:element name="FreeText' + index + '" minOccurs="0" maxOccurs="1" type="textType">
+					<xsd:annotation>
+						<xsd:documentation></xsd:documentation>
+						<xsd:appinfo>
+							<label>Free text ' + index + '</label>
+							<key>freeText' + index + '</key>
+							<searchable>true</searchable>
+							<description>Free text ' + index + '</description>
+						</xsd:appinfo>
+					</xsd:annotation>
+				</xsd:element>
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+	<xsd:complexType name="textType">
+		<xsd:simpleContent>
+			<xsd:extension base="xsd:string" />
+		</xsd:simpleContent>
+	</xsd:complexType>
+	<xsd:complexType name="objectType">
+		<xsd:simpleContent>
+			<xsd:extension base="xsd:string" />
+		</xsd:simpleContent>
+	</xsd:complexType>
+	<xsd:simpleType name="listType">
+		<xsd:restriction base="xsd:string" />
+	</xsd:simpleType>
+</xsd:schema>'
+
+			metadataProfiles[i.to_s] = createMetadataProfile(Kaltura::KalturaMetadataObjectType::ENTRY, xsd)
+		end
+
+		for i in 1 .. entriesCount
+			entry = createEntry()
+			entries.push(entry)
+
+			for j in 1 .. metadataProfileCount
+				index = j.to_s
+				xml = '<metadata>
+	<Choice' + index + '>on</Choice' + index + '>
+	<FreeText' + index + '>example text ' + index + '</FreeText' + index + '>
+</metadata>'
+
+				createMetadata(metadataProfiles[j.to_s].id, Kaltura::KalturaMetadataObjectType::ENTRY, entry.id, xml)
+			end
+		end
+
+		return [entries, metadataProfiles]
+	end
+
+	# this test adds entries, metadata-profiles and  metadata objects and retrieves the list of the entries with their metadata using response-profile
+	should "list entries with their metadata using response-profile" do
+
+		@uniqueTag = uniqid('tag_')
+		entriesTotalCount = 4
+		entriesPageSize = 4
+		metadataPageSize = 2
+
+		entries, metadataProfiles = createEntriesWithMetadataObjects(entriesTotalCount)
+
+		entriesFilter = Kaltura::KalturaMediaEntryFilter.new()
+		entriesFilter.tags_like = @uniqueTag
+		entriesFilter.status_in = Kaltura::KalturaEntryStatus::PENDING + ',' + Kaltura::KalturaEntryStatus::NO_CONTENT
+
+		entriesPager = Kaltura::KalturaFilterPager.new()
+		entriesPager.page_size = entriesPageSize
+
+		metadataFilter = Kaltura::KalturaMetadataFilter.new()
+		metadataFilter.metadata_object_type_equal = Kaltura::KalturaMetadataObjectType::ENTRY
+
+		metadataMapping = Kaltura::KalturaResponseProfileMapping.new()
+		metadataMapping.filter_property = 'objectIdEqual'
+		metadataMapping.parent_property = 'id'
+
+		metadataPager = Kaltura::KalturaFilterPager.new()
+		metadataPager.page_size = metadataPageSize
+
+		metadataResponseProfile = Kaltura::KalturaDetachedResponseProfile.new()
+		metadataResponseProfile.name = uniqid('test_')
+		metadataResponseProfile.type = Kaltura::KalturaResponseProfileType::INCLUDE_FIELDS
+		metadataResponseProfile.fields = 'id,objectId,createdAt, xml'
+		metadataResponseProfile.filter = metadataFilter
+		metadataResponseProfile.pager = metadataPager
+		metadataResponseProfile.mappings = [metadataMapping]
+
+		responseProfile = Kaltura::KalturaResponseProfile.new()
+		responseProfile.name = uniqid('test_')
+		responseProfile.system_name = uniqid('test_')
+		responseProfile.type = Kaltura::KalturaResponseProfileType::INCLUDE_FIELDS
+		responseProfile.fields = 'id,name,createdAt'
+		responseProfile.related_profiles = [metadataResponseProfile]
+
+		responseProfile = @client.response_profile_service.add(responseProfile)
+
+		nestedResponseProfile = Kaltura::KalturaResponseProfileHolder.new()
+		nestedResponseProfile.id = responseProfile.id
+
+		@client.response_profile = nestedResponseProfile
+		list = @client.base_entry_service.list(entriesFilter, entriesPager)
+
+		assert_equal(entriesTotalCount, list.total_count)
+		assert_equal(entriesPageSize, list.objects.size())
+
+		list.objects.each do |entry|
+			assert_equal(entry.related_objects != nil, true)
+			assert_equal(entry.related_objects.include?(metadataResponseProfile.name), true)
+			assert_equal(metadataProfiles.size(), entry.related_objects[metadataResponseProfile.name].objects.size())
+
+			entry.related_objects[metadataResponseProfile.name].objects.each do |metadata|
+				assert_equal(entry.id, metadata.object_id)
+			end
+		end
+	end
+end

data/test/test_helper.rb

@@ -47,13 +47,13 @@ class Test::Unit::TestCase
     administrator_secret = config_file["test"]["administrator_secret"]
     timeout = config_file["test"]["timeout"]
     
-    config = Kaltura::KalturaConfiguration.new(partner_id, service_url)
+    config = Kaltura::KalturaConfiguration.new()
+    config.service_url = service_url
     config.logger = Logger.new(STDOUT)
     config.timeout = timeout
     
     @client = Kaltura::KalturaClient.new( config )
-    session = @client.session_service.start( administrator_secret, '', Kaltura::KalturaSessionType::ADMIN )
-    @client.ks = session
+    @client.generate_session(administrator_secret, '', Kaltura::KalturaSessionType::ADMIN, partner_id )
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kaltura-client
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -35,71 +35,72 @@ extra_rdoc_files: []
 files:
 - lib/kaltura.rb
 - lib/kaltura_client.rb
-- lib/kaltura_plugins/kaltura_widevine_client_plugin.rb
-- lib/kaltura_plugins/kaltura_bulk_upload_filter_client_plugin.rb
-- lib/kaltura_plugins/kaltura_like_client_plugin.rb
-- lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb
-- lib/kaltura_plugins/kaltura_caption_search_client_plugin.rb
-- lib/kaltura_plugins/kaltura_var_console_client_plugin.rb
-- lib/kaltura_plugins/kaltura_drop_folder_xml_bulk_upload_client_plugin.rb
-- lib/kaltura_plugins/kaltura_velocix_client_plugin.rb
-- lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb
-- lib/kaltura_plugins/kaltura_scheduled_task_content_distribution_client_plugin.rb
-- lib/kaltura_plugins/kaltura_short_link_client_plugin.rb
-- lib/kaltura_plugins/kaltura_annotation_client_plugin.rb
-- lib/kaltura_plugins/kaltura_tag_search_client_plugin.rb
-- lib/kaltura_plugins/kaltura_webex_drop_folder_client_plugin.rb
+- lib/kaltura_client_base.rb
+- lib/kaltura_enums.rb
+- lib/kaltura_plugins/kaltura_ad_cue_point_client_plugin.rb
 - lib/kaltura_plugins/kaltura_admin_console_client_plugin.rb
+- lib/kaltura_plugins/kaltura_annotation_client_plugin.rb
+- lib/kaltura_plugins/kaltura_attachment_client_plugin.rb
 - lib/kaltura_plugins/kaltura_bulk_upload_client_plugin.rb
-- lib/kaltura_plugins/kaltura_event_cue_point_client_plugin.rb
+- lib/kaltura_plugins/kaltura_bulk_upload_csv_client_plugin.rb
+- lib/kaltura_plugins/kaltura_bulk_upload_filter_client_plugin.rb
+- lib/kaltura_plugins/kaltura_bulk_upload_xml_client_plugin.rb
 - lib/kaltura_plugins/kaltura_caption_client_plugin.rb
-- lib/kaltura_plugins/kaltura_attachment_client_plugin.rb
+- lib/kaltura_plugins/kaltura_caption_search_client_plugin.rb
+- lib/kaltura_plugins/kaltura_cielo24client_plugin.rb
+- lib/kaltura_plugins/kaltura_code_cue_point_client_plugin.rb
+- lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb
+- lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb
 - lib/kaltura_plugins/kaltura_document_client_plugin.rb
-- lib/kaltura_plugins/kaltura_ad_cue_point_client_plugin.rb
+- lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb
+- lib/kaltura_plugins/kaltura_drop_folder_xml_bulk_upload_client_plugin.rb
+- lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb
+- lib/kaltura_plugins/kaltura_event_cue_point_client_plugin.rb
 - lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb
 - lib/kaltura_plugins/kaltura_external_media_client_plugin.rb
-- lib/kaltura_plugins/kaltura_thumb_cue_point_client_plugin.rb
-- lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb
-- lib/kaltura_plugins/kaltura_kontiki_client_plugin.rb
+- lib/kaltura_plugins/kaltura_feed_drop_folder_client_plugin.rb
+- lib/kaltura_plugins/kaltura_file_sync_client_plugin.rb
 - lib/kaltura_plugins/kaltura_http_notification_client_plugin.rb
-- lib/kaltura_plugins/kaltura_bulk_upload_csv_client_plugin.rb
+- lib/kaltura_plugins/kaltura_integration_client_plugin.rb
+- lib/kaltura_plugins/kaltura_kaltura_internal_tools_client_plugin.rb
+- lib/kaltura_plugins/kaltura_kontiki_client_plugin.rb
+- lib/kaltura_plugins/kaltura_like_client_plugin.rb
+- lib/kaltura_plugins/kaltura_metadata_client_plugin.rb
+- lib/kaltura_plugins/kaltura_quiz_client_plugin.rb
+- lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb
+- lib/kaltura_plugins/kaltura_scheduled_task_content_distribution_client_plugin.rb
 - lib/kaltura_plugins/kaltura_scheduled_task_event_notification_client_plugin.rb
-- lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb
-- lib/kaltura_plugins/kaltura_code_cue_point_client_plugin.rb
-- lib/kaltura_plugins/kaltura_aspera_client_plugin.rb
 - lib/kaltura_plugins/kaltura_scheduled_task_metadata_client_plugin.rb
-- lib/kaltura_plugins/kaltura_abc_screeners_watermark_access_control_client_plugin.rb
-- lib/kaltura_plugins/kaltura_feed_drop_folder_client_plugin.rb
-- lib/kaltura_plugins/kaltura_multi_centers_client_plugin.rb
-- lib/kaltura_plugins/kaltura_drm_client_plugin.rb
-- lib/kaltura_plugins/kaltura_bulk_upload_xml_client_plugin.rb
-- lib/kaltura_plugins/kaltura_kaltura_internal_tools_client_plugin.rb
-- lib/kaltura_plugins/kaltura_audit_client_plugin.rb
-- lib/kaltura_plugins/kaltura_virus_scan_client_plugin.rb
-- lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb
-- lib/kaltura_plugins/kaltura_file_sync_client_plugin.rb
-- lib/kaltura_plugins/kaltura_play_ready_client_plugin.rb
+- lib/kaltura_plugins/kaltura_short_link_client_plugin.rb
 - lib/kaltura_plugins/kaltura_system_partner_client_plugin.rb
-- lib/kaltura_plugins/kaltura_metadata_client_plugin.rb
-- lib/kaltura_client_base.rb
+- lib/kaltura_plugins/kaltura_tag_search_client_plugin.rb
+- lib/kaltura_plugins/kaltura_thumb_cue_point_client_plugin.rb
+- lib/kaltura_plugins/kaltura_transcript_client_plugin.rb
+- lib/kaltura_plugins/kaltura_var_console_client_plugin.rb
+- lib/kaltura_plugins/kaltura_velocix_client_plugin.rb
+- lib/kaltura_plugins/kaltura_virus_scan_client_plugin.rb
+- lib/kaltura_plugins/kaltura_voicebase_client_plugin.rb
+- lib/kaltura_plugins/kaltura_wowza_client_plugin.rb
+- lib/kaltura_types.rb
 - Rakefile
 - README
 - agpl.txt
 - kaltura.yml
 - test/test_helper.rb
-- test/base_entry_service_test.rb
-- test/media_service_test.rb
 - test/access_control_service_test.rb
-- test/document_service_test.rb
+- test/base_entry_service_test.rb
 - test/configuration_test.rb
+- test/cue_point_service_test.rb
 - test/data_service_test.rb
+- test/document_service_test.rb
+- test/media_service_test.rb
 - test/metadata_profile_service_test.rb
-- test/cue_point_service_test.rb
-- test/media/test.swf
+- test/response_profile_test.rb
 - test/media/test.mov
+- test/media/test.pdf
 - test/media/test.png
+- test/media/test.swf
 - test/media/test.wmv
-- test/media/test.pdf
 homepage: http://www.kaltura.com/
 licenses: []
 post_install_message: 
@@ -126,16 +127,17 @@ specification_version: 3
 summary: A gem implementation of Kaltura's Ruby Client
 test_files:
 - test/test_helper.rb
-- test/base_entry_service_test.rb
-- test/media_service_test.rb
 - test/access_control_service_test.rb
-- test/document_service_test.rb
+- test/base_entry_service_test.rb
 - test/configuration_test.rb
+- test/cue_point_service_test.rb
 - test/data_service_test.rb
+- test/document_service_test.rb
+- test/media_service_test.rb
 - test/metadata_profile_service_test.rb
-- test/cue_point_service_test.rb
-- test/media/test.swf
+- test/response_profile_test.rb
 - test/media/test.mov
+- test/media/test.pdf
 - test/media/test.png
+- test/media/test.swf
 - test/media/test.wmv
-- test/media/test.pdf

data/lib/kaltura_plugins/kaltura_abc_screeners_watermark_access_control_client_plugin.rb

@@ -1,37 +0,0 @@
-# ===================================================================================================
-#                           _  __     _ _
-#                          | |/ /__ _| | |_ _  _ _ _ __ _
-#                          | ' </ _` | |  _| || | '_/ _` |
-#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
-#
-# 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-2011  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'
-
-module Kaltura
-
-	class KalturaABCScreenersWatermarkCondition < KalturaCondition
-
-	end
-
-
-end