YahooSearchApi Version 0.0.6
==============

Version 0.0.6 - 2007/04/15
- Added YahooSearchApi::AssistSearchService.
It can access to Yahoo Assist Word Search.

Version 0.0.5 - 2007/04/15
- Added YahooSearchApi::VideoSearchService. It can access to Yahoo Video Search.

Version 0.0.4 - 2007/04/14
- Added YahooSearchApi::ImageSearchService. It can access to Yahoo Image Search.

Version 0.0.3 - 2007/04/12
- Fix bug in Sample Usage of Readme.
- Add module name to classes called in YahooSearchApi::WebSearchService.

Version 0.0.2 - 2007/04/10
- Method "results" is added. This is recommended more than "get_results".

Version 0.0.1 - 2007/04/09

by Junya Ishihara <http://blog.champierre.com>  

== Overview

This plugin is a library to use Yahoo Search API on Ruby on Rails.

== Installing

Run

  script/plugin install
  http://rails-workshop-tokyo.googlecode.com/svn/trunk/plugins/yahoo_search_api

or checkout the source into your plugins folder.

  svn checkout 
  http://rails-workshop-tokyo.googlecode.com/svn/trunk/plugins/yahoo_search_api

== Example Usage

=== Controller(yahoo_controller.rb)

  class YahooController < ApplicationController
    def search
      # For detail of parameters, please see
      # http://developer.yahoo.co.jp/search/web/V1/webSearch.html
      search_params = {
        :type => 'all',
        :results => 10,
        :start => 1,
        :adult_ok => nil,
        :similar_ok => nil,
        :language => 'ja',
        :country => nil,
        :site => {'www.yahoo.co.jp', 'www.asahi.com'}
      }

      web_search_service = YahooSearchApi::WebSearchService.new(
        'Your Yahoo Application ID',
        'Search Keyword',
        search_params
      )

      # Get search results
      @results = web_search_service.results

      # Get request URL
      @req_url = web_search_service.req_url
    end
    
    def image_search
      # For detail of parameters, please see
      # http://developer.yahoo.co.jp/search/image/V1/imageSearch.html
      search_params = {
        :type => 'all',
        :results => 10,
        :start => 1,
        :format => 'any',
        :adult_ok => nil,
        :coloration => 'any',
        :site => {'www.yahoo.co.jp', 'www.asahi.com'}
      }
      
      image_search_service = YahooSearchApi::ImageSearchService.new(
        'Your Yahoo Application ID',
        'Search Keyword',
        search_params
      )
      
      # Get search results
      @results = image_search_service.results
      
      # Get request URL
      @req_url = image_search_service.req_url
    end
    
    def video_search
      # For detail of parameters, please see
      # http://developer.yahoo.co.jp/search/video/V1/videoSearch.html
      search_params = {
        :type => 'all',
        :results => 10,
        :start => 1,
        :format => 'any',
        :adult_ok => nil,
        :site => {'www.yahoo.co.jp', 'www.asahi.com'}
      }
    
      video_search_service = YahooSearchApi::VideoSearchService.new(
        'Your Yahoo Application ID',
        'Search Keyword',
        search_params
      )
    
      # Get search results
      @results = video_search_service.results
      
      # Get request URL
      @req_url = video_search_service.req_url
    end
    
    def assist_search
      # For detail of parameters, please see
      # http://developer.yahoo.co.jp/search/webunit/V1/webunitSearch.html
      search_params = {
        :results => 10,
        :start => 1,
      }

      assist_search_service = YahooSearchApi::AssistSearchService.new(
        'Your Yahoo Application ID',
        'Search Keyword',
        search_params
      )
      
      # Get search results
      @results = assist_search_service.results

      # Get request URL
      @req_url = assist_search_service.req_url
    end
  end

=== View(search.rhtml)

  <h1>Yahoo#search</h1>
  Request URL: <%= @req_url %><br>
  <br>
  <%- unless @results.is_a?(Array) -%>
    Error: <%= @results %>
  <%- else -%>
    <%- @results.each do |result| -%>
      <p>
      <%= link_to result.Title, result.ClickUrl %><br>
      <%= result.Summary %><br>
      <%= result.Url %>
        - <%= Time.at(result.ModificationDate.to_i).strftime("%d %b %Y")%>
      </p>
    <%- end -%>
  <%- end -%>
  
=== View(image_search.rhtml)

  <h1>Yahoo#image_search</h1>
  Request URL: <%= @req_url %><br>
  <br>
  <%- unless @results.is_a?(Array) -%>
    Error: <%= @results %>
  <%- else -%>
    <%- @results.each do |result| -%>
      <p>
      Title: <%= result.Title %><br>
      Summary: <%= result.Summary %><br> 
      <img src="<%= result.Thumbnail.Url %>"
           height="<%= result.Thumbnail.Height %>"
           width="<%= result.Thumbnail.Width %>"
      ><br>
      Image Url: <%= link_to result.Url, result.ClickUrl %><br>
      Referer: <%= link_to result.RefererUrl, result.RefererUrl %><br>
      FileSize: <%= result.FileSize %><br>
      FileFormat: <%= result.FileFormat %><br>
      Height: <%= result.Height %><br>
      Width: <%= result.Width %><br>
      Publisher: <%= result.Publisher %><br>
      Restrictions: <%= result.Restrictions %><br>
      Copyright: <%= result.Copyright %><br>
      </p>
      <hr>
    <%- end -%>
  <%- end -%>

=== View(video_search.rhtml)

  <h1>Yahoo#video_search</h1>
  Request URL: <%= @req_url %><br>
  <br>
  <%- unless @results.is_a?(Array) -%>
    Error: <%= @results %>
  <%- else -%>
    <%- @results.each do |result| -%>
      <p>
      Title: <%= result.Title %><br>
      Summary: <%= result.Summary %><br>
      <a href="<%= result.ClickUrl %>">
      <img src="<%= result.Thumbnail.Url %>"
           height="<%= result.Thumbnail.Height %>"
           width="<%= result.Thumbnail.Width %>"
      ></a><br>
      Image Url: <%= link_to result.Url, result.ClickUrl %><br>
      Referer: <%= link_to result.RefererUrl, result.RefererUrl %><br>
      FileSize: <%= result.FileSize %><br>
      FileFormat: <%= result.FileFormat %><br>
      Height: <%= result.Height %><br>
      Width: <%= result.Width %><br>
      Duration: <%= result.Duration %><br>
      Channels: <%= result.Channels %><br>
      Streaming: <%= result.Streaming %><br>
      Publisher: <%= result.Publisher %><br>
      Restrictions: <%= result.Restrictions %><br>
      Copyright: <%= result.Copyright %><br>
      </p>
      <hr>
    <%- end -%>
  <%- end -%>

=== View(assist_search.rhtml)

  <h1>Yahoo#assist_search</h1>
  Request URL: <%= @req_url %><br>
  <br>
  <%- unless @results.is_a?(Array) -%>
    Error: <%= @results %>
  <%- else -%>
    <%- @results.each do |result| -%>
      <%= result %><br>
    <%- end -%>
  <%- end -%>

== Documentation

You can create the documentation by running:

  rake rdoc

== Required files

open-uri rexml/document cgi

== Links

Yahoo! JAPAN DEVELOPER NETWORK http://developer.yahoo.co.jp/search/

== License

This plugin is released under the MIT license.  See MIT-LICENSE for details.

== Feedback

Please leave a comment or send a trackback to

http://blog.champierre.com/archives/504