youtubesearchresultscraper 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,3 +1,7 @@
-*0.1.0*
+0.0.1 2006-11-26
+  First public release
+
+0.0.2 2006-12-03
+  Add rdoc.
+  Add each() method into YouTube::SearchResultScraper
 
-* First public release

data/README

@@ -1,13 +1,23 @@
-YouTubeの検索結果のHTMLをスクレイピングして、YouTube Developer APIのyoutube.videos.list_by_tagと同様な形式のXMLを返すライブラリです。
+Introduction
 
-使用例: 
-8< - - - - 8< - - - - 8< - - - - 8< - - - - 
-require "youtube/searchresultscraper"
+  Youtube::SearchResultScraper scrapes video information from search result page on www.youtube.com.
+  You can get result as array or xml.
+  XML format is same as YouTube Developer API (www.youtube.com/dev_api_ref?m=youtube.videos.list_by_tag).
 
-scraper = Youtube::SearchResultScraper.new(keyword, page)
-scraper.open
-scraper.scrape
-puts scraper.get_xml
-8< - - - - 8< - - - - 8< - - - - 8< - - - - 
+Example
 
-参考) http://www.ark-web.jp/sandbox/wiki/183.html
+  require "rubygems"
+  require "youtube/searchresultscraper"
+
+  scraper = Youtube::SearchResultScraper.new(keyword, page)
+  scraper.open
+  scraper.scrape
+  puts scraper.get_xml
+
+More Information
+
+  http://www.ark-web.jp/sandbox/wiki/184.html (japanese only)
+
+  Author:	Yuki SHIDA, shida@in3c.org
+  Version:	0.0.2
+  License:	MIT license

data/lib/youtube/searchresultscraper.rb

@@ -1,3 +1,4 @@
+#--
 # Copyright (C) 2006 by in3c.org                                                                               
 #
 # Permission is hereby granted, free of charge, to any person obtaining
@@ -18,6 +19,9 @@
 # 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.
+#++
+# :main:Youtube::SearchResultScraper
+# :title:Youtube::SearchResultScraper RDoc Documentation
 
 require 'open-uri'
 require 'cgi'
@@ -25,7 +29,33 @@ require 'rubygems'
 require 'hpricot'
 require 'youtube/video'
 
-module Youtube
+module Youtube #:nodoc:
+
+  # = Introduction
+  # Youtube::SearchResultScraper scrapes video information from search result page
+  # on http://www.youtube.com.
+  #
+  # You can get result as array or xml.
+  #
+  # XML format is same as YouTube Developer API
+  # (http://www.youtube.com/dev_api_ref?m=youtube.videos.list_by_tag).
+  #
+  # = Example
+  #   require "rubygems"
+  #   require "youtube/searchresultscraper"
+  #
+  #   scraper = Youtube::SearchResultScraper.new(keyword, page)
+  #   scraper.open
+  #   scraper.scrape
+  #   puts scraper.get_xml
+  # 
+  # = More Information
+  # http://www.ark-web.jp/sandbox/wiki/184.html (japanese only)
+  #
+  # Author::   Yuki SHIDA <shida@in3c.org>
+  # Version::  0.0.2
+  # License::  MIT license
+
   class SearchResultScraper
 
     attr_accessor :keyword
@@ -33,11 +63,21 @@ module Youtube
 
     @@youtube_search_base_url = "http://www.youtube.com/results?search_query="
 
+    # Create Youtube::SearchResultScraper object specifying keyword and number of page.
+    #
+    # You cannot specify number of videos per page.
+    # Always, the number of videos is 20 per page.
+    #
+    # * keyword - specify keyword that you want to search on YouTube.
+    #   You must specify keyword encoded by UTF-8.
+    # * page    - specify number of page
+
     def initialize keyword, page=nil
       @keyword = keyword
       @page    = page if not page == nil
     end
 
+    # Get search result from youtube by specified keyword.
     def open
       url = @@youtube_search_base_url + CGI.escape(@keyword)
       url += "&page=#{@page}" if not @page == nil
@@ -46,6 +86,7 @@ module Youtube
       @search_result = Hpricot.parse(@html)
     end
 
+    # Scrape video information from search result html.
     def scrape
       @videos = []
 
@@ -64,11 +105,21 @@ module Youtube
         video.url            = scrape_url(video_html)
         @videos << video
       end
+
+      @videos
+    end
+
+    # Iterator for scraped videos.
+    def each 
+      @videos.each do |video|
+        yield video
+      end
     end
 
+    # Return videos information as XML Format.
     def get_xml
       xml = "<ut_response status=\"ok\"><video_list>\n"
-      @videos.each do |video|
+      each do |video|
         xml += video.to_xml
       end
       xml += "</video_list></ut_response>"

data/lib/youtube/video.rb

@@ -1,3 +1,4 @@
+#--
 # Copyright (C) 2006 by in3c.org                                                                               
 # http://in3c.org/ 
 #
@@ -19,6 +20,7 @@
 # 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.
+#++
 
 module Youtube
 
@@ -37,6 +39,7 @@ module Youtube
     attr_accessor :url
     attr_accessor :thumbnail_url
 
+    # Return self information as XML format.
     def to_xml
       xml = "<video>\n"
       instance_variables.each do |attr| 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: youtubesearchresultscraper
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2006-11-26 00:00:00 +09:00
+  version: 0.0.2
+date: 2006-12-03 00:00:00 +09:00
 summary: This gem provide function to scrape html of search result on youtube
 require_paths: 
 - lib
@@ -15,7 +15,7 @@ description:
 autorequire: youtube/searchresultscraper
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">="