velir_kaltura-ruby 0.4.6 → 0.4.7

data/lib/kaltura/constants/media.rb

@@ -1,35 +1,54 @@
 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::MediaEntryFilter
+    # @see Kaltura::MediaEntry
+    ##
     module Media
+      ##
+      # 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::MediaEntryFilter
+      ##      
       class OrderBy
-    		MEDIA_TYPE_ASC = "+mediaType"
-    		MEDIA_TYPE_DESC = "-mediaType"
-    		PLAYS_ASC = "+plays"
-    		PLAYS_DESC = "-plays"
-    		VIEWS_ASC = "+views"
-    		VIEWS_DESC = "-views"
-    		DURATION_ASC = "+duration"
-    		DURATION_DESC = "-duration"
-    		MS_DURATION_ASC = "+msDuration"
-    		MS_DURATION_DESC = "-msDuration"
-    		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"
+    		MEDIA_TYPE_ASC = "+mediaType" #order by media type ascending
+    		MEDIA_TYPE_DESC = "-mediaType" #order by media type descending
+    		PLAYS_ASC = "+plays" #order by plays ascending
+    		PLAYS_DESC = "-plays" #order by plays descending
+    		VIEWS_ASC = "+views" #order by views ascending
+    		VIEWS_DESC = "-views" #order by views descending
+    		DURATION_ASC = "+duration" #order by duration ascending
+    		DURATION_DESC = "-duration" #order by duration descending
+    		MS_DURATION_ASC = "+msDuration" #order by millisecond duration ascending
+    		MS_DURATION_DESC = "-msDuration" #order by millisecond duration descending
+    		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
     	
+      ##
+      # 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::MediaEntry
+      ##    	
     	class Type
-    		VIDEO = 1
-    		IMAGE = 2
-    		AUDIO = 5
-    		LIVE_STREAM_FLASH = 201
-    		LIVE_STREAM_WINDOWS_MEDIA = 202
-    		LIVE_STREAM_REAL_MEDIA = 203
-    		LIVE_STREAM_QUICKTIME = 204
+    		VIDEO = 1 # Video
+    		IMAGE = 2 # Image
+    		AUDIO = 5 # Audio
+    		LIVE_STREAM_FLASH = 201 #Flash Live Stream
+    		LIVE_STREAM_WINDOWS_MEDIA = 202 #Windows Media Live Stream
+    		LIVE_STREAM_REAL_MEDIA = 203 #Real Media Live Stream
+    		LIVE_STREAM_QUICKTIME = 204 #Quicktime Live Stream
     	end
     end
   end

data/lib/kaltura/constants/mix_entry_order_by.rb

@@ -1,22 +1,28 @@
 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::MixEntryFilter
+    ##
     class MixEntryOrderBy
-  		PLAYS_ASC = "+plays"
-  		PLAYS_DESC = "-plays"
-  		VIEWS_ASC = "+views"
-  		VIEWS_DESC = "-views"
-  		DURATION_ASC = "+duration"
-  		DURATION_DESC = "-duration"
-  		MS_DURATION_ASC = "+msDuration"
-  		MS_DURATION_DESC = "-msDuration"
-  		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"
+  		PLAYS_ASC = "+plays" #order by plays ascending
+  		PLAYS_DESC = "-plays" #order by plays descending
+  		VIEWS_ASC = "+views" #order by views ascending
+  		VIEWS_DESC = "-views" #order by views descending
+  		DURATION_ASC = "+duration" #order by duration ascending
+  		DURATION_DESC = "-duration" #order by duration descending
+  		MS_DURATION_ASC = "+msDuration" #order by millisecond duration ascending
+  		MS_DURATION_DESC = "-msDuration" #order by millisecond duration descending
+  		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/moderation.rb

@@ -1,21 +1,33 @@
 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::ModerationFlag
+    ##
     module Moderation
+      ##
+      # 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::ModerationFlag
+      ##      
       class FlagStatus
-    		PENDING = 1
-    		MODERATED = 2
+    		PENDING = 1 #Pending moderation flag
+    		MODERATED = 2 #Moderated flag
     	end
     	
     	class FlagType
