kaltura_fu 0.1.5 → 0.2.0

data/README.markdown

@@ -12,19 +12,36 @@ About Kaltura
 About Kaltura_Fu
 ------------------
 
-kaltura_fu is a gem for rails that extends the basic functionality of the Kaltura ruby client and adds in some Rails view helpers to generate video players, thumbnails, and the uploader.  The Kaltura session and client are managed in a singleton pattern, and there are additional modules that allow you to more perform basic API actions in a more efficient manner.
+Kaltura_Fu is a gem that wraps the Kaltura-Ruby API wrapper and also adds some convenience methods for Rails'
+ActionView.  The intent of this library is to provide a far easier means to communicate with your Kaltura server.
+It's just too much of a pain to update simple things like the metadata fields with the default kaltura-ruby client.
 
 Installation:
 -------------
 Install the gem with the command:
     
-    gem install kaltura_fu --pre
+    gem install kaltura_fu
 Run: 
   
     script/generate kaltura_fu_install
     
 This will install the kaltura.yml file into your application's config directory and the kaltura_upload.js into the application's public/javascripts directory.
 	
+Testing:
+--------
+
+The Kaltura_Fu library is being tested against the following version of Ruby:
+
+* 1.8.7(MRI)
+* 1.8.7(EE)
+* 1.9.2(YARV)
+* Rubinius
+	
+In order to test this gem (for local development), you'll need to have access to a Kaltura server.
+I use a local installation of KalturaCE.  You'll have to add a config file under spec/config/kaltura.yml and 
+add in a small video file named video.flv in the same folder.  Since Kaltura provides no testing in kaltura-ruby,
+I tend to use this library as a test suite for fixes for that library as well.	
+	
 
 Documentation:
 ------

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
-:minor: 1
-:patch: 5
 :build: 
+:minor: 2
+:patch: 0

