opensearch 0.0.1

data/CHANGES

@@ -0,0 +1,6 @@
+= OpenSearch Changelog
+
+== Version 0.0.1
+initial release
+
+* initial release

data/README

@@ -0,0 +1,31 @@
+= OpenSearch
+
+Ruby/OpenSearch - Search A9 OpenSearch compatible engines
+
+OpenSearch is simple format of sharing of search results by A9. See http://opensearch.a9.com/ for detail.
+
+This library is for OpenSearch version 1.0 or 1.1
+
+== Usage
+
+ require 'rubygems'
+ require 'opensearch'
+
+ # initialize
+ engine = OpenSearch::OpenSearch.new "http://search.hatena.ne.jp/osxml"
+
+ # get information of  Description Document 
+ name = engine.short_name 
+ tags = engine.tags
+
+ # search (retrun value is RSS::Rss)
+ feed = engine.search("some text")
+
+ # OpenSearch Version 1.1
+ feed = engine.search("some text", "type") # type is like "application/rss+xml"
+ 
+== Author 
+-  drawnboy ( http://nowherenear.net ) <drawn.boy@gmail.com.nospam> 
+
+== License
+- Same as Ruby.

data/Rakefile

@@ -0,0 +1,154 @@
+# Rakefile for MetaProject
+
+# Copyright 2005 by Aslak Hellesoy (aslak.hellesoy@gmail.org)
+# All rights reserved.
+
+# This file is may be distributed under an MIT style license.  See
+# MIT-LICENSE for details.
+
+$:.unshift('lib')
+require 'meta_project'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/xforge'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+# Versioning scheme: MAJOR.MINOR.PATCH
+# MAJOR bumps when API is broken backwards
+# MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
+# -OR when a new release is made and propaganda is sent out.
+# PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
+# Later DamageControl can bump PATCH automatically.
+#
+# REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
+PKG_NAME = "opensearch"
+PKG_VERSION = "0.0.1"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  'lib/**/*.rb', 
+  'doc/**/*'
+]
+
+task :default => [:gem]
+
+desc "Execute RSpec specifications (rspec gem must be installed)"
+task :spec do
+  ruby 'behaviours/suite.rb'
+end
+
+# Create a task to build the RDOC documentation tree.
+rd = Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'html'
+#  rdoc.template = 'kilmer'
+#  rdoc.template = 'css2'
+#  rdoc.template = 'doc/jamis.rb'
+  rdoc.title    = "opensearch"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'CHANGES')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+  rdoc.rdoc_files.exclude('doc/**/*_attrs.rdoc')
+end
+
+# ====================================================================
+# Create a task that will package the Rake software into distributable
+# tar, zip and gem files.
+
+spec = Gem::Specification.new do |s|
+  
+  #### Basic information.
+
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Search A9 OpenSearch compatible engines"
+  s.description = <<-EOF
+  OpenSearch is simple format of sharing of search results by A9. See opensearch.a9.com/ for detail.
+
+  This library is for OpenSearch version 1.0 or 1.1 
+  EOF
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+  #s.autorequire = 'meta_project'
+
+  #### Documentation and testing.
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+  s.rdoc_options <<
+    '--title' <<  'OpenSearch' <<
+    '--main' << 'README' <<
+    '--line-numbers'
+
+  #### Author and project details.
+
+  s.author = "drawnboy"
+  s.email = "drawn.boy@gmail.com"
+  s.homepage = "http://opensearch.rubyforge.org"
+  s.rubyforge_project = "opensearch"
+end
+
+desc "Build Gem"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+# Support Tasks ------------------------------------------------------
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  Pathname.new(File.dirname(__FILE__)).egrep(/#.*(FIXME|TODO|TBD|DEPRECATED)/) do |match|
+    puts match
+  end
+end
+
+task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news, :tag]
+
+task :verify_env_vars do
+  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
+end
+
+task :publish_doc do
+  publisher = Rake::RubyForgePublisher.new('opensearch', ENV['RUBYFORGE_USER'])
+  publisher.upload
+end
+
+desc "Release files on RubyForge"
+task :release_files => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('opensearch')) do |release|
+    # Never hardcode user name and password in the Rakefile!
+    release.user_name = ENV['RUBYFORGE_USER']
+    release.password = ENV['RUBYFORGE_PASSWORD']
+    release.files = release_files.to_a
+    release.release_name = "#{PKG_NAME} #{PKG_VERSION}"
+    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
+  end
+end
+
+desc "Publish news on RubyForge"
+task :publish_news => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new('opensearch')) do |news|
+    # Never hardcode user name and password in the Rakefile!
+    news.user_name = ENV['RUBYFORGE_USER']
+    news.password = ENV['RUBYFORGE_PASSWORD']
+  end
+end
+
+desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
+task :tag do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  puts "Tagging CVS with [#{reltag}]"
+  sh %{cvs tag #{reltag}}
+end

data/lib/opensearch.rb

@@ -0,0 +1,57 @@
+#
+# Copyright (C) 2006 drawnboy (drawn.boy@gmail.com)
+#
+# This program is free software.
+# You can distribute/modify this program under the terms of the Ruby License.
+#
+
+require 'open-uri'
+require 'rexml/document'
+
+require 'opensearch/1.0'
+require 'opensearch/1.1'
+
+module OpenSearch
+  class OpenSearch
+    class << self
+      def new(url)
+        engine = nil
+        ns_uri, doc = fetch_description url
+
+        case ns_uri
+        when %r"http://a9.com/-/spec/opensearch(rss|)/1.0/"
+          engine = OpenSearch10.new doc
+        when %r"http://a9.com/-/spec/opensearch/1.1/"
+          engine = OpenSearch11.new doc
+        end
+
+        raise "Cannot detect description of opensearch version 1.0 or 1.1" if engine.nil?
+        engine
+      end
+
+      private
+      def fetch_description(url)
+        content = open(url) {|f| content = f.read }
+        doc = REXML::Document.new content
+        ns_uri = nil
+        REXML::XPath.each(doc, "//Format") do |node|
+          ns_uri = node.text
+        end
+        if ns_uri.nil?
+          REXML::XPath.each(doc, "//OpenSearchDescription") do |node|
+            ns_uri = node.attributes.get_attribute("xmlns").to_s
+          end
+        end
+        return ns_uri, doc
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  #engine = OpenSearch::OpenSearch.new "http://bulkfeeds.net/opensearch.xml"
+  engine = OpenSearch::OpenSearch.new "http://127.0.0.1/example.xml"
+  engine.set_custom("items_per_page", 20)
+  feed = engine.search("test", "text/html")
+  p feed
+end

data/lib/opensearch/1.0.rb

@@ -0,0 +1,46 @@
+require 'opensearch/base'
+
+module OpenSearch 
+  class OpenSearch10 < OpenSearchBase
+    Nodes = %w(url format short_name long_name description tags image sample_search developer contact attribution syndication_right adult_content)
+    Pagers = { 
+      "count"       => 20,
+      "start_index" => 1,
+      "start_page"  => 1
+    }
+
+    def initialize(doc)
+      @description = Hash.new
+      @pager       = Pagers.dup
+      super
+    end
+
+    def search(query)
+      url =  @description["url"] 
+      rss = super(url, query)
+      parse_rss(rss)
+    end
+
+    private
+    def install_accessor
+      class << self
+        Nodes.each do |node|
+          define_method(node){ @description[node] }
+        end
+
+        Pagers.each_key do |pager|
+          define_method(pager){ @pager[pager] }
+          define_method("#{pager}="){|value| @pager[pager] = value }
+        end
+      end
+    end
+
+    def setup_description(doc)
+      Nodes.each do |node|
+       REXML::XPath.each(doc, "//#{node.gsub(/(^|_)(.)/){$2.upcase}}") do |n|
+         @description[node] = n.text
+       end
+      end
+    end
+  end
+end

data/lib/opensearch/1.1.rb

@@ -0,0 +1,103 @@
+require 'opensearch/base'
+
+module OpenSearch
+  class OpenSearch11 < OpenSearch::OpenSearchBase
+    Nodes = { 
+      "url"               => { :format => {}, :requirements => [] },
+      "short_name"        => { :format => "", :requirements => nil }, 
+      "long_name"         => { :format => "", :requirements => nil },
+      "description"       => { :format => "", :requirements => nil },
+      "tags"              => { :format => "", :requirements => nil },
+      "image"             => { :format => {}, :requirements => [] },
+      "query"             => { :format => {}, :requirements => [] },
+      "developer"         => { :format => "", :requirements => nil },
+      "contact"           => { :format => "", :requirements => nil },
+      "attribution"       => { :format => "", :requirements => nil },
+      "syndication_right" => { :format => "", :requirements => nil },
+      "adult_content"     => { :format => "", :requirements => nil },
+      "language"          => { :format => "", :requirements => [] },
+      "input_encoding"    => { :format => "", :requirements => [] },
+      "output_encoding"   => { :format => "", :requirements => [] },
+    }
+    Pagers = { 
+      "count"           => 20,
+      "start_index"     => 1,
+      "start_page"      => 1,
+      "language"        => "*",
+      "output_encoding" => "UTF-8",
+      "input_encoding"  => "UTF-8",
+    }
+
+    def initialize(doc)
+      @description = Hash.new
+      @pager       = Pagers.dup
+      super
+    end
+
+    def search(query, type = nil)
+      url  = nil
+      post = false
+      if type.nil?
+        url = @description["url"][0]["template"]
+      else
+        @description["url"].each do |u|
+          if u["type"] == type
+            url = u["template"] 
+            if u["method"] =~ /post/i
+              post = u["param"] 
+              post = setup_query(post, query)
+            end
+          end
+        end
+      end
+      raise "cannot find strict url from Description." if url.nil?
+      super(url, query, post)
+    end
+
+    private
+    def install_accessor
+      class << self
+        Nodes.each_key do |node|
+          define_method(node){ @description[node] }
+        end
+
+        Pagers.each_key do |pager|
+          define_method(pager){ @pager[pager] }
+          define_method("#{pager}="){|value| @pager[pager] = value }
+          define_method("set_custom"){|pager, value|  @pager[pager] = value }
+          define_method("get_pager"){|pager|  @pager[pager] }
+        end
+      end
+    end
+
+    def setup_description(doc)
+      Nodes.each_key do |node|
+        REXML::XPath.each(doc, "//#{node.gsub(/(^|_)(.)/){$2.upcase}}") do |n|
+          description = nil
+          if Nodes[node][:format].class == Hash
+            description = Hash.new
+            n.attributes.each do |key, value|
+              description[key] = value
+            end
+            description[node] = n.text unless n.text.nil?
+            if node == "url" && n.has_elements?
+              description["param"] = ""
+              REXML::XPath.each(n, "//Param") do |param|
+                param.attributes.each do |k, v|
+                  description["param"] << "#{k}=#{v}&"
+                end
+              end
+            end
+          else
+            description = n.text
+          end
+          if Nodes[node][:requirements].class == Array
+            @description[node] = @description[node].to_a.push(description)
+          else
+            @description[node] = description
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/base.rb

@@ -0,0 +1,70 @@
+require 'uri'
+require 'net/http'
+require 'rexml/document'
+require "rss/1.0"
+require "rss/2.0"
+require "rss/dublincore"
+
+module OpenSearch
+  class OpenSearchBase
+    def initialize(doc)
+      install_accessor
+      setup_description doc
+      self
+    end
+
+    def search(url, query, post = false)
+      query = setup_query(url, query)
+      post ? post_content(query, post) : get_content(query)
+    end
+
+    private
+    def install_accessor
+    end
+
+    def setup_description(doc)
+    end
+
+    def setup_query(url, query)
+      search_terms = URI.escape(query)
+      url.gsub!("{searchTerms}", search_terms)
+      @pager.each do |key, value|
+        key = key.gsub(/_(.)/){$1.upcase}
+        url.gsub!(/\{#{key}(\?|)\}/, value.to_s)
+      end
+      url
+    end
+
+    def get_content(uri)
+      uri =  URI.parse(uri)
+      Net::HTTP.version_1_2
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        response = http.get("#{uri.path}?#{uri.query}")
+        raise "Get Error : #{response.code} - #{response.message}" unless response.code == "200"
+        response.body
+      end
+    end
+
+    def post_content(uri, data)
+      uri =  URI.parse(uri)
+      Net::HTTP.version_1_2
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        response = http.get("#{uri.path}?#{uri.query}", data)
+        raise "Post Error : #{response.code} - #{response.message}" unless response.code == "200"
+        response.body
+      end
+    end
+
+    def parse_rss(rss)
+      begin
+        RSS::Parser.parse(rss)
+      rescue RSS::InvalidRSSError
+        RSS::Parser.parse(rss, false)
+      end
+    end
+
+    ## No implementation of atom format parser, not yet...
+    # def atom_parser(xml)
+    # end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: opensearch
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-01-11 00:00:00 +09:00
+summary: Search A9 OpenSearch compatible engines
+require_paths: 
+- lib
+email: drawn.boy@gmail.com
+homepage: http://opensearch.rubyforge.org
+rubyforge_project: opensearch
+description: OpenSearch is simple format of sharing of search results by A9. See opensearch.a9.com/ for detail.  This library is for OpenSearch version 1.0 or 1.1
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- drawnboy
+files: 
+- README
+- Rakefile
+- CHANGES
+- lib/opensearch.rb
+- lib/opensearch/1.1.rb
+- lib/opensearch/base.rb
+- lib/opensearch/1.0.rb
+test_files: []
+
+rdoc_options: 
+- --title
+- OpenSearch
+- --main
+- README
+- --line-numbers
+extra_rdoc_files: 
+- README
+- CHANGES
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+