-    		SEXUAL_CONTENT = 1
-    		VIOLENT_REPULSIVE = 2
-    		HARMFUL_DANGEROUS = 3
-    		SPAM_COMMERCIALS = 4
+    		SEXUAL_CONTENT = 1 #Flag for sexual content
+    		VIOLENT_REPULSIVE = 2 #Flag for violent or repulsive content
+    		HARMFUL_DANGEROUS = 3 #Flag for harmful or dangerous content
+    		SPAM_COMMERCIALS = 4 #Spam flag
     	end
     	
       class ObjectType
-    		ENTRY = 2
-    		USER = 3
+    		ENTRY = 2 #flag a entry.
+    		USER = 3 #flag a user.
     	end
     end
   end

data/lib/kaltura/constants/notification.rb

@@ -1,23 +1,42 @@
 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::NotificationFilter
+    # @see Kaltura::Service::NotificationService
+    ##
     module Notification
+      ##
+      # 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::NotificationFilter
+      ##
       class OrderBy
-    		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 descening.
+    		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::Service::NotificationService
+      ##    	
     	class Type
-    		ENTRY_ADD = 1
-    		ENTR_UPDATE_PERMISSIONS = 2
-    		ENTRY_DELETE = 3
-    		ENTRY_BLOCK = 4
-    		ENTRY_UPDATE = 5
-    		ENTRY_UPDATE_THUMBNAIL = 6
-    		ENTRY_UPDATE_MODERATION = 7
-    		USER_ADD = 21
-    		USER_BANNED = 26
+    		ENTRY_ADD = 1 #Notify when an entry is added.
+    		ENTR_UPDATE_PERMISSIONS = 2 #Notify when an entries permisisons have changed.
+    		ENTRY_DELETE = 3 #Notify when an entry is deleted.
+    		ENTRY_BLOCK = 4 #Notify when an entry becomes unavailable due to moderation.
+    		ENTRY_UPDATE = 5 #Notify when an entry is updated.
+    		ENTRY_UPDATE_THUMBNAIL = 6 #Notify when an entries thumbnail is updated.
+    		ENTRY_UPDATE_MODERATION = 7 #Notify when an entry is moderated.
+    		USER_ADD = 21 #Notify when a new user is created.
+    		USER_BANNED = 26 #Notify when a user is banned.
     	end
     end
   end

data/lib/kaltura/constants/nullable_boolean.rb

@@ -1,9 +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.
+    #
+    ##
     class NullableBoolean
-  		NULL_VALUE = -1
-  		FALSE_VALUE = 0
-  		TRUE_VALUE = 1
+  		NULL_VALUE = -1 #Null
+  		FALSE_VALUE = 0 #False
+  		TRUE_VALUE = 1 #True
   	end
   end
 end

data/lib/kaltura/constants/partner.rb

@@ -1,38 +1,63 @@
 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::PartnerFilter
+    # @see Kaltura::Partner
+    ##    
     module Partner
+      ##
+      # 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::PartnerFilter
+      ##      
       class OrderBy
-    		ID_ASC = "+id"
-    		ID_DESC = "-id"
-    		NAME_ASC = "+name"
-    		NAME_DESC = "-name"
-    		WEBSITE_ASC = "+website"
-    		WEBSITE_DESC = "-website"
-    		CREATED_AT_ASC = "+createdAt"
-    		CREATED_AT_DESC = "-createdAt"
-    		ADMIN_NAME_ASC = "+adminName"
-    		ADMIN_NAME_DESC = "-adminName"
-    		ADMIN_EMAIL_ASC = "+adminEmail"
-    		ADMIN_EMAIL_DESC = "-adminEmail"
-    		STATUS_ASC = "+status"
-    		STATUS_DESC = "-status"
+    		ID_ASC = "+id" #order by ID ascending
+    		ID_DESC = "-id" #order by ID descending
+    		NAME_ASC = "+name" #order by name ascending
+    		NAME_DESC = "-name" #order by name descending
+    		WEBSITE_ASC = "+website" #order by website ascending
+    		WEBSITE_DESC = "-website" #order by website descending
+    		CREATED_AT_ASC = "+createdAt" #order by created_at ascending
+    		CREATED_AT_DESC = "-createdAt" #order by created_at descending
+    		ADMIN_NAME_ASC = "+adminName" #order by admin name ascending
+    		ADMIN_NAME_DESC = "-adminName" #order by admin name descending
+    		ADMIN_EMAIL_ASC = "+adminEmail" #order by admin email ascending
+    		ADMIN_EMAIL_DESC = "-adminEmail" #order by admin email descending
+    		STATUS_ASC = "+status" #order by status ascending
+    		STATUS_DESC = "-status" #order by status 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::Partner
+      ##    	
     	class Status
