| Module | +Naver | +
| In: | +
+
+ lib/naver/base.rb
+
+ + + lib/naver/item.rb + + + + lib/naver/result.rb + + + + lib/naver/rss.rb + + + + lib/naver.rb + + + |
+
| RSS_LIST | += | +%w[kin video image doc book book_adv local shop encyc krdic endic jpdic blog cafe cafearticle webkr news] | ++ | +Searches that returns results in RSS format + + | +
| XML_LIST | += | +%w[rank ranktheme recmd adult errata shortcut] | ++ | +Searches that returns results in Non-RSS but +XML format + + | +
| METHOD_LIST | += | +RSS_LIST.concat(XML_LIST) | ++ | +Whole available search list + + | +
| ABBREVIATION | += | +{:d => :display, :st => :start, :so => :sort, :f => :filter, :p => :payment, :dt => :d_titl, :da => :d_auth, :dco => :d_cont, :di => :d_isbn, :dp => :d_publ, :ddaf => :d_dafr, :ddat => :d_dato, :dca => :d_catg} | ++ | +Abbreviation for passing options + + | +
| Class | +Naver::Base | +
| In: | +
+
+ lib/naver/base.rb
+
+ + |
+
| Parent: | ++ Object + | +
+fundamental class for naver gem +
+ +| doc_root | +[RW] | ++attributes for accessing retrieved raw xml and parsed libxml root node + + | +
| raw_xml | +[RW] | ++attributes for accessing retrieved raw xml and parsed libxml root node + + | +
+Replace this API key with your own (see dev.naver.com/openapi/register) +
+ ++ # File lib/naver/base.rb, line 10 +10: def initialize(key=nil) +11: @key = key +12: @host = 'http://openapi.naver.com' +13: @api = '/search' +14: end ++
+Does an HTTP GET on a given URL and returns the response body +
+ ++ # File lib/naver/base.rb, line 49 +49: def http_get(url) +50: Net::HTTP.get_response(URI.parse(url)).body.to_s +51: end ++
+ # File lib/naver/base.rb, line 16 +16: def method_missing(target, query, params={}) +17: raise NoQuery if query.empty? +18: if METHOD_LIST.include?(target.to_s) +19: request(target, query, params) +20: if XML_LIST.include?(target.to_s) +21: return Result.new(@doc_root, target.to_s) +22: else +23: return RSS.new(@doc_root) +24: end +25: else +26: raise NoMethod +27: end +28: end ++
+Takes a Naver API method name and set of +parameters; returns an libxml object with the response +
+ ++ # File lib/naver/base.rb, line 31 +31: def request(target, query, params={}) +32: response = http_get(request_url(target, query, params)) +33: parser, parser.string = LibXML::XML::Parser.new, response +34: @raw_xml = parser.parse +35: @doc_root = @raw_xml.root +36: end ++
+Takes a Naver API method name and set of +parameters; returns the correct URL for the REST API. +
+ ++ # File lib/naver/base.rb, line 39 +39: def request_url(target, query, params={}) +40: url = "#{@host}#{@api}?key=#{@key}&target=#{target}&query=#{query}" +41: params.each do |key, value| +42: key = ABBREVIATION[key] unless ABBREVIATION[key].nil? +43: url += "&#{key}=" + CGI::escape(value) +44: end unless params.nil? +45: url +46: end ++
| Class | +Naver::Item | +
| In: | +
+
+ lib/naver/item.rb
+
+ + |
+
| Parent: | ++ Object + | +
+contains each item‘s information and converts XML format to Ruby +format +
+ ++creates Item class object from libxml node input +
+ ++ # File lib/naver/item.rb, line 7 + 7: def initialize(doc) + 8: if cs = doc.children + 9: cs.each do |c| +10: Item.class_eval("attr_accessor :#{c.name}") +11: self.instance_variable_set("@#{c.name}", c.content) +12: end +13: end +14: end ++
| Class | +Naver::NoMethod | +
| In: | +
+
+ lib/naver.rb
+
+ + |
+
| Parent: | ++ StandardError + | +
| Class | +Naver::NoQuery | +
| In: | +
+
+ lib/naver.rb
+
+ + |
+
| Parent: | ++ StandardError + | +
| Class | +Naver::RSS | +
| In: | +
+
+ lib/naver/rss.rb
+
+ + |
+
| Parent: | ++ Object + | +
+contains RSS type return and converts XML format to +Ruby format +
+ +| items | +[RW] | ++variable for accessing items + + | +
+creates RSS class object from libxml node input +
+ ++ # File lib/naver/rss.rb, line 10 +10: def initialize(doc_root) +11: channel = doc_root.find("//rss/channel").first +12: %w[lastBuildDate total start display].each do |f| +13: RSS.class_eval("attr_accessor :#{f}") +14: self.instance_variable_set("@#{f}", channel.find(f).first.content) +15: end +16: +17: @items = [] +18: channel.find("item").each do |i| +19: @items << Item.new(i) +20: end +21: end ++
| Class | +Naver::Result | +
| In: | +
+
+ lib/naver/result.rb
+
+ + |
+
| Parent: | ++ Object + | +
+contains Result type return and converts XML +format to Ruby format +
+ +| items | +[RW] | ++variable for accessing items + + | +
+creates Result object from libxml node input +
+ ++ # File lib/naver/result.rb, line 10 +10: def initialize(doc_root, target) +11: channel = doc_root.find("//result").first +12: +13: case target +14: when "rank", "ranktheme": +15: Result.class_eval("attr_accessor :ranks") +16: @ranks = [] +17: channel.find("item").first.children.each do |c| +18: @ranks << Item.new(c) +19: end +20: when "recmd": +21: Result.class_eval("attr_accessor :recmds") +22: @recmds = [] +23: channel.find("item").each do |i| +24: @recmds << i.content +25: end +26: when "adult", "errata": +27: Result.class_eval("attr_accessor :#{target}") +28: self.instance_variable_set("@#{target}", channel.find("item/#{target}").first.content) +29: when "shortcut": +30: Result.class_eval("attr_accessor :shortcuts") +31: @shortcuts = [] +32: channel.find("item/shortcut").each do |s| +33: @shortcuts << Item.new(s) +34: end +35: else +36: Result.class_eval("attr_accessor :items") +37: @items = [] +38: channel.find("item").each do |i| +39: @items << Item.new(i) +40: end +41: end +42: end ++
| Path: | +CHANGELOG.rdoc + | +
| Last Update: | +Thu Dec 04 23:07:45 -0800 2008 | +
| Path: | +README.rdoc + | +
| Last Update: | +Thu Dec 04 22:55:30 -0800 2008 | +
+Ruby gem for using Naver OpenAPI (dev.naver.com/openapi/tutorial). +네이버 OpenAPI를 위한 루비젬입니다. +
++You can install the gem from rubyforge directly. 루비포지에서 바로 +설치하실 수 있습니다. +
++ gem install naver ++
+Before using this gem, you need to get your own API key. To obtain your API +key, see dev.naver.com/openapi/register. +이 젬을 사용하기 전에 API 키를 발급 받으셔야 합니다. +API 키 발급을 위해서는 dev.naver.com/openapi/register +링크를 참고해 주세요. +
+
+ require 'naver'
+ naver = Naver::Base.new(api_key) ### create a naver client / 네이버 클라이언트를 생성합니다
+ naver.request("kin", "go", {:display => "5", :start => "1", :sort => "sim"}) ### return root node as libxml node / libxml 형식의 노드로 루트 노드를 반환합니다
+ naver.kin("go", {:display => "5", :start => "1", :sort => "sim"}) ### return RSS object / 자체 정의된 RSS 클래스 오브젝트를 반환합니다
+ naver.kin("go", {:d => "5", :st => "5", :so => "sim"}) ### It's possible to use abbreviation for each option / 검색 옵션을 넘길 때 약어를 사용 가능합니다
+ naver.kin("go").lastBuildDate ### return lastBuildDate content in String / 스트링으로 lastBuildDate 값을 반환합니다
+ naver.kin("go").items.each do |i| ### items returns array of Item object which contains title, link, and so on.
+ puts i.title ### items는 Item 오브젝트의 배열을 반환하고 각 Item 오브젝트 속에 title, link 등이 들어있습니다.
+ end
+
++You may want to take a look at the test file (test/test_naver.rb) to better +understand the usage. 보다 자세한 사용법을 이해하시길 +원하시면 테스트 파일 (test/test_naver.rb)을 참고하시면 +됩니다. +
++The full list of abbreviation codes is the following. (You can still use +full name of each parameter.) 약어 전체 목록을 아래에 +정리하였습니다. (약어를 쓰지 않으셔도 작동합니다.) +
++ d = display + st = start + so = sort + f = filter + p = payment + dt = d_titl + da = d_auth + dcon = d_cont + di = d_isbn + dp = d_publ + ddaf = d_dafr + ddat = d_dato + dcat = d_catg ++
| Copyright: | Copyright (c) 2008 Hyunwoo Park <hwpark@oksurerails.com> + + |
| License: | MIT <www.opensource.org/licenses/mit-license.php> + + |
| Path: | +lib/naver/base.rb + | +
| Last Update: | +Thu Dec 04 14:41:58 -0800 2008 | +
| Path: | +lib/naver/item.rb + | +
| Last Update: | +Thu Dec 04 16:26:58 -0800 2008 | +
| Path: | +lib/naver/result.rb + | +
| Last Update: | +Thu Dec 04 22:41:58 -0800 2008 | +
| Path: | +lib/naver/rss.rb + | +
| Last Update: | +Thu Dec 04 14:46:33 -0800 2008 | +
| Path: | +lib/naver.rb + | +
| Last Update: | +Thu Dec 04 11:52:13 -0800 2008 | +
+ An easy interface to the Naver OpenAPI (http://dev.naver.com/openapi/tutorial). By Hyunwoo Park. ++
| Author: | Hyunwoo Park <hwpark@oksurerails.com> + + |
| Copyright: | Copyright (c) 2008 Hyunwoo Park <hwpark@oksurerails.com> + + |
| License: | MIT <www.opensource.org/licenses/mit-license.php> + + |
+USAGE: +
+
+ require 'naver'
+ naver = Naver.new(api_key) ### create a naver client
+ naver.request("kin", "go", {:display => "5", :start => "1", :sort => "sim"}) ### return root node as libxml node
+
+
+