doubapi 0.0.9 → 0.1.0

data/README

@@ -1,20 +1,29 @@
 Usage:
 require 'doubapi'
 
-key = "许巍"
-Doubapi.search_events_of(key).each do |event|
-		puts event.title
-		puts event.when
-		puts event.where
-		puts event.link
+
+Release NOTES:
+1.2012/7/17: v0.1.0: The API have been changed in 0.1.0 release and it is not backward compatible.
+
+Previously:
+
+Doubapi.search_events_of("all").each do |event|
+	puts event.title
+	puts event.when
+	puts event.where
+	puts event.link
 end
 
-author = "李志"
-Doubapi.search_albums_of(author, "2010-05").each do |album|
-		puts album.author	
-		puts album.release_date	
-		puts album.title	
-		puts album.link	
+After 0.1.0
+
+Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => 1,:max_result => 30) do |event|
+	puts event.title
+	puts event.when
+	puts event.where
+	puts event.link
 end
 
 
+check lib/test.rb for more usage.
+
+

data/lib/doubapi/version.rb

@@ -1,3 +1,3 @@
 module Doubapi
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/doubapi.rb

@@ -1,29 +1,65 @@
+#
+# Copyright (c) 2009-2012 pierr.chen at gmail dot com
+#
+# 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.
+#
+
 require 'RUBYgems'  #a hack to require failure for nokogiri
 require 'open-uri'
 require 'nokogiri'
 require 'pp'
 
 
+#useful information:
+#when accessing the the Nokogiri parsed result, all the name are downcase-d
+#for example : to access the totalResults element
+#<openSearch:totalResults>111</openSearch:totalResults>
+#you should use doc.at_xpath(".//totalresults")
+
+#at_xpath  is to return single element and you know only there is only one element.
+#xpath is to return an array of elements
+
 module Doubapi
 #return a Nokogiri XML  object
 #use Douban API
-
-
-Event =  Struct.new :title, :when, :where, :what, :link
+Event =  Struct.new :title, :when, :where, :what,:link,:poster_mobile,:bar_icon
 #release_date is in the format of YY-MM-DD
-Album =  Struct.new :author, :title, :release_date,  :link
+Album =  Struct.new :author, :title, :release_date, :link,:cover_thumbnail,:publisher,:mobile_site
 
 #input:{key => "all/singer_name", :location => "shanghai", :start_index => 16,:max_result => 15}
-#return Doubapi::Event[]
-def self.search_events_of h
-	Douban.search_events_of h
+#return total number of events satisfying the search criterion 
+#Doubapi::Event[]
+def self.search_events_of h ,&block
+	totalResult, returnedResult = Douban.search_events_of h 
+	returnedResult.each {|event| block.call(event) if block_given?}
+	return totalResult;
 end
 
 
 #input {:singer,:since}
+#return total number of events satisfying the search criterion 
 #return Doubapi::Album[]
-def self.search_albums_of h 
-	Douban.search_albums_of h 
+def self.search_albums_of h ,&block
+ totalResult, returnedResult =	Douban.search_albums_of h 
+ returnedResult.each {|album| block.call(album) if block_given?}
+ return totalResult;
 end
 
 protected 
@@ -34,13 +70,19 @@ class << self
 def douban_get_xml url
 	puts url
 	#I have forgot why i need to specify the user agend
-    doc = open(url, :proxy => nil, 'User-Agent' => 'ruby')
-    Nokogiri::HTML(doc,nil, "utf-8")
-    #Nokogiri::HTML(open(url,:proxy => nil,'User-Agent' => 'ruby'),nil, "utf-8")
+  doc = open(url, :proxy => nil, 'User-Agent' => 'ruby')
+  if doc.nil?
+    puts "error:failed to open #{url}"
+    return nil;
+  end
+  
+  Nokogiri::HTML(doc,nil, "utf-8")
+  
+  #Nokogiri::HTML(open(url,:proxy => nil,'User-Agent' => 'ruby'),nil, "utf-8")
 	#no network access, used to simulator 
 	#doc = File.read(File.join(RAILS_ROOT, "app","controllers","event_sample.xml"))
 	#Nokogiri::HTML(doc,nil, "utf-8")
