kaltura_fu 0.1.3.prel → 0.1.3

data/lib/kaltura_fu/entry/metadata.rb

@@ -0,0 +1,147 @@
+require 'active_support'
+
+module KalturaFu
+  module Entry
+    module Metadata
+
+      ##
+      # @private
+      ##
+      def self.included(base)
+        base.extend ClassAndInstanceMethods
+        base.class_eval do
+          include ClassAndInstanceMethods
+        end
+        super
+      end
+      
+      ##
+      # @private
+      ##      
+      def method_missing(name, *args)
+        case name.to_s
+          when /^set_(.*)/
+            valid_entry_attribute?($1.to_sym) ? set_attribute($1,*args) : super
+          when /^add_(.*)/
+            valid_entry_attribute?($1.pluralize.to_sym) ? add_attribute($1.pluralize,*args) : super
+          when /^get_(.*)/
+            valid_entry_attribute?($1.to_sym) ? get_entry(*args).send($1.to_sym) : super
+        else
+          super
+        end
+      end
+      
+      ##
+      # @private
+      ##
+      def respond_to?(method)
+        case method.to_s
+          when /^(get|set)_(.*)/
+            valid_entry_attribute?($2.to_sym) || super
+          when /^(add)_(.*)/
+            (valid_entry_attribute?($2.pluralize.to_sym) && valid_add_attribute?($2) ) || super
+        else
+          super
+        end         
+      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.
+      # @raose [Kaltura::APIError] Raises a kaltura error if it can't find the entry.
+      ##
+      def get_entry(entry_id)  
+        KalturaFu.check_for_client_session
+
+        KalturaFu.client.media_service.get(entry_id)      
+      end
+      
+      ##
+      # Sets a specific Kaltura::MediaEntry attribute given a Kaltura entry.
+      # This method is called by method_missing, allowing this module set attributes based
+      # off of the current API wrapper, rather than having to update along side the API wrapper.
+      #
+      # @param [String] attr_name The attribute to set.
+      # @param [String] entry_id The Kaltura entry ID.
+      # @param [String] value The value you wish to set the attribute to.
+      # 
+      # @return [String] Returns the value as stored in the Kaltura database.  Tag strings come back
+      #   slightly funny.
+      #
+      # @raise [Kaltura::APIError] Passes Kaltura API errors directly through.
+      ##
+      def set_attribute(attr_name,entry_id,value)
+        KalturaFu.check_for_client_session
+        
+        add_categories_to_kaltura(value) if (attr_name =~ /^(.*)_categories/ || attr_name =~ /^categories/)
+        
+        media_entry = Kaltura::MediaEntry.new
+        media_entry.send("#{attr_name}=",value)
+        KalturaFu.client.media_service.update(entry_id,media_entry).send(attr_name.to_sym)
+        
+      end
+      
+      ##
+      # @private
+      ##
+      def add_categories_to_kaltura(categories)
+        KalturaFu.check_for_client_session
+        
+        categories.split(",").each do |category|
+          unless category_exists?(category)
+            cat = Kaltura::Category.new
+            cat.name = category
+            KalturaFu.client.category_service.add(cat)            
+          end
+        end
+      end
+      
+      ## 
+      # @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
+      
+      
+      ##
+      # Appends a specific Kaltura::MediaEntry attribute to the end of the original attribute given a Kaltura entry.
+      # This method is called by method_missing, allowing this module add attributes based
+      # off of the current API wrapper, rather than having to update along side the API wrapper.
+      #
+      # @param [String] attr_name The attribute to set.
+      # @param [String] entry_id The Kaltura entry ID.
+      # @param [String] value The value you wish to append the attribute with.
+      # 
+      # @return [String] Returns the value as stored in the Kaltura database.  Tag strings come back
+      #   slightly funny.
+      #
+      # @raise [Kaltura::APIError] Passes Kaltura API errors directly through.
+      ##      
+      def add_attribute(attr_name,entry_id,value)
+        KalturaFu.check_for_client_session
+
+
+        add_categories_to_kaltura(value) if (attr_name =~ /^(.*)_categor(ies|y)/ || attr_name =~ /^categor(ies|y)/)        
+        
+        old_attributes = KalturaFu.client.media_service.get(entry_id).send(attr_name.to_sym)
+        media_entry = Kaltura::MediaEntry.new
+        media_entry.send("#{attr_name}=","#{old_attributes},#{value}")
+        KalturaFu.client.media_service.update(entry_id,media_entry).send(attr_name.to_sym)
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module KalturaFu
+  module Entry
+    module Metadata
+      
+      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_media_entry_methods.find{|m| m.to_sym == request_attribute.to_sym} ? true : false
+        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 /^(.*)_(categor(y|ies)|(tag|tags))/ 
+              return true
+            when /^(categor(y|ies)|tag)/
+              return true
+          else
+            return false
+          end 
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/kaltura_fu/flavor.rb

@@ -0,0 +1,89 @@
+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/railtie.rb

