goncalossilva-kaltura_fu 0.2.0

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

@@ -0,0 +1,54 @@
+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
+        
+        ##
+        # Checks if a requested attribute is in fact a valid MediaEntry atrribute.  
+        ##
+        def valid_entry_attribute?(request_attribute)
+          object_methods, media_entry_methods = Object.instance_methods , Kaltura::MediaEntry.instance_methods
+
+          #clean out all the setter methods from the media entry methods
+          valid_media_entry_methods = media_entry_methods.map{|m| m unless m =~/^(.*)=/}.compact!
+
+          valid_media_entry_methods -= object_methods
+          valid_entry_attributes.include?(request_attribute.to_sym)
+        end
+        
+        ##
+        # @private
+        ## 
+        def valid_entry_attributes
+          object_methods, media_entry_methods = Object.instance_methods , Kaltura::MediaEntry.instance_methods
+
+          #clean out all the setter methods from the media entry methods
+          valid_media_entry_methods = media_entry_methods.map{|m| m.to_sym unless m =~/^(.*)=/}.compact!
+
+          valid_media_entry_methods -= object_methods
+        end
+        ##
+        # Determines if an attribute is valid in the sense of the add method making sense.  Only 
+        # categories and tags are currently considered valid.
+        ## 
+        def valid_add_attribute?(request_attribute)
+          case request_attribute.to_s
+            when /^(.*)_(categories|tags)/ 
+              return true
+            when /^(categories|tags)/
+              return true
+          else
+            return false
+          end 
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module KalturaFu
+  module Entry
+    module Metadata
+      module ClassMethods
+        
+        # Contains the names of the generated attribute methods.
+        def generated_methods #:nodoc:
+          @generated_methods ||= Set.new
+        end
+
+        def generated_methods?
+          !generated_methods.empty?
+        end
+        
+        ##
+        # This method is called from with method_missing.  It generates
+        # actual methods for all the valid Kaltura::Media Entry methods
+        # the first time a dynamic getter/setter/adder is called.
+        ##
+        def define_attribute_methods
+          return if generated_methods?
+          valid_entry_attributes.each do |name|
+            define_set_method(name)
+            define_get_method(name)
+            define_add_method(name) if valid_add_attribute?(name)
+          end        
+        end
+      
+        ##
+        # Defines the set method for a specific Media Entry attribute
+        ##
+        def define_set_method(attr_name) 
+          evaluate_attribute_method( attr_name, 
+            "def set_#{attr_name}(entry,new_value);set_attribute('#{attr_name}',entry,new_value);end", 
+            "set_#{attr_name}"
+          )
+        end
+
+        ##
+        # defines a get methods 
+        ##
+        def define_get_method(attr_name)
+          evaluate_attribute_method( attr_name, 
+            "def get_#{attr_name}(entry);get_entry(entry).send('#{attr_name}');end", 
+            "get_#{attr_name}"
+          )
+        end
+
+        def define_add_method(attr_name) 
+          evaluate_attribute_method( attr_name, 
+            "def add_#{attr_name}(entry,new_value);add_attribute('#{attr_name}',entry,new_value);end", 
+            "add_#{attr_name}"
+          )
+        end
+        
+        def evaluate_attribute_method(attr_name, method_definition, method_name=attr_name) 
+          generated_methods << method_name
+
+          begin
+            class_eval(method_definition, __FILE__, __LINE__) 
+          rescue SyntaxError => err
+            generated_methods.delete(attr_name) 
+          end
+        end
+      
+      end
+    end
+  end
+end
+      
+      

data/lib/kaltura_fu/railtie.rb