-    #Nokogiri::HTML(open(url,:proxy => nil,'User-Agent' => 'ruby'),nil, "utf-8")
+  #Nokogiri::HTML(open(url,:proxy => nil,'User-Agent' => 'ruby'),nil, "utf-8")
 end
 
 
@@ -107,45 +149,64 @@ def compare_date a , b
 	return true if (ya.to_i * 12 + ma.to_i ) >= (yb.to_i*12+mb.to_i)
 end
 
+
+def formate_release_date release_date
+   	#make release data YY-MM-DD style
+  	r = release_date.scan(/\d{1,4}/)
+  	#if DD was not specified
+  	r << "01"         if r.size == 2
+  	r << "01" << "01" if r.size == 1
+
+  	y , m , d = r
+
+  	m = "01" unless (1..12).include?(m.to_i) 
+  	d = "01" unless (1..30).include?(d.to_i)
+  	
+  	"#{y}-#{m}-#{d}" 
+end
+
+
+#
+#search albums tagged with h[:singer]. It is not quite accurate. I have seen some irrevlant result are returned.
+#
+#
 def search_albums_of h 
   artist = h[:singer]
   after_date = h[:since]||"1900.01"
-	doc = search_ablum h
-	albums=[]
-
-	doc.xpath("//entry").each do |entry|
-		title = entry.at_xpath(".//title").text
-		author = unless entry.at_xpath(".//name").nil?
-				 entry.at_xpath(".//name").text
-			     else
-				 "unknown(#{artist}?)"
-				 end
-		release_date = unless entry.at_xpath(".//attribute[@name='pubdate']").nil?
-							entry.at_xpath(".//attribute[@name='pubdate']").text
-					   else
-							#means unknow
-							"0000-00"
-					   end
-    	link =  entry.at_xpath(".//link[@rel='alternate']")["href"]
-    
-		#make release data YY-MM-DD style
-		r = release_date.scan(/\d{1,4}/)
-		#if DD was not specified
-		r << "01"         if r.size == 2
-		r << "01" << "01" if r.size == 1
-	
-		y , m , d = r
-
-		m = "01" unless (1..12).include?(m.to_i) 
-		d = "01" unless (1..30).include?(d.to_i) 
-
-		formated_release_day = "#{y}-#{m}-#{d}" 
-		#check the release date
-		if compare_date release_date, after_date			
-			albums << Doubapi::Album.new(author, title, formated_release_day, link)
-		end
-	end
-	albums
+  doc = search_ablum h
+ 
+  if(doc.nil?) 
+    return [0,[]];
+  end
+  
+  #the totalResult here trying
+  #totalResults = doc.at_xpath(".//totalresults").text.to_i
+   
+  albums=[]
+  doc.xpath("//entry").each do |entry|
+  	title = entry.at_xpath(".//title").text
+  	#author
+  	authorItem = entry.at_xpath(".//name")
+  	author = if authorItem.nil? then artist else authorItem.text end
+  	#link - pc web
+		link =  entry.at_xpath(".//link[@rel='alternate']")["href"]
+	  cover_thumnail = entry.at_xpath(".//link[@rel='image']")["href"]
+	  #publisher
+  	pubItem = entry.at_xpath(".//attribute[@name='publisher']")
+  	publisher = if pubItem.nil? then "unknow" else pubItem.text end
+    #link - mobile_site
+  	mobile_site = entry.at_xpath(".//link[@rel='mobile']")["href"]
+    #release_date
+    pubDateItem = entry.at_xpath(".//attribute[@name='pubdate']")
+    release_date = if pubDateItem.nil? then "0000-00" else pubDateItem.text end
+  	formated_release_day = formate_release_date(release_date)
+  	#check the release date
+  	if compare_date release_date, after_date			
+  		albums << Doubapi::Album.new(author, title, formated_release_day, link, cover_thumnail,publisher,mobile_site)
+  	end
+  end
+  #improve ME
+  [albums.size,albums]
 end
 
 
@@ -160,12 +221,13 @@ end
   end
 
 def search_events_of(h={})
-  
-  puts h.inspect
   artist = h[:key]
   after_date =  h[:after_date]||Time.now.strftime("%Y-%m")
   doc = search_event h
   events=[]
+  
+  #NOTES:all the key will be downcase-d
+  totalResults = doc.at_xpath(".//totalresults").text.to_i
   doc.xpath("//entry").each do |entry|
     #pp entry
     title = entry.at_xpath(".//title").text
@@ -175,15 +237,22 @@ def search_events_of(h={})
     where = entry.at_xpath('.//where')["valuestring"]
     link =  entry.at_xpath(".//link[@rel='alternate']")["href"]
     what = entry.at_xpath(".//content").text
+    posterItem = entry.at_xpath(".//link[@rel='image-lmobile']")
+    poster_mobile = if posterItem.nil? then "empty" else posterItem["href"] end
+    authItem = entry.at_xpath(".//author")
+    iconLink = if authItem.nil? then nil else authItem.at_xpath(".//link[@rel='icon']") end
+    bar_icon = if (iconLink.nil?) then nil else iconLink["href"] end
 
 	#check the date
 	if parse_date(start_time) > parse_date(after_date)
-	    events << Doubapi::Event.new(title, start_time, where, what, link)
+	    events << Doubapi::Event.new(title, start_time, where, what, link, poster_mobile, bar_icon)
     end
   end
 	
   #filtering of the results
-  events.select{|e| looks_like_a_live_show?(e,artist)}
+  events.select!{|e| looks_like_a_live_show?(e,artist)}
+  
+  [totalResults, events]
 end
 
 end #self,instance method end

data/lib/test.rb

@@ -19,44 +19,79 @@ end
 
 def test2
   author = "李志"
-  Doubapi.search_albums_of(:singer=>author,:since=>"2010-05").each do |album|
+  Doubapi.search_albums_of(:singer=>author,:since=>"2010-05") do |album|
+    puts "-------------------------------"
     puts album.author	
     puts album.release_date	
     puts album.title	
+    puts album.cover_thumbnail
+    puts album.publisher
     puts album.link	
+    puts album.mobile_site
   end
 end 
 
 
 
-def test3
+def test_get_all_events
   
-  puts "1-30"
-  Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => 1,:max_result => 30).each do |event|
-    puts "#{event.when} #{event.title}"
-    #puts event.where
-    #puts event.link
+  
+  puts "trying to get 30 first"
+  
+  batch_size = 30;
+  totalResults1 = Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => 1,:max_result => batch_size) do |event|
+   # puts "#{event.when} #{event.title}"
   end
   
-  puts "1-15"
+  puts "total results #{totalResults1} ,will fetch others"
   
-  Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => 1,:max_result => 15).each do |event|
-    puts "#{event.when} #{event.title}"
-    #puts event.where
-    #puts event.link
+  return if(totalResults1 <= batch_size)
+  
+  (2..totalResults1/batch_size).each do |i|
+    start_index = (i-1)*batch_size+1;
+    max_result = batch_size;
+    puts "start_index :#{start_index}"
+    Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => start_index, :max_result => max_result) do |event|
+     # puts "#{event.when} #{event.title}"
+    end
+    
   end
   
-  puts "16-30"
+  return if((totalResults1%batch_size)==0)
   
-  Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => 16,:max_result => 15).each do |event|
-    puts "#{event.when} #{event.title}"
-    #puts event.where
-    #puts event.link
+  last_fetch_size = totalResults1 - (totalResults1/batch_size)*batch_size;
+  
+  start_index = (totalResults1/batch_size)*batch_size+1;
+  max_result = last_fetch_size;
+  puts "start_index :#{start_index}"
+  Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => start_index, :max_result => max_result) do |event|
+   # puts "#{event.when} #{event.title}"
   end
+  
+  
+  
+  
+    
+
+  
 end
 
 
-#test3
-#test1
-test2
+def test4
+  
+  totalResults = Doubapi.search_events_of(:key => "all", :location => "shanghai", :start_index => 1,:max_result => 1) do |event|
+    puts "#{event.when} #{event.title}"
+    puts event.where
+    puts event.link
+    puts event.poster_mobile
+    puts event.bar_icon
+  end
+  
+  puts "totalResults #{totalResults}"
+  
+end 
 
+test_get_all_events
+#test1
+#test2
+#test4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doubapi
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec