kaltura-ruby-client 1.0

data/test/access_control_service_test.rb

@@ -0,0 +1,75 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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 AccessControlServiceTest < Test::Unit::TestCase
+  
+  # this test create a access control object and reset the restrictions using and empty array.
+  should "be able to send empty array to the api and reset the values" do
+    
+    # cleaning up the list
+    access_control_filter = Kaltura::KalturaAccessControlFilter.new
+    filter_pager = Kaltura::KalturaFilterPager.new
+    access_control_list = @client.access_control_service.list(access_control_filter, filter_pager)
+    access_control_list.objects.each do |obj|
+      @client.access_control_service.delete(obj.id) rescue nil
+    end  if access_control_list.objects
+        
+    access_control = Kaltura::KalturaAccessControl.new
+    access_control.name = "kaltura_test"
+    access_control.is_default = Kaltura::KalturaNullableBoolean::FALSE_VALUE
+    
+    access_control.restrictions = []
+    
+    restriction1 = Kaltura::KalturaCountryRestriction.new
+    restriction1.country_restriction_type = Kaltura::KalturaCountryRestrictionType::RESTRICT_COUNTRY_LIST
+    restriction1.country_list = 'UK,LK'
+    access_control.restrictions << restriction1
+
+    restriction2 = Kaltura::KalturaSiteRestriction.new
+    restriction2.site_restriction_type = Kaltura::KalturaSiteRestrictionType::RESTRICT_SITE_LIST
+    restriction2.site_list = 'http://www.kaltura.com'
+    access_control.restrictions << restriction2
+    
+    created_access_control = @client.access_control_service.add(access_control)
+    
+    assert_not_nil created_access_control.id
+    assert_equal created_access_control.restrictions.size, 2
+    
+    # edited access control
+    edited_access_control = Kaltura::KalturaAccessControl.new
+    edited_access_control.name = access_control.name  
+    edited_access_control.restrictions = []
+    
+    updated_access_control = @client.access_control_service.update(created_access_control.id, edited_access_control)
+    
+    assert_equal updated_access_control.restrictions, nil
+    assert_nil @client.access_control_service.delete(updated_access_control.id)
+  end
+end

data/test/base_entry_service_test.rb

