kaltura_api 1.0

data/test/media_service_test.rb

@@ -0,0 +1,294 @@
+# coding: utf-8
+
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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'
+require 'uri'
+
+class MediaServiceTest < Test::Unit::TestCase
+  
+  # this test uploads a video file to kaltura and creates a media entry using the uploaded file.
+  should "upload a video file and create a kaltura entry" do
+        
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test1"
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    video_file = File.open("test/media/test.wmv")
+    
+    video_token = @client.media_service.upload(video_file)
+    created_entry1 = @client.media_service.add_from_uploaded_file(media_entry, video_token)
+    
+    assert_not_nil created_entry1.id
+    assert_nil @client.media_service.delete(created_entry1.id)
+  end
+  
+  # this test uploads a image file to kaltura and creates a media entry using the uploaded file.  
+  should "upload a image file and create a kaltura entry" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test2"
+    media_entry.media_type = KalturaApi::KalturaMediaType::IMAGE
+    video_file = File.open("test/media/test.png")
+    
+    video_token = @client.media_service.upload(video_file)
+    created_entry2 = @client.media_service.add_from_uploaded_file(media_entry, video_token)
+    
+    assert_not_nil created_entry2.id
+    assert_nil @client.media_service.delete(created_entry2.id)
+  end
+  
+  # this test uploads a video file to kaltura reading from a url and creates a media entry using the uploaded file.  
+  should "upload a flv file from url and create a kaltura entry" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test3"
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    
+    created_entry3 = @client.media_service.add_from_url(media_entry, URI.escape("http://www.kaltura.org/kalorg/kaltura-api-clients-generators/trunk/sources/csharp/KalturaClientTester/DemoVideo.flv", Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")))
+    
+    assert_not_nil created_entry3.id
+    assert_equal created_entry3.status, KalturaApi::KalturaEntryStatus::IMPORT
+    assert_nil @client.media_service.delete(created_entry3.id)
+  end
+  
+  # this test creates an entry and ranks it  
+  should "set the rank attributes" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test"
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    video_file = File.open("test/media/test.wmv")
+    
+    video_token = @client.media_service.upload(video_file)
+    created_entry = @client.media_service.add_from_uploaded_file(media_entry, video_token)
+        
+    assert_not_nil created_entry.id
+    assert_equal created_entry.rank, 0
+    assert_equal created_entry.total_rank, 0
+    assert_equal created_entry.votes, 0
+    
+    @client.media_service.anonymous_rank(created_entry.id, 5)
+    created_entry = @client.media_service.get(created_entry.id)
+        
+    assert_equal created_entry.rank, 5
+    assert_equal created_entry.total_rank, 5
+    assert_equal created_entry.votes, 1
+    
+    @client.media_service.anonymous_rank(created_entry.id, 2)
+    created_entry = @client.media_service.get(created_entry.id)
+        
+    assert_equal created_entry.rank, 3.5
+    assert_equal created_entry.total_rank, 7
+    assert_equal created_entry.votes, 2
+            
+    assert_nil @client.media_service.delete(created_entry.id)
+  end
+  
+  # this test creates an entry and updates the thumbnail of it using a image url  
+  should "update the thumbnail from url" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test"
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    video_file = File.open("test/media/test.wmv")
+    
+    video_token = @client.media_service.upload(video_file)
+    created_entry = @client.media_service.add_from_uploaded_file(media_entry, video_token)
+        
+    assert_not_nil created_entry.id
+    
+    updated_entry = @client.media_service.update_thumbnail_from_url(created_entry.id, "http://corp.kaltura.com/sites/kaltura-website/files/logo_0.png")
+        
+    assert_not_nil updated_entry
+    assert_not_nil updated_entry.thumbnail_url
+    assert_not_equal created_entry.thumbnail_url, updated_entry.thumbnail_url
+            
+    assert_nil @client.media_service.delete(created_entry.id)
+  end
+  
+  # this test tries to create a media entry with invalid token.
+  should "not create a media entry for a invalid token" do
+       
+    assert_raise KalturaApi::KalturaAPIError do
+      @created_entry = @client.media_service.get("invalid entry id")
+    end  
+  end 
+  
+  # this test validates the response of a multi request when thre are no requests in the queue 
+  should "get empty array for multi request when there are no requests in the queue" do
+    
+    @client.start_multirequest
+    
+    retVal = @client.do_multirequest
+    
+    assert_equal retVal, [] 
+  end 
+  
+  # this test starts multirequest couple of times  
+  should "not raise any errors for double start multi request" do
+    
+    assert_nothing_raised KalturaApi::KalturaAPIError do
+        @client.start_multirequest
+        @client.start_multirequest
+    end
+  end
+  
+  # this test calls do_multirequest without stating it. 
+  should "get an empty array for the multirequest when it calls without starting it" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test3"
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    video_file = File.open("test/media/test.wmv")
+    
+    video_token = @client.media_service.upload(video_file)
+    
+    ceated_media_entry = @client.media_service.add_from_uploaded_file(media_entry, video_token)
+    
+    media_entry_filter = KalturaApi::KalturaMediaEntryFilter.new
+    media_entry_filter.name_multi_like_or = "kaltura_test3"
+    filter_pager = KalturaApi::KalturaFilterPager.new
+    @client.media_service.list(media_entry_filter, filter_pager)
+    
+    retVal = @client.do_multirequest
+    
+    assert_equal retVal, [] 
+    
+    assert_nil @client.media_service.delete(ceated_media_entry.id)  
+  end
+  
+  # this test uses multi request to retrieve the media entry list and create a new entry.  
+  should "get the media list and create a media entry" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test3"
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    video_file = File.open("test/media/test.wmv")
+    
+    video_token = @client.media_service.upload(video_file)
+    
+    @client.start_multirequest
+    
+    @client.media_service.add_from_uploaded_file(media_entry, video_token)
+    
+    media_entry_filter = KalturaApi::KalturaMediaEntryFilter.new
+    media_entry_filter.name_multi_like_or = "kaltura_test3"
+    filter_pager = KalturaApi::KalturaFilterPager.new
+    @client.media_service.list(media_entry_filter, filter_pager)
+    
+    retVal = @client.do_multirequest
+    
+    assert_instance_of KalturaApi::KalturaMediaEntry, retVal[0]
+    assert_instance_of KalturaApi::KalturaMediaListResponse, retVal[1]    
+    assert_not_nil retVal[0].id
+    assert_not_nil retVal[1].total_count
+    assert_nil @client.media_service.delete(retVal[0].id)  
+  end
+  
+  # this test retrieves error objects when a action in a multi request fails.  
+  should "return error objects for failed actions" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    
+    @client.start_multirequest
+    
+    @client.media_service.get("invalid entry id")
+    
+    media_entry_filter = KalturaApi::KalturaMediaEntryFilter.new
+    filter_pager = KalturaApi::KalturaFilterPager.new
+    @client.media_service.list(media_entry_filter, filter_pager)
+    
+    retVal = @client.do_multirequest
+        
+    assert_instance_of KalturaApi::KalturaAPIError, retVal[0]
+    assert_instance_of KalturaApi::KalturaMediaListResponse, retVal[1]
+    assert_not_nil retVal[1].total_count
+  end
+  
+  # this test uses utf8 content in the media entry meta data.
+  should "support UTF content in entry metadata" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "שלום"
+    media_entry.description = @description
+    
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    video_file = File.open("test/media/test.wmv")
+    
+    video_token = @client.media_service.upload(video_file)
+    created_entry = @client.media_service.add_from_uploaded_file(media_entry, video_token)
+    
+    assert_not_nil created_entry.id
+    
+    media_entry = @client.base_entry_service.get(created_entry.id)
+    
+    assert_equal media_entry.name, "שלום"
+    assert_equal media_entry.description, @description
+    assert_nil @client.media_service.delete(media_entry.id)
+  end
+  
+  # this test resets content in the media entry meta data.
+  should "support setting nil for content in entry metadata" do
+    
+    media_entry = KalturaApi::KalturaMediaEntry.new
+    media_entry.name = "kaltura_test1"
+    media_entry.description = "kaltura_test1 description"
+    media_entry.media_type = KalturaApi::KalturaMediaType::VIDEO
+    video_file = File.open("test/media/test.wmv")
+    
+    video_token = @client.media_service.upload(video_file)
+    created_entry = @client.media_service.add_from_uploaded_file(media_entry, video_token)
+    
+    assert_not_nil created_entry.id
+    
+    media_entry = @client.base_entry_service.get(created_entry.id)
+    
+    assert_equal media_entry.name, "kaltura_test1"
+    assert_equal media_entry.description, "kaltura_test1 description"
+    
+    # update the desc with value
+    media_entry = KalturaApi::KalturaBaseEntry.new
+    media_entry.name = "kaltura_test1 updated"
+    media_entry.description = nil
+    media_entry_updated = @client.base_entry_service.update(created_entry.id, media_entry)
+    
+    assert_equal media_entry_updated.description, nil
+    
+    assert_nil @client.media_service.delete(media_entry_updated.id)
+  end
+  
+  def setup
+    super
+    @description=
+    <<-DESC
+          שלום עולם
+    DESC
+  end
+  
+end

data/test/metadata_profile_service_test.rb

@@ -0,0 +1,63 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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 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 = KalturaApi::KalturaMetadataProfileFilter.new
+    filter_pager = KalturaApi::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 = KalturaApi::KalturaMetadataProfile.new
+     metadata_profile.name = "test profile"
+     metadata_profile.metadata_object_type = KalturaApi::KalturaMetadataObjectType::ENTRY 
+     metadata_profile.create_mode = KalturaApi::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 = KalturaApi::KalturaMetadataProfileFilter.new
+     filter_pager = KalturaApi::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
+end

data/test/test_helper.rb

@@ -0,0 +1,59 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'yaml'
+require 'logger'
+
+require 'kaltura'
+
+class Test::Unit::TestCase
+
+  # read the kaltura config file
+  # initiate a kaltura configuration object
+  # initiate kaltura client object
+  # get the sesion object and assigns it to the client
+  def setup
+    config_file = YAML.load_file("kaltura.yml")
+        
+    partner_id = config_file["test"]["partner_id"]
+    service_url = config_file["test"]["service_url"]
+    administrator_secret = config_file["test"]["administrator_secret"]
+    timeout = config_file["test"]["timeout"]
+    
+    config = KalturaApi::KalturaConfiguration.new(partner_id, service_url)
+    config.logger = Logger.new(STDOUT)
+    config.timeout = timeout
+    
+    @client = KalturaApi::KalturaClient.new( config )
+    session = @client.session_service.start( administrator_secret, '', KalturaApi::KalturaSessionType::ADMIN )
+    @client.ks = session
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: kaltura_api
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- rojace shrestha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem implementation of Kaltura's Ruby Client.
+email: rojace2011@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- Rakefile
+- kaltura_api.yml
+- lib/kaltura_api.rb
+- lib/kaltura_client.rb
+- lib/kaltura_client_base.rb
+- lib/kaltura_plugins/kaltura_abc_screeners_watermark_access_control_client_plugin.rb
+- lib/kaltura_plugins/kaltura_ad_cue_point_client_plugin.rb
+- lib/kaltura_plugins/kaltura_annotation_client_plugin.rb
+- lib/kaltura_plugins/kaltura_aspera_client_plugin.rb
+- lib/kaltura_plugins/kaltura_attachment_client_plugin.rb
+- lib/kaltura_plugins/kaltura_audit_client_plugin.rb
+- lib/kaltura_plugins/kaltura_bulk_upload_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_caption_search_client_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_drm_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_notification_client_plugin.rb
+- lib/kaltura_plugins/kaltura_external_media_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_kontiki_client_plugin.rb
+- lib/kaltura_plugins/kaltura_like_client_plugin.rb
+- lib/kaltura_plugins/kaltura_metadata_client_plugin.rb
+- lib/kaltura_plugins/kaltura_multi_centers_client_plugin.rb
+- lib/kaltura_plugins/kaltura_short_link_client_plugin.rb
+- lib/kaltura_plugins/kaltura_tag_search_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_webex_drop_folder_client_plugin.rb
+- lib/kaltura_plugins/kaltura_widevine_client_plugin.rb
+- test/access_control_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/test.mov
+- test/media/test.pdf
+- test/media/test.png
+- test/media/test.swf
+- test/media/test.wmv
+- test/media_service_test.rb
+- test/metadata_profile_service_test.rb
+- test/test_helper.rb
+homepage: http://www.kaltura.com/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A gem implementation of Kaltura's Ruby Client
+test_files:
+- test/test_helper.rb
+- test/access_control_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/media/test.mov
+- test/media/test.pdf
+- test/media/test.png
+- test/media/test.swf
+- test/media/test.wmv
+has_rdoc: