papyromancer-kaltura-ruby 0.0.0

data/lib/kaltura_client_base.rb

@@ -0,0 +1,217 @@
+#
+# This file is part of the Kaltura Collaborative Media Suite which allows users
+# to do with audio, video, and animation what Wiki platfroms allow them to do with
+# text.
+#
+# Copyright (C) 2006-2008 Kaltura Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 
+
+require 'rubygems'
+require 'json'
+require 'net/http'
+require 'active_support'
+require 'active_resource'
+require 'digest/md5'
+
+module Kaltura
+  class KalturaClientBase
+  
+  	FORMATS = {
+  		:KALTURA_SERVICE_FORMAT_JSON => 1, 
+  		:KALTURA_SERVICE_FORMAT_XML => 2,
+  		:KALTURA_SERVICE_FORMAT_PHP => 3}
+  
+  	KALTURA_API_VERSION = "0.7"
+  
+  	attr_accessor :config
+  	attr_accessor :ks
+  	attr_accessor :shouldLog
+  
+    def serialize_params(params)
+      params.keys.map {|key| key.to_s }.sort.map {|key|
+        "#{escape(key)}=#{escape(params[key])}"
+      }.join("&")
+    end
+      
+    def connection
+      @connection ||= ActiveResource::Connection.new(@config.serviceUrl)
+    end
+
+    def post(path, options)
+      connection.post(path, serialize_params(options), headers)
+    end
+  
+    def headers
+      @headers ||= { 'Content-Type' => 'application/x-www-form-urlencoded' }
+    end
+  
+    # Escapes a query parameter. Stolen from RFuzz
+    def escape(s)
+      s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+        '%' + $1.unpack('H2'*$1.size).join('%').upcase
+      }.tr(' ', '+')
+    end
+      
+  	#
+  	# Kaltura client constuctor, expecting configuration object 
+  	#
+  	# @param KalturaConfiguration $config
+  	#
+    def initialize(config)
+  		@shouldLog = false
+  		@config = config;
+  		
+  		logger = config.getLogger()
+  
+  		if logger != nil
+        @shouldLog = true
+      end
+    end
+  
+  	def hit(method, session_user, params)
+      start_time = Time.now
+      
+      log("service url: [#{@config.serviceUrl}]");
+      log("trying to call method: [#{method}] for user id: [#{session_user.userId}] using session: [#{@ks}]");
+      
+      # append the basic params
+      params["kaltura_api_version"] 	= KalturaClientBase::KALTURA_API_VERSION
+      params["partner_id"] 			= @config.partnerId
+      params["subp_id"] 				= @config.subPartnerId
+      params["format"]          = @config.format
+      params["uid"]             = session_user.userId
+      addOptionalParam(params, "user_name", session_user.screenName)
+      addOptionalParam(params, "ks", @ks)
+      
+      params["kalsig"] = signature(params);
+    
+      url = "/index.php/partnerservices2/" + method
+      log("full reqeust url: [#{url}] params: [#{serialize_params(params)}]")
+      
+  		response = post(url, params)
+      
+      log("result (serialized): #{response.body}");
+      
+  		json = JSON.parse(response.body)
+      #log("result (object dump): #{dump}");
+      
+      end_time = Time.now
+      
+      log("execution time for method [#{method}]: [#{end_time - start_time}]")
+      
+      return json
+  	end
+  
+  	def start(session_user, secret)
+  		result = startSession(session_user, secret)
+  
+  		@ks = result["result"]["ks"]
+  		return result
+  	end
+  	
+  	def signature(params)
+      str = params.keys.map {|key| key.to_s }.sort.map {|key|
+        "#{escape(key)}#{escape(params[key])}"
+      }.join("")
+      
+      Digest::MD5.hexdigest(str)
+  	end
+  		
+  	def getKs()
+  		@ks
+  	end
+  	
+  	def setKs(ks)
+  		@ks = ks
+  	end
+  	
+  	def addOptionalParam(params, paramName, paramValue)
+  		params[paramName] = paramValue if paramValue
+  	end
+  	
+  	def log(msg)
+      #print "#{msg}\n"
+  		if @shouldLog
+  			config.getLogger().log(msg)
+  		end
+  	end
+  
+  
+  end
+  
+  class KalturaSessionUser
+  	attr_accessor :userId
+  	attr_accessor :screenName
+  	
+  	def initialize(userId, screenName = nil)
+  		@userId = userId;
+  		@screenName = screenName;
+  	end
+  end
+  
+  class KalturaConfiguration
+  	attr_accessor :logger
+  
+  	def serviceUrl
+  		URI.parse("http://www.kaltura.com/")
+  	end
+  
+  	def format
+  		KalturaClientBase::FORMATS[:KALTURA_SERVICE_FORMAT_JSON]
+  	end
+  
+  	attr_accessor :partnerId
+  	attr_accessor :subPartnerId
+  
+  	#
+  	# Constructs new kaltura configuration object, expecting partner id & sub partner id
+  	#
+  	# @param int $partnerId
+  	# @param int $subPartnerId
+  	#
+  	def initialize(partnerId, subPartnerId)
+  		@partnerId 	= partnerId;
+  		@subPartnerId = subPartnerId;
+  	end
+  	
+  	#
+  	# Set logger to get kaltura client debug logs
+  	#
+  	# @param IKalturaLogger $log
+  	#
+  	def setLogger(log)
+  		@logger = log
+  	end
+  	
+  	#
+  	# Gets the logger (Internal client use)
+  	#
+  	# @return unknown
+  	#
+  	def getLogger()
+  		@logger;
+  	end
+  end
+  
+  #
+  # Implement to get kaltura client logs
+  #
+  #
+  class IKalturaLogger 
+  	def log(msg)
+  	end
+  end
+end

data/test/kaltura-ruby_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class KalturaRubyTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test.rb

@@ -0,0 +1,23 @@
+require "kaltura_client.rb"
+
+include Kaltura
+conf = KalturaConfiguration.new(250, 25000)
+user = KalturaSessionUser.new(2)
+cl = KalturaClient.new(conf)
+secert = 'dae1be648b8a86d25adafdac2d32e8c3'
+cl.start(user, secert)
+
+kshow = KalturaKShow.new()
+kshow.name = "test ruby"
+kshow.description = "desc ruby"
+
+result = cl.addKShow(user, kshow, 1)
+
+print (result['result']['kshow']['name'])
+
+print("\n")
+print("\n")
+
+result = cl.search(user, KalturaEntryMediaType::VIDEO, KalturaEntryMediaSource::MYSPACE, "funny");
+
+print (result['result'])

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'kaltura-ruby'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: papyromancer-kaltura-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- papyromancer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: papyromancer@papyromancer.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/kaltura-ruby.rb
+- lib/kaltura_client.rb
+- lib/kaltura_client_base.rb
+- test/kaltura-ruby_test.rb
+- test/test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/papyromancer/kaltura-ruby
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Ruby gem for accessing the Kaltura API
+test_files: 
+- test/test_helper.rb
+- test/test.rb
+- test/kaltura-ruby_test.rb