kaltura_fu 0.1.3.prel → 0.1.3

data/spec/metadata_spec.rb

@@ -0,0 +1,271 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class MetadataSpecTester 
+  include KalturaFu::Entry::Metadata
+end
+
+class EntryUploader
+  include KalturaFu::Entry
+end
+
+describe "Actions on an entries metadata" 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 respond to getting valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :get_name
+  end
+  
+  it "should respond to getting valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :get_description
+  end
+  
+  it "should respond to getting valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :get_categories
+  end
+  
+  it "should respond to setting valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :set_description
+  end
+  
+  it "should respond to setting valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :set_name
+  end
+  
+  it "should respond to setting valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :set_categories
+  end
+  
+  it "should respond to adding valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :add_category
+  end
+  
+  it "should respond to adding valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :add_categories
+  end
+  
+  it "should respond to adding valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :add_tag
+  end
+  
+  it "should respond to adding valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :add_tags
+  end
+  
+  it "should respond to adding valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :add_admin_tag
+  end
+  
+  it "should respond to adding valid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should respond_to :add_admin_tags
+  end
+  
+  it "should not respond to getting invalid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should_not respond_to :get_barack_obama
+  end
+  
+  it "should not respond to setting invalid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should_not respond_to :set_magic
+  end
+  
+  it "should not respond to adding invalid entry attributes" do
+    test = MetadataSpecTester.new
+    test.should_not respond_to :add_waffles
+  end  
+  
+  it "should not respond to adding valid entry attributes, but improperly typed" do
+    test = MetadataSpecTester.new
+    test.should_not respond_to :add_name
+  end
+  
+  it "should not respond to adding valid entry attributes, but improperly typed" do
+    test = MetadataSpecTester.new
+    test.should_not respond_to :add_names
+  end
+  
+  it "should set the name field when asked kindly" do
+    test = MetadataSpecTester.new    
+    test.set_name(@entry_id,"waffles").should == "waffles"
+  end
+  
+  it "should set the desription field when asked kindly" do
+    test = MetadataSpecTester.new    
+    test.set_description(@entry_id,"The beginning of the end of the beginning").should == "The beginning of the end of the beginning"
+  end
+  
+  it "should be a little weirder when setting a group of tags" do
+    test = MetadataSpecTester.new
+    test.set_tags(@entry_id,"waffles,awesome,rock,hard").should == "waffles, awesome, rock, hard"
+    test.get_tags(@entry_id).should == "waffles, awesome, rock, hard"
+  end
+  
+  it "should just be weird with tags, admin tags don't act this way either" do
+    test = MetadataSpecTester.new
+    test.set_admin_tags(@entry_id,"waffles,awesome,rock,hard").should == "waffles,awesome,rock,hard"
+    test.get_admin_tags(@entry_id).should == "waffles,awesome,rock,hard"
+  end  
+  
+  it "shouldn't act like tags with categories" do
+    test = MetadataSpecTester.new
+    test.set_categories(@entry_id,"waffles,awesome,rock,hard").should == "waffles,awesome,rock,hard"
+  end
+  
+  it "should raise a Kaltura::APIError when you give it a bogus entry" do
+    test = MetadataSpecTester.new
+    
+    lambda {test.set_name("waffles","waffles")}.should raise_error(Kaltura::APIError)
+  end
+  
+  it "should not increment the version when you perform set actions" do
+    test = MetadataSpecTester.new
+    
+    version_count = test.get_version(@entry_id).to_i
+    
+    test.set_name(@entry_id,"my new name")
+    test.get_version(@entry_id).to_i.should == version_count
+  end
+  
+  it "should not increment the version when you perform set actions on tags" do
+    test = MetadataSpecTester.new
+    
+    version_count = test.get_version(@entry_id).to_i
+    
+    test.set_tags(@entry_id,"buttons,kittens,pirates")
+    test.get_version(@entry_id).to_i.should == version_count
+  end
+  
+  it "should be making KMC categories for every category you set unless it already exists." do
+    test = MetadataSpecTester.new
+    
+    categories = "waffles#{rand(10)},pirates#{rand(18)},peanuts#{rand(44)}"
+    categories.split(",").each do |category|
+      test.category_exists?(category).should be_false
+    end
+    
+    test.set_categories(@entry_id,categories)
+    
+    categories.split(",").each do |category|
+      cat = test.category_exists?(category)
+      cat.should_not be_false
+    end
+    
+    bob = KalturaFu.client.category_service.list.objects
+    bob.each do |cat|
+      if cat.name =~/^(waffles|pirates|peanuts)(.*)/
+        KalturaFu.client.category_service.delete(cat.id)
+      end
+    end
+      
+  end
+  
+  it "should allow you to add tags onto an existing tag string without knowing the original tags" do
+    test = MetadataSpecTester.new
+    
+    original_tags = test.set_tags(@entry_id,"gorillaz, pop, damon, albarn")
+    
+    test.add_tags(@entry_id,"mos,def").should == original_tags + ", mos, def"
+  end
+  
+  it "should let you add a single tag too, syntax sugar is rad." do
+    test = MetadataSpecTester.new
+    
+    original_tags = test.set_tags(@entry_id,"gorillaz, pop, damon, albarn")
+    
+    test.add_tag(@entry_id,"mos").should == original_tags + ", mos"    
+  end
+  
+  it "should allow you to add admin tags onto an existing tag string without knowing the original tags" do
+    test = MetadataSpecTester.new
+    
+    original_tags = test.set_admin_tags(@entry_id,"gorillaz,pop,damon,albarn")
+    
+    test.add_admin_tags(@entry_id,"mos,def").should == original_tags + ",mos,def"
+  end
+  
+  it "should let you add a single admin tag too, syntax sugar is rad." do
+    test = MetadataSpecTester.new
+    
+    original_tags = test.set_admin_tags(@entry_id,"gorillaz, pop, damon, albarn")
+    
+    test.add_admin_tag(@entry_id,"mos").should == original_tags + ",mos"    
+  end
+  
+  it "should let you add categories onto an existing category string as well." do
+    test = MetadataSpecTester.new
+    
+    original_categories = test.set_categories(@entry_id,"peanuts#{rand(10)}")
+    
+    new_cats = "pirates#{rand(10)},waffles#{rand(10)}"
+    test.add_categories(@entry_id,new_cats).should == original_categories + ",#{new_cats}"
+    check_string = original_categories + ",#{new_cats}"
+    check_string.split(",").each do |category|
+      cat = test.category_exists?(category)
+      cat.should_not be_false
+    end
+    bob = KalturaFu.client.category_service.list.objects
+    bob.each do |cat|
+      if cat.name =~/^(waffles|pirates|peanuts)(.*)/
+        KalturaFu.client.category_service.delete(cat.id)
+      end
+    end
+  end
+  
+  it "should create categories for each one you add if they don't exist." do
+    test = MetadataSpecTester.new
+    
+    original_categories = test.set_categories(@entry_id,"peanuts#{rand(10)}")
+    
+    new_cats = "pirates#{rand(10)},waffles#{rand(10)}"
+    test.add_categories(@entry_id,new_cats)
+    check_string = original_categories + ",#{new_cats}"
+    check_string.split(",").each do |category|
+      cat = test.category_exists?(category)
+      cat.should_not be_false
+    end
+    bob = KalturaFu.client.category_service.list.objects
+    bob.each do |cat|
+      if cat.name =~/^(waffles|pirates|peanuts)(.*)/
+        KalturaFu.client.category_service.delete(cat.id)
+      end
+    end
+  end
+  
+  it "should let you add categories onto an existing category string as well." do
+    test = MetadataSpecTester.new
+    
+    original_categories = test.set_categories(@entry_id,"peanuts#{rand(10)},pirates#{rand(10)}")
+    
+    new_cat = "waffles#{rand(10)}"
+    test.add_category(@entry_id,new_cat).should == original_categories + ",#{new_cat}"
+    
+    bob = KalturaFu.client.category_service.list.objects
+    bob.each do |cat|
+      if cat.name =~/^(waffles|pirates|peanuts)(.*)/
+        KalturaFu.client.category_service.delete(cat.id)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -1,10 +1,28 @@
-begin
-  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
-rescue LoadError
-  puts "You need to install rspec in your base app"
-  exit
-end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'kaltura_fu'
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+require 'kaltura'
+require 'yaml'
+require 'active_support'
 