-    		ACTIVE = 1
-    		BLOCKED = 2
-    		FULL_BLOCK = 3
+    		ACTIVE = 1 #Partner is active.
+    		BLOCKED = 2 #Partner is banned.
+    		FULL_BLOCK = 3 #Partner is mega-banned
     	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::Partner
+      ##    	
     	class Type
-    		KMC = 1
-    		WIKI = 100
-    		WORDPRESS = 101
-    		DRUPAL = 102
-    		DEKIWIKI = 103
-    		MOODLE = 104
-    		COMMUNITY_EDITION = 105
-    		JOOMLA = 106
+    		KMC = 1 #KMC Partner
+    		WIKI = 100 #Media Wiki Partner
+    		WORDPRESS = 101 #Wordpress Partner
+    		DRUPAL = 102 #Drupal Partner
+    		DEKIWIKI = 103 #Deki Wiki Partner
+    		MOODLE = 104 #Moodle Partner
+    		COMMUNITY_EDITION = 105 #CE Partner
+    		JOOMLA = 106 #Joomla Partner
     	end
     end
   end

data/lib/kaltura/constants/playable_entry_order_by.rb

@@ -1,22 +1,28 @@
 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 PlayableEntryOrderBy
-  		PLAYS_ASC = "+plays"
-  		PLAYS_DESC = "-plays"
-  		VIEWS_ASC = "+views"
-  		VIEWS_DESC = "-views"
-  		DURATION_ASC = "+duration"
-  		DURATION_DESC = "-duration"
-  		MS_DURATION_ASC = "+msDuration"
-  		MS_DURATION_DESC = "-msDuration"
-  		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"
+  		PLAYS_ASC = "+plays" #order by plays ascending
+  		PLAYS_DESC = "-plays" #order by plays descending
+  		VIEWS_ASC = "+views" #order by views ascending
+  		VIEWS_DESC = "-views" #order by views descending
+  		DURATION_ASC = "+duration" #order by duration ascending
+  		DURATION_DESC = "-duration" #order by duration descending
+  		MS_DURATION_ASC = "+msDuration" #order by millisecond duration ascending
+  		MS_DURATION_DESC = "-msDuration" #order by millisecond duration descending
+  		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/playlist.rb

@@ -1,21 +1,34 @@
 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::PlaylistFilter
+    # @see Kaltura::Playlist
+    ##    
     module Playlist
+      ##
+      # 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::PlaylistFilter
+      ##      
       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" #order by created_at descending
+    		RANK_ASC = "+rank" #order by rank ascending
+    		RANK_DESC = "-rank" #order by rank descending
     	end
     	
     	class Type
-    		DYNAMIC = 10
-    		STATIC_LIST = 3
-    		EXTERNAL = 101
+    		DYNAMIC = 10 #Dynamic playlist
+    		STATIC_LIST = 3 #Static playlist
+    		EXTERNAL = 101 #External Playlist
     	end
     end
   end

data/lib/kaltura/constants/report_type.rb

@@ -1,14 +1,24 @@
 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::ReportGraph
+    # @see Kaltura::ReportInputFilter
+    # @see Kaltura::ReportTable
+    # @see Kaltura::ReportTotal
+    # @see Kaltura::ReportType
+    ##
     class ReportType
