velir_kaltura-ruby 0.4.6 → 0.4.7

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 4
-:patch: 6
+:patch: 7
 :build: 

data/lib/kaltura/constants/access_control_order_by.rb

@@ -1,8 +1,14 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::AccessControlFilter
+    ##
 	  class AccessControlOrderBy
-		  CREATED_AT_ASC = "+createdAt"
-		  CREATED_AT_DESC = "-createdAt"
+		  CREATED_AT_ASC = "+createdAt" #Order by Created at ascending for a list of AccessControls
+		  CREATED_AT_DESC = "-createdAt" #Order by Created at descending for a list of AccessControls
 	  end
   end
 end

data/lib/kaltura/constants/audio_codec.rb

@@ -1,11 +1,16 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    ##
     class AudioCodec
-	    NONE = ""
-	    MP3 = "mp3"
-	    AAC = "aac"
-	    VORBIS = "vorbis"
-	    WMA = "wma"
+	    NONE = "" #invalid audio codec
+	    MP3 = "mp3" # mp3 formatted audio file
+	    AAC = "aac" # apple formatted audio file
+	    VORBIS = "vorbis" #ogg vorbis formatted audio file
+	    WMA = "wma" # windows audio formatted audio file
     end
   end
 end

data/lib/kaltura/constants/base.rb

@@ -1,33 +1,60 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::BaseSyndicationFeedFilter
+    # @see Kaltura::Filter::BaseJobFilter
+    # @see Kaltura::Filter::BaseEntryFilter
+    ##
     module Base
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::Filter::BaseSyndicationFeedFilter
+      ##    
       class SyndicationFeedOrderBy
-    		PLAYLIST_ID_ASC = "+playlistId"
-    		PLAYLIST_ID_DESC = "-playlistId"
-    		NAME_ASC = "+name"
-    		NAME_DESC = "-name"
-    		TYPE_ASC = "+type"
-    		TYPE_DESC = "-type"
-    		CREATED_AT_ASC = "+createdAt"
-    		CREATED_AT_DESC = "-createdAt"
+    		PLAYLIST_ID_ASC = "+playlistId" #order by playlist ID ascending.
+    		PLAYLIST_ID_DESC = "-playlistId" #order by playlist ID descending.
+    		NAME_ASC = "+name" #order by name ascending.
+    		NAME_DESC = "-name" #order by by name descending.
+    		TYPE_ASC = "+type" #order by type ascending.
+    		TYPE_DESC = "-type" #order by type descending.
+    		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+    		CREATED_AT_DESC = "-createdAt" #order by created_at descending.
     	end
     	
+    	
+    	##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::Filter::BaseJobFilter
+      ##
     	class JobOrderBy
-    		CREATED_AT_ASC = "+createdAt"
-    		CREATED_AT_DESC = "-createdAt"
-    		EXECUTION_ATTEMPTS_ASC = "+executionAttempts"
-    		EXECUTION_ATTEMPTS_DESC = "-executionAttempts"
+    		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+    		CREATED_AT_DESC = "-createdAt" #order by created_at descending.
+    		EXECUTION_ATTEMPTS_ASC = "+executionAttempts" #order by execution attempts ascending.
+    		EXECUTION_ATTEMPTS_DESC = "-executionAttempts" #order by execution attempts descending.
     	end
     	
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::Filter::BaseEntryFilter
+      ##
     	class EntryOrderBy
-  		  NAME_ASC = "+name"
-  		  NAME_DESC = "-name"
-  		  MODERATION_COUNT_ASC = "+moderationCount"
-  		  MODERATION_COUNT_DESC = "-moderationCount"
-  		  CREATED_AT_ASC = "+createdAt"
-  		  CREATED_AT_DESC = "-createdAt"
-  		  RANK_ASC = "+rank"
-  		  RANK_DESC = "-rank"
+  		  NAME_ASC = "+name" #order by name ascending.
+  		  NAME_DESC = "-name" #order by name descending.
+  		  MODERATION_COUNT_ASC = "+moderationCount" #order by moderation count ascending.
+  		  MODERATION_COUNT_DESC = "-moderationCount" #order by moderation count descending.
+  		  CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+  		  CREATED_AT_DESC = "-createdAt" #ordery by created_at descending.
+  		  RANK_ASC = "+rank" #order by rank ascending.
+  		  RANK_DESC = "-rank" #order by rank descending.
   	  end
     end
   end

data/lib/kaltura/constants/batch_job.rb

@@ -1,61 +1,86 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::BatchJobFilter
+    # @see Kaltura::BulkUpload
+    ##
     module BatchJob
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::Filter::BatchJobFilter
+      ##      
       class OrderBy
-    		STATUS_ASC = "+status"
-    		STATUS_DESC = "-status"
-    		QUEUE_TIME_ASC = "+queueTime"
-    		QUEUE_TIME_DESC = "-queueTime"
-    		FINISH_TIME_ASC = "+finishTime"
-    		FINISH_TIME_DESC = "-finishTime"
-    		CREATED_AT_ASC = "+createdAt"
-    		CREATED_AT_DESC = "-createdAt"
-    		EXECUTION_ATTEMPTS_ASC = "+executionAttempts"
-    		EXECUTION_ATTEMPTS_DESC = "-executionAttempts"
+    		STATUS_ASC = "+status" #order by status ascending.
+    		STATUS_DESC = "-status" #order by status descending.
+    		QUEUE_TIME_ASC = "+queueTime" #order by queue time ascending.
+    		QUEUE_TIME_DESC = "-queueTime" #order by queue time descending.
+    		FINISH_TIME_ASC = "+finishTime" #order by finish time ascending.
+    		FINISH_TIME_DESC = "-finishTime" #order by finish time descending.
+    		CREATED_AT_ASC = "+createdAt" #order by created at ascending.
+    		CREATED_AT_DESC = "-createdAt" #order by created_at descending.
+    		EXECUTION_ATTEMPTS_ASC = "+executionAttempts" #order by execution attempts ascending.
+    		EXECUTION_ATTEMPTS_DESC = "-executionAttempts" #order by execution attempts descending.
     	end
-    	
+
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::BulkUpload
+      ##    	
     	class Status
-    		PENDING = 0
-    		QUEUED = 1
-    		PROCESSING = 2
-    		PROCESSED = 3
-    		MOVEFILE = 4
-    		FINISHED = 5
-    		FAILED = 6
-    		ABORTED = 7
-    		ALMOST_DONE = 8
-    		RETRY = 9
-    		FATAL = 10
-    		DONT_PROCESS = 11
+    		PENDING = 0 #pending status
+    		QUEUED = 1 #queued status
+    		PROCESSING = 2 #processing status
+    		PROCESSED = 3 #processed status
+    		MOVEFILE = 4 #moving the file status
+    		FINISHED = 5 #finished status
+    		FAILED = 6 #failed state
+    		ABORTED = 7 #aborted state
+    		ALMOST_DONE = 8 #nearly completed status
+    		RETRY = 9 #retrying status
+    		FATAL = 10 #fatal error state
+    		DONT_PROCESS = 11 #unable to process state
     	end
     	
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::BulkUpload
+      ##
     	class Type
-    		CONVERT = 0
-    		IMPORT = 1
-    		DELETE = 2
-    		FLATTEN = 3
-    		BULKUPLOAD = 4
-    		DVDCREATOR = 5
-    		DOWNLOAD = 6
-    		OOCONVERT = 7
-    		CONVERT_PROFILE = 10
-    		POSTCONVERT = 11
-    		PULL = 12
-    		REMOTE_CONVERT = 13
-    		EXTRACT_MEDIA = 14
-    		MAIL = 15
-    		NOTIFICATION = 16
-    		CLEANUP = 17
-    		SCHEDULER_HELPER = 18
-    		BULKDOWNLOAD = 19
-    		DB_CLEANUP = 20
-    		PROVISION_PROVIDE = 21
-    		CONVERT_COLLECTION = 22
-    		STORAGE_EXPORT = 23
-    		PROVISION_DELETE = 24
-    		STORAGE_DELETE = 25
-    		EMAIL_INGESTION = 26
-    		PROJECT = 1000
+    		CONVERT = 0 #conversion job
+    		IMPORT = 1 #importing job
+    		DELETE = 2 #deletion job
+    		FLATTEN = 3 #flatten job
+    		BULKUPLOAD = 4 #bulk upload job
+    		DVDCREATOR = 5 #DVD creation job
+    		DOWNLOAD = 6 #download job
+    		OOCONVERT = 7 #conversion job
+    		CONVERT_PROFILE = 10 #conversion profile creation job
+    		POSTCONVERT = 11 #post conversion job
+    		PULL = 12 #pull request job
+    		REMOTE_CONVERT = 13 #remote conversion job
+    		EXTRACT_MEDIA = 14 #media extraction job
+    		MAIL = 15 #sending mail job
+    		NOTIFICATION = 16 #notification job
+    		CLEANUP = 17 #cleanup job
+    		SCHEDULER_HELPER = 18 #scheduling job
+    		BULKDOWNLOAD = 19 #bulk download job
+    		DB_CLEANUP = 20 #database cleanup job
+    		PROVISION_PROVIDE = 21 #provisioning job
+    		CONVERT_COLLECTION = 22 #collection conversion job
+    		STORAGE_EXPORT = 23 #storage export job
+    		PROVISION_DELETE = 24 #provisioning deletion job
+    		STORAGE_DELETE = 25 #storage deletion job
+    		EMAIL_INGESTION = 26 #email ingestion job
+    		PROJECT = 1000 #project job
     	end
     end
   end