@@ -0,0 +1,267 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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 BaseEntryServiceTest < Test::Unit::TestCase
+  
+  # this test uploads a file to kaltura and creates an entry using the uploaded file.
+  should "upload a file and create an entry" do
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::DOCUMENT
+      base_entry.name = "kaltura_test"
+      pdf_file = File.open("test/media/test.pdf")
+      
+      pdf_token = @client.base_entry_service.upload(pdf_file)
+      created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry.id
+      assert_nil @client.base_entry_service.delete(created_entry.id)
+   end
+  
+  # this test uploads a file to kaltura and creates an entry using the uploaded file.   
+   should "upload a file and create an entry" do
+       
+       base_entry = Kaltura::KalturaBaseEntry.new
+       base_entry.type = Kaltura::KalturaEntryType::AUTOMATIC
+       base_entry.name = "kaltura_test"
+       swf_file = File.open("test/media/test.swf")
+       
+       pdf_token = @client.base_entry_service.upload(swf_file)
+       created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+       
+       assert_not_nil created_entry.id
+       assert_nil @client.base_entry_service.delete(created_entry.id)
+    end
+    
+    # this test simulates an api response with 'not supported' attributes and try to parse and generate an entry object out of it.
+    should "silently ignore any fields returned from the server that it does not recognize" do
+        
+        response_body = 
+        <<-XML
+        <?xml version='1.0' encoding='utf-8'?><xml><result><objectType>KalturaBaseEntry</objectType><id>0_npdg4rrs</id><not_supported_attr>not_supported_attr val</not_supported_attr><name>102_1321456940</name><description></description><partnerId>102</partnerId><userId></userId><tags></tags><adminTags></adminTags><categories></categories><status>2</status><moderationStatus>6</moderationStatus><moderationCount>0</moderationCount><type>10</type><createdAt>1321456940</createdAt><rank>0</rank><totalRank>0</totalRank><votes>0</votes><groupId></groupId><partnerData></partnerData><downloadUrl>http://ec2-174-129-124-16.compute-1.amazonaws.com/p/102/sp/10200/raw/entry_id/0_npdg4rrs/version/100000</downloadUrl><searchText>  102_1321456940 </searchText><licenseType>-1</licenseType><version>100000</version><thumbnailUrl>http://ec2-174-129-124-16.compute-1.amazonaws.com/p/102/sp/10200/thumbnail/entry_id/0_npdg4rrs/version/0</thumbnailUrl><accessControlId>4</accessControlId><startDate></startDate><endDate></endDate></result><executionTime>0.110525846481</executionTime></xml>
+        XML
+        created_entry = @client.parse_to_objects(response_body)
+        
+        assert_instance_of Kaltura::KalturaBaseEntry, created_entry
+        assert_not_nil created_entry.id
+     end
+    
+    # this test creates an entry and retrieves the list of entries and count from kaltura by setting a filter.
+    should "get the base entry list" do
+      
+      # cleaning up the list
+      base_entry_filter = Kaltura::KalturaBaseEntryFilter.new
+      base_entry_filter.name_multi_like_or = "kaltura_test"
+      filter_pager = Kaltura::KalturaFilterPager.new
+      base_entry_list = @client.base_entry_service.list(base_entry_filter, filter_pager)
+      base_entry_list.objects.each do |obj|
+        @client.base_entry_service.delete(obj.id) rescue nil
+      end  if base_entry_list.objects
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::AUTOMATIC
+      base_entry.name = "kaltura_test"
+      swf_file = File.open("test/media/test.swf")
+      
+      pdf_token = @client.base_entry_service.upload(swf_file)
+      created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry.id
+      
+      base_entry_filter = Kaltura::KalturaBaseEntryFilter.new
+      base_entry_filter.name_multi_like_or = "kaltura_test"
+      filter_pager = Kaltura::KalturaFilterPager.new
+      base_entry_list = @client.base_entry_service.list(base_entry_filter, filter_pager)
+      
+      assert_equal base_entry_list.total_count, 1
+      
+      count = @client.base_entry_service.count(base_entry_filter)     
+      
+      assert_equal count.to_i, 1
+            
+      assert_nil @client.base_entry_service.delete(created_entry.id)
+    end
+    
+    # this test creates an entry and retrieves it back using the id.
+    should "get the base entry" do
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::DOCUMENT
+      base_entry.name = "kaltura_test"
+      swf_file = File.open("test/media/test.pdf")
+      
+      pdf_token = @client.base_entry_service.upload(swf_file)
+      created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry.id
+      
+      base_entry = @client.base_entry_service.get(created_entry.id)
+      
+      assert_not_nil base_entry
+      assert_instance_of Kaltura::KalturaDocumentEntry, base_entry
+      assert_equal base_entry.id, created_entry.id
+      assert_nil @client.base_entry_service.delete(base_entry.id)
+    end
+    
+    # this test creates couple of entries and retrieves them back using the ids
+    should "get the base entries using the ids" do
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::DOCUMENT
+      base_entry.name = "kaltura_test"
+      swf_file = File.open("test/media/test.pdf")
+      
+      pdf_token = @client.base_entry_service.upload(swf_file)
+      created_entry1 = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry1.id
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::AUTOMATIC
+      base_entry.name = "kaltura_test"
+      swf_file = File.open("test/media/test.swf")
+      
+      pdf_token = @client.base_entry_service.upload(swf_file)
+      created_entry2 = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry2.id
+      
+      base_entry_list = @client.base_entry_service.get_by_ids("#{created_entry1.id},#{created_entry2.id}")
+      
+      assert_not_nil base_entry_list
+      assert_instance_of Array, base_entry_list
+      assert_equal base_entry_list.count, 2          
+      assert_nil @client.base_entry_service.delete(created_entry1.id)
+      assert_nil @client.base_entry_service.delete(created_entry2.id)
+    end
+    
+    # this test tries toretrieve an entry with invalid id.
+    should "throw an error for invalid base entry id" do
+      
+      assert_raise Kaltura::KalturaAPIError do
+        @client.base_entry_service.get("invalid_base_entry_id")
+      end
+      
+    end    
+    
+    # this test creates an entry and updates the metadata of it.
+    should "update the base entry metadata" do
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::AUTOMATIC
+      base_entry.name = "kaltura test"
+      swf_file = File.open("test/media/test.swf")
+      
+      pdf_token = @client.base_entry_service.upload(swf_file)
+      created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry.id
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.name = "kaltura test updated"
+      base_entry.description = "kaltura test description"
+      base_entry_updated = @client.base_entry_service.update(created_entry.id, base_entry)
+      
+      assert_not_nil base_entry_updated
+      assert_instance_of Kaltura::KalturaBaseEntry, base_entry_updated
+      assert_equal base_entry_updated.name, "kaltura test updated"
+      assert_equal base_entry_updated.description, "kaltura test description"
+      
+      assert_nil @client.base_entry_service.delete(base_entry_updated.id)
+    end
+    
+    # this test creates an entry and updates it's thumbnail.
+    should "upload a thumbnail for the base entry " do
+    
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::DOCUMENT
+      base_entry.name = "kaltura_test"
+      pdf_file = File.open("test/media/test.pdf")
+      
+      pdf_token = @client.base_entry_service.upload(pdf_file)
+      created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry.id
+    
+      img_file = File.open("test/media/test.png")
+            
+      updated_entry = @client.base_entry_service.update_thumbnail_jpeg(created_entry.id, img_file)
+      
+      assert_not_nil updated_entry.thumbnail_url     
+      assert_not_equal updated_entry.thumbnail_url, created_entry.thumbnail_url
+      assert_nil @client.base_entry_service.delete(updated_entry.id)
+    end
+    
+    # this test creates an entry and set it's moderation flags.
+    should "set the moderation flags" do
+    
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::DOCUMENT
+      base_entry.name = "kaltura_test"
+      pdf_file = File.open("test/media/test.pdf")
+      
+      pdf_token = @client.base_entry_service.upload(pdf_file)
+      created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry.id
+      
+      # first list the flags. should be empty      
+      moderation_flag_list = @client.base_entry_service.list_flags(created_entry.id)
+      
+      assert_equal moderation_flag_list.total_count, 0
+
+      # add a new flag for moderate
+      flag = Kaltura::KalturaModerationFlag.new
+      flag.flagged_entry_id = created_entry.id
+      flag.flag_type = Kaltura::KalturaModerationFlagType::SEXUAL_CONTENT
+      flag = @client.base_entry_service.flag(flag)
+      
+      # list the flags, should be 1
+      moderation_flag_list = @client.base_entry_service.list_flags(created_entry.id)
+      
+      assert_equal moderation_flag_list.total_count, 1
+      assert_equal moderation_flag_list.objects[0].status, Kaltura::KalturaModerationFlagStatus::PENDING
+      
+      # approve the flags
+      @client.base_entry_service.approve(created_entry.id)
+      
+      # list the flags, should be empty
+      moderation_flag_list = @client.base_entry_service.list_flags(created_entry.id)
+      
+      assert_equal moderation_flag_list.total_count, 0
+      
+      # get the entry and check the moderation status
+      created_entry = @client.base_entry_service.get(created_entry.id)
+      
+      assert_equal created_entry.moderation_status, Kaltura::KalturaEntryModerationStatus::APPROVED
+      
+      assert_nil @client.base_entry_service.delete(created_entry.id)
+    end
+
+end