-  		TOP_CONTENT = 1
-  		CONTENT_DROPOFF = 2
-  		CONTENT_INTERACTIONS = 3
-  		MAP_OVERLAY = 4
-  		TOP_CONTRIBUTORS = 5
-  		TOP_SYNDICATION = 6
-  		CONTENT_CONTRIBUTIONS = 7
-  		ADMIN_CONSOLE = 10
+  		TOP_CONTENT = 1 #Top content report
+  		CONTENT_DROPOFF = 2 #content drop-off report
+  		CONTENT_INTERACTIONS = 3 #content interactions report
+  		MAP_OVERLAY = 4 #map overlay report
+  		TOP_CONTRIBUTORS = 5 #top contributors report
+  		TOP_SYNDICATION = 6 #top syndication report
+  		CONTENT_CONTRIBUTIONS = 7 #content contributions report
+  		ADMIN_CONSOLE = 10 #admin console report
   	end
   end
 end

data/lib/kaltura/constants/search_provider_type.rb

@@ -1,22 +1,29 @@
 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::Search
+    # @see Kaltura::SearchResult
+    ##    
     class SearchProviderType
-  		FLICKR = 3
-  		YOUTUBE = 4
-  		MYSPACE = 7
-  		PHOTOBUCKET = 8
-  		JAMENDO = 9
-  		CCMIXTER = 10
-  		NYPL = 11
-  		CURRENT = 12
-  		MEDIA_COMMONS = 13
-  		KALTURA = 20
-  		KALTURA_USER_CLIPS = 21
-  		ARCHIVE_ORG = 22
-  		KALTURA_PARTNER = 23
-  		METACAFE = 24
-  		SEARCH_PROXY = 28
-  		PARTNER_SPECIFIC = 100
+  		FLICKR = 3 #Flickr search
+  		YOUTUBE = 4 #Youtube search
+  		MYSPACE = 7 #MySpace search
+  		PHOTOBUCKET = 8 #photobucket search
+  		JAMENDO = 9 #Jamendo search
+  		CCMIXTER = 10 #CCMixer search
+  		NYPL = 11 #NYPL search 
+  		CURRENT = 12 #Current search
+  		MEDIA_COMMONS = 13 #Media Commons search
+  		KALTURA = 20 #Kaltura search
+  		KALTURA_USER_CLIPS = 21 #Kaltura mix search
+  		ARCHIVE_ORG = 22 #Archive.org search
+  		KALTURA_PARTNER = 23 #Kaltura partner search
+  		METACAFE = 24 #Metacafe search
+  		SEARCH_PROXY = 28 #Search proxy
+  		PARTNER_SPECIFIC = 100 #partner specific search
   	end
   end
 end

data/lib/kaltura/constants/session_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::Service::SessionService
+    ##
     class SessionType
-  		USER = 0
-  		ADMIN = 2
+  		USER = 0 #User KS
+  		ADMIN = 2 #Admin KS
   	end
   end
 end

data/lib/kaltura/constants/site_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::SiteRestriction
+    ##    
     class SiteRestrictionType
-  		RESTRICT_SITE_LIST = 0
-  		ALLOW_SITE_LIST = 1
+  		RESTRICT_SITE_LIST = 0 #Site white list
+  		ALLOW_SITE_LIST = 1 #Site black list
   	end
   end
 end

data/lib/kaltura/constants/source_type.rb

@@ -1,11 +1,17 @@
 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::MediaEntry
+    ##    
     class SourceType
-  		FILE = 1
-  		WEBCAM = 2
-  		URL = 5
-  		SEARCH_PROVIDER = 6
-  		AKAMAI_LIVE = 29
+  		FILE = 1 #Sourced by a file
+  		WEBCAM = 2 #Sourced from a webcam recording
+  		URL = 5 #Sourced by an external URL
+  		SEARCH_PROVIDER = 6 #Sourced by a website search.
+  		AKAMAI_LIVE = 29 #Sourced from Akamai.
   	end
   end
 end