@@ -0,0 +1,28 @@
+require 'kaltura_fu'
+require 'kaltura_fu/view_helpers'
+require 'rails'
+
+module KalturaFu
+  class Railtie < Rails::Railtie
+    initializer 'install kaltura_fu' do
+      $: << File.dirname(__FILE__) + '/../lib'
+    
+      ActionView::Base.send :include, KalturaFu::ViewHelpers
+
+      kaltura_yml = File.join(RAILS_ROOT,'config','kaltura.yml')
+
+      unless File.exists?(kaltura_yml)
+        raise RuntimeError, "Unable to find \"config/kaltura.yml\" file."
+      end
+
+      config_file = YAML.load_file(kaltura_yml)[Rails.env]
+      KalturaFu.config = config_file.symbolize_keys
+
+
+      unless[:partner_id,:subpartner_id,:administrator_secret].all? {|key| KalturaFu.config.key?(key)}
+        raise RuntimeError, "Kaltura config requires :partner_id, :subpartner_id,"+
+      		      "and :administrator_secret keys"
+      end
+    end
+  end
+end

data/lib/kaltura_fu/view_helpers.rb

@@ -0,0 +1,182 @@
+module KalturaFu
+  
+  ##
+  # The ViewHelpers module provides extensions to Rails ActionView class that allow interactions with Kaltura on rails view layer.
+  # 
+  # @author Patrick Robertson
+  ##
+  module ViewHelpers
+    # default UI Conf ID of the kdp player
+    DEFAULT_KPLAYER = '1339442'
+    # default embedded KDP width
+    PLAYER_WIDTH = '400'
+    # default embedded KDP height
+    PLAYER_HEIGHT = '330'
+    
+    ##
+    # Convienence to include SWFObject and the required Kaltura upload embed javascripts.
+    ##
+    def include_kaltura_fu(*args)
+      content = javascript_include_tag('kaltura_upload')
+      content << "\n#{javascript_include_tag('http://ajax.googleapis.com' + 
+		 '/ajax/libs/swfobject/2.2/swfobject.js')}" 
+    end
+    
+    ##
+    # Returns the thumbnail of the provided Kaltura Entry.
+    # @param [String] entry_id Kaltura entry_id
+    # @param [Hash] options the options for the thumbnail parameters.
+    # @option options [Array] :size ([]) an array of [width,height]
+    # @option options [String] :second (nil) the second of the Kaltura entry that the thumbnail should be of.
+    # 
+    # @return [String] Image tag of the thumbnail resource.
+    ##
+    def kaltura_thumbnail(entry_id,options={})
+      options[:size] ||= []
+      size_parameters = ""
+      seconds_parameter = ""
+      
+      unless options[:size].empty?
+        size_parameters = "/width/#{options[:size].first}/height/" +
+			  "#{options[:size].last}"
+      else
+        # if the thumbnail width and height are defined in the config,
+	      # use it, assuming it wasn't locally overriden
+        if KalturaFu.config[:thumb_width] && KalturaFu.config[:thumb_height]
+          size_parameters = "/width/#{KalturaFu.config[:thumb_width]}/height/" +
+			    "#{KalturaFu.config[:thumb_height]}"
+        end
+      end
+      
+      unless options[:second].nil?
+        seconds_parameter = "/vid_sec/#{options[:second]}"
+      else
+        seconds_parameter = "/vid_sec/5"
+      end
+      
+      image_tag("http://www.kaltura.com/p/#{KalturaFu.config[:partner_id]}" +
+		"/thumbnail/entry_id/#{entry_id}" + 
+		seconds_parameter + 
+		size_parameters)
+    end
+    
+    ##
+    # Returns the code needed to embed a KDPv3 player.
+    #
+    # @param [String] entry_id Kaltura entry_id
+    # @param [Hash] options the embed code options.
+    # @option options [String] :div_id ('kplayer') The div element that the flash object will be inserted into.
+    # @option options [Array] :size ([]) The [width,wight] of the player.
+    # @option options [Boolean] :use_url (false) flag to determine whether entry_id is an entry or a URL of a flash file.
+    # @option options [String] :player_conf_id (KalturaFu.config(:player_conf_id)) A UI Conf ID to override the player with.
+    #
+    # @return [String] returns a string representation of the html/javascript necessary to play a Kaltura entry.
+    ##
+    def kaltura_player_embed(entry_id,options={})
+      player_conf_parameter = "/ui_conf_id/"
+      options[:div_id] ||= "kplayer"
+      options[:size] ||= []
+      options[:use_url] ||= false
+      width = PLAYER_WIDTH
+      height = PLAYER_HEIGHT
+      source_type = "entryId"
+
+      unless options[:size].empty?
+	      width = options[:size].first
+	      height = options[:size].last
+      end
+        
+      if options[:use_url] == true
+        source_type = "url"
+      end
+    
+      unless options[:player_conf_id].nil?
+        player_conf_parameter += "#{options[:player_conf_id]}"
+      else
+        unless KalturaFu.config[:player_conf_id].nil?
+          player_conf_parameter += "#{KalturaFu.config[:player_conf_id]}"
+	      else
+	        player_conf_parameter += "#{DEFAULT_KPLAYER}"
+        end
+      end
+      
+      "<div id=\"#{options[:div_id]}\"></div>
+      <script type=\"text/javascript\">
+      	var params= {
+      		allowscriptaccess: \"always\",
+      		allownetworking: \"all\",
+      		allowfullscreen: \"true\",
+      		wmode: \"opaque\"
+      	};
+      	var flashVars = {};
+      	flashVars.sourceType = \"#{source_type}\";      	  
+      	flashVars.entryId = \"#{entry_id}\";
+      	flashVars.emptyF = \"onKdpEmpty\";
+    		flashVars.readyF = \"onKdpReady\";
+      		
+      	var attributes = {
+          id: \"#{options[:div_id]}\",
+          name: \"#{options[:div_id]}\"
+      	};
+
+      	swfobject.embedSWF(\"http://www.kaltura.com/kwidget/wid/_#{KalturaFu.config[:partner_id]}" + player_conf_parameter + "\",\"#{options[:div_id]}\",\"#{width}\",\"#{height}\",\"10.0.0\",\"http://ttv.mit.edu/swfs/expressinstall.swf\",flashVars,params,attributes);
+      </script>"
+    end
+    
+    ##
+    # Returns the html/javascript necessary for a KSU widget.
+    #
+    # @param [Hash] options 
+    # @option options [String] :div_id ('uploader') div that the flash object will be inserted into.
+    ##
+    def kaltura_upload_embed(options={})
+      options[:div_id] ||="uploader"
+      "<div id=\"#{options[:div_id]}\"></div>
+    		<script type=\"text/javascript\">
+
+    		var params = {
+    			allowScriptAccess: \"always\",
+    			allowNetworking: \"all\",
+    			wmode: \"transparent\"
+    		};
+    		var attributes = {
+    			id: \"uploader\",
+    			name: \"KUpload\"
+    		};
+    		var flashVars = {
+    			uid: \"ANONYMOUS\",
+    			partnerId: \"#{KalturaFu.config[:partner_id]}\",
+    			subPId: \"#{KalturaFu.config[:subpartner_id]}\",
+    			entryId: \"-1\",
+    			ks: \"#{KalturaFu.session_key}\",
+    			uiConfId: '1103',
+    			jsDelegate: \"delegate\",
+    			maxFileSize: \"999999999\",
+    			maxTotalSize: \"999999999\"
+    		};
+
+        swfobject.embedSWF(\"http://www.kaltura.com/kupload/ui_conf_id/1103\", \"uploader\", \"160\", \"26\", \"9.0.0\", \"expressInstall.swf\", flashVars, params,attributes);
+
+    	</script>"
+    end
+    
+    ##
+    # Creates a link_to tag that seeks to a certain time on a KDPv3 player.
+    #
+    # @param [String] content The text in the link tag.
+    # @param [Integer] seek_time The time in seconds to seek the player to.
+    # @param [Hash] options
+    #
+    # @option options [String] :div_id ('kplayer') The div of the KDP player.
+    ##
+    def kaltura_seek_link(content,seek_time,options={})
+      options[:div_id] ||= "kplayer"
+
+      options[:onclick] = "$(#{options[:div_id]}).get(0).sendNotification('doSeek',#{seek_time});window.scrollTo(0,0);return false;"
+      options.delete(:div_id)
+      link_to(content,"#", options)
+    end
+  end
+  
+  
+end

data/rails/init.rb

@@ -0,0 +1,22 @@
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'kaltura-ruby'
+require 'kaltura_fu'
+
+ActionView::Base.send :include, KalturaFu::ViewHelpers
+
+kaltura_yml = File.join(RAILS_ROOT,'config','kaltura.yml')
+
+unless File.exists?(kaltura_yml)
+  raise RuntimeError, "Unable to find \"config/kaltura.yml\" file."
+end
+
+
+KalturaFu.config = YAML.load_file(kaltura_yml).symbolize_keys[RAILS_ENV.to_sym]
+
+
+unless[:partner_id,:subpartner_id,:administrator_secret].all? {|key| KalturaFu.config.key?(key)}
+  raise RuntimeError, "Kaltura config requires :partner_id, :subpartner_id,"+
+		      "and :administrator_secret keys"
+end

data/spec/debug.log

@@ -0,0 +1 @@
+# Logfile created on Mon Jun 14 10:07:52 -0400 2010 by /

data/spec/entry_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+class EntrySpecTester
+  include KalturaFu::Entry
+end
+
+describe "Kaltura Fu's Entry Class Methods" do
+  before(:all) do
+    KalturaFuTestConfiguration.setup
+    @tester = EntrySpecTester.new
+  end
+  
+  it "Responds to upload" do
+    EntrySpecTester.should respond_to :upload
+  end
+  
+  it "Allows a valid file to be uploaded and deleted" do
+    entry_id = nil
+    lambda {entry_id = EntrySpecTester.upload(KalturaFuTestConfiguration.video, :source=>:file)}.should_not raise_error
+    
+    lambda {@tester.get_entry(entry_id)}.should_not raise_error
+    check = @tester.delete_entry(entry_id)
+    check.should be_true
+  end
+  
+  it "Does nothing when you don't source the method as a file upload" do
+    entry_id = nil
+    lambda {entry_id = EntrySpecTester.upload("waffles",:source=>:url)}.should_not raise_error
+    entry_id.should be_nil
+  end
+  
+  it "Handles valid Media Entry attributes when you provide them in the options hash" do
+    video_options = {}
+    video_options[:name] = "My fantastic movie."
+    video_options[:description] = "A movie of unparralled awesomeness."
+    video_options[:tags] = "man, this, is, awesome"
+    video_options[:source] = :file
+    
+    entry_id = nil
+    lambda {entry_id = EntrySpecTester.upload(KalturaFuTestConfiguration.video,video_options)}.should_not raise_error
+    
+    media_entry = nil
+    lambda {media_entry = @tester.get_entry(entry_id)}.should_not raise_error
+    media_entry.name.should == video_options[:name]
+    media_entry.description.should == video_options[:description]
+    media_entry.tags.should == video_options[:tags]
+    
+    check = @tester.delete_entry(entry_id)
+    check.should be_true
+  end
+  
+  it "Is totally cool with you supplying jibberish in the options too." do
+    video_options = {}
+    video_options[:name] = "My fantastic movie."
+    video_options[:description] = "A movie of unparralled awesomeness."
+    video_options[:tags] = "man, this, is, awesome"
+    video_options[:source] = :file
+    video_options[:waffles] = "WHATEVER WAFFLES"
+    
+    entry_id = nil
+    lambda {entry_id = EntrySpecTester.upload(KalturaFuTestConfiguration.video,video_options)}.should_not raise_error
+    
+    media_entry = nil
+    lambda {media_entry = @tester.get_entry(entry_id)}.should_not raise_error
+    media_entry.name.should == video_options[:name]
+    media_entry.description.should == video_options[:description]
+    media_entry.tags.should == video_options[:tags]
+    media_entry.should_not respond_to :waffles
+    
+    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