kaltura_fu 0.1.0.prel

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+doc/**

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.

data/README.markdown

@@ -0,0 +1,66 @@
+kaltura_fu
+--------------
+**Homepage**: [http://www.velir.com](http://www.velir.com)
+**Author**: [Patrick Robertson](mailto:patrick.robertson@velir.com)
+**Copyright**: 2010
+**License**: [MIT License](file:MIT-LICENSE)
+
+About Kaltura
+----------------
+[Kaltura](http://kaltura.org/) is an open source video streaming service.
+
+About kaltura_fu
+------------------
+
+kaltura_fu is a rails plugin 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.
+
+Installation:
+-------------
+Install the plugin with the command 
+	script/plugin install git@github.com:patricksrobertson/kaltura_fu.git
+Run 
+	rake kaltura_fu:install:all
+This will install the config/kaltura.yml file into your application's root directory and the kaltura_upload.js into the application's public/javascripts directory.  You may choose to run these commands instead:
+	rake kaltura_fu:install:config
+	rake kaltura_fu:install:js
+	
+
+Usage:
+------
+Kaltura_fu provides four ActionView helper methods presently:
+
+* include_kaltura_fu
+* kaltura_thumbnail(entry_id, options={})
+* kaltura_player_embed(entry_id,options={})
+* kaltura_upload_embed(options={})
+
+include_kaltura_fu embeds the kaltura_upload.js into the header.
+
+kaltura_thumbnail(entry_id, options={}) has the following parameters:
+
+* entry_id - The Kaltura entry_id of which you want to display a thumbnail
+* hash of options.  The supported options are:
+
+	* :size=> Array of integers.  [width,height].  This can be defaulted in the config with thumb_width and thumb_height.
+	* :second=> Integer.  Specify the second of the video to create the thumbnail with.
+	
+kaltura_player_embed(entry_id,options={}) has the following parameters:
+
+* entry_id - The Kaltura entry_id that you want to display in the player.
+* hash of options.  The supported options are:
+
+	* :div_id=> String.  Specifies the div ID of the object that will be embeded.  Defaults to kplayer.
+	* :player_conf_id=> String.  The configuration ID of the player to use.  This can be defaulted in the config with player_conf_id.
+	
+kaltura_upload_embed(options={}) has the following parameters:
+
+* hash of options:  The supported options are:
+
+	* none at this time.
+	
+
+To Do's
+-------
+* Buff the options for the upload script a bit more.  
+
+Copyright (c) 2010 [Patrick Robertson](http://www.velir.com), released under the MIT license

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+require 'yaml'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "kaltura_fu"
+    gem.summary = "Rails gem for making Kaltura integrations easier."
+    gem.email = "patrick.robertson@velir.com"
+    gem.homepage = "http://github.com/Velir/kaltura_fu"
+    gem.authors = ["Patrick Robertson"]
+    gem.add_dependency('velir_kaltura-ruby', '>=0.4.3')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "kaltura-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

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

data/config/kaltura.yml

@@ -0,0 +1,22 @@
+# config/kaltura.yml
+base: &base
+  login_email: 'USER_EMAIL'
+  login_password: 'THE_PASSWORD'
+  partner_id: 'PARTNER_ID'
+  subpartner_id: 'PARTNER_ID * 100'
+  administrator_secret: 'ADMINISTRATOR_SECRET'
+  user_secret: 'USER_SECRET'
+  thumb_width: '300'
+  thumb_height: '300'
+  player_conf_id: 'whatever'
+  service_url: 'http://www.kaltura.com'
+
+development:
+  <<: *base
+
+test:
+  <<: *base
+
+
+production:
+  <<: *base

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/javascripts/kaltura_upload.js

@@ -0,0 +1,67 @@
+var flashObj;
+var delegate = {};
+var mediaTypeInput;
+
+//KSU handlers
+delegate.readyHandler = function()
+{	
+	flashObj = document.getElementById("uploader");
+}
+
+delegate.selectHandler = function()
+{	
+	//flashObj.upload();
+	console.log("selectHandler()");		
+	console.log(flashObj.getTotalSize());
+}
+
+function setMediaType()
+{
+	var mediaType = document.getElementById("mediaTypeInput").value; 
+	//alert(mediaType);
+	console.log(mediaType);
+	flashObj.setMediaType(mediaType);
+}
+
+delegate.singleUploadCompleteHandler = function(args)
+{
+	
+	flashObj.addEntries();
+	console.log("singleUploadCompleteHandler", args[0].title);
+	document.getElementById('button_submit').disabled = false;
+	
+}
+
+delegate.allUploadsCompleteHandler = function()
+{
+	console.log("allUploadsCompleteHandler");
+}
+
+delegate.entriesAddedHandler = function(entries)
+{
+	//alert(entries.length);
+	var entry = entries[0];
+	//alert(entry.entryId);
+	document.getElementById('video_entry_id').value = entry.entryId
+	console.log(entries);
+}
+
+delegate.progressHandler = function(args)
+{	
+	document.getElementById('video_title').value = args[2].title;
+	var bob = Math.round(args[0] / args[1] * 100);	
+	document.getElementById('progress').value = bob;
+	console.log(args[2].title + ": " + args[0] + " / " + args[1]);
+}
+
+delegate.uiConfErrorHandler = function()
+{
+	console.log("ui conf loading error");
+}
+
+<!--- JavaScript callback methods to activate Kaltura services via the KSU widget.-->
+function upload()
+{
+	flashObj.upload();
+	//flashObj.addEntries();
+}

data/kaltura_fu.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kaltura_fu}
+  s.version = "0.1.0.prel"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Patrick Robertson"]
+  s.date = %q{2010-10-07}
+  s.email = %q{patrick.robertson@velir.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "config/kaltura.yml",
+     "install.rb",
+     "javascripts/kaltura_upload.js",
+     "kaltura_fu.gemspec",
+     "lib/kaltura_fu.rb",
+     "lib/kaltura_fu/category.rb",
+     "lib/kaltura_fu/report.rb",
+     "lib/kaltura_fu/video.rb",
+     "lib/kaltura_fu/view_helpers.rb",
+     "rails/init.rb",
+     "spec/kaltura_fu_spec.rb",
+     "spec/spec_helper.rb",
+     "tasks/kaltura_fu_tasks.rake",
+     "test/kaltura_fu_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/Velir/kaltura_fu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails gem for making Kaltura integrations easier.}
+  s.test_files = [
+    "spec/kaltura_fu_spec.rb",
+     "spec/spec_helper.rb",
+     "test/kaltura_fu_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<velir_kaltura-ruby>, [">= 0.4.3"])
+    else
+      s.add_dependency(%q<velir_kaltura-ruby>, [">= 0.4.3"])
+    end
+  else
+    s.add_dependency(%q<velir_kaltura-ruby>, [">= 0.4.3"])
+  end
+end
+

data/lib/kaltura_fu/category.rb

@@ -0,0 +1,112 @@
+module KalturaFu
+  
+  ##
+  # The Category module provides class methods to add/append category metadata to Kaltura entries.
+  #
+  # @author Patrick Robertson
+  #
+  # @example Create a new Category Filter on the Kaltura Management Console:
+  #    create_category('waffles')
+  #
+  # @example Append a Category to the end of the Entries metadata list:
+  #    add_category_to_video('1_xw34a324','pancakes')
+  #
+  # @example Append a Category and make sure it is a KMC filter if it doesn't exist:
+  #    add_category_to_video('1_wx34a324','pancakes',true)
+  #
+  # @example Set the Category metadata to a specific category and overriding the existing values:
+  #    set_category('1_wx34a324','Ninja Pancake Assasin')
+  ##
+  module Category
+    include KalturaFu::Video
+    ##
+    # Appends a category to the Kaltura entry.  It is capable of adding the category to the Kaltura server 
+    # if it doesn't already exist.  This method will not override existing categories, instead it appends the new
+    # category to the end of the list.
+    #
+    # @param [String] video_id Kaltura entry_id of the video.
+    # @param [String] category The category to add to the Kaltura entry.
+    # @param [Boolean] force_add true/false flag to force adding the category to the Kaltura server if it doesn't already
+    #   exist.  Defaults to false.
+    #
+    # @return [Kaltura::MediaEntry] Returns the entry updated with the new category appended.
+    ##  
+    def add_category_to_video(video_id,category,force_add=false)
+      KalturaFu.check_for_client_session
+  
+      existing_category = category_exists?(category)
+      if force_add && !existing_category
+        self.create_category(category)
+      elsif !force_add && !existing_category
+        raise "Category: #{category} does not exist.  Either use the force add flag or manually add the category."
+      end
+  
+      video = get_video_info(video_id)
+      updated_entry = Kaltura::MediaEntry.new
+      if video.categories.nil?
+        updated_categories = category
+      else
+        updated_categories = video.categories + "," + category
+      end
+      updated_entry.categories = updated_categories
+      KalturaFu.client.media_service.update(video_id,updated_entry)     
+    end    
+    
+    ##
+    # Creates a category on the Kaltura server if it doesn't already exist.
+    #
+    # @param [String] category_name category you wish to add.
+    ##
+    def create_category(category_name)
+      KalturaFu.check_for_client_session
+  
+      existing_category = self.category_exists?(category_name)
+      unless existing_category
+        category = Kaltura::Category.new
+        category.name = category_name
+        KalturaFu.client.category_service.add(category)
+      else
+        existing_category
+      end
+    end
+
+    ##
+    # Sets the Kaltura entry metadata to the desired category.  It will overwrite existing categories.
+    #
+    # @param [String] video_id Kaltura entry_id of the video.
+    # @param [String] category The category to add to the Kaltura entry.
+    #
+    # @return [Boolean] Returns true if the entry was updated, otherwise false.
+    ##
+    def set_category(video_id,category)
+      KalturaFu.check_for_client_session
+  
+      if video_exists?(video_id)
+        updated_entry = Kaltura::MediaEntry.new
+        updated_entry.categories = category
+        KalturaFu.client.media_service.update(video_id,updated_entry)
+        true
+      else
+        false
+      end
+    end
+    
+    protected
+    
+    ## 
+    # @private
+    ##  
+    def category_exists?(category_name)
+      KalturaFu.check_for_client_session
+  
+      category_filter = Kaltura::Filter::CategoryFilter.new
+      category_filter.full_name_equal = category_name
+      category_check = KalturaFu.client.category_service.list(category_filter).objects
+      if category_check.nil?
+        false
+      else
+        category_check
+      end
+    end
+  end  
+end

data/lib/kaltura_fu/report.rb

@@ -0,0 +1,147 @@
+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