data/test/configuration_test.rb

@@ -0,0 +1,178 @@
+# ===================================================================================================
+#                           _  __     _ _
+#                          | |/ /__ _| | |_ _  _ _ _ __ _
+#                          | ' </ _` | |  _| || | '_/ _` |
+#                          |_|\_\__,_|_|\__|\_,_|_| \__,_|
+#
+# 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 ConfigurationTest < Test::Unit::TestCase
+  
+  # this test validates the session id 
+  should "not have a nil client session" do
+    assert_not_nil @client.ks
+  end
+  
+  # this test generates a exception inside the client library code. 
+  should "raise an error for invalid api calls" do
+    
+    assert_raise NoMethodError do
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::DOCUMENT
+      base_entry.name = "kaltura_test"
+      pdf_file = File.open("test/media/test.pdf")
+      pdf_token = @client.invalid_service.upload(pdf_file)
+    end
+  end
+  
+  # this test invoke the api actions in https channel
+  should "support HTTPS" do
+    config = YAML.load_file("kaltura.yml")
+        
+    partner_id = config["test"]["partner_id"]
+    service_url = config["test"]["service_url"]
+    administrator_secret = config["test"]["administrator_secret"]
+    timeout = config["test"]["timeout"]
+    
+    service_url.gsub(/http:/, "https:/")
+    
+    config = Kaltura::KalturaConfiguration.new(partner_id, service_url)
+    config.logger = Logger.new(STDOUT)
+    config.timeout = timeout
+    
+    @client = Kaltura::KalturaClient.new( config )
+    assert_equal @client.ks, Kaltura::KalturaNotImplemented
+    
+    session = @client.session_service.start( administrator_secret, '', Kaltura::KalturaSessionType::ADMIN )
+    @client.ks = session
+    
+    assert_not_nil @client.ks
+  end
+  
+  # this test generates a exception inside the client library code. 
+  should "raise an error for invalid service url" do
+    
+    config = YAML.load_file("kaltura.yml")
+        
+    partner_id = config["test"]["partner_id"]
+    service_url = "http://invalid-service-url"
+    administrator_secret = config["test"]["administrator_secret"]
+    
+    config = Kaltura::KalturaConfiguration.new(partner_id, service_url)
+    config.logger = Logger.new(STDOUT)
+    
+    @client = Kaltura::KalturaClient.new( config )
+    
+    assert_raise Kaltura::KalturaAPIError do
+      session = @client.session_service.start( administrator_secret, '', Kaltura::KalturaSessionType::ADMIN )
+    end
+  end
+  
+  # this test tries to retrieve a session key for a invalid configuration.
+  should "not create a valid client session for invalid credentials" do
+    
+    config = YAML.load_file("kaltura.yml")
+        
+    partner_id = config["test"]["partner_id"]
+    service_url = config["test"]["service_url"]
+    
+    config = Kaltura::KalturaConfiguration.new(partner_id, service_url)
+    config.logger = Logger.new(STDOUT)
+    
+    @client = Kaltura::KalturaClient.new( config )
+    
+    assert_raise Kaltura::KalturaAPIError do
+      session = @client.session_service.start( "invalid_administrator_secret", '', Kaltura::KalturaSessionType::ADMIN )
+      @client.ks = session
+    end
+    
+    assert_equal @client.ks, Kaltura::KalturaNotImplemented
+  end
+  
+  # this test uses a session created in client side to comunicate with api.
+  should "upload a file and create an entry using the session created in client side" do
+      
+      config = YAML.load_file("kaltura.yml")
+  
+      partner_id = config["test"]["partner_id"]
+      service_url = config["test"]["service_url"]
+      administrator_secret = config["test"]["administrator_secret"]
+      timeout = config["test"]["timeout"]
+  
+      config = Kaltura::KalturaConfiguration.new(partner_id, service_url)
+      config.logger = Logger.new(STDOUT)
+      config.timeout = timeout
+  
+      @client = Kaltura::KalturaClient.new( config )
+    
+      assert_equal @client.ks, Kaltura::KalturaNotImplemented
+    
+      @client.generate_session(administrator_secret, '', Kaltura::KalturaSessionType::ADMIN, partner_id)
+      
+      assert_not_nil @client.ks
+      
+      base_entry = Kaltura::KalturaBaseEntry.new
+      base_entry.type = Kaltura::KalturaEntryType::DOCUMENT
+      base_entry.name = "kaltura_test"
+      pdf_file = File.open("test/media/test.pdf")
+      
+      
+      pdf_token = @client.base_entry_service.upload(pdf_file)
+      created_entry = @client.base_entry_service.add_from_uploaded_file(base_entry, pdf_token)
+      
+      assert_not_nil created_entry.id
+      assert_nil @client.base_entry_service.delete(created_entry.id)
+   end
+  
+  # this test is to validate the timeout configuration setting.
+  should "time out the request" do
+    
+    config = YAML.load_file("kaltura.yml")
+        
+    partner_id = config["test"]["partner_id"]
+    service_url = config["test"]["service_url"]
+    administrator_secret = config["test"]["administrator_secret"]
+    timeout = 0
+    
+    config = Kaltura::KalturaConfiguration.new(partner_id, service_url)
+    config.logger = Logger.new(STDOUT)
+    config.timeout = timeout
+    
+    exception = assert_raise Kaltura::KalturaAPIError do
+      @client = Kaltura::KalturaClient.new( config )
+      session = @client.session_service.start( administrator_secret, '', Kaltura::KalturaSessionType::ADMIN )
+      
+      @client.ks = session
+      
+      media_entry = Kaltura::KalturaMediaEntry.new
+      media_entry.name = "kaltura_test1"
+      media_entry.media_type = Kaltura::KalturaMediaType::VIDEO
+      video_file = File.open("test/media/test.wmv")
+  
+      video_token = @client.media_service.upload(video_file)
+    end
+    
+    assert_equal exception.message, 'Request Timeout'
+  end
+end