mextractr_webapi 0.0.1 → 0.0.2

data/ChangeLog

@@ -1,2 +1,3 @@
 2008-08-27 古川大輔 v0.0.1 release
+2008-12-09 古川大輔 v0.0.2 非公開バージョン
 

data/lib/mextractr_webapi.rb

@@ -16,39 +16,64 @@ require 'uri'
 require 'net/http'
 require 'cgi'
 
+#
+#= Mextractr WEB API(http://api.emetadata.net/)をrubyから使うためのラッパークラス
+#Copyright:: Copyright (C) D.Furukawa 2008. All rights reserved.
+#License::   Ruby ライセンスに準拠
+#
 class MextractrWebApi
 	Mextractr_webapi_url = 'http://api.emetadata.net/mextractr?text=[[text]]&out=[[out]]&apikey=[[apikey]]'
+	@webapi_url = nil
 	@apikey = nil
 	@log = nil
 	@result=nil
 	
 	attr_reader :apikey,:result
-	#デバッグ用のメソッドたち。new(APIKEY,log)のlog部分にloggerオブジェクトを渡すと出力されます。
-	def debug_out(text)
-		if (@log)
-			@log.debug(text.to_s) 
-		end
-	end
 
-	def debug_obj(obj,msg=nil)
-		if (@log)
-			@log.debug(msg.to_s+"\n"+PP.pp(obj,""))
-		end
+  #== 現在利用しているwebAPIのURLを取得
+	def api_uri()
+		return @webapi_url
 	end
 	
-	def initialize(myapikey,mylog=nil)
+  #== オブジェクトの生成
+  #
+  #myapikey :: Mextractr Web APIのAPIキーです。http://api.emetadata.net/docから取得したものを設定してください
+  #mylog :: loggerを渡すと、Mextractr Web APIとのやりとりの内容が出力されます。デバッグ用です。
+  #options :: そのほかのオプションです。
+  #             - :webapi_url : Mextractr Web APIのURLです。デフォルトと異なるURLに接続したい場合に指定してください。書式は、http://api.emetadata.net/mextractr?text=[[text]]&out=[[out]]&apikey=[[apikey]] という具合です。
+  #             - :log : loggerを渡すと、Mextractr Web APIとのやりとりの内容が出力されます。デバッグ用です。第二引数のmylogより優先して使用されます。
+  #             - :myapikey : Mextractr Web APIのAPIキーです。第一引数のmyapikeyより優先して使用されます。
+  #
+	def initialize(myapikey,mylog=nil,options=nil)
 		@apikey = myapikey
 		@log = mylog
 		if (@log)
 			require 'pp'
 		end
+		@webapi_url = Mextractr_webapi_url
+		setOptions(options) if (options)
 	end
-	
+
+  #== オプションの設定
+  #
+  # initializeメソッドに渡すoptions引数と同じものを後から設定することが出来ます。通常この関数を直接呼び出す必要はなく、initializeで十分なはずです。
+  #
+	def setOptions(options)
+		@webapi_url = options[:webapi_url] if options[:webapi_url] 
+		@log = options[:log] if options[:log] 
+		@apikey = options[:apikey] if options[:apikey] 
+	end
+
+  #== 文章解析の実行
+  #
+  # 引数で渡されたtextをMextractr Web APIに渡して結果を取得します。結果は、この関数の帰り値として取得する事も出来ますし、resultプロパティを参照することも出来ます。
+  # いずれにせよ、result["where"],result["when"],といった形で結果が格納されています。
+  #
 	def parse(text)
 		text_encoded = CGI.escape( CGI.escapeHTML(text.toutf8) )
 
 		#Mextractr APIを呼び出す
-		uri = URI.parse( Mextractr_webapi_url.gsub('[[text]]',text_encoded).gsub('[[out]]','atom').gsub('[[apikey]]',@apikey) )
+		uri = URI.parse( @webapi_url.gsub('[[text]]',text_encoded).gsub('[[out]]','atom').gsub('[[apikey]]',@apikey) )
 		debug_out("uri:"+uri.to_s)
 		response = nil
 		Net::HTTP.start(uri.host,uri.port){|http|
@@ -77,6 +102,7 @@ class MextractrWebApi
 			item = {}
 			item['valueString'] = elem.attributes['valueString']
 			item['startTime'] = elem.attributes['startTime']
+			item['endTime'] = elem.attributes['endTime']
 			@result['when'] << item
 		}
 		doc.elements.each("feed/entry/gd:where"){|elem|
@@ -102,10 +128,25 @@ class MextractrWebApi
 		
 		return @result
 	end
+
+	private
+	def debug_out(text)
+		if (@log)
+			@log.debug(text.to_s) 
+		end
+	end
+
+	def debug_obj(obj,msg=nil)
+		if (@log)
+			@log.debug(msg.to_s+"\n"+PP.pp(obj,""))
+		end
+	end
 end
 
 =begin
 [更新履歴]
 2008-08-27 D.Furukawa とりあえず作ってみた。帰り値、これでいいかなぁ？
 2008-09-25 D.Furukawa ファイル名とクラス名をrailsの規約にあわせる
+2008-12-10 D.Furukawa WebAPIのURLが変わる可能性があるみたいなので、対応できる機能を追加。
+2008-12-10 D.Furukawa rdocコメントを追加。
 =end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mextractr_webapi
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Daisuke Furukawa
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-26 00:00:00 +09:00
+date: 2008-12-10 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -19,17 +19,18 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - lib/mextractr_webapi.rb
 - README
 - ChangeLog
-has_rdoc: false
+has_rdoc: true
 homepage: http://mogya.com
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -46,10 +47,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: mextractr_webapi
 rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
-summary: "Mextractr WEB API(http://api.emetadata.net/)\xE3\x82\x92ruby\xE3\x81\x8B\xE3\x82\x89\xE4\xBD\xBF\xE3\x81\x86\xE3\x81\x9F\xE3\x82\x81\xE3\x81\xAE\xE3\x83\xA9\xE3\x83\x83\xE3\x83\x91\xE3\x83\xBC\xE3\x82\xAF\xE3\x83\xA9\xE3\x82\xB9"
+summary: wrapper class for Mextractr WEB API(http://api.emetadata.net/)
 test_files: []