velir_kaltura-ruby 0.4.5 → 0.4.6

data/lib/kaltura/service/flavor_params_service.rb

@@ -1,19 +1,57 @@
 module Kaltura
   module Service
+    
+    ##
+    # The Flavor Params service is responsible for adding and managing flavor params
+    ##
     class FlavorParamsService < BaseService
 
+      ##
+      # Adds a new Flavor param.
+      #
+      # @param [Kaltura::FlavorParams] flavor_params The flavor params object to add to Kaltura.
+      #
+      # @return [Kaltura::FlavorParams] Returns the flavor params object as stored in the Kaltura system.
+      #   Would be helpful to store the ID for later use.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors
+      ##
   		def add(flavor_params)
   			kparams = {}
   			client.add_param(kparams, 'flavorParams', flavor_params)
   			perform_request('flavorParams','add',kparams,false)
   		end
 
+      ##
+      # Retrieves a flavor param.
+      #
+      # @param [Integer] id The flavor param ID.
+      #
+      # @return [Kaltura::FlavorParams] The requested flavor params.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
   		def get(id)
   			kparams = {}
   			client.add_param(kparams, 'id', id)
   			perform_request('flavorParams','get',kparams,false)
   		end
 
+      ##
+      # Updates an existing flavor params object.
+      # As with other Kaltura API update actions, it is best to instantiate a new flavor params
+      # object instead of retrieving the existing one.  You only add fields for the fields you wish to
+      # change.
+      #
+      # @param [Integer] id The flavor param ID.
+      # @param [Kaltura::FlavorParams] A newly instantiated flavor params object that contains the fields 
+      #   you wish to change on the existing flavor params object.
+      #
+      # @return [Kaltura::FlavorParams] The newly updated flavor param object.  The version will have been bumped.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      #
+      ##
   		def update(id, flavor_params)
   			kparams = {}
   			client.add_param(kparams, 'id', id)
@@ -21,12 +59,32 @@ module Kaltura
   			perform_request('flavorParams','update',kparams,false)
   		end
 
+      ##
+      # Deletes the requested flavor param.
+      # 
+      # @param [Integer] id The flavor param id.
+      #
+      # @return [nil] Returns nothing.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
   		def delete(id)
   			kparams = {}
   			client.add_param(kparams, 'id', id)
   			perform_request('flavorParams','delete',kparams,false)
   		end
 
+      ##
+      # Lists flavor params by filter with paging support.
+      # In addition, all system default parameters will be listed as well.
+      #
+      # @param [Kaltura::Filter::FlavorParamsFilter] filter The filter to apply.
+      # @param [Kaltura::FilterPager] The default Kaltura pager.
+      #
+      # @return [Kaltura::Response::FlavorParamsListResponse] Wrapper for Kaltura::Response::BaseResponse.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors.
+      ##
   		def list(filter=nil, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)
@@ -34,6 +92,15 @@ module Kaltura
   			perform_request('flavorParams','list',kparams,false)
   		end
 
+      ##
+      # Retrieves all flavor params from a specific Conversion Profile.
+      #
+      # @param [Integer] conversion_profile_id The conversion profile ID.
+      #
+      # @return [Array] Returns an array of Flavor Params with a specific conversion profile.
+      #
+      # @raise [Kaltura::APIError] Raises default Kaltura API errors      
+      ##
   		def get_by_conversion_profile_id(conversion_profile_id)
   			kparams = {}
   			client.add_param(kparams, 'conversionProfileId', conversion_profile_id)

data/lib/kaltura/service/live_stream_service.rb

@@ -1,20 +1,61 @@
 module Kaltura
   module Service
+    
+    ##
+    # The live stream service lets you manage live stream channels.
+    ##
     class LiveStreamService < BaseService