@@ -15,8 +15,8 @@ module KalturaFu
         raise RuntimeError, "Unable to find \"config/kaltura.yml\" file."
       end
 
-
-      KalturaFu.config = YAML.load_file(kaltura_yml).recursively_symbolize_keys[RAILS_ENV.to_sym]
+      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)}

data/rails/init.rb

@@ -13,7 +13,7 @@ unless File.exists?(kaltura_yml)
 end
 
 
-KalturaFu.config = YAML.load_file(kaltura_yml).recursively_symbolize_keys[RAILS_ENV.to_sym]
+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)}

data/spec/entry_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/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/kaltura_fu_spec.rb

@@ -1,166 +1,63 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe KalturaFu, :type => :helper do 
-
-  it "should have the proper javascript include tags" do
-    html = helper.include_kaltura_fu
-    
-    html.should have_tag("script[src= ?]", 
-			 "http://ajax.googleapis.com/ajax/libs/swfobject" + 
-			 "/2.2/swfobject.js" )
-
-    html.should have_tag("script[src = ?]",
-			 %r{/javascripts/kaltura_upload.js\?[0-9]*})    
+describe "General Configuration testing" do
+  before(:all) do
+    KalturaFu.config = {}
+    KalturaFu.client_configuration =nil
+    KalturaFu.clear_session_key!
+    KalturaFu.client = nil
   end
-
-  it "should create a plain thumbnail" do
-    html = helper.kaltura_thumbnail(12345)
-
-
-    if KalturaFu.config[:thumb_width] && KalturaFu.config[:thumb_height]
-      html.should have_tag("img[src = ?]" , "http://www.kaltura.com/p/" + 
-			   KalturaFu.config[:partner_id] + 
-			   "/thumbnail/entry_id/12345" + "/width/" + 
-			   KalturaFu.config[:thumb_width] + "/height/" + 
-			   KalturaFu.config[:thumb_height])
-    else
-      html.should have_tag("img[src = ?]", 
-			   "http://www.kaltura.com/p/" + 
-			   KalturaFu.config[:partner_id] +
-			   "/thumbnail/entry_id/12345")
-    end
+  it "Should start with an empty config" do
+    KalturaFu.config.should be_empty
   end
-  it "should create an appropriately sized thumbnail" do
-    html = helper.kaltura_thumbnail(12345,:size=>[800,600])
-
-    html.should have_tag("img[src = ?]", "http://www.kaltura.com/p/" +
-			 KalturaFu.config[:partner_id] +
-			 "/thumbnail/entry_id/12345" + "/width/800" +
-			 "/height/600")
-  end
-  it "should create a thumbnail at the right second" do
-    html = helper.kaltura_thumbnail(12345,:size=>[800,600],:second=> 6)
-
-    html.should have_tag("img[src = ?]", "http://www.kaltura.com/p/" +
-			 KalturaFu.config[:partner_id] +
-			 "/thumbnail/entry_id/12345" + "/vid_sec/6" +
-			 "/width/800/height/600")
+  
+  it "Shouldn't generate a Kaltura session on an empty config" do
+    lambda {KalturaFu.generate_session_key}.should raise_error(RuntimeError, "Missing Partner Identifier")
   end
-  it "should embed a default player" do
-    html = helper.kaltura_player_embed(12345)
-
-    #check the outer div
-    html.should have_tag("div#kplayer")
-
-    # check the parameters
-    html.should have_tag("script",%r{allowscriptaccess: "always"})
-    html.should have_tag("script",%r{allownetworking: "all"})
-    html.should have_tag("script",%r{allowfullscreen: "true"})
-    html.should have_tag("script",%r{wmode: "opaque"})
-
-    # check the vars
-    html.should have_tag("script",%r{entryId: "12345"})  
-
-    # check the embed
-    html.should have_tag("script",%r{swfobject.embedSWF})
-    html.should have_tag("script",
-      %r{http://www.kaltura.com/kwidget/wid/_#{KalturaFu.config[:partner_id]}})
-    if KalturaFu.config[:player_conf_id]
-      html.should have_tag("script",
-        %r{/ui_conf_id/#{KalturaFu.config[:player_conf_id]}})
-    else 
-      html.should have_tag("script",
-	%r{/ui_conf_id/#{KalturaFu::ViewHelpers::DEFAULT_KPLAYER}})
-    end
-    html.should have_tag("script",%r{"kplayer","400","330"})
+  
+  it "Shouldn't generate a Kaltura session without an administrator secret" do
+    KalturaFu.config[:partner_id] = '121413'
+    lambda {KalturaFu.generate_session_key}.should raise_error(RuntimeError, "Missing Administrator Secret")
   end
-  it "should embed a player with a different div" do
-    html = helper.kaltura_player_embed(12345,:div_id=>"waffles")
-
-    #check the outer div
-    html.should have_tag("div#waffles")
-
-    # check the parameters
-    html.should have_tag("script",%r{allowscriptaccess: "always"})
-    html.should have_tag("script",%r{allownetworking: "all"})
-    html.should have_tag("script",%r{allowfullscreen: "true"})
-    html.should have_tag("script",%r{wmode: "opaque"})
-
-    # check the vars
-    html.should have_tag("script",%r{entryId: "12345"})  
-
-    # check the embed
-    html.should have_tag("script",%r{swfobject.embedSWF})
-    html.should have_tag("script",
-      %r{http://www.kaltura.com/kwidget/wid/_#{KalturaFu.config[:partner_id]}})
-    if KalturaFu.config[:player_conf_id]
-      html.should have_tag("script",
-        %r{/ui_conf_id/#{KalturaFu.config[:player_conf_id]}})
-    else
-      html.should have_tag("script",
-	%r{/ui_conf_id/#{KalturaFu::ViewHelpers::DEFAULT_KPLAYER}})
-    end
-    html.should have_tag("script",%r{"waffles","400","330"})
-  end 
-
-  it "should embed a player with a different config id" do
-    html = helper.kaltura_player_embed(12345, :player_conf_id=>"1234")
-
-    #check the outer div
-    html.should have_tag("div#kplayer")
-
-    # check the parameters
-    html.should have_tag("script",%r{allowscriptaccess: "always"})
-    html.should have_tag("script",%r{allownetworking: "all"})
-    html.should have_tag("script",%r{allowfullscreen: "true"})
-    html.should have_tag("script",%r{wmode: "opaque"})
-
-    # check the vars
-    html.should have_tag("script",%r{entryId: "12345"})  
-
-    # check the embed
-    html.should have_tag("script",%r{swfobject.embedSWF})
-    html.should have_tag("script",
-      %r{http://www.kaltura.com/kwidget/wid/_#{KalturaFu.config[:partner_id]}})
-    html.should have_tag("script",
-      %r{/ui_conf_id/1234})
-    html.should have_tag("script",%r{"kplayer","400","330"})
-  end 
-
-  it "should allow a resize on the player" do
-    html = helper.kaltura_player_embed(12345,:size=>[200,170])
-
-    #check the outer div
-    html.should have_tag("div#kplayer")
-
-    # check the parameters
-    html.should have_tag("script",%r{allowscriptaccess: "always"})
-    html.should have_tag("script",%r{allownetworking: "all"})
-    html.should have_tag("script",%r{allowfullscreen: "true"})
-    html.should have_tag("script",%r{wmode: "opaque"})
-
-    # check the vars
-    html.should have_tag("script",%r{entryId: "12345"})  
-
-    # check the embed
-    html.should have_tag("script",%r{swfobject.embedSWF})
-    html.should have_tag("script",
-      %r{http://www.kaltura.com/kwidget/wid/_#{KalturaFu.config[:partner_id]}})
-    if KalturaFu.config[:player_conf_id]
-      html.should have_tag("script",
-        %r{/ui_conf_id/#{KalturaFu.config[:player_conf_id]}})
-    else 
-      html.should have_tag("script",
-	%r{/ui_conf_id/#{KalturaFu::ViewHelpers::DEFAULT_KPLAYER}})
-    end
-    html.should have_tag("script",%r{"kplayer","200","170"})
+  
+  it "Should respect the Service URL when constructing a Client configuration" do
+    KalturaFu.config[:parnter_id] = '123434'
+    lambda {KalturaFu.create_client_config}.should_not raise_error
+    
+    KalturaFu.client_configuration.service_url.should == "http://www.kaltura.com"
+    
+    service_url = "http://www.waffletastic.com"
+    KalturaFu.config[:service_url] = service_url
+    KalturaFu.create_client_config
+    KalturaFu.client_configuration.service_url.should == service_url
   end
   
-  it "should seek to a time in seconds when asked" do
-    html = helper.kaltura_seek_link("Seek to 5 seconds","5")
-    html.should have_tag("a[href=\"#\"]", "Seek to 5 seconds")
-    html.should have_tag("a[onclick=\"$(kplayer).get(0).sendNotification(\'doSeek\',5);window.scrollTo(0,0);return false;\"]")
-    html.should_not have_tag("a[div_id=\"kplayer\"]")
+  it "Should raise a Kaltura::APIError when you provide incorrect information." do
+    KalturaFu.config = {}
+    KalturaFu.config[:partner_id] , KalturaFu.config[:administrator_secret] = '1241' , 'a3$35casd'
+    lambda {KalturaFu.generate_session_key}.should raise_error(Kaltura::APIError)
   end
-
 end
+describe "Valid Configuration tests" do
+  before :each do 
+    KalturaFuTestConfiguration.setup
+  end
+  
+  it "Should function just fine with proper credentials" do
+    lambda {KalturaFu.generate_session_key}.should_not raise_error
+  end
+  
+  it "Should allow you to clear the session" do
+    KalturaFu.generate_session_key
+    KalturaFu.clear_session_key!
+    
+    KalturaFu.session_key.should be nil
+  end
+  
+  it "Should generate a valid session if you ask politely" do
+    KalturaFu.clear_session_key!
+    KalturaFu.check_for_client_session
+    
+    KalturaFu.session_key.should_not be nil
+  end
+end