data/kaltura_fu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kaltura_fu}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Patrick Robertson"]
-  s.date = %q{2010-11-05}
+  s.date = %q{2010-11-06}
   s.email = %q{patrick.robertson@velir.com}
   s.extra_rdoc_files = [
     "README.markdown"
@@ -29,18 +29,17 @@ Gem::Specification.new do |s|
      "lib/kaltura_fu/configuration.rb",
      "lib/kaltura_fu/entry.rb",
      "lib/kaltura_fu/entry/class_methods.rb",
+     "lib/kaltura_fu/entry/flavor.rb",
      "lib/kaltura_fu/entry/instance_methods.rb",
      "lib/kaltura_fu/entry/metadata.rb",
      "lib/kaltura_fu/entry/metadata/class_and_instance_methods.rb",
      "lib/kaltura_fu/entry/metadata/class_methods.rb",
-     "lib/kaltura_fu/flavor.rb",
      "lib/kaltura_fu/railtie.rb",
-     "lib/kaltura_fu/report.rb",
-     "lib/kaltura_fu/video.rb",
      "lib/kaltura_fu/view_helpers.rb",
      "rails/init.rb",
      "spec/debug.log",
      "spec/entry_spec.rb",
+     "spec/flavor_spec.rb",
      "spec/kaltura_fu_spec.rb",
      "spec/metadata_spec.rb",
      "spec/spec.opts",
@@ -54,6 +53,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Rails gem for making Kaltura integrations easier.}
   s.test_files = [
     "spec/entry_spec.rb",
+     "spec/flavor_spec.rb",
      "spec/kaltura_fu_spec.rb",
      "spec/metadata_spec.rb",
      "spec/spec_helper.rb"

data/lib/kaltura_fu/configuration.rb

@@ -1,10 +1,10 @@
 module KalturaFu
   module Configuration
   
-    @@config = {}
-    @@client = nil
-    @@client_configuration = nil
-    @@session_key = nil
+    @@config = {} #A Has containing the Kaltura server information
+    @@client = nil #An insantiated Kaltura::Client class 
+    @@client_configuration = nil #Configuration values for the @@client.
+    @@session_key = nil #The Kaltura ks to use.
   
     def config
       @@config ||= {}

data/lib/kaltura_fu/entry/class_methods.rb

@@ -57,5 +57,5 @@ module KalturaFu
       end
       
     end #ClassMethods
-  end
-end
+  end #Entry
+end #KalturaFu

data/lib/kaltura_fu/entry/flavor.rb

@@ -0,0 +1,117 @@
+module KalturaFu
+  module Entry
+    ##
+    # The flavor module mixes in instance methods for a class that includes the Entry module.  This 
+    # module primarily provides means to operate on the original upload to Kaltura.  It also contains
+    # a very important method for checking the overall status of a specific entry.  
+    #
+    # @author Patrick Robertson
+    ##
+    module Flavor
+      ##
+      # Checks each flavor under a Kaltura entry for readiness.  It is possible under v3 of the Kaltura API
+      # to receive a 'ready' status for the entry while flavors are still encoding.  Attempting to view the entry
+      # with a player will result in a 'Media is converting' error screen.  This prevents that occurance.
+      # 
+      # @param [String] video_id Kaltura entry_id of the video.
+      #
+      # @return [Number] Kaltura::Constants::FlavorAssetStatus.  2 is ready.
+      ##
+      def check_status(entry_id)
+        KalturaFu.check_for_client_session
+
+        entry_status = get_status(entry_id)
+        if entry_status == Kaltura::Constants::Entry::Status::READY
+         flavor_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(entry_id)
+         error_count = 0
+         not_ready_count = 0
+         ready_count = 0
+         flavor_array.each do |flavor|
+           case flavor.status
+             when Kaltura::Constants::FlavorAssetStatus::READY ||  Kaltura::Constants::FlavorAssetStatus::DELETED || Kaltura::Constants::FlavorAssetStatus::NOT_APPLICABLE
+               ready_count +=1
+             when Kaltura::Constants::FlavorAssetStatus::ERROR
+               error_count +=1
+             when Kaltura::Constants::FlavorAssetStatus::QUEUED || Kaltura::Constants::FlavorAssetStatus::CONVERTING
+               not_ready_count +=1
+           end
+         end
+         #puts "errors: #{error_count} ready:#{ready_count} not_ready:#{not_ready_count} total:#{video_array.size} \n"
+         if error_count > 0
+           Kaltura::Constants::FlavorAssetStatus::ERROR
+         elsif not_ready_count > 0
+           Kaltura::Constants::FlavorAssetStatus::CONVERTING
+         else
+           Kaltura::Constants::FlavorAssetStatus::READY
+         end
+        else
+         entry_status
+        end
+      end
+    
+      ##
+      # Returns the flavor ID of the original file uploaded to Kaltura.
+      #
+      # @param [String] video_id Kaltura entry_id of the video.
+      #
+      # @return [String] flavor_id
+      ##
+      def original_flavor(entry_id)
+       KalturaFu.check_for_client_session
+
+       flavor_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(entry_id)
+       ret_flavor = nil
+
+       flavor_array.each do |flavor|
+         if flavor.is_original
+           ret_flavor = flavor.id.to_s
+           break
+         end
+       end
+       ret_flavor
+      end
+
+      ##
+      # Returns the file extension of the original file uploaded to Kaltura for a given entry
+      #
+      # @param [String] video_id Kaltura entry_id of the video.
+      #
+      # @return [String] file extension
+      ##
+      def original_file_extension(entry_id)
+        KalturaFu.check_for_client_session
+
+        flavor_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(entry_id)
+        source_extension = nil
+        flavor_array.each do |flavor|
+          if flavor.is_original
+            source_extension = flavor.file_ext
+            break
+          end
+        end
+        source_extension
+      end
+
+      ##
+      # Returns a download URL suitable to be used for iTunes one-click syndication.  serveFlavor is not documented in KalturaAPI v3
+      # nor is the ?novar=0 paramter.  
+      # 
+      # @param [String] video_id Kaltura entry_id of the video
+      #
+      # @return [String] URL that works with RSS/iTunes syndication.  Normal flavor serving is flakey with syndication.
+      ##
+      def original_download_url(video_id)
+        KalturaFu.check_for_client_session
+        
+        service_url = KalturaFu.config[:service_url] || "http://www.kaltura.com"
+        partner_id = KalturaFu.config[:partner_id]
+        subpartner_id = (partner_id.to_i * 100).to_s
+        flavor = original_flavor(video_id)
+        extension = original_file_extension(video_id)
+        
+        "#{service_url}/p/#{partner_id}/sp/#{subpartner_id}/serveFlavor/flavorId/#{flavor}/name/#{flavor}.#{extension}?novar=0"
+      end
+             
+    end #Flavor
+  end #Entry
+end #KalturaFu

data/lib/kaltura_fu/entry/instance_methods.rb

@@ -1,5 +1,8 @@
 module KalturaFu
   module Entry
+    ##
+    # Instance level methods for the Entry module.
+    ##
     module InstanceMethods
       ##
       # Deletes a Kaltura entry.  Unlike the base API delete method, this returns true/false based on success.
@@ -18,7 +21,7 @@ module KalturaFu
         rescue Kaltura::APIError => e
           false
         end      
-      end
+      end     
       
     end
   end

data/lib/kaltura_fu/entry/metadata/class_and_instance_methods.rb

@@ -2,6 +2,10 @@ module KalturaFu
   module Entry
     module Metadata
       
+      ##
+      # It is necessary to have the check for valid Kaltura MediaEntry methods available at both
+      # the class and instance level, so they are thrown into this module.
+      ##
       module ClassAndInstanceMethods
         
         ##

data/lib/kaltura_fu/entry/metadata.rb

@@ -2,6 +2,13 @@ require 'active_support'
 
 module KalturaFu
   module Entry
+    
+    ##
+    # The Metadata module provides methods that get/set and add metadata to the 
+    # Kaltura installation.  
+    #
+    # @author Patrick Robertson
+    ##
     module Metadata
 
       ##

data/lib/kaltura_fu/entry.rb

@@ -1,5 +1,95 @@
 module KalturaFu
-  module Entry    
+  
+  ##
+  # The entry module provides a slightly more intuitive interface to the
+  # Kaltura media service.  It determines what retrieval and setting actions 
+  # you can perform based upon the version of the Kaltura-Ruby library using 
+  # reflection.  This allows Kaltura_Fu to be a bit more future proof than the 
+  # Kaltura API client itself!   The tradeoff is that getting/adding/setting 
+  # attributes are defined dynamically.  The current behavior is that the first
+  # call to a dynamic method will then define all of Kaltura's media entries 
+  # methods.  This allows the module to be slightly lighter weight in the event
+  # that it is included in a class but never used, and faster than using method_missing
+  # lookups for 100% of the dynamic methods.  The first call will be slower though,
+  # as it generates numerous other methods.
+  # 
+  # == Usage
+  # The entry module is intended to be used to link Rails Models to Kaltura MediaEntry's.  
+  # However, you should not perform these actions during a web application request.  Doing
+  # so will slow down your request unecessarily.  There is nearly nothing gained from adding a
+  # round trip to your Kaltura server to make an update synchronus.  Instead, this module
+  # should mostly be used in processing a background request from an observer.  
+  #
+  # == Uploading to Kaltura
+  # The entry module provides convienance to uploading directly to your installation of 
+  # Kaltura.  For your web application, there are two Kaltura flash widgets that perform
+  # a much better job of uploading files though.  This functionality has been used in 
+  # production environments that use lecture capture.  A video file is placed in a folder, 
+  # a script picks the file up, and then uploads it into Kaltura.
+  #
+  # The Kaltura API supports uploading media from files, URL's, and also has a batch action.  
+  # The implementation of Kaltura Fu currently ignores the URL and batch methods, instead 
+  # focusing on file uploading.
+  #
+  # @example A basic file upload example:
+  #   media_file = File.new("/path/to/video.mp4")
+  #   upload(media_file,:source => :file)
+  #
+  # @example A file upload with metadata fields populated:
+  #   media_file = File.new("/path/to/video.mp4")
+  #   upload(media_file, :source => :file,
+  #     :name => "My Rad video",
+  #     :description => "I'm capable of such rad things.",
+  #     :tags => "rad,rowdy,video,h.264",
+  #     :categories => "raditude"
+  #   )
+  # == Getting, Setting, and Adding Metadata
+  # The entry module provides an easy mean to retrieve the current state and modify a Kaltura entry.
+  # For metadata fields that act as a list of objects, it also provides an easy way to append values
+  # onto the list.  It uses get_ and set_ instead of the more common Ruby practice of using just the 
+  # attribute and attribute= so that you can include this module in your model without conflict.  Also,
+  # when you are performing actions on the category fields, the module is making sure these are available
+  # in the KMC by calling Kaltura's Category service.
+  # 
+  # @example Retrieving metadata:
+  #   get_name("1_q34aa52a")
+  #   get_categories("1_q34aa52a")
+  #
+  # @example Setting metadata:
+  #   set_name("1_q34aa52a", "waffles")
+  #   set_categories("1_q34aa52a", "HD,h.264,live recording")
+  #
+  # @example Appending tags to an existing set:
+  #   add_tags("1_q34aa52a","eductation, lecture capture")
+  # 
+  # == Checking the Status of an Entry
+  # One unfortunate aspect of the Kaltura API is that an entry will report it's status as "ready"
+  # while flavors are still encoding.  When you embed the entry on a webpage, it will render an
+  # error "Media is currently converting".  The only solution is to instead check the status of 
+  # each flavor instead to ensure total readiness.
+  #
+  # @example Checking an entries status:
+  #   check_status("1_q34aa52a")
+  #
+  # == Retrieving Status About the Source Video
+  # Occasionally, you need to interact with the original video in some form or another with Kaltura.
+  # One production situation I have encountered in the past is maintaining a copy of the source video
+  # on a large data store seperate from Kaltura.  It is extremely difficult to work with the download
+  # URL that Kaltura provides for that.
+  #
+  # @example Getting the Flavor ID of the original video associated with an entry:
+  #   original_flavor("1_q34aa52a")
+  #
+  # @example Getting the file extension of the original video associated with an entry:
+  #   original_file_extension("1_q34aa52a")
+  # 
+  # @example Getting a usable download URL for the entries original file:
+  #   original_download_url("1_q34aa52a")
+  #
+  # @author Patrick Robertson
+  ##
+  module Entry
+        
     ##
     # @private
     ##
@@ -8,6 +98,7 @@ module KalturaFu
       base.class_eval do 
         include Metadata
         include InstanceMethods
+        include Flavor
       end
       super
     end

data/lib/kaltura_fu.rb

@@ -1,33 +1,52 @@
+#--
+# Copyright (c) 2010 Velir Studios
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
 ##
-# The KalturaFu module provides a singleton implementation for Kaltura API interaction.  It stores session and API client information so that they do not need to be reset.
+# The KalturaFu module provides a singleton implementation for Kaltura API interaction.  
+# It stores session and API client information so that they do not need to be reset.
+#
 # @author Patrick Robertson
 #
-# @example Initilize a session:
-#   KalturaFu.generate_session_key #=> "OTQyNzA2NzAxNzZmNDQyMTA1YzBiNzA5YWFjNzQ0ODNjODQ5MjZkM3wyMDM4MjI7MjAzODIyOzEyODUzNTA2ODg7MjsxMjg1MjY0Mjg4LjI2NTs7"
-# @example Retrieve a client object:
-#   client = KalturaFu.client #=> #<Kaltura::Client:0x1071e39f0 @session_service=#<Kaltura::Service::SessionService:0x1071e3900 @client=#<Kaltura::Client:0x1071e39f0 ...>>, @calls_queue=[], @should_log=false, @is_multirequest=false, @ks="OTQyNzA2NzAxNzZmNDQyMTA1YzBiNzA5YWFjNzQ0ODNjODQ5MjZkM3wyMDM4MjI7MjAzODIyOzEyODUzNTA2ODg7MjsxMjg1MjY0Mjg4LjI2NTs7", @config=#<Kaltura::Configuration:0x1071e39c8 @client_tag="ruby", @format=2, @service_url="http://www.kaltura.com", @partner_id="20322323", @timeout=10>>
-# @example Clear a session:
-#   KalturaFu.clear_session_key! #=> nil
 ##
 require 'rubygems'
 require 'kaltura'
+require 'active_support/all'
 
 module KalturaFu
   
   #Initilize the configuration and send the ViewHelpers into ActionView::Base when it's a Rails 3 app.
   require 'kaltura_fu/railtie' if defined?(Rails) && Rails.version.split(".").first == "3"
   
-  autoload :Video, 'kaltura_fu/video'
-  autoload :Category, 'kaltura_fu/category'
-  autoload :Report, 'kaltura_fu/report'
   autoload :Configuration, 'kaltura_fu/configuration'
   autoload :Entry, 'kaltura_fu/entry'
   
   module Entry
+    
     autoload :Metadata, 'kaltura_fu/entry/metadata'
     autoload :ClassMethods, 'kaltura_fu/entry/class_methods'
     autoload :InstanceMethods, 'kaltura_fu/entry/instance_methods'
-    
+    autoload :Flavor, 'kaltura_fu/entry/flavor'
+      
     module Metadata
       autoload :ClassMethods, 'kaltura_fu/entry/metadata/class_methods'
       autoload :ClassAndInstanceMethods, 'kaltura_fu/entry/metadata/class_and_instance_methods'

data/spec/entry_spec.rb

@@ -70,4 +70,5 @@ describe "Kaltura Fu's Entry Class Methods" do
     check = @tester.delete_entry(entry_id)
     check.should be_true    
   end
+  
 end

data/spec/flavor_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+class FlavorSpecTester 
+  include KalturaFu::Entry
+end
+
+class EntryUploader
+  include KalturaFu::Entry
+end
+
+describe "Actions specific to an entries flavors" do
+  before(:all) do
+    KalturaFuTestConfiguration.setup
+  end
+  
+  before(:each) do 
+    @entry_id = EntryUploader.upload(KalturaFuTestConfiguration.video,:source=>:file)
+  end
+  
+  after(:each) do
+    EntryUploader.new.delete_entry(@entry_id)
+  end
+
+  it "should return a status of not-ready when a video uploads" do  
+    flavor = FlavorSpecTester.new
+    flavor.check_status(@entry_id).should_not == Kaltura::Constants::FlavorAssetStatus::READY
+  end
+  
+  it "should respond to original_flavor" do
+    flavor = FlavorSpecTester.new
+    
+    flavor.should respond_to :original_flavor
+  end
+  
+  it "should be able to get the original flavor ID without an error" do
+    flavor = FlavorSpecTester.new
+    
+    lambda{flavor.original_flavor(@entry_id)}.should_not raise_error
+  end
+  
+  it "should respond to original_file_extension" do
+    flavor = FlavorSpecTester.new
+    
+    flavor.should respond_to :original_file_extension
+  end
+  
+  it "should be able to get the original file extension without error" do
+    flavor = FlavorSpecTester.new
+    
+    lambda{flavor.original_file_extension(@entry_id)}.should_not raise_error
+  end
+  
+  it "should have a file extension of FLV for the test video" do
+    flavor = FlavorSpecTester.new
+    
+    extension = nil
+    extension = flavor.original_file_extension(@entry_id)
+    extension.should == "flv"
+  end
+  
+  it "should respond to original_download_url" do
+    flavor = FlavorSpecTester.new
+    
+    flavor.should respond_to :original_download_url
+  end
+  
+  it "shouldn't blow up when I call original_download_url" do
+    flavor = FlavorSpecTester.new
+    
+    lambda {flavor.original_download_url(@entry_id)}.should_not raise_error
+  end
+  
+  it "original_download_url should look like a reasonable URL" do
+    flavor = FlavorSpecTester.new
+    
+    url = flavor.original_download_url(@entry_id)
+    test_url = "#{KalturaFu.config[:service_url]}/p/#{KalturaFu.config[:partner_id]}/sp/#{KalturaFu.config[:subpartner_id]}/serveFlavor/flavorId/#{flavor.original_flavor(@entry_id)}/name/#{flavor.original_flavor(@entry_id)}.#{flavor.original_file_extension(@entry_id)}?novar=0"
+    url.should == test_url
+  end
+  
+  it "should respond to changes in service_url" do
+    flavor = FlavorSpecTester.new
+    old_service_url = KalturaFu.config[:service_url]
+    KalturaFu.config[:service_url] = "http://www.waffles.com"
+    
+    url = flavor.original_download_url(@entry_id)
+    test_url = "http://www.waffles.com/p/#{KalturaFu.config[:partner_id]}/sp/#{KalturaFu.config[:subpartner_id]}/serveFlavor/flavorId/#{flavor.original_flavor(@entry_id)}/name/#{flavor.original_flavor(@entry_id)}.#{flavor.original_file_extension(@entry_id)}?novar=0"
+    KalturaFu.config[:service_url] = old_service_url
+    url.should == test_url
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kaltura_fu
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 5
-  version: 0.1.5
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Patrick Robertson
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 -04:00
+date: 2010-11-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 1
         - 3
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -53,6 +56,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 0
         - 4
@@ -83,18 +87,17 @@ files:
 - lib/kaltura_fu/configuration.rb
 - lib/kaltura_fu/entry.rb
 - lib/kaltura_fu/entry/class_methods.rb
+- lib/kaltura_fu/entry/flavor.rb
 - lib/kaltura_fu/entry/instance_methods.rb
 - lib/kaltura_fu/entry/metadata.rb
 - lib/kaltura_fu/entry/metadata/class_and_instance_methods.rb
 - lib/kaltura_fu/entry/metadata/class_methods.rb
-- lib/kaltura_fu/flavor.rb
 - lib/kaltura_fu/railtie.rb
-- lib/kaltura_fu/report.rb
-- lib/kaltura_fu/video.rb
 - lib/kaltura_fu/view_helpers.rb
 - rails/init.rb
 - spec/debug.log
 - spec/entry_spec.rb
+- spec/flavor_spec.rb
 - spec/kaltura_fu_spec.rb
 - spec/metadata_spec.rb
 - spec/spec.opts
@@ -114,6 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -122,6 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -134,6 +139,7 @@ specification_version: 3
 summary: Rails gem for making Kaltura integrations easier.
 test_files: 
 - spec/entry_spec.rb
+- spec/flavor_spec.rb
 - spec/kaltura_fu_spec.rb
 - spec/metadata_spec.rb
 - spec/spec_helper.rb

data/lib/kaltura_fu/flavor.rb

@@ -1,89 +0,0 @@
-module KalturaFu
-  ##
-  # The Flavor module provides interactions for adding and removing specific encodings from a Kaltura entry.
-  ##
-  module Flavor
-    
-    ##
-    # Adds a specific encoding profile to a Kaltura entry.
-    #
-    # @param [String] video_id The Kaltura media entry.
-    # @param [Integer] flavor_param_id The ID of the FlavorParam (individual encoding profile) to use.
-    # 
-    # @return [nil] Returns nothing.
-    #
-    # @raie [RuntimeError] Raises a runtime error if the video_id doesn't exist.
-    #
-    # @since 0.1.3
-    #
-    # @todo Make this method return something.
-    ##
-    def add_flavor_to_video(video_id,flavor_param_id)
-      self.check_for_client_session
-      
-      if video_exists?(video_id)
-        @@client.flavor_asset_service.convert(video_id,flavor_param_id)
-      end
-    end
-    
-    ##
-    # Finds a specific flavor object given a Kaltura entry and FlavorParam.  This is useful if you want to
-    # delete a specific type of encoding from a Video programatically.
-    #
-    # @param [String] video_id The Kaltura media entry.
-    # @param [Integer] flavor_param_id The ID of the FlavorParam (individual encoding profile) to use.
-    #
-    # @return [Kaltura::FlavorAsset] Returns the requested FlavorAsset.
-    #
-    # @raise [RuntimeError] Raises a runtime error if the video_id doesn't exist.
-    #
-    # @since 0.1.3
-    # 
-    # @todo Ensure a graceful error when the FlavorAsset isn't found as well.
-    ##
-    def find_flavor_from_entry(video_id,flavor_param_id)
-      self.check_for_client_session
-      return_flavor = nil
-      
-      if video_exists?(video_id)
-        flavor_array = @@client.flavor_asset_service.get_flavor_assets_with_params(video_id)
-        flavor_array.each do |flavor_object|
-          if flavor_object.flavor_params.id == flavor_param_id
-            return_flavor = flavor_object.flavor_asset.id
-          end
-        end
-      end
-    end
-    
-    ##
-    # Removes either a specific flavor asset.  If you know the exact Flavor you wish to delete
-    #   you can specify it.  Otherwise, you can specify the videos entry_id and a specific 
-    #   FlavorParam (encoding profile) and it will locate and remove the Flavor for you.
-    #
-    # @param [String] entry_or_flavor The Kaltura entry_id or the FlavorAsset ID.
-    # @param [Integer] flavor_param_id An optional flavorParam encoding profile to seek.
-    #
-    # @return [Boolean] Returns true if the removal was succesful.  
-    #
-    # @raise [RuntimeError] Raises a runtime error if the video's entry_id doesn't exist.
-    #
-    # @since 0.1.3
-    #
-    # @todo Ensure that a missing FlavorParam or FlavorAsset doesn't cause unexpected behavior.
-    ##
-    def remove_flavor_from_video(entry_or_flavor, flavor_param_id=nil)
-      self.check_for_client_session
-      ret_val = false
-      
-      if flavor_param_id.nil?
-        @@client.flavor_asset_service.delete(entry_or_flavor)
-        ret_val = true
-      else
-        flavor_to_delete = self.find_flavor_from_entry(entry_or_flavor,flavor_param_id)
-        self.remove_flavor_from_video(flavor_to_delete)
-      end
-      ret_val
-    end
-    
-  end
-end

data/lib/kaltura_fu/report.rb

@@ -1,147 +0,0 @@
-module KalturaFu
-  
-  ##
-  # The Report module provides class methods to retrieve analytic information and reports from Kaltura entries.
-  #
-  # @author Patrick Robertson 
-  ##
-  module Report
-    
-    ##
-    # Returns an Array of hashes that contains a Kaltura content drop-off report ordered by # of plays descending.
-    # Kaltura treats # of plays as a string, so 5 comes before 353.
-    #
-    # @param [Date] from_date The starting date for the report.  The end date is currently always today.
-    # @param [String] video_list a comma delimited list of Kaltura entry_id's to report upon.
-    # 
-    # @return [Array] An array of Hashes that contains the entry_id, total plays, and then plays for 25%, 50%, 75% and 100% through the content.
-    ##
-    def generate_report(from_date,video_list)
-      hash_array = []
-          
-      KalturaFu.check_for_client_session
-    
-      report_filter = Kaltura::Filter::ReportInputFilter.new
-      report_filter.from_date = from_date.to_i
-      report_filter.to_date = Time.now.utc.to_i
-      report_pager = Kaltura::FilterPager.new
-      report_pager.page_size = 1000
-    
-      report_raw = KalturaFu.client.report_service.get_table(Kaltura::Constants::ReportType::CONTENT_DROPOFF,
-                                                     report_filter,
-                                                     report_pager,
-                                                     Kaltura::Constants::Media::OrderBy::PLAYS_DESC,
-                                                     video_list)
-      unless report_raw.data.nil?
-        report_split_by_entry = report_raw.data.split(";")
-        report_split_by_entry.each do |row|
-          segment = row.split(",")
-          row_hash = {}
-          row_hash[:entry_id] = segment.at(0)
-          row_hash[:plays] = segment.at(2)
-          row_hash[:play_through_25] = segment.at(3)
-          row_hash[:play_through_50] = segment.at(4)
-          row_hash[:play_through_75] = segment.at(5)
-          row_hash[:play_through_100] = segment.at(6)
-          hash_array << row_hash
-        end
-    
-        hash_array = hash_array.sort{|a,b| b[:plays].to_i <=> a[:plays].to_i}
-      end
-      hash_array                                              
-    end
-  
-    ##
-    # creates a report CSV on the kaltura server and then returns the url to grab it.  Unfortunately the MIME type of the resource is "text/plain"
-    # instead of "text/csv" so there isn't a ton you can do with it.
-    #
-    # @param [Date] from_date The starting date for the report.  The end date is currently always today.
-    # @param [String] video_list a comma delimited list of Kaltura entry_id's to report upon.
-    #
-    # @return [String] URL to grab the report in CSV format.
-    ##
-    def generate_report_csv_url(from_date,video_list)
-      report_title = "TTV Video Report"
-      report_text = "I'm not sure what this is"
-      headers = "Kaltura Entry,Plays,25% Play-through,50% Play-through, 75% Play-through, 100% Play-through, Play-Through Ratio"
-    
-      KalturaFu.check_for_client_session
-    
-      report_filter = Kaltura::Filter::ReportInputFilter.new
-      report_filter.from_date = from_date.to_i
-      report_filter.to_date = Time.now.utc.to_i
-      report_pager = Kaltura::FilterPager.new
-      report_pager.page_size = 1000
-    
-      report_url = KalturaFu.client.report_service.get_url_for_report_as_csv(report_title,
-                                                                     report_text,
-                                                                     headers,
-                                                                     Kaltura::Constants::ReportType::CONTENT_DROPOFF,
-                                                                     report_filter,
-                                                                     "",
-                                                                     report_pager,
-                                                                     Kaltura::Constants::Media::OrderBy::PLAYS_DESC,
-                                                                     video_list)
-      report_url      
-    end  
-  
-    ##
-    # Returns a grand total of the plays broken down by content drop-off given a list of Kaltura entries.
-    #
-    # @param [Date] from_date The starting date for the report.  The end date is currently always today.
-    # @param [String] video_list a comma delimited list of Kaltura entry_id's to report upon.
-    # 
-    # @return [Hash] a list that contains total plays and plays broken down to 25%, 50%, 75%, and 100% through content.
-    ##
-    def generate_report_total(from_date,video_list)
-      row_hash = {}
-    
-      KalturaFu.check_for_client_session
-    
-      report_filter = Kaltura::Filter::ReportInputFilter.new
-      report_filter.from_date = from_date.to_i
-      report_filter.to_date = Time.now.utc.to_i      
-      report_raw = KalturaFu.client.report_service.get_total(Kaltura::Constants::ReportType::CONTENT_DROPOFF,
-                                                     report_filter,
-                                                     video_list)
-      unless report_raw.data.nil?
-        segment = report_raw.data.split(",")
-        row_hash[:plays] = segment.at(0)
-        row_hash[:play_through_25] = segment.at(1)
-        row_hash[:play_through_50] = segment.at(2)
-        row_hash[:play_through_75] = segment.at(3)
-        row_hash[:play_through_100] = segment.at(4)                                         
-      
-        row_hash
-      end
-    end
-  
-    ##
-    # Returns the total number of Kaltura entries that had any plays during the reporting period.
-    #
-    # @param [Date] from_date The starting date for the report.  The end date is currently always today.
-    # @param [String] video_list a comma delimited list of Kaltura entry_id's to report upon.      
-    ##
-    def generate_report_video_count(from_date,video_list)
-      row_hash = {}
-    
-      KalturaFu.check_for_client_session
-    
-      report_filter = Kaltura::Filter::ReportInputFilter.new
-      report_filter.from_date = from_date.to_i
-      report_filter.to_date = Time.now.utc.to_i
-      report_pager = Kaltura::FilterPager.new
-      report_pager.page_size = 1000
-    
-      report_raw = KalturaFu.client.report_service.get_table(Kaltura::Constants::ReportType::CONTENT_DROPOFF,
-                                                     report_filter,
-                                                     report_pager,
-                                                     Kaltura::Constants::Media::OrderBy::PLAYS_DESC,
-                                                     video_list)
-      unless report_raw.data.nil?                                     
-        report_raw.total_count
-      end
-    end
-    
-  end
-end

data/lib/kaltura_fu/video.rb

@@ -1,190 +0,0 @@
-module KalturaFu
-  ##
-  # the Video module provides class methods to retrieve and set information specific to Kaltura Entries.
-  # @author Patrick Robertson
-  ##
-  module Video
-
-    ##
-    # Checks each flavor under a Kaltura entry for readiness.  It is possible under v3 of the Kaltura API
-    # to receive a 'ready' status for the entry while flavors are still encoding.  Attempting to view the entry
-    # with a player will result in a 'Media is converting' error screen.  This prevents that occurance.
-    # 
-    # @param [String] video_id Kaltura entry_id of the video.
-    #
-    # @return [Number] Kaltura::Constants::FlavorAssetStatus.  2 is ready.
-    ##
-    def check_video_status(video_id)
-      KalturaFu.check_for_client_session
-    
-      video_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(video_id)
-      status = Kaltura::Constants::FlavorAssetStatus::ERROR
-      video_array.each do |video|
-        status = video.status
-        if video.status != Kaltura::Constants::FlavorAssetStatus::READY
-          if video.status == Kaltura::Constants::FlavorAssetStatus::NOT_APPLICABLE
-            status = Kaltura::Constants::FlavorAssetStatus::READY
-          else
-            break
-          end
-        end
-      end
-      status
-    end
-
-    ##
-    # Deletes a Kaltura entry.
-    # 
-    # @param [String] video_id Kaltura entry_id of the video.
-    #
-    # @return [Boolean] returns true if the delete was successful or false otherwise.
-    ##
-    def delete_video(video_id)
-      KalturaFu.check_for_client_session
-    
-      begin
-        KalturaFu.client.media_service.delete(video_id)
-        true
-      rescue Kaltura::APIError => e
-        false
-      end
-    end
-
-    ##
-    # Returns the flavor of the original file uploaded to Kaltura.
-    #
-    # @param [String] video_id Kaltura entry_id of the video.
-    #
-    # @return [String] flavor_id
-    ##
-    def get_original_flavor(video_id)
-      KalturaFu.check_for_client_session
-    
-      video_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(video_id)
-      ret_flavor = nil
-    
-      video_array.each do |video|
-        if video.is_original
-          ret_flavor = video.id.to_s
-        end
-      end
-      ret_flavor
-    end
-
-    ##
-    # Returns the file extension of the original file uploaded to Kaltura for a given entry
-    #
-    # @param [String] video_id Kaltura entry_id of the video.
-    #
-    # @return [String] file extension
-    ##
-    def get_original_file_extension(video_id)
-      KalturaFu.check_for_client_session
-  
-      video_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(video_id)
-      source_extension = nil
-      video_array.each do |video|
-        if video.is_original
-          source_extension = video.file_ext
-        end
-      end
-      source_extension
-    end
-
-    ##
-    # Returns the URL of the requested video. 
-    # 
-    # @param [String] video_id Kaltura entry_id of the video.
-    # @param [Number] time optional paramter that will set the thumbnail to a particular second of the video
-    # @param [Number] width optional width of the thumbnail.  Defaults to the thumb_width config value.
-    # @param [Number] height optional height of the thumbnail.  Defaults to the thumb_height config value.
-    # 
-    # @return [String] the thumbnail url.
-    ##
-    def get_thumbnail(video_id,time=nil,width=@@config[:thumb_width],height=@@config[:thumb_height])
-      config = KalturaFu.config
-      
-      thumbnail_string = "#{config[:service_url]}/p/#{config[:partner_id]}/thumbnail/entry_id/#{video_id}/width/#{width}/height/#{height}"
-      thumbnail_string += "/vid_sec/#{time}" unless time.nil?
-      return thumbnail_string
-    end
-
-    ##
-    # Gets a Kaltura::MediaEntry given a Kaltura entry.
-    #
-    # @param [String] video_id Kaltura entry_id of the video.
-    #
-    # @return [Kaltura::MediaEntry] The MediaEntry object for the Kaltura entry.
-    ##
-    def get_video_info(video_id)  
-      KalturaFu.check_for_client_session
-    
-      response = self.video_exists?(video_id)
-      raise "ID: #{video_id} Not found!" unless response
-      response
-    end
-
-    ##
-    # Returns a download URL suitable to be used for iTunes one-click syndication.  serveFlavor is not documented in KalturaAPI v3
-    # nor is the ?novar=0 paramter.  
-    # 
-    # @param [String] video_id Kaltura entry_id of the video
-    #
-    # @return [String] URL that works with RSS/iTunes syndication.  Normal flavor serving is flakey with syndication.
-    ##
-    def set_syndication_url(video_id)
-      KalturaFu.check_for_client_session
-    
-      video_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(video_id)
-    
-      download_url = nil
-      video_array.each do |video|
-        if video.is_original
-          download_url = 'http://www.kaltura.com/p/203822/sp/20382200/serveFlavor/flavorId/' + video.id.to_s + '/name/' + video.id.to_s + '.' + video.file_ext.to_s + '?novar=0'
-        end
-      end
-      download_url
-    end
-
-    ##
-    # Sets the Kaltura entry description metadata.
-    #
-    # @param [String] video_id Kaltura entry_id of the video.
-    # @param [String] description description to add to the Kaltura video.
-    #
-    # @return [Boolean] returns true if the update was successful or false otherwise.
-    ##
-    def set_video_description(video_id,description)
-      KalturaFu.check_for_client_session
-    
-      if self.video_exists?(video_id)
-        new_entry = Kaltura::MediaEntry.new
-        new_entry.description = description
-        KalturaFu.client.media_service.update(video_id,new_entry)
-        true
-      else
-        false
-      end
-    end
-  
-    protected
-    ##
-    # Checks if a Kaltura entry exists.
-    # @private
-    def video_exists?(video_id)
-      KalturaFu.check_for_client_session
-    
-      begin
-        response = KalturaFu.client.media_service.get(video_id)
-      rescue Kaltura::APIError => e
-        response = nil
-      end
-      if response.nil?
-        false
-      else
-        response
-      end
-    end
-    
-  end
-end