lyrics 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David A. Cuadrado
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= lyrics
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 David A. Cuadrado. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lyrics"
+    gem.summary = %Q{lib and cli to fetch lyrics}
+    gem.description = %Q{lib and cli to fetch lyrics}
+    gem.email = "krawek@gmail.com"
+    gem.homepage = "http://github.com/dcu/lyrics"
+    gem.authors = ["David A. Cuadrado"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+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 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/lyrics

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+# 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.
+
+$:.unshift File.dirname(__FILE__)+"/../lib"
+
+require "lyrics"
+
+options = OptionsParser.parse( ARGV )
+
+HTTP.set_proxy_settings( options.proxy ) if options.proxy
+
+app = Application.new(
+  :featuring_fix => options.feat_fix,
+  :sites => options.sites,
+  :cleanup_lyrics => options.cleanup,
+  :submit => options.submit,
+  :review => options.review,
+  :prompt_autogen => options.prompt_autogen,
+  :prompt_no_lyrics => options.prompt_no_lyrics,
+  :username => options.username,
+  :password => options.password
+)
+
+begin
+  app.restore_session( options.session_file ) if options.session_file
+
+  if options.batch_file
+    notify( I18n.get( "cli.application.batchmode" ) )
+    file = File.new( options.batch_file, "r" )
+    count = 0
+    while ( line = file.gets )
+      params = line.split( ";" )
+      next if params.length < 2
+      app.process( params[0], params[1], params[2], params[3] )
+      count += 1
+    end
+    notify( I18n.get( "cli.application.processedcount", count ) )
+    file.close()
+  else
+    app.process( options.artist, options.title, options.album, options.year )
+  end
+
+  app.save_session( options.session_file ) if options.session_file
+
+ensure
+
+  app.finalize()
+
+end

data/lib/lyrics.rb

@@ -0,0 +1,4 @@
+$:.unshift File.dirname(__FILE__)+"/../lib/lyrics"
+
+require 'lyrics/lyrics'
+require 'cli/application'

data/lib/lyrics/cli/application.rb

@@ -0,0 +1,99 @@
+require "i18n/i18n"
+require "utils/strings"
+require "utils/logger"
+require "cli/optionsparser"
+require "cli/plugins"
+
+class Application
+  def initialize(options = {})
+    Plugins.load_plugins( options[:sites] || Plugins.find_plugins() )
+
+    @featuring_fix = options[:featuring_fix] || true
+    @submit_plugin = nil
+    @logger = Logger.new( "#{ENV["HOME"]}/.wikilyrics.log" )
+    Plugins.all_plugins().each() do |plugin|
+      plugin.cleanup_lyrics = options[:cleanup_lyrics] || true
+      plugin.logger = @logger
+      if plugin.plugin_name() == options[:submit]
+        @submit_plugin = plugin
+        @submit_plugin.set_submit_settings( options[:username],
+                                            options[:password],
+                                            options[:review] || true,
+                                            options[:prompt_autogen] || false,
+                                            options[:prompt_no_lyrics] || false)
+      end
+    end
+  end
+
+  def finalize()
+    @logger.finalize() if @logger
+  end
+
+  def Application.notify( message )
+    $stderr.puts "Wiki-Lyrics: " + message.gsub( /\/?<[^>]+>/, "" )
+  end
+
+  def notify( message )
+    self.class.notify( message )
+  end
+
+  def restore_session( session_file )
+    @submit_plugin.restore_session( session_file ) if @submit_plugin
+  end
+
+  def save_session( session_file )
+    @submit_plugin.save_session( session_file ) if @submit_plugin
+  end
+
+  def fetch_lyrics( request )
+
+    used_plugins = Plugins.all_plugins()
+
+    response = nil
+    response_plugin = nil
+    submit_plugin_searched = false
+
+    used_plugins.each() do |plugin|
+      begin
+        submit_plugin_searched = true if plugin == @submit_plugin
+        response = plugin.lyrics_full_search( request )
+        if response.lyrics
+          response_plugin = plugin
+          break
+        end
+      rescue TimeoutError
+        notify( I18n.get( "cli.application.plugintimeout", plugin.plugin_name(), plugin.site_host() ) )
+      end
+    end
+
+    return response, response_plugin
+
+  end
+
+  def fetch(artist, title, album = nil, year = nil)
+    if @featuring_fix
+      artist = Strings.cleanup_artist( artist, title )
+      title  = Strings.cleanup_title( title )
+    end
+
+    request = Lyrics::Request.new( artist, title, album, year )
+    response, response_plugin = fetch_lyrics( request )
+    response
+  end
+
+  def process( artist, title, album, year )
+    notify( I18n.get( "cli.application.searchinglyrics", title, artist ) )
+
+    response = fetch(artist, title, album, year)
+
+    if response.lyrics
+      artist = response.artist ? response.artist : response.request.artist
+      title = response.title ? response.title : response.request.title
+      puts "\n#{response.lyrics}\n\n"
+    else
+      notify( I18n.get( "cli.application.nolyricsfound", request.title, request.artist ) )
+    end
+
+  end
+
+end

data/lib/lyrics/cli/optionsparser.rb

@@ -0,0 +1,228 @@
+# 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 File.expand_path( File.dirname( __FILE__ ) + "/../i18n/i18n" )
+require File.expand_path( File.dirname( __FILE__ ) + "/plugins" )
+require File.expand_path( File.dirname( __FILE__ ) + "/../mediawikilyrics" )
+
+require "optparse"
+require "ostruct"
+require "uri"
+
+WIKILYRICS_VERSION = "Wiki-Lyrics v#{MediaWikiLyrics.version()}"
+TOOLKITS_DEFAULT = ["qt3", "qt4", "gtk", "tk"]
+
+module OptionsParser
+
+	@@max_chunksize = 80
+	begin
+		require "curses"
+		@@max_chunksize = Curses::Window.new( 0, 0, 0, 0 ).maxx() - 38
+		Curses::close_screen()
+	rescue Exception
+		@@max_chunksize = 80
+	end
+
+	def self.get_text_chunk( text, start_idx )
+
+		# find first non empty character in chunk:
+		while ( start_idx < (text.size-1) && "\n ".index( text[start_idx] ) )
+			start_idx += 1
+		end
+
+		# no more chunks left
+		return nil if start_idx >= text.size
+
+		# buscar el ultimo " " o el primer "\n "
+		end_idx = nil
+		idx = start_idx
+		while ( idx < text.size && idx < start_idx + @@max_chunksize + 1 )
+			if text[idx] == "\n"[0]
+				end_idx = idx
+				break
+			elsif text[idx] == " "[0]
+				end_idx = idx
+			end
+			idx += 1
+		end
+		end_idx = idx if ! end_idx || idx == text.size
+		return text.slice( start_idx..end_idx-1 ), end_idx
+
+	end
+
+	def self.split( text )
+		ret = []
+		start_idx = 0
+		while ( (chunk, start_idx = get_text_chunk( text, start_idx )) && chunk != nil )
+			ret << chunk
+		end
+		return ret
+	end
+
+	def self.parse( args )
+
+		opts = OpenStruct.new()
+		opts.cleanup = true
+		opts.feat_fix = true
+		opts.meta = true
+		opts.sites = ["Lyriki", "LyricWiki"]
+		opts.submit = nil
+		opts.review = true
+		opts.prompt_autogen = false
+		opts.prompt_no_lyrics = false
+		opts.proxy = nil
+		opts.toolkits = TOOLKITS_DEFAULT
+
+		parser = OptionParser.new() do |parser|
+			parser.banner = I18n.get( "cli.usage", "wikilyrics.rb" )
+ 			parser.separator I18n.get( "cli.description" )
+
+			parser.separator ""
+			parser.separator I18n.get( "cli.options" )
+			parser.on( "-a", "--artist [ARTIST]", *split( I18n.get( "cli.options.artist", "batch-file" ) ) ) do |artist|
+				opts.artist = artist
+			end
+			parser.on( "-t", "--title [TITLE]", *split( I18n.get( "cli.options.title", "batch-file" ) ) ) do |title|
+				opts.title = title
+			end
+			parser.on( "-l", "--album [ALBUM]", *split( I18n.get( "cli.options.album" ) ) ) { |album| opts.album = album }
+			parser.on( "-y", "--year [YEAR]", *split( I18n.get( "cli.options.year" ) ) ) { |year| opts.year = year }
+			parser.on( "-f", "--[no-]featfix", *split( I18n.get( "cli.options.featfix", I18n.get( "cli.values.true" ) ) ) ) do |feat_fix|
+				opts.feat_fix = feat_fix
+			end
+
+			parser.separator ""
+			parser.on( "-b", "--batch-file [FILE]", *split( I18n.get( "cli.options.batchfile" ) ) ) do |batch_file|
+				opts.batch_file = batch_file
+			end
+
+			parser.separator ""
+			parser.on( "-c", "--[no-]cleanup", *split( I18n.get( "cli.options.cleanup", I18n.get( "cli.values.true" ) ) ) ) do |cleanup|
+				opts.cleanup = cleanup
+			end
+			parser.separator ""
+			parser.on( "--sites [SITE1,SITE2...]", Array, *split( I18n.get( "cli.options.sites", opts.sites.join( "," ), "sites-list" ) ) ) { |sites| opts.sites = sites }
+			parser.on( "--sites-list", *split( I18n.get( "cli.options.sites.list" ) ) ) do
+				puts I18n.get( "cli.options.sites.list.available" )
+				Plugins.load_plugins( Plugins.find_plugins() )
+				plugins = Plugins.all_plugins().sort { |a,b| a.class.name <=> b.class.name }
+				plugins.each() { |plugin| puts " - #{plugin.class.name.slice(12..-1)} (#{plugin.site_host})" }
+				exit
+			end
+
+			parser.separator ""
+			parser.on( "-s", "--submit [Lyriki|LyricWiki]", *split( I18n.get( "cli.options.submit", "username", "password" ) ) ) do |submit|
+				opts.submit = submit
+			end
+			parser.on( "-u", "--username [USERNAME]", *split( I18n.get( "cli.options.username", "submit" ) ) ) do |username|
+				opts.username = username
+			end
+			parser.on( "-p", "--password [PASSWORD]", *split( I18n.get( "cli.options.password", "submit" ) ) ) do |password|
+				opts.password = password
+			end
+			parser.on( "--persist [SESSIONFILE]", *split( I18n.get( "cli.options.persist", "username", "password" ) ) ) do |file|
+				opts.session_file = file
+			end
+
+			parser.on( "-r", "--[no-]review", *split( I18n.get( "cli.options.prompt.review", I18n.get( "cli.values.true" ), "submit" ) ) ) { |review| opts.review = review }
+			parser.on( "-g", "--[no-]autogen", *split( I18n.get( "cli.options.prompt.autogen", I18n.get( "cli.values.false" ), "review" ) ) ) { |autogen| opts.prompt_autogen = autogen }
+			parser.on( "-n", "--[no-]new", *split( I18n.get( "cli.options.prompt.nolyrics", I18n.get( "cli.values.false" ), "review" ) ) ) { |prompt_no_lyrics| opts.prompt_no_lyrics = prompt_no_lyrics }
+
+			parser.separator ""
+			parser.on( "-x", "--proxy [PROXY]", *split( I18n.get( "cli.options.proxy" ) ) ) { |proxy| opts.proxy = proxy }
+
+			parser.separator ""
+			parser.on( "-k", "--toolkits [TK1,TK2...]", Array, *split( I18n.get( "cli.options.toolkits", TOOLKITS_DEFAULT.join( "," ) ) ) ) { |toolkits| opts.toolkits = toolkits ? toolkits : [] }
+
+			parser.separator ""
+			parser.on_tail( "-h", "--help", *split( I18n.get( "cli.options.help" ) ) ) { puts parser; exit }
+			parser.on_tail( "-v", "--version", *split( I18n.get( "cli.options.version" ) ) ) { puts "#{WIKILYRICS_VERSION}"; exit }
+		end
+
+		begin
+
+			parser.parse!( args )
+
+			raise ArgumentError, I18n.get( "cli.error.missingoption", "--artist" ) if ! opts.artist && ! opts.batch_file
+			raise ArgumentError, I18n.get( "cli.error.missingoption", "--title" ) if ! opts.title && ! opts.batch_file
+
+			raise ArgumentError, I18n.get( "cli.error.missingoption", "--username" ) if opts.submit && ! opts.username
+			raise ArgumentError, I18n.get( "cli.error.missingoption", "--password" ) if opts.submit && ! opts.password
+
+			if opts.batch_file && (opts.artist || opts.title || opts.album || opts.year)
+				raise ArgumentError, I18n.get( "cli.error.incompatibleoptions", "-b", "-a/-t/-l/-y" )
+			end
+
+			if opts.prompt_autogen && ( ! opts.submit || ! opts.review )
+				raise ArgumentError, I18n.get( "cli.error.missingdependency", "-g", "-r" )
+			end
+
+			if opts.prompt_no_lyrics && ( ! opts.submit || ! opts.review )
+				raise ArgumentError, I18n.get( "cli.error.missingdependency", "-n", "-r" )
+			end
+
+			opts.toolkits.each() do |toolkit|
+				if ! TOOLKITS_DEFAULT.include?( toolkit )
+					raise ArgumentError, I18n.get( "cli.error.invalidoptionvalue", "toolkit", toolkit )
+				end
+			end
+
+ 			if opts.submit && opts.review && opts.toolkits.empty?
+				raise ArgumentError, I18n.get( "cli.error.notoolkit" )
+			end
+
+			if opts.submit
+				if ! ["Lyriki","LyrikiLocal","LyricWiki"].include?( opts.submit )
+					raise ArgumentError, I18n.get( "cli.error.invalidoptionvalue", "submit", opts.submit )
+				end
+				opts.sites = [] if ! opts.sites
+				opts.sites << opts.submit
+			end
+
+			if ! opts.sites || opts.sites.empty?
+				raise ArgumentError, I18n.get( "cli.error.nosite" )
+			else
+				found_plugins = Plugins.find_plugins()
+				opts.sites.uniq!()
+				opts.sites.each() do |site|
+					if ! found_plugins.include?( site )
+						raise ArgumentError, I18n.get( "cli.error.invalidoptionvalue", "site", site )
+					end
+				end
+			end
+
+			if opts.proxy
+				begin
+					# TODO is this correct?
+					opts.proxy = nil if URI.parse( opts.proxy ).to_s() != ""
+				rescue Exception
+					raise ArgumentError, I18n.get( "cli.error.invalidoptionvalue", "proxy", opts.proxy )
+				end
+			end
+
+			return opts
+
+		rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption, ArgumentError => ex
+			puts ex.is_a?( ArgumentError ) ? "error: #{ex}" : ex
+			puts parser
+			exit 1
+		end
+
+	end
+
+end