-
+      
+      ##
+      # Adds a new live stream entry.
+      # The entry will be queued for provision.  Note, this uses a LiveStreamAdminEntry instead of a 
+      # normal LiveStreamEntry object.  LiveStreamAdminEntry is a child class, and adds a few fields
+      # pertinent to administering a Live stream.
+      #
+      # @param [Kaltura::LiveStreamAdminEntry] live_stream_entry The live stream entry metadata.
+      #   In order to succesfully create a live stream entry you need to have the media_type,
+      #   encoding_ip1, and encoding_ip2 fields populated.
+      #
+      # @return [Kaltura::LiveStreamAdminEntry] Returns the live stream entry saved on the database.
+      #   It might be a good idea to save the ID field on return.
+      #
+      # @raise [Kaltura::APIError] Raises 'PROPERTY_VALIDATION_CANNOT_BE_NULL' if media_type, encoding_ip1, 
+      #   or encoding_ip2 are null.
+      #
+      ##
   		def add(live_stream_entry)
   			kparams = {}
   			client.add_param(kparams, 'liveStreamEntry', live_stream_entry)
   			perform_request('liveStream','add',kparams,false)
   		end
 
+      ##
+      # Retrieves a live stream entry by ID.
+      # The Kaltura API docs indicate that this action will return a LiveStreamEntry object, 
+      # but the reality is that it will return a LiveStreamAdminEntry object instead.
+      #
+      # @param [String] entry_id The live stream entry ID.
+      # @param [Integer] version The version of the entry.
+      #
+      # @return [Kaltura::LiveStreamAdminEntry] The requested live stream object.
+      #
+      # @raise [Kaltura::APIError] Raises 'ENTRY_ID_NOT_FOUND' if the entry doesn't exist.
+      ##
   		def get(entry_id, version=-1)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)
   			client.add_param(kparams, 'version', version)
   			perform_request('liveStream','get',kparams,false)
   		end
-
+      
+      ##
+      # Updates a live stream entry object.  
+      # 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 
+      #
+      ##
   		def update(entry_id, live_stream_entry)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)

data/lib/kaltura/service.rb

@@ -31,10 +31,35 @@ require 'kaltura/service/system_user_service'
 require 'kaltura/service/system_partner_service'
 
 module Kaltura
+  ##
+  # The service module provides instance methods to the Kaltura::Client class.  This is the bulk of API actions.
+  ##
   module Service
-          	  		  		  			  			  		  		  	  	  		  	
+      
+    ##
+    # FileSyncService is a system user service.
+    #
+    # @example List up to 100 file sync objects with an error status:
+    #    client = Kaltura::Client.new
+    #    filter = Kaltura::Filter::FileSyncFilter.new
+    #    filter.status_equal = Kaltura::Constants::FileSync::Status::ERROR
+    #    pager = Kaltura::FilterPager.new
+    #    pager.page_size = 100
+    #    client.file_sync_service.list(filter,pager)
+    #
+    ##      	  		  		  			  			  		  		  	  	  		  	
   	class FileSyncService < BaseService
-
+      
+      ##
+      # Lists file sync objects by a filter and a pager.
+      #
+      # @param [Kaltura::Filter::FileSyncFilter] filter The filter to apply to the list.
+      # @param [Kaltura::FilterPager] pager The default pager to apply to large lists.
+      #
+      # @return [Kaltura::Response::FileSyncListResponse] FileSyncListResponse is equivalent to Kaltura::Response::BaseResponse
+      #
+      # @raise [Kaltura::APIError] raises default Kaltura errors.
+      ##
   		def list(filter=nil, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)
@@ -43,8 +68,22 @@ module Kaltura
   		end
   	end #class FileSyncService
   	
+  	##
+  	# FlavorParamsOutputService is not documented by Kaltura.  Probably best to not play with this.
+  	# This is likely just used internally by the KMC.
+  	##
   	class FlavorParamsOutputService < BaseService
 
