aef-launchy-opensearch 1.2.1

data/History.txt

@@ -0,0 +1,43 @@
+=== 1.2.1 / 2009-04-05
+
+* 1 minor bugfix
+
+  * Loading path problem fixed
+
+=== 1.2.0 / 2009-04-05
+
+* 1 major enhancement
+
+  * Namespaced into module Aef
+
+* 5 minor enhancements
+
+  * Better metadata for gem
+  * Test refactoring
+  * Minor refactorings
+  * Improved documentation
+  * Added test for --version command
+  * Renamed gem and executable from launchy_opensearch to launchy-opensearch
+
+* 1 minor bugfix
+
+  * Fixed some bugs related to Ruby 1.8.6
+
+=== 1.1.0 / 2009-03-08
+
+* 1 major enhancements
+
+  * Better commandline outputs
+  * Now compatibile with ruby 1.9.1
+
+* 3 minor enhancement
+
+  * Added a --version command to output version and licensing information
+  * Added automated tests
+  * Some more comments
+
+=== 1.0.0 / 2009-02-24
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+COPYING.txt
+Rakefile
+bin/launchy-opensearch
+lib/launchy_opensearch.rb
+lib/launchy_opensearch/launchy_opensearch.rb
+spec/launchy_opensearch_spec.rb
+spec/fixtures/launchy.ini
+spec/fixtures/discogs.xml
+spec/fixtures/secure-wikipedia-english.xml
+spec/fixtures/youtube.xml

data/README.rdoc

@@ -0,0 +1,164 @@
+= LaunchyOpenSearch
+
+* Project: https://rubyforge.org/projects/aef/
+* RDoc: http://aef.rubyforge.org/launchy-opensearch/
+* Github: http://github.com/aef/launchy-opensearch/
+
+== DESCRIPTION:
+
+LaunchyOpenSearch is a Ruby library and commandline tool that allows to parse
+OpenSearch XML files and include them as search engines in the Weby plugin of
+the keystroke app launcher Launchy by editing Launchy's ini config file.
+
+== FEATURES/PROBLEMS:
+
+* Usable as library and commandline tool
+* Tested and fully working on:
+  * Ubuntu Linux 8.10 i386_64 (Ruby 1.8.7 and 1.9.1p0)
+  * Debian GNU/Linux 4.0 i386 (Ruby 1.8.6)
+  * Windows XP i386 (Ruby 1.8.6)
+* The commandline tool doesn't work with Ruby 1.9.x because the user-choices gem
+  is not yet updated. A patch is available here:
+  https://rubyforge.org/tracker/index.php?func=detail&aid=24307&group_id=4192&atid=16176
+
+== SYNOPSIS:
+
+=== Commandline
+
+Launchy should be closed while using OpenSearchLaunchy
+
+  launchy-opensearch youtube.xml
+
+=== Library
+
+Notice that the library is written with an underscore instead of the dash used
+in the gem's and commandline tool's name
+
+  require 'launchy_opensearch'
+
+Determine launchy ini path
+
+  config_path = Aef::LaunchyOpenSearch.launchy_config_path
+
+Parse an OpenSearch engine into a variable
+
+  new_engine = Aef::LaunchyOpenSearch.parse_opensearch_file('youtube.xml')
+
+Read the launchy ini file into a variable
+
+  config = Aef::LaunchyOpenSearch.read_config_hash(config_path)
+
+Extract hash with current search engines
+
+  current_engines = Aef::LaunchyOpenSearch.extract_config_hash(config)
+
+Add new engine to the engines hash
+
+  new_engines = current_engines + new_engine
+
+Patch the engines hash into the config hash
+
+  Aef::LaunchyOpenSearch.patch_config_hash(config, new_engines)
+
+Write the config hash as ini back to the disk
+
+  Aef::LaunchyOpenSearch.write_config_hash(config, config_path)
+
+== REQUIREMENTS:
+
+* rubygems
+* hpricot
+* facets
+* sys-uname
+
+=== Additional for commandline
+* user-choices
+
+=== Additional for automated testing
+* rspec
+
+== INSTALL:
+
+=== Normal
+
+  gem install launchy-opensearch
+
+Additionally for the commandline tool:
+
+  gem install user-choices
+
+=== High security (recommended)
+
+There is a high security installation option available through rubygems. It is
+highly recommended over the normal installation, although it may be a bit less
+comfortable. To use the installation method, you will need my public key, which
+I use for cryptographic signatures on all my gems. You can find the public key
+and more detailed verification information in the aef-certificates section of my
+rubyforge project[https://rubyforge.org/frs/?group_id=7890&release_id=31749]
+
+Add the key to your rubygems' trusted certificates by the following command:
+
+  gem cert --add aef.pem
+
+Now you can install the gem while automatically verifying it's signature by the
+following command:
+
+  gem install launchy-opensearch --ignore-dependencies -P HighSecurity
+
+Please notice that you will need other keys for dependent libraries, so you may
+have to install dependencies manually.
+
+=== Automated testing
+
+You can test this package through rspec on your system. First find the path
+where the gem was installed to:
+
+  gem which launchy-opensearch
+
+Go into the root directory of the installed gem and run the following command
+to start the test runner:
+
+  rake spec
+
+On Windows systems you have to run the following instead:
+
+  spec spec/**/*_spec.rb
+
+If something goes wrong you should be noticed through failing examples.
+
+== DEVELOPMENT:
+
+This software is developed in the source code management system git hosted
+at github.com. You can download the most recent sourcecode through the following
+command:
+
+  git clone git://github.com/aef/launchy-opensearch.git
+
+Help on making this software better is always very appreciated. If you want your
+changes to be included in the official release, please send me a patch through
+the project's tracker[https://rubyforge.org/tracker/?group_id=7890] at
+rubyforge.org. You can generate a patch-file by the following command:
+
+  git diff > patch.diff
+
+Please make sure to write tests for your changes and notice that I can't promise
+to include your changes before reviewing them.
+
+== LICENSE:
+
+Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+
+This file is part of LaunchyOpenSearch.
+
+LaunchyOpenSearch 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 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/launchy_opensearch.rb'
+
+Hoe.new('launchy-opensearch', Aef::LaunchyOpenSearch::VERSION) do |p|
+  p.rubyforge_name = 'aef'
+  p.developer('Alexander E. Fischer', 'aef@raxys.net')
+  p.extra_deps = %w{facets hpricot sys-uname}
+  p.extra_dev_deps = %w{user-choices}
+  p.url = 'https://rubyforge.org/projects/aef/'
+  p.readme_file = 'README.rdoc'
+  p.extra_rdoc_files = %w{README.rdoc}
+  p.spec_extras = {
+    :rdoc_options => ['--main', 'README.rdoc', '--inline-source', '--line-numbers', '--title', 'LaunchyOpenSearch']
+  }
+end
+
+# vim: syntax=Ruby

data/bin/launchy-opensearch

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of LaunchyOpenSearch.
+#
+# LaunchyOpenSearch 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# TODO: If user-choices patch gets accepted, use :one_way => true for --version
+
+# If library is not locally accessible, use gem to include it.
+begin
+  require 'lib/launchy_opensearch'
+rescue LoadError
+  require 'rubygems'
+  require 'launchy_opensearch'
+end
+
+# User friendly message if user-choices is not available
+begin
+  require 'user-choices'
+rescue LoadError
+  warn "This command needs the user-choices gem to be installed.\n\nSolution: gem install user-choices"; exit false
+end
+
+class Aef::LaunchyOpenSearch::Application < UserChoices::Command
+  include UserChoices
+
+  MODES = %w{append replace}
+
+  # Prepare configuration sources
+  def add_sources(builder)
+    builder.add_source(
+      CommandLineSource, :usage,
+      "Usage: #$PROGRAM_NAME [options] opensearch-files\n\n",
+      "Import OpenSearch XML files into the Weby plugin of the keystroke application launcher Launchy\n"
+    )
+  end
+  
+  # Define configuration options
+  def add_choices(builder)
+    builder.add_choice(:config_path, :default => Aef::LaunchyOpenSearch.launchy_config_path) do |cli|
+      cli.uses_option('-c', '--config FILE',
+        'Launchy ini file to modify. Uses the current user\'s config file by default.')
+    end
+
+    builder.add_choice(:mode, :default => MODES.first, :type => MODES ) do |cli|
+      cli.uses_option('-m', '--mode MODE',
+        "Insert mode. Possible settings: #{MODES.join(', ')}. Default is #{MODES.first}.")
+    end
+
+    builder.add_choice(:version, :default => false, :type => :boolean) do |cli|
+      cli.uses_switch('-v', '--version', 'Display version and licensing information')
+    end
+
+    builder.add_choice(:filenames) {|cli| cli.uses_arglist }
+  end
+
+  # Manual option post processing
+  def postprocess_user_choices
+    version if @user_choices[:version]
+  end
+
+  # Version and licensing information output
+  def version
+    name = 'LaunchyOpenSearch'
+    puts "#{name} #{Aef::LaunchyOpenSearch::VERSION}"
+    puts
+    puts 'Project: https://rubyforge.org/projects/aef/'
+    puts "RDoc: http://aef.rubyforge.org/launchy-opensearch/"
+    puts "Github: http://github.com/aef/launchy-opensearch/"
+    puts
+    puts 'Copyright 2009 Alexander E. Fischer <aef@raxys.net>'
+    # Read and print licensing information from the top of this file
+    if Gem::Version.new(RUBY_VERSION) <= Gem::Version.new('1.8.6')
+      puts File.read(__FILE__).map{|line| line[2..-1]}[5..17]
+    else
+      puts File.read(__FILE__).lines.map{|line| line[2..-1]}[5..17]
+    end
+    exit
+  end
+
+  # Main program
+  def execute
+    if @user_choices[:filenames].empty?
+      warn 'No OpenSearch files specified'; exit false
+    end
+
+    @user_choices[:filenames].each do |filename|
+      warn "Ignoring #{filename}. Not readable or missing." unless File.readable?(filename)
+    end
+
+    new_engines = Aef::LaunchyOpenSearch.parse_opensearch_files(@user_choices[:filenames])
+    count = new_engines.size
+    config = Aef::LaunchyOpenSearch.read_config_hash(@user_choices[:config_path])
+
+    if @user_choices[:mode] == 'append'
+      current_engines = Aef::LaunchyOpenSearch.extract_config_hash(config)
+      new_engines = current_engines + new_engines
+    end
+
+    Aef::LaunchyOpenSearch.patch_config_hash(config, new_engines)
+    Aef::LaunchyOpenSearch.write_config_hash(config, @user_choices[:config_path])
+
+    puts "#{count} search engines installed."
+  end
+end
+
+S4tUtils.with_pleasant_exceptions {Aef::LaunchyOpenSearch::Application.new.execute}

data/lib/launchy_opensearch.rb

@@ -0,0 +1,30 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of LaunchyOpenSearch.
+#
+# LaunchyOpenSearch 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Namespace for projects of Alexander E. Fischer <aef@raxys.net>
+#
+# If you want to be able to simply type Example instead of Aef::Example to
+# address classes in this namespace simply write the following before using the
+# classes:
+#
+#  include Aef
+module Aef
+
+end
+
+libdir = File.dirname(__FILE__)
+require File.join(libdir, 'launchy_opensearch/launchy_opensearch')

data/lib/launchy_opensearch/launchy_opensearch.rb

@@ -0,0 +1,167 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of LaunchyOpenSearch.
+#
+# LaunchyOpenSearch 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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'tempfile'
+require 'uri'
+
+require 'rubygems'
+require 'hpricot'
+require 'facets/ini'
+require 'sys/uname'
+
+# Offers static methods for all steps in parsing usefull information out of the
+# OpenSearch XML format and modifying the configuration of Launchy's Weby plugin
+module Aef::LaunchyOpenSearch
+
+  VERSION = '1.2.1'
+
+  # Determines the location of Launchy's configuration Ini file on different
+  # platforms
+  def self.launchy_config_path
+    if Sys::Uname.sysname.downcase.include?("windows")
+      File.join(ENV['APPDATA'], 'Launchy', 'Launchy.ini')
+    else
+      File.join(ENV['HOME'], '.launchy', 'launchy.ini')
+    end
+  end
+
+  # Parses an OpenSearch XML document
+  #
+  # Returns a Hash with the keys :name, :base, :query and :default
+  def self.parse_opensearch(content)
+    opensearch = Hpricot.XML(content)
+
+    uri = URI.parse(opensearch.at('os:Url').get_attribute('template').gsub(/\{searchTerms\}/, ':PLACEHOLDER'))
+
+    {
+      :name => opensearch.at('os:ShortName').inner_html,
+      :base => "#{uri.scheme}://#{uri.host}/",
+      :query => "\"#{uri.path[1..-1]}?#{uri.query}\"".gsub(/:PLACEHOLDER/, '%s'),
+      :default => 'false'
+    }
+  end
+
+  # Reads and parses a single OpenSearch file from the filesystem.
+  #
+  # Returns a Hash with the keys :name, :base, :query and :default
+  def self.parse_opensearch_file(file)
+    if file.is_a?(String)
+      content = File.read(file)
+    elsif file.respond_to?(:read)
+      content = file.read
+    else
+      raise "Expected file path as string or an object responding to read. Got #{file.class.name}"
+    end
+    
+    parse_opensearch(content)
+  end
+
+  # Reads multiple OpenSearch files from filesystem
+  #
+  # Returns an Array of Hashes with the keys :name, :base, :query and :default
+  def self.parse_opensearch_files(file_list)
+    engines = []
+    file_list.each do |file|
+      if File.readable?(file)
+        engines << parse_opensearch_file(file)
+      end
+    end
+    engines
+  end
+
+  # Reads an Ini file from filesystem into a launchy config hash.
+  def self.read_config_hash(path)
+    # Ini class doesn't like empty lines and can only read from files.
+    original = File.read(path)
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9')
+      cleaned = original.lines.map{|line| line.chomp.squeeze(' ')}.reject{|line| line == ''}.join("\n")
+    else
+      cleaned = original.map{|line| line.chomp.squeeze(' ')}.reject{|line| line == ''}.join("\n")
+    end
+
+    temp_file = Tempfile.open('launchy')
+    temp_file.write(cleaned)
+    temp_file.close
+
+    config = Ini.read_from_file(temp_file.path)
+
+    temp_file.unlink
+
+    config
+  end
+
+  # Reads relevant parts out of the weby section of a launchy config hash.
+  #
+  # Returns an Array of Hashes with the keys :name, :base, :query and :default
+  def self.extract_config_hash(config_hash)
+    engines = {}
+    config_hash['weby'].each do |entry, value|
+      entry.match(/^sites\\([0-9]{1,2})\\(.*)$/)
+      if $1 and $2
+        engines[$1.to_i] ||= {}
+        engines[$1.to_i][$2.to_sym] = value
+      end
+    end
+    
+    engines_array = []
+    engines.sort.each do |key, content|
+      engines_array << content
+    end
+    engines_array
+  end
+
+  # Replaces the site entries of the Weby section of a launchy config hash with
+  # an engines array as returned by extract_config_hash
+  #
+  # Attention: This method modifies the config hash given as argument. It is
+  # returned as result only for convenience.
+  def self.patch_config_hash(config_hash, engines)
+    new_section = {}
+    config_hash['weby'].each do |entry, value|
+      unless entry.match(/^sites\\/)
+        new_section[entry] = value
+      end
+    end
+    engines.each_with_index do |settings, i|
+      settings.each {|key, value|
+        new_section["sites\\#{i + 1}\\#{key}"] = value
+      }
+    end
+    new_section['sites\\size'] = engines.size.to_s
+    config_hash['weby'] = new_section
+    config_hash
+  end
+
+  # Writes a launchy config hash back to filesystem in INI format
+  def self.write_config_hash(config_hash, path)
+    if File.exists?(path) and File.readable?(path) and File.file?(path)
+      original = File.read(path)
+
+      File.open("#{path}.bak", 'w') do |f|
+        f.write(original)
+      end
+    end
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9')
+      # Facets ini parser doesn't seems to use the .lines enumerator yet
+      Ini.write_to_file(path, config_hash)
+    else
+      Ini.write_to_file(path, config_hash, "Written by LaunchyOpenSearch #{Time.now}\n")
+    end
+  end
+end