data/lib/kaltura/constants/bit_rate_mode.rb

@@ -1,8 +1,14 @@
 module Kaltura
 	module Constants
+	  ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::BitRateMode
+    ##
 	  class BitRateMode
-  		CBR = 1
-  		VBR = 2
+  		CBR = 1 #CBR bitrate
+  		VBR = 2 #VBR bitrate
   	end
   end
 end

data/lib/kaltura/constants/category_order_by.rb

@@ -1,12 +1,18 @@
 module Kaltura
 	module Constants
+	  ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::CategoryFilter
+    ##
 	  class CategoryOrderBy
-  		DEPTH_ASC = "+depth"
-  		DEPTH_DESC = "-depth"
-  		FULL_NAME_ASC = "+fullName"
-  		FULL_NAME_DESC = "-fullName"
-  		CREATED_AT_ASC = "+createdAt"
-  		CREATED_AT_DESC = "-createdAt"
+  		DEPTH_ASC = "+depth" #order by depth ascending.
+  		DEPTH_DESC = "-depth" #order by depth descending.
+  		FULL_NAME_ASC = "+fullName" #order by full name ascending.
+  		FULL_NAME_DESC = "-fullName" #order by full name descending. 
+  		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+  		CREATED_AT_DESC = "-createdAt" #order by created_at descending.
   	end
   end
 end

data/lib/kaltura/constants/commercial_use_type.rb

@@ -1,8 +1,14 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Partner
+    ##    
     class CommercialUseType
-  		COMMERCIAL_USE = "commercial_use"
-  		NON_COMMERCIAL_USE = "non-commercial_use"
+  		COMMERCIAL_USE = "commercial_use" #Used for commercial purposes.
+  		NON_COMMERCIAL_USE = "non-commercial_use" #used for non-commercial purposes.
   	end
   end
 end

data/lib/kaltura/constants/container_format.rb

@@ -1,15 +1,21 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::FlavorAsset
+    ##
     class ContainerFormat
-  		FLV = "flv"
-  		MP4 = "mp4"
-  		AVI = "avi"
-  		MOV = "mov"
-  		MP3 = "mp3"
-  		_3GP = "3gp"
-  		OGG = "ogg"
-  		WMV = "wmv"
-  		ISMV = "ismv"
+  		FLV = "flv" #flash video.
+  		MP4 = "mp4" #MPEG-4 video
+  		AVI = "avi" #audio video interleave file
+  		MOV = "mov" #Apple Quicktime Movie
+  		MP3 = "mp3" #mp3 Audio
+  		_3GP = "3gp" #3GPP multimedia file
+  		OGG = "ogg" #ogg-vorbis video
+  		WMV = "wmv" #windows media video
+  		ISMV = "ismv" # iMovie file?  Unsure of this one.
   	end
   end
 end

data/lib/kaltura/constants/control_panel_command.rb

@@ -1,13 +1,26 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::ControlPanelCommandFilter
+    ##
     module ControlPanelCommand
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::Filter::ControlPanelCommandFilter
+      ##      
       class OrderBy
-    		CREATED_AT_ASC = "+createdAt"
-    		CREATED_AT_DESC = "-createdAt"
-    		UPDATED_AT_ASC = "+updatedAt"
-    		UPDATED_AT_DESC = "-updatedAt"
+    		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+    		CREATED_AT_DESC = "-createdAt" #order by created_at descending.
+    		UPDATED_AT_ASC = "+updatedAt" #order by updated_at ascending.
+    		UPDATED_AT_DESC = "-updatedAt" #order by updated_at descending.
     	end
     	
+    	# @private
     	class Status
     		PENDING = 1
     		HANDLED = 2
@@ -15,6 +28,7 @@ module Kaltura
     		FAILED = 4
     	end
     	
+    	# @private
     	class TargetType
     		DATA_CENTER = 1
     		SCHEDULER = 2
@@ -23,6 +37,7 @@ module Kaltura
     		BATCH = 5
     	end
     	
+    	# @private
     	class Type
     		STOP = 1
     		START = 2

data/lib/kaltura/constants/conversion_profile_order_by.rb

@@ -1,8 +1,14 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::ConversionProfileFilter
+    ##    
     class ConversionProfileOrderBy
-  		CREATED_AT_ASC = "+createdAt"
-  		CREATED_AT_DESC = "-createdAt"
+  		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+  		CREATED_AT_DESC = "-createdAt" #order by created_at descending.
   	end
   end
 end

data/lib/kaltura/constants/country_restriction_type.rb