-plugin_spec_dir = File.dirname(__FILE__)
-ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+Spec::Runner.configure do |config|
+  
+end
 
+class KalturaFuTestConfiguration
+  def self.setup
+    kaltura_yml = File.join(File.dirname(__FILE__),'config','kaltura.yml')
+    KalturaFu.config = YAML.load_file(kaltura_yml).symbolize_keys
+    
+    #remove any lingering and possibly incorrect client information
+    KalturaFu.client = nil
+    KalturaFu.client_configuration = nil
+  end
+  
+  def self.video
+    File.open(File.join(File.dirname(__FILE__),'config','video.flv'))
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kaltura_fu
 version: !ruby/object:Gem::Version 
-  hash: -1876988255
-  prerelease: true
+  hash: 29
+  prerelease: false
   segments: 
   - 0
   - 1
   - 3
-  - prel
-  version: 0.1.3.prel
+  version: 0.1.3
 platform: ruby
 authors: 
 - Patrick Robertson
@@ -16,13 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-12 00:00:00 -04:00
+date: 2010-11-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: velir_kaltura-ruby
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: velir_kaltura-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -34,7 +49,7 @@ dependencies:
         - 3
         version: 0.4.3
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 description: 
 email: patrick.robertson@velir.com
 executables: []
@@ -55,16 +70,23 @@ files:
 - install.rb
 - kaltura_fu.gemspec
 - lib/kaltura_fu.rb
-- lib/kaltura_fu/category.rb
+- lib/kaltura_fu/configuration.rb
+- lib/kaltura_fu/entry.rb
+- lib/kaltura_fu/entry/class_methods.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/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/entry_spec.rb
 - spec/kaltura_fu_spec.rb
+- spec/metadata_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
-- test/kaltura_fu_test.rb
-- test/test_helper.rb
 - uninstall.rb
 has_rdoc: true
 homepage: http://github.com/Velir/kaltura_fu
@@ -87,14 +109,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -103,7 +123,7 @@ signing_key:
 specification_version: 3
 summary: Rails gem for making Kaltura integrations easier.
 test_files: 
+- spec/entry_spec.rb
 - spec/kaltura_fu_spec.rb
+- spec/metadata_spec.rb
 - spec/spec_helper.rb
-- test/kaltura_fu_test.rb
-- test/test_helper.rb

data/lib/kaltura_fu/category.rb

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