kaltura_fu 0.1.3.prel → 0.1.3

data/.gitignore

@@ -1,2 +1,4 @@
 *.swp
 doc/**
+.svn
+.DS_Store

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "patrick.robertson@velir.com"
     gem.homepage = "http://github.com/Velir/kaltura_fu"
     gem.authors = ["Patrick Robertson"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
     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
@@ -18,18 +19,27 @@ 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
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+    test.libs << 'spec'
+    test.pattern = 'spec/**/*_spec.rb'
     test.verbose = true
   end
 rescue LoadError

data/VERSION.yml

@@ -2,4 +2,4 @@
 :major: 0
 :minor: 1
 :patch: 3
-:build: prel
+:build:

data/kaltura_fu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kaltura_fu}
-  s.version = "0.1.3.prel"
+  s.version = "0.1.3"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Patrick Robertson"]
-  s.date = %q{2010-10-12}
+  s.date = %q{2010-11-01}
   s.email = %q{patrick.robertson@velir.com}
   s.extra_rdoc_files = [
     "README.markdown"
@@ -26,16 +26,23 @@ Gem::Specification.new do |s|
      "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"
   ]
   s.homepage = %q{http://github.com/Velir/kaltura_fu}
@@ -44,10 +51,10 @@ Gem::Specification.new do |s|
   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"
+    "spec/entry_spec.rb",
+     "spec/kaltura_fu_spec.rb",
+     "spec/metadata_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -55,11 +62,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_runtime_dependency(%q<velir_kaltura-ruby>, [">= 0.4.3"])
     else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<velir_kaltura-ruby>, [">= 0.4.3"])
     end
   else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<velir_kaltura-ruby>, [">= 0.4.3"])
   end
 end

data/lib/kaltura_fu.rb

@@ -1,24 +1,3 @@
-##
-# @private
-##
-class Hash
-  
-  ##
-  # @private
-  ##
-  def recursively_symbolize_keys
-    tmp = {}
-    for k, v in self
-      tmp[k] = if v.respond_to? :recursively_symbolize_keys
-                 v.recursively_symbolize_keys
-               else
-                 v
-               end
-    end
-    tmp.symbolize_keys
-  end
-end
-
 ##
 # 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
@@ -30,85 +9,29 @@ end
 # @example Clear a session:
 #   KalturaFu.clear_session_key! #=> nil
 ##
+require 'rubygems'
+require 'kaltura'
+
 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'
   
-  # Kaltura's ready state.
-  READY = Kaltura::Constants::FlavorAssetStatus::READY
-  
-  
-  @@config = {}
-  @@client = nil
-  @@client_configuration = nil
-  @@session_key = nil
-  mattr_reader :config
-  mattr_reader :client
-  mattr_reader :session_key
-  
-  class << self
-    ##
-    # @private
-    ##
-    def config=(options)
-      @@config = options
-    end
-    
-    ##
-    # @private
-    #
-    def create_client_config
-      @@client_configuration = Kaltura::Configuration.new(@@config[:partner_id])
-      unless @@config[:service_url].blank?
-        @@client_configuration.service_url = @@config[:service_url]
-      end
-      @@client_configuration
-    end
-    
-    ##
-    # @private
-    ##
-    def create_client
-      if @@client_configuration.nil?
-        self.create_client_config
-      end
-      @@client = Kaltura::Client.new(@@client_configuration)
-      @@client
-    end
+  module Entry
+    autoload :Metadata, 'kaltura_fu/entry/metadata'
+    autoload :ClassMethods, 'kaltura_fu/entry/class_methods'
+    autoload :InstanceMethods, 'kaltura_fu/entry/instance_methods'
     
-    ##
-    # Generates a Kaltura ks and adds it to the KalturaFu client object.
-    #
-    # @return [String] a Kaltura KS.
-    ## 
-    def generate_session_key
-      self.check_for_client_session
-      
-      @@session_key = @@client.session_service.start(@@config[:administrator_secret],'',Kaltura::Constants::SessionType::ADMIN)
-      @@client.ks = @@session_key
-    end
-    ##
-    # Clears the current Kaltura ks.
-    ##
-    def clear_session_key!
-      @@session_key = nil
+    module Metadata
+      autoload :ClassAndInstanceMethods, 'kaltura_fu/entry/metadata/class_and_instance_methods'
     end
-    
-    ##
-    # @private
-    ##
-    def check_for_client_session
-      if @@client.nil?
-        self.create_client
-        self.generate_session_key
-        true
-      else
-        true
-      end
-    end
-          
   end
+  
+  extend Configuration
 end

data/lib/kaltura_fu/configuration.rb

@@ -0,0 +1,92 @@
+module KalturaFu
+  module Configuration
+  
+    @@config = {}
+    @@client = nil
+    @@client_configuration = nil
+    @@session_key = nil
+  
+    def config
+      @@config ||= {}
+    end
+    
+    def config=(value)
+      @@config = value
+    end
+    
+    def client
+      @@client ||= nil
+    end
+    
+    def client=(value)
+      @@client = value
+    end
+  
+    def client_configuration
+      @@client_configuration ||= nil
+    end
+    def client_configuration=(value)
+      @@client_configuration = value
+    end
+    def session_key
+      @@session_key ||=nil
+    end
+    
+    
+    ##
+    # @private
+    ##
+    def create_client_config
+      raise "Missing Partner Identifier" unless @@config[:partner_id]
+      @@client_configuration = Kaltura::Configuration.new(@@config[:partner_id])
+      unless @@config[:service_url].nil?
+        @@client_configuration.service_url = @@config[:service_url]
+      end
+      @@client_configuration
+    end
+
+    ##
+    # @private
+    ##
+    def create_client
+      if @@client_configuration.nil?
+        self.create_client_config
+      end
+      @@client = Kaltura::Client.new(@@client_configuration)
+      @@client
+    end
+
+    ##
+    # Generates a Kaltura ks and adds it to the KalturaFu client object.
+    #
+    # @return [String] a Kaltura KS.
+    ## 
+    def generate_session_key
+      self.check_for_client_session
+      
+      raise "Missing Administrator Secret" unless @@config[:administrator_secret]
+      @@session_key = @@client.session_service.start(@@config[:administrator_secret],'',Kaltura::Constants::SessionType::ADMIN)
+      @@client.ks = @@session_key
+    end
+    ##
+    # Clears the current Kaltura ks.
+    ##
+    def clear_session_key!
+      @@session_key = nil
+    end
+
+    ##
+    # @private
+    ##
+    def check_for_client_session
+      if @@client.nil?
+        self.create_client
+        self.generate_session_key
+        true
+      else
+        true
+      end
+    end
+    
+  end
+end

data/lib/kaltura_fu/entry.rb

@@ -0,0 +1,16 @@
+module KalturaFu
+  module Entry    
+    ##
+    # @private
+    ##
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do 
+        include Metadata
+        include InstanceMethods
+      end
+      super
+    end
+    
+  end #Entry
+end #KalturFu

data/lib/kaltura_fu/entry/class_methods.rb

@@ -0,0 +1,61 @@
+module KalturaFu
+  module Entry
+    
+    ##
+    # Class level methods for the Entry module.  
+    ##
+    module ClassMethods
+      #extend KalturaFu::Entry::Metadata
+      ##
+      # Allows you to upload some variety of media into Kaltura.  
+      # This isn't going to be as great to use as one of their flash widgets, and 
+      # should likely be used "off" the web process to not slow the application down.
+      #
+      # @param upload_object The object to upload.  Currently, it only works with a File.
+      # @param [Hash] options An options hash of Kaltura Media Entry attributes to add & the
+      #   upload_object source.
+      # @option options [Symbol] :source(nil) Currently only accepts :file
+      #
+      # @return [String] Returns the Kaltura Media Entry's ID that was created.
+      # @raise [Kaltura::APIError] It will force a Kaltura::APIError if something went terribly wrong.
+      #
+      # @todo Add the other upload types.
+      ##
+      def upload(upload_object,options={})
+        KalturaFu.check_for_client_session
+        
+        #options_for_media_entry = options.delete(:source)
+        media_entry = construct_entry_from_options(options)
+        upload_from_file(upload_object,media_entry) if options[:source] == :file
+      end
+      
+      ##
+      # @todo Build find.
+      ##
+      def find
+        #pending
+      end
+      
+      ##
+      # @private
+      ##
+      def upload_from_file(upload_object,media_entry)
+        upload_token = KalturaFu.client.media_service.upload(upload_object)
+        KalturaFu.client.media_service.add_from_uploaded_file(media_entry,upload_token).id
+      end
+      
+      ##
+      # @private
+      ##
+      def construct_entry_from_options(options={})
+        media_entry = Kaltura::MediaEntry.new
+        options.each do |key,value|
+          media_entry.send("#{key}=",value) if valid_entry_attribute?(key)
+        end
+          media_entry.media_type = Kaltura::Constants::Media::Type::VIDEO if options[:media_type].nil?
+          return media_entry
+      end
+      
+    end #ClassMethods
+  end
+end

data/lib/kaltura_fu/entry/instance_methods.rb

@@ -0,0 +1,25 @@
+module KalturaFu
+  module Entry
+    module InstanceMethods
+      ##
+      # Deletes a Kaltura entry.  Unlike the base API delete method, this returns true/false based on success.
+      # 
+      # @param [String] entry_id Kaltura entry ID to delete.
+      #
+      # @return [Boolean] returns true if the delete was successful or false otherwise.
+      # 
+      ##
+      def delete_entry(entry_id)
+        KalturaFu.check_for_client_session
+
+        begin
+          KalturaFu.client.media_service.delete(entry_id)
+          true
+        rescue Kaltura::APIError => e
+          false
+        end      
+      end
+      
+    end
+  end
+end