velir_kaltura-ruby 0.4.6 → 0.4.7

data/lib/kaltura/constants/stats/kmc_event_type.rb

@@ -1,70 +1,76 @@
 module Kaltura
   module Constants
     module Stats
+      ##
+      # 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::StatsKmcEvent
+      ##
       class KmcEventType
-    		CONTENT_PAGE_VIEW = 1001
-    		CONTENT_ADD_PLAYLIST = 1010
-    		CONTENT_EDIT_PLAYLIST = 1011
-    		CONTENT_DELETE_PLAYLIST = 1012
-    		CONTENT_DELETE_ITEM = 1058
-    		CONTENT_EDIT_ENTRY = 1013
-    		CONTENT_CHANGE_THUMBNAIL = 1014
-    		CONTENT_ADD_TAGS = 1015
-    		CONTENT_REMOVE_TAGS = 1016
-    		CONTENT_ADD_ADMIN_TAGS = 1017
-    		CONTENT_REMOVE_ADMIN_TAGS = 1018
-    		CONTENT_DOWNLOAD = 1019
-    		CONTENT_APPROVE_MODERATION = 1020
-    		CONTENT_REJECT_MODERATION = 1021
-    		CONTENT_BULK_UPLOAD = 1022
-    		CONTENT_ADMIN_KCW_UPLOAD = 1023
-    		CONTENT_CONTENT_GO_TO_PAGE = 1057
-    		CONTENT_ENTRY_DRILLDOWN = 1088
-    		CONTENT_OPEN_PREVIEW_AND_EMBED = 1089
-    		ACCOUNT_CHANGE_PARTNER_INFO = 1030
-    		ACCOUNT_CHANGE_LOGIN_INFO = 1031
-    		ACCOUNT_CONTACT_US_USAGE = 1032
-    		ACCOUNT_UPDATE_SERVER_SETTINGS = 1033
-    		ACCOUNT_ACCOUNT_OVERVIEW = 1034
-    		ACCOUNT_ACCESS_CONTROL = 1035
-    		ACCOUNT_TRANSCODING_SETTINGS = 1036
-    		ACCOUNT_ACCOUNT_UPGRADE = 1037
-    		ACCOUNT_SAVE_SERVER_SETTINGS = 1038
-    		ACCOUNT_ACCESS_CONTROL_DELETE = 1039
-    		ACCOUNT_SAVE_TRANSCODING_SETTINGS = 1040
-    		LOGIN = 1041
-    		DASHBOARD_IMPORT_CONTENT = 1042
-    		DASHBOARD_UPDATE_CONTENT = 1043
-    		DASHBOARD_ACCOUNT_CONTACT_US = 1044
-    		DASHBOARD_VIEW_REPORTS = 1045
-    		DASHBOARD_EMBED_PLAYER = 1046
-    		DASHBOARD_EMBED_PLAYLIST = 1047
-    		DASHBOARD_CUSTOMIZE_PLAYERS = 1048
-    		APP_STUDIO_NEW_PLAYER_SINGLE_VIDEO = 1050
-    		APP_STUDIO_NEW_PLAYER_PLAYLIST = 1051
-    		APP_STUDIO_NEW_PLAYER_MULTI_TAB_PLAYLIST = 1052
-    		APP_STUDIO_EDIT_PLAYER_SINGLE_VIDEO = 1053
-    		APP_STUDIO_EDIT_PLAYER_PLAYLIST = 1054
-    		APP_STUDIO_EDIT_PLAYER_MULTI_TAB_PLAYLIST = 1055
-    		APP_STUDIO_DUPLICATE_PLAYER = 1056
-    		REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_TAB = 1070
-    		REPORTS_AND_ANALYTICS_CONTENT_REPORTS_TAB = 1071
-    		REPORTS_AND_ANALYTICS_USERS_AND_COMMUNITY_REPORTS_TAB = 1072
-    		REPORTS_AND_ANALYTICS_TOP_CONTRIBUTORS = 1073
-    		REPORTS_AND_ANALYTICS_MAP_OVERLAYS = 1074
-    		REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS = 1075
-    		REPORTS_AND_ANALYTICS_TOP_CONTENT = 1076
-    		REPORTS_AND_ANALYTICS_CONTENT_DROPOFF = 1077
-    		REPORTS_AND_ANALYTICS_CONTENT_INTERACTIONS = 1078
-    		REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS = 1079
-    		REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN = 1080
-    		REPORTS_AND_ANALYTICS_CONTENT_DRILL_DOWN_INTERACTION = 1081
-    		REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS_DRILLDOWN = 1082
-    		REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN_DROPOFF = 1083
-    		REPORTS_AND_ANALYTICS_MAP_OVERLAYS_DRILLDOWN = 1084
-    		REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS_DRILL_DOWN = 1085
-    		REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_MONTHLY = 1086
-    		REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_YEARLY = 1087
+    		CONTENT_PAGE_VIEW = 1001 #A page with a KDP widget is viewed.
+    		CONTENT_ADD_PLAYLIST = 1010 #A playable entry is added to a playlist.
+    		CONTENT_EDIT_PLAYLIST = 1011 #A playist is edited.
+    		CONTENT_DELETE_PLAYLIST = 1012 #Content is removed from a playlist.
+    		CONTENT_DELETE_ITEM = 1058 #A property is removed from an entry.
+    		CONTENT_EDIT_ENTRY = 1013 #An entry is edited.
+    		CONTENT_CHANGE_THUMBNAIL = 1014 #An entry's thumbnail is changed.
+    		CONTENT_ADD_TAGS = 1015 #Tags are added to an entry.
+    		CONTENT_REMOVE_TAGS = 1016 #Tags are removed from an entry.
+    		CONTENT_ADD_ADMIN_TAGS = 1017 #Administrative tags are added to an entry.
+    		CONTENT_REMOVE_ADMIN_TAGS = 1018 #Administrative tags are removed from an entry.
+    		CONTENT_DOWNLOAD = 1019 #An entry/flavor is downloaded.
+    		CONTENT_APPROVE_MODERATION = 1020 #An entry is appproved.
+    		CONTENT_REJECT_MODERATION = 1021 #An entry is rejected.
+    		CONTENT_BULK_UPLOAD = 1022 #The Batch uploaded use used.
+    		CONTENT_ADMIN_KCW_UPLOAD = 1023 #The KCW is used to upload content.
+    		CONTENT_CONTENT_GO_TO_PAGE = 1057 #An entry is clicked, bringing up a detailed menu.
+    		CONTENT_ENTRY_DRILLDOWN = 1088 #A dropdown is entered from the entry menu.
+    		CONTENT_OPEN_PREVIEW_AND_EMBED = 1089 #the preview and embed link is clicked.
+    		ACCOUNT_CHANGE_PARTNER_INFO = 1030 #The accounts API information is changed.
+    		ACCOUNT_CHANGE_LOGIN_INFO = 1031 #The accounts login information is changed.
+    		ACCOUNT_CONTACT_US_USAGE = 1032 #The accounts contact information is changed.
+    		ACCOUNT_UPDATE_SERVER_SETTINGS = 1033 #The accounts server settings are changed.
+    		ACCOUNT_ACCOUNT_OVERVIEW = 1034 #The account overview settings are changed.
+    		ACCOUNT_ACCESS_CONTROL = 1035 #The access control for an account is modified.
+    		ACCOUNT_TRANSCODING_SETTINGS = 1036 #The default transcoding settings are modified.
+    		ACCOUNT_ACCOUNT_UPGRADE = 1037 #The Account is upgraded/downgraded.
+    		ACCOUNT_SAVE_SERVER_SETTINGS = 1038 #The Account udpates are saved to the database.
+    		ACCOUNT_ACCESS_CONTROL_DELETE = 1039 #The account's access has been revoked.
+    		ACCOUNT_SAVE_TRANSCODING_SETTINGS = 1040 #The accounts encoding settings have been saved to the database.
+    		LOGIN = 1041 #A KMC login event fires.
+    		DASHBOARD_IMPORT_CONTENT = 1042 #The content report is brought in on the dashboard.
+    		DASHBOARD_UPDATE_CONTENT = 1043 #The content report is updated on the dashbaord.
+    		DASHBOARD_ACCOUNT_CONTACT_US = 1044 #The Dashboard contact settings have changed.
+    		DASHBOARD_VIEW_REPORTS = 1045 #The view report for the Dashboard is updated.
+    		DASHBOARD_EMBED_PLAYER = 1046 #The player is embedded on the Dashboard report is updated.
+    		DASHBOARD_EMBED_PLAYLIST = 1047 #The dashboard playlist is updated.
+    		DASHBOARD_CUSTOMIZE_PLAYERS = 1048 #The dashboard player is customized.
+    		APP_STUDIO_NEW_PLAYER_SINGLE_VIDEO = 1050 #A new single video player is created.
+    		APP_STUDIO_NEW_PLAYER_PLAYLIST = 1051 #A new playlist player is created.
+    		APP_STUDIO_NEW_PLAYER_MULTI_TAB_PLAYLIST = 1052 #A new multi-tab playlist player is created.
+    		APP_STUDIO_EDIT_PLAYER_SINGLE_VIDEO = 1053 #A single video player is updated.
+    		APP_STUDIO_EDIT_PLAYER_PLAYLIST = 1054 #A playlist player is updated.
+    		APP_STUDIO_EDIT_PLAYER_MULTI_TAB_PLAYLIST = 1055 #A multitab playlist player is updated.
+    		APP_STUDIO_DUPLICATE_PLAYER = 1056 #A player is duplicated.
+    		REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_TAB = 1070 #The bandwidth usage report is updated.
+    		REPORTS_AND_ANALYTICS_CONTENT_REPORTS_TAB = 1071 #The content reports tab is updated.
+    		REPORTS_AND_ANALYTICS_USERS_AND_COMMUNITY_REPORTS_TAB = 1072 #The user community report is updated.
+    		REPORTS_AND_ANALYTICS_TOP_CONTRIBUTORS = 1073 #The top contributors report is updated.
+    		REPORTS_AND_ANALYTICS_MAP_OVERLAYS = 1074 #The map overlays report is updated.
+    		REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS = 1075 #The top syndications report is updated.
+    		REPORTS_AND_ANALYTICS_TOP_CONTENT = 1076 #The top content report is updated.
+    		REPORTS_AND_ANALYTICS_CONTENT_DROPOFF = 1077 #The content dropoff report is updated.
+    		REPORTS_AND_ANALYTICS_CONTENT_INTERACTIONS = 1078 #The content intearaction report is updated.
+    		REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS = 1079 #The content contributions report is updated. 
+    		REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN = 1080 #The dropdowns on the reports section is clicked.
+    		REPORTS_AND_ANALYTICS_CONTENT_DRILL_DOWN_INTERACTION = 1081 #The dropdown on the report section is used.
+    		REPORTS_AND_ANALYTICS_CONTENT_CONTRIBUTIONS_DRILLDOWN = 1082 #The content contributions dropdown is selected.
+    		REPORTS_AND_ANALYTICS_VIDEO_DRILL_DOWN_DROPOFF = 1083 #The content dropoff dropdown is selected.
+    		REPORTS_AND_ANALYTICS_MAP_OVERLAYS_DRILLDOWN = 1084 #The map overlays dropdown is selected.
+    		REPORTS_AND_ANALYTICS_TOP_SYNDICATIONS_DRILL_DOWN = 1085 #The top syndications dropdown is selected.
+    		REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_MONTHLY = 1086 #The monthly bandwith report.
+    		REPORTS_AND_ANALYTICS_BANDWIDTH_USAGE_VIEW_YEARLY = 1087 #The yearly bandwith report.
     	end
     end
   end

data/lib/kaltura/constants/stats.rb

@@ -2,34 +2,47 @@ require 'kaltura/constants/stats/kmc_event_type'
 
 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::StatsEvent
+    # @see Kaltura::StatsKmcEvent
+    ##
     module Stats
+      ##
+      # 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::StatsEvent
+      ##
       class EventType
-    		WIDGET_LOADED = 1
-    		MEDIA_LOADED = 2
-    		PLAY = 3
-    		PLAY_REACHED_25 = 4
-    		PLAY_REACHED_50 = 5
-    		PLAY_REACHED_75 = 6
-    		PLAY_REACHED_100 = 7
-    		OPEN_EDIT = 8
-    		OPEN_VIRAL = 9
-    		OPEN_DOWNLOAD = 10
-    		OPEN_REPORT = 11
-    		BUFFER_START = 12
-    		BUFFER_END = 13
-    		OPEN_FULL_SCREEN = 14
-    		CLOSE_FULL_SCREEN = 15
-    		REPLAY = 16
-    		SEEK = 17
-    		OPEN_UPLOAD = 18
-    		SAVE_PUBLISH = 19
-    		CLOSE_EDITOR = 20
-    		PRE_BUMPER_PLAYED = 21
-    		POST_BUMPER_PLAYED = 22
-    		BUMPER_CLICKED = 23
-    		FUTURE_USE_1 = 24
-    		FUTURE_USE_2 = 25
-    		FUTURE_USE_3 = 26
+    		WIDGET_LOADED = 1 #Widget loaded event.
+    		MEDIA_LOADED = 2 #Media loaded event.
+    		PLAY = 3 #Play event.
+    		PLAY_REACHED_25 = 4 #Player has reached 25% completed event.
+    		PLAY_REACHED_50 = 5 #Player has reached 50% completed event.
+    		PLAY_REACHED_75 = 6 #Player has reached 75% completed event.
+    		PLAY_REACHED_100 = 7 #Player has reached 100% completed event.
+    		OPEN_EDIT = 8 #Editor has been opened event.
+    		OPEN_VIRAL = 9 #Share button has been clicked.
+    		OPEN_DOWNLOAD = 10 #Download button has been clicked.
+    		OPEN_REPORT = 11 #Report has been generated.
+    		BUFFER_START = 12 #The player has started buffering.
+    		BUFFER_END = 13 #The player has ended buffering.
+    		OPEN_FULL_SCREEN = 14 #The fullscreen button has been clicked.
+    		CLOSE_FULL_SCREEN = 15 #The fullscreen window has been closed.
+    		REPLAY = 16 #The replay button has been clicked.
+    		SEEK = 17 #A seek event has fired.
+    		OPEN_UPLOAD = 18 #A KSU/KCW upload has begun.
+    		SAVE_PUBLISH = 19 #A KCW/KAE/KSE clip has been saved.
+    		CLOSE_EDITOR = 20 #A KCW/KAE/KSE clip has been saved.
+    		PRE_BUMPER_PLAYED = 21 #The ad at the start of the video has played
+    		POST_BUMPER_PLAYED = 22 #The ad at the end of the video has been played.
+    		BUMPER_CLICKED = 23 #The ad was clicked.
+    		FUTURE_USE_1 = 24 #When unicorns rule the earth.
+    		FUTURE_USE_2 = 25 #Reserved for when twitter gains sentience.
+    		FUTURE_USE_3 = 26 #Unsure.
     	end
     end
   end

data/lib/kaltura/constants/syndication_feed.rb

@@ -1,16 +1,36 @@
 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::SyndicationFeedService
+    ##    
     module SyndicationFeed
+      
+      ##
+      # 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::SyndicationFeedService
+      ##      
       class Status
-    		DELETED = -1
-    		ACTIVE = 1
+    		DELETED = -1 #Deleted Syndication Feed
+    		ACTIVE = 1 #Active Syndication Feed
     	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::ITunesSyndicationFeedFilter
+      # @see Kaltura::Service::SyndicationFeedService
+      ##
     	class Type
-    		GOOGLE_VIDEO = 1
-    		YAHOO = 2
-    		ITUNES = 3
-    		TUBE_MOGUL = 4
+    		GOOGLE_VIDEO = 1 #GoogleVideoSyndicationFeed
+    		YAHOO = 2 #YahooSyndicationFeed
+    		ITUNES = 3 #ITunesSyndicationFeed
+    		TUBE_MOGUL = 4 #TubeMogulSyndicationFeed
     	end
     end
   end

data/lib/kaltura/constants.rb

@@ -49,14 +49,27 @@ require 'kaltura/constants/widget'
 require 'kaltura/constants/yahoo_syndication_feed'
 
 module Kaltura
+  ##
+  # The constants module will soon be depreciated into an Enumeration module to
+  # be more in line with the C# API client's namespacing.
+  ##
   module Constants
-  
+    
+    ##
+    # @deprecated This class has no constants.
+    ##
 	  class FlavorParamsOrderBy
 	  end
 
+    ##
+    # @deprecated This class has no constants.
+    ##
 	  class FlavorParamsOutputOrderBy
 	  end
-	
+
+    ##
+    # @deprecated This class has no constants.
+    ##	
 	  class MediaInfoOrderBy
 	  end
 	    

data/lib/kaltura/kaltura_client_base.rb

@@ -282,7 +282,9 @@ module Kaltura
 	    request.gsub("Kaltura","")
     end
 	  def self.request_is_response?(request)
-	    request == request.split("Response",0).to_s
+	    request_array = []
+	    request_array << request
+	    request_array == request.split("Response",0)
     end
 	end
 	

data/lib/kaltura/service/base_entry_service.rb

@@ -316,7 +316,7 @@ module Kaltura
       # @param [Kaltura::EntryContextDataParams] context_data_params The only field not inherited from Kaltura::ObjectBase
       #   is referrer, so I imagine that is what you should set.
       #
-      # @return [Kaltura::EntryConextDataResult] Returns some context info, including is the entry restricted by country or session.
+      # @return [Kaltura::EntryContextDataResult] Returns some context info, including is the entry restricted by country or session.
       #
       # @raise [Kaltura::APIError] Raises default Kaltura errors.
       ##

data/lib/kaltura/service/live_stream_service.rb

@@ -53,7 +53,12 @@ module Kaltura
       # Like all of the other Kaltura API update actions it is best to instantiate a new LiveStreamAdminEntry object
       # instead of pulling the existing one and updating its fields.
       #
-      # @param [String] The 
+      # @param [String] entry_id The live stream entry ID.
+      # @param [Kaltura::LiveStreamEntry] live_stream_entry A LiveStreamEntry object with the fields you wish to update populated.
+      #
+      # @return [Kaltura::LiveStreamEntry] Returns the entry_id with the updated fields.  It will also bump the version.
+      #
+      # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
       #
       ##
   		def update(entry_id, live_stream_entry)
@@ -63,19 +68,49 @@ module Kaltura
   			perform_request('liveStream','update',kparams,false)
   		end
 
+      ##
+      # Deletes a live stream entry object.
+      #
+      # @param [String] entry_id The live stream entry ID.
+      #
+      # @return [nil] Returns nothing
+      #
+      # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
+      ##
   		def delete(entry_id)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			perform_request('liveStream','delete',kparams,false)
   		end
-
+  		
+      ##
+      # Lists live streams by the filter with paging support for large sets of live streams.
+      #
+      # @param [Kaltura::Filter::LiveStreamEntryFilter] The live stream filter is a wrapper for Kaltura::Filter::MediaEntryFilter
+      # @param [Kaltura::FilterPager] The default Kaltura pager.
+      #
+      # @return [Kaltura::Response::LiveStreamListResponse] This is a wrapper for Kaltura::Response::BaseRespsone.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
   		def list(filter=nil, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)
   			client.add_param(kparams, 'pager', pager)
   			perform_request('liveStream','list',kparams,false)
   		end
-
+  		
+  		##
+  		# Updates the live stream entries offline thumbnail using a raw jpgeg file.
+  		#
+  		# @param [String] entry_id The live stream entry ID.
+  		# @param [File] file_data The JPEG file to use as the stream is offline backdrop.
+  		#
+  		# @return [Kaltura::LiveStreamEntry] The live stream entry with the updated thumbnail and version.
+  		#
+  		# @raise [Kaltura::APIError] Raises default Kaltura errors plus 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist and
+  	  #   'PERMISSION_DENIED_TO_UPDATE_ENTRY' if the user is does not own the live stream and isn't an administrator.
+  		##
   		def update_offline_thumbnail_jpeg(entry_id, file_data)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
@@ -83,6 +118,17 @@ module Kaltura
   			perform_request('liveStream','updateOfflineThumbnailJpeg',kparams,false)
   		end
 
+  		##
+  		# Updates the live stream entries offline thumbnail using a URL.
+  		#
+  		# @param [String] entry_id The live stream entry ID.
+  		# @param [File] url The URL to a JPEG file to use as the stream is offline backdrop.
+  		#
+  		# @return [Kaltura::LiveStreamEntry] The live stream entry with the updated thumbnail and version.
+  		#
+  		# @raise [Kaltura::APIError] Raises default Kaltura errors plus 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist and
+  	  #   'PERMISSION_DENIED_TO_UPDATE_ENTRY' if the user is does not own the live stream and isn't an administrator.
+  		##
   		def update_offline_thumbnail_from_url(entry_id, url)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)