@@ -1,8 +1,16 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Service::BaseEntryService
+    # @see Kaltura::EntryContextDataResult
+    # @see Kaltura::EntryContextDataParams
+    ##    
     class CountryRestrictionType
-  		RESTRICT_COUNTRY_LIST = 0
-  		ALLOW_COUNTRY_LIST = 1
+  		RESTRICT_COUNTRY_LIST = 0 #restrict countries.
+  		ALLOW_COUNTRY_LIST = 1 #allow countries.
   	end
   end
 end

data/lib/kaltura/constants/data_entry_order_by.rb

@@ -1,14 +1,20 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::DataEntryFilter
+    ##
     class DataEntryOrderBy
-  		NAME_ASC = "+name"
-  		NAME_DESC = "-name"
-  		MODERATION_COUNT_ASC = "+moderationCount"
-  		MODERATION_COUNT_DESC = "-moderationCount"
-  		CREATED_AT_ASC = "+createdAt"
-  		CREATED_AT_DESC = "-createdAt"
-  		RANK_ASC = "+rank"
-  		RANK_DESC = "-rank"
+  		NAME_ASC = "+name" #order by name ascending.
+  		NAME_DESC = "-name" #order by name descending.
+  		MODERATION_COUNT_ASC = "+moderationCount" #order by moderation count ascending.
+  		MODERATION_COUNT_DESC = "-moderationCount" #order by moderation count descending.
+  		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+  		CREATED_AT_DESC = "-createdAt" #order by created_at descending.
+  		RANK_ASC = "+rank" #order by rank ascending.
+  		RANK_DESC = "-rank" #order by rank descending.
   	end
   end
 end

data/lib/kaltura/constants/directory_restriction_type.rb

@@ -1,8 +1,14 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::DirectoryRestriction
+    ##    
     class DirectoryRestrictionType
-  		DONT_DISPLAY = 0
-  		DISPLAY_WITH_LINK = 1
+  		DONT_DISPLAY = 0 #do not display the directory.
+  		DISPLAY_WITH_LINK = 1 #display the directory.
   	end
   end
 end

data/lib/kaltura/constants/document.rb

@@ -1,20 +1,38 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::DocumentEntryFilter
+    # @see Kaltura::DocumentEntry
+    ##    
     module Document
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::Filter::DocumentFilter
+      ##
       class OrderBy
-    		NAME_ASC = "+name"
-    		NAME_DESC = "-name"
-    		MODERATION_COUNT_ASC = "+moderationCount"
-    		MODERATION_COUNT_DESC = "-moderationCount"
-    		CREATED_AT_ASC = "+createdAt"
-    		CREATED_AT_DESC = "-createdAt"
-    		RANK_ASC = "+rank"
-    		RANK_DESC = "-rank"
+    		NAME_ASC = "+name" #order by name ascending.
+    		NAME_DESC = "-name" #order by name descending.
+    		MODERATION_COUNT_ASC = "+moderationCount" #order by moderation count ascending.
+    		MODERATION_COUNT_DESC = "-moderationCount" #order by moderation count descending.
+    		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+    		CREATED_AT_DESC = "-createdAt" #ordery by created_at descending.
+    		RANK_ASC = "+rank" #order by rank ascending.
+    		RANK_DESC = "-rank" #order by rank descending.
     	end
-    	
+    	##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::DocumentEntry
+      ##
     	class Type
-    		DOCUMENT = 11
-    		SWF = 12
+    		DOCUMENT = 11 #Document.
+    		SWF = 12 #Executable Flash file.
     	end
     end
   end

data/lib/kaltura/constants/duration_type.rb

@@ -1,10 +1,16 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::PlayableEntryFilter
+    ##    
     class DurationType
-  		NOT_AVAILABLE = "notavailable"
-  		SHORT = "short"
-  		MEDIUM = "medium"
-  		LONG = "long"
+  		NOT_AVAILABLE = "notavailable" #unavailable duration.
+  		SHORT = "short" #short duration.
+  		MEDIUM = "medium" #medium duration.
+  		LONG = "long" #long duration.
   	end
   end	
 end

data/lib/kaltura/constants/editor_type.rb

@@ -1,8 +1,14 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::MixEntry
+    ##
     class EditorType
-  		SIMPLE = 1
-  		ADVANCED = 2
+  		SIMPLE = 1 #simple Mix Editor
+  		ADVANCED = 2 #advanced Mix Editor
   	end
   end
 end

data/lib/kaltura/constants/email_ingestion_profile_status.rb

@@ -1,8 +1,14 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::EmailIngestionProfile
+    ##
     class EmailIngestionProfileStatus
-  		INACTIVE = 0
-  		ACTIVE = 1
+  		INACTIVE = 0 #inactive profile.
+  		ACTIVE = 1 #active profile.
   	end
   end
 end