+      ##
+      # Lists file sync objects by a filter and a pager.
+      #
+      # @param [Kaltura::Filter::FlavorParamsOutputFilter] filter The filter to apply to the list action.
+      # @param [Kaltura::FilterPager] pager The default pager to apply to large lists.
+      # 
+      # @return [Kaltura::Response::FlavorParamsOutputListResponse] This is equivalent to the BaseResponse class.
+      # 
+      # @raise [Kaltura::APIError] raises default Kaltura errors.
+      ##
   		def list(filter=nil, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)
@@ -53,8 +92,21 @@ module Kaltura
   		end
   	end #class FlavorParamsOutputService
   	
+  	##
+  	# MediaInfoService is not documented by Kaltura.  Probably best to not play with this.
+  	# This is likely just used internally by the KMC.
+  	##
   	class MediaInfoService < BaseService
-
+      ##
+      # Lists media info objects by a filter and a pager.
+      #
+      # @param [Kaltura::Filter::MediaInfoFilter] filter The filter to apply to the list action.
+      # @param [Kaltura::FilterPager] pager The default pager to apply to large lists.
+      #
+      # @return [Kaltura::Response::MediaInfoListResponse] This is equivalent to the BaseResponse class.
+      #
+      # @raise [Kaltura::APIError] raises default Kaltura errors.
+      ##
   		def list(filter=nil, pager=nil)
   			kparams = {}
   			client.add_param(kparams, 'filter', filter)
@@ -63,8 +115,22 @@ module Kaltura
   		end
   	end #class MediaInfoService
   	
+  	##
+  	# EntryAdminService is not documented by Kaltura.  Probably best not to play with this.
+  	# This is likely just used internally by the KMC.
+  	##
   	class EntryAdminService < BaseService
 
+      ##
+      # Gets an EntryAdmin object by entry_id.
+      #
+      # @param [String] entry_id Media entry id
+      # @param [Integer] version Desired version of the data.
+      #
+      # @return [Object] Not entirely sure what this returns.  
+      # 
+      # @raise [Kaltura::APIError] Raises default Kaltura errors.
+      ##
   		def get(entry_id, version=-1)
   			kparams = {}
   			client.add_param(kparams, 'entryId', entry_id)

data/lib/kaltura.rb

@@ -12,8 +12,8 @@ require 'net/http'
 require 'digest/md5'
 require 'rexml/document'
 
-#include Kaltura
-
+##
+# the Kaltura Module's sole function is to provide the top level namespace for the Kaltura API Library client.
+##
 module Kaltura
-
 end

data/velir_kaltura-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{velir_kaltura-ruby}
-  s.version = "0.4.5"
+  s.version = "0.4.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Patrick Robertson"]
-  s.date = %q{2010-09-29}
+  s.date = %q{2010-10-11}
   s.email = %q{patrick.robertson@velir.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -159,19 +159,19 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, ["<= 2.3.8"])
-      s.add_runtime_dependency(%q<activeresource>, ["<= 2.3.8"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.8"])
+      s.add_runtime_dependency(%q<activeresource>, [">= 2.3.8"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<rest-client>, [">= 1.5.1"])
     else
-      s.add_dependency(%q<activesupport>, ["<= 2.3.8"])
-      s.add_dependency(%q<activeresource>, ["<= 2.3.8"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+      s.add_dependency(%q<activeresource>, [">= 2.3.8"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<rest-client>, [">= 1.5.1"])
     end
   else
-    s.add_dependency(%q<activesupport>, ["<= 2.3.8"])
-    s.add_dependency(%q<activeresource>, ["<= 2.3.8"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+    s.add_dependency(%q<activeresource>, [">= 2.3.8"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<rest-client>, [">= 1.5.1"])
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: velir_kaltura-ruby
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 4
-  - 5
-  version: 0.4.5
+  - 6
+  version: 0.4.6
 platform: ruby
 authors: 
 - Patrick Robertson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-29 00:00:00 -04:00
+date: 2010-10-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - <=
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 19
         segments: 
@@ -40,7 +40,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - <=
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 19
         segments: