lyrics-ebook 0.1

data/lib/wiki_lyrics/tests/plugin_tests.rb

@@ -0,0 +1,161 @@
+# Copyright (C) 2007 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the
+# Free Software Foundation, Inc.,
+# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+if $0 == __FILE__
+	puts "Nothing to see here..."
+	puts "Did you meant to run plugins_tests.rb?"
+	exit 1
+end
+
+require File.expand_path( File.dirname( __FILE__ ) + "/../utils/htmlentities" )
+require "test/unit"
+
+class PluginTests < Test::Unit::TestCase
+
+	def self.build_suite( plugin, cases )
+		@@tmp_plugin = plugin
+		@@tmp_cases = cases
+		eval(
+			"class #{plugin.class.name}Tests < PluginTests\n" + \
+				"@@plugin = @@tmp_plugin\n" + \
+				"@@cases = @@tmp_cases\n" + \
+				"def self.plugin()\n" + \
+					"return @@plugin\n" + \
+				"end\n" + \
+				"def self.cases()\n" + \
+					"return @@cases\n" + \
+				"end\n" + \
+			"end"
+		)
+		return eval( "#{plugin.class.name}Tests.suite()" )
+	end
+
+	def plugin()
+		return self.class.plugin()
+	end
+
+	def cases()
+		return self.class.cases()
+	end
+
+	def lyrics_test_data()
+		test_data = plugin().lyrics_test_data()
+		return test_data if ! cases() || cases().empty?
+		test_data2 = []
+		cases().each() { |index| test_data2 << test_data[index] if test_data[index] }
+		return test_data2
+	end
+
+	def suggestions_test_data()
+		test_data = plugin().suggestions_test_data()
+		return test_data if ! cases() || cases().empty?
+		test_data2 = []
+		cases().each() { |index| test_data2 << test_data[index] if test_data[index] }
+		return test_data2
+	end
+
+	def check_suggestions( suggestions, request, site_name )
+		assert_not_nil( suggestions, "No suggestions for #{request.title} by #{request.artist} returned by #{site_name}" )
+		assert( ! suggestions.empty?, "Empty suggestions list for #{request.title} by #{request.artist} returned by #{site_name}" )
+		suggestions.each() do |suggestion|
+			sugg = { "artist" => suggestion.artist, "title" => suggestion.title }
+			sugg.each() do |key, value|
+				assert_nil(
+					value.downcase().index( "lyrics" ),
+					"Suggestions for #{request.title} by #{request.artist} returned by #{site_name} contains the 'lyrics' word (#{value})"
+				)
+				assert(
+					value == HTMLEntities.decode( value ),
+					"Suggestions for #{request.title} by #{request.artist} returned by #{site_name} contains unexpected HTML entities (#{value})"
+				)
+			end
+		end
+	end
+
+	def check_response( response, request, site_name )
+		[response.artist.to_s(), response.title.to_s(), response.album.to_s()].each() do |metadata|
+			assert_nil(
+				metadata.downcase().index( "lyrics" ),
+				"Lyrics metadata for #{request.title} by #{request.artist} returned by #{site_name} contains the 'lyrics' word"
+			)
+		end
+		assert_not_nil(
+			response.lyrics,
+			"No lyrics for #{request.title} by #{request.artist} returned by #{site_name}"
+		)
+		assert(
+			! response.lyrics.strip().empty?,
+			"Empty lyrics for #{request.title} by #{request.artist} returned by #{site_name}"
+		)
+		# assert(
+		# 	response.lyrics.include?( "\n" ),
+		# 	"Lyrics for #{request.title} by #{request.artist} returned by #{site_name} don't have any line breaks"
+		# )
+		md = /<\/?(a|h[1-6]|hr|p|br|body|html|span|div|br|script|!?--) *\/?>*/i.match( response.lyrics )
+		assert_nil(
+			md,
+			"Lyrics for #{request.title} by #{request.artist} returned" + \
+			" by #{site_name} contains unexpected HTML tags: #{md ? md[1] : ""}"
+		)
+	end
+
+	def test_lyrics_direct_search()
+		puts "\nTesting #{plugin().site_name()} lyrics direct search..."
+		lyrics_test_data().each() do |request|
+			fetch_data = plugin().build_lyrics_fetch_data( request )
+			if fetch_data.url
+				puts " - searching lyrics for #{request.title} by #{request.artist}"
+				response = plugin().lyrics_direct_search( request )
+				check_response( response, request, plugin.site_name() )
+			else
+				puts " - skipping lyrics search for #{request.title} by #{request.artist} (no direct fetch data received)"
+				break
+			end
+		end
+	end
+
+	def test_lyrics_from_suggestions()
+		puts "\nTesting #{plugin().site_name()} lyrics from suggestions..."
+		suggestions_test_data().each() do |request|
+			puts " - searching suggestions for #{request.title} by #{request.artist}"
+			suggestions = plugin().suggestions( request )
+			check_suggestions( suggestions, request, plugin.site_name() )
+			puts " - searching lyrics to #{request.title} by #{request.artist} in suggestions"
+			response, suggestions = plugin().lyrics_from_suggestions( request, suggestions )
+			check_response( response, request, plugin.site_name() )
+		end
+	end
+
+	def test_lyrics_full_search()
+		puts "\nTesting #{plugin().site_name()} lyrics full search..."
+		lyrics_test_data().each() do |request|
+			puts " - searching lyrics for #{request.title} by #{request.artist}"
+			response = plugin().lyrics_full_search( request )
+			check_response( response, request, plugin.site_name() )
+		end
+	end
+
+	def test_no_lyrics_found()
+		puts "\nTesting #{plugin().site_name()} forced retrieval fail..."
+		request = Lyrics::Request.new( "Fake Artist", "Fake Title", "Fake Album" )
+		puts " - searching lyrics for #{request.title} by #{request.artist}"
+		response = plugin().lyrics_full_search( request )
+		assert_nil( response.lyrics, "Unexpected lyrics returned for #{request.title} by #{request.artist} by #{plugin.site_name()}" )
+	end
+
+end

data/lib/wiki_lyrics/tests/tests.rb

@@ -0,0 +1,74 @@
+# Copyright (C) 2007 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the
+# Free Software Foundation, Inc.,
+# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+require "test/unit/testsuite"
+require "test/unit/ui/console/testrunner"
+require "plugin_tests"
+
+$LOG_FILE = "#{ENV["HOME"]}/.wikilyrics.log"
+
+class PluginsTests
+
+	def self.find_plugins( plugin_names )
+		plugins = {}
+		Dir.new( File.expand_path( File.dirname( __FILE__ ) + "/.." ) ).each() do |filename|
+			filename = File.expand_path( File.dirname( __FILE__ ) + "/../" + filename )
+			if File.file?( filename ) && (md = /\/lyrics_([A-Za-z_0-9]*)\.rb$/.match( filename ))
+				next if plugin_names && ! plugin_names.include?( md[1] )
+				plugins[md[1]] = filename
+			end
+		end
+		return plugins
+	end
+
+	def self.load_plugins( plugins )
+		@plugins = []
+		plugins.each() do |classname, filename|
+			require( filename ? filename : File.expand_path( File.dirname( __FILE__ ) + "/../lyrics_#{classname}.rb" ) )
+			classobj = eval( classname )
+			@plugins << eval( "#{classname}.new()" )
+		end
+		@plugins.sort!() { |x,y| x.site_name() <=> y.site_name() }
+	end
+
+	def self.suite( plugin_names, cases )
+		suite = Test::Unit::TestSuite.new( "Lyrics Plugins Tests" )
+		plugin_names = plugin_names ? plugin_names.split( "," ) : nil
+		if plugin_names && plugin_names.size == 1 && cases
+			cases = cases.split( "," )
+			cases.size.times { |index| cases[index] = cases[index].to_i - 1 }
+			cases = nil if cases.empty?
+		end
+		plugins = self.load_plugins( self.find_plugins( plugin_names ) )
+		if plugins.empty?
+			puts "No valid plugin to test selected..."
+		else
+			logger = Logger.new( $LOG_FILE, 0 )
+			plugins.each() { |plugin| plugin.logger = logger }
+			plugins.each() { |plugin| suite << PluginTests.build_suite( plugin, cases ) }
+		end
+		return suite
+	end
+
+end
+
+if $0 == __FILE__
+
+	Test::Unit::UI::Console::TestRunner.run( PluginsTests.suite( ARGV[0], ARGV[1]) )
+
+end

data/lib/wiki_lyrics/utils/formdata.rb

@@ -0,0 +1,56 @@
+# Copyright (C) 2006-2008 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the
+# Free Software Foundation, Inc.,
+# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+require "cgi"
+
+module URLEncodedFormData
+
+	def URLEncodedFormData.prepare_query( params )
+		query = params.collect { |name, value| "#{name}=#{CGI.escape( value.to_s() )}" }.join( "&" )
+		header = { "Content-type" => "application/x-www-form-urlencoded" }
+		return query, header
+	end
+
+end
+
+module MultipartFormData
+
+	@@boundary = "----------nOtA5FcjrNZuZ3TMioysxHGGCO69vA5iYysdBTL2osuNwOjcCfU7uiN"
+
+	def MultipartFormData.text_param( name, value )
+		return	"Content-Disposition: form-data; name=\"#{CGI.escape(name)}\"\r\n" \
+				"\r\n" \
+				"#{value}\r\n"
+	end
+
+	def MultipartFormData.file_param( name, file, mime_type, content )
+		return	"Content-Disposition: form-data; name=\"#{CGI.escape(name)}\"; filename=\"#{file}\"\r\n" \
+				"Content-Transfer-Encoding: binary\r\n" \
+				"Content-Type: #{mime_type}\r\n" \
+				"\r\n" \
+				"#{content}\r\n"
+	end
+
+	def MultipartFormData.prepare_query( params )
+		query = params.collect { |param| "--#{@@boundary}\r\n#{param}" }.join( "" ) + "--#{@@boundary}--"
+		header = { "Content-type" => "multipart/form-data; boundary=" + @@boundary }
+		return query, header
+	end
+
+end
+

data/lib/wiki_lyrics/utils/htmlentities.rb

@@ -0,0 +1,291 @@
+# Copyright (C) 2006-2008 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the
+# Free Software Foundation, Inc.,
+# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+module HTMLEntities
+
+	def HTMLEntities.decode!( text )
+		aux1 = text.gsub!( /&([a-zA-Z]+);/ ) { (n = @@named_entities[$1]) ? [n].pack( "U" ) : $0 }
+		aux2 = text.gsub!( /&#(\d{2,4});/ ) { [$1.to_i()].pack( "U" ) }
+		aux3 = text.gsub!( /&#x([0-9a-fA-F]{2,4});/ ) { [s.to_i(16)].pack( "U" ) }
+		return (aux1||aux2||aux3) ? text : nil
+	end
+
+	def HTMLEntities.decode( text )
+		text = String.new( text )
+		HTMLEntities.decode!( text )
+		return text
+	end
+
+	@@named_entities = {
+		"quot" => 34,
+		"amp" => 38,
+		"lt" => 60,
+		"gt" => 62,
+		"OElig" => 338,
+		"oelig" => 339,
+		"Scaron" => 352,
+		"scaron" => 353,
+		"Yuml" => 376,
+		"circ" => 710,
+		"tilde" => 732,
+		"ensp" => 8194,
+		"emsp" => 8195,
+		"thinsp" => 8201,
+		"zwnj" => 8204,
+		"zwj" => 8205,
+		"lrm" => 8206,
+		"rlm" => 8207,
+		"ndash" => 8211,
+		"mdash" => 8212,
+		"lsquo" => 8216,
+		"rsquo" => 8217,
+		"sbquo" => 8218,
+		"ldquo" => 8220,
+		"rdquo" => 8221,
+		"bdquo" => 8222,
+		"dagger" => 8224,
+		"Dagger" => 8225,
+		"permil" => 8240,
+		"lsaquo" => 8249,
+		"rsaquo" => 8250,
+		"euro" => 8364,
+
+		"fnof" => 402,
+		"Alpha" => 913,
+		"Beta" => 914,
+		"Gamma" => 915,
+		"Delta" => 916,
+		"Epsilon" => 917,
+		"Zeta" => 918,
+		"Eta" => 919,
+		"Theta" => 920,
+		"Iota" => 921,
+		"Kappa" => 922,
+		"Lambda" => 923,
+		"Mu" => 924,
+		"Nu" => 925,
+		"Xi" => 926,
+		"Omicron" => 927,
+		"Pi" => 928,
+		"Rho" => 929,
+		"Sigma" => 931,
+		"Tau" => 932,
+		"Upsilon" => 933,
+		"Phi" => 934,
+		"Chi" => 935,
+		"Psi" => 936,
+		"Omega" => 937,
+		"alpha" => 945,
+		"beta" => 946,
+		"gamma" => 947,
+		"delta" => 948,
+		"epsilon" => 949,
+		"zeta" => 950,
+		"eta" => 951,
+		"theta" => 952,
+		"iota" => 953,
+		"kappa" => 954,
+		"lambda" => 955,
+		"mu" => 956,
+		"nu" => 957,
+		"xi" => 958,
+		"omicron" => 959,
+		"pi" => 960,
+		"rho" => 961,
+		"sigmaf" => 962,
+		"sigma" => 963,
+		"tau" => 964,
+		"upsilon" => 965,
+		"phi" => 966,
+		"chi" => 967,
+		"psi" => 968,
+		"omega" => 969,
+		"thetasym" => 977,
+		"upsih" => 978,
+		"piv" => 982,
+		"bull" => 8226,
+		"hellip" => 8230,
+		"prime" => 8242,
+		"Prime" => 8243,
+		"oline" => 8254,
+		"frasl" => 8260,
+		"weierp" => 8472,
+		"image" => 8465,
+		"real" => 8476,
+		"trade" => 8482,
+		"alefsym" => 8501,
+		"larr" => 8592,
+		"uarr" => 8593,
+		"rarr" => 8594,
+		"darr" => 8595,
+		"harr" => 8596,
+		"crarr" => 8629,
+		"lArr" => 8656,
+		"uArr" => 8657,
+		"rArr" => 8658,
+		"dArr" => 8659,
+		"hArr" => 8660,
+		"forall" => 8704,
+		"part" => 8706,
+		"exist" => 8707,
+		"empty" => 8709,
+		"nabla" => 8711,
+		"isin" => 8712,
+		"notin" => 8713,
+		"ni" => 8715,
+		"prod" => 8719,
+		"sum" => 8721,
+		"minus" => 8722,
+		"lowast" => 8727,
+		"radic" => 8730,
+		"prop" => 8733,
+		"infin" => 8734,
+		"ang" => 8736,
+		"and" => 8743,
+		"or" => 8744,
+		"cap" => 8745,
+		"cup" => 8746,
+		"int" => 8747,
+		"there4" => 8756,
+		"sim" => 8764,
+		"cong" => 8773,
+		"asymp" => 8776,
+		"ne" => 8800,
+		"equiv" => 8801,
+		"le" => 8804,
+		"ge" => 8805,
+		"sub" => 8834,
+		"sup" => 8835,
+		"nsub" => 8836,
+		"sube" => 8838,
+		"supe" => 8839,
+		"oplus" => 8853,
+		"otimes" => 8855,
+		"perp" => 8869,
+		"sdot" => 8901,
+		"lceil" => 8968,
+		"rceil" => 8969,
+		"lfloor" => 8970,
+		"rfloor" => 8971,
+		"lang" => 9001,
+		"rang" => 9002,
+		"loz" => 9674,
+		"spades" => 9824,
+		"clubs" => 9827,
+		"hearts" => 9829,
+		"diams" => 9830,
+
+		"nbsp" => 160,
+		"iexcl" => 161,
+		"cent" => 162,
+		"pound" => 163,
+		"curren" => 164,
+		"yen" => 165,
+		"brvbar" => 166,
+		"sect" => 167,
+		"uml" => 168,
+		"copy" => 169,
+		"ordf" => 170,
+		"laquo" => 171,
+		"not" => 172,
+		"shy" => 173,
+		"reg" => 174,
+		"macr" => 175,
+		"deg" => 176,
+		"plusmn" => 177,
+		"sup2" => 178,
+		"sup3" => 179,
+		"acute" => 180,
+		"micro" => 181,
+		"para" => 182,
+		"middot" => 183,
+		"cedil" => 184,
+		"sup1" => 185,
+		"ordm" => 186,
+		"raquo" => 187,
+		"frac14" => 188,
+		"frac12" => 189,
+		"frac34" => 190,
+		"iquest" => 191,
+		"Agrave" => 192,
+		"Aacute" => 193,
+		"Acirc" => 194,
+		"Atilde" => 195,
+		"Auml" => 196,
+		"Aring" => 197,
+		"AElig" => 198,
+		"Ccedil" => 199,
+		"Egrave" => 200,
+		"Eacute" => 201,
+		"Ecirc" => 202,
+		"Euml" => 203,
+		"Igrave" => 204,
+		"Iacute" => 205,
+		"Icirc" => 206,
+		"Iuml" => 207,
+		"ETH" => 208,
+		"Ntilde" => 209,
+		"Ograve" => 210,
+		"Oacute" => 211,
+		"Ocirc" => 212,
+		"Otilde" => 213,
+		"Ouml" => 214,
+		"times" => 215,
+		"Oslash" => 216,
+		"Ugrave" => 217,
+		"Uacute" => 218,
+		"Ucirc" => 219,
+		"Uuml" => 220,
+		"Yacute" => 221,
+		"THORN" => 222,
+		"szlig" => 223,
+		"agrave" => 224,
+		"aacute" => 225,
+		"acirc" => 226,
+		"atilde" => 227,
+		"auml" => 228,
+		"aring" => 229,
+		"aelig" => 230,
+		"ccedil" => 231,
+		"egrave" => 232,
+		"eacute" => 233,
+		"ecirc" => 234,
+		"euml" => 235,
+		"igrave" => 236,
+		"iacute" => 237,
+		"icirc" => 238,
+		"iuml" => 239,
+		"eth" => 240,
+		"ntilde" => 241,
+		"ograve" => 242,
+		"oacute" => 243,
+		"ocirc" => 244,
+		"otilde" => 245,
+		"ouml" => 246,
+		"divide" => 247,
+		"oslash" => 248,
+		"ugrave" => 249,
+		"uacute" => 250,
+		"ucirc" => 251,
+		"uuml" => 252,
+		"yacute" => 253,
+		"thorn" => 254,
+		"yuml" => 255,
+	}
+
+end