oksure-daum 0.0.1 → 0.1.1

data/CHANGELOG.rdoc

@@ -0,0 +1,14 @@
+== 0.1.1, release 2008-12-17
+
+* added init.rb, CHANGELOG.rdoc, Unit Test
+* implemented search api wrapper
+* init.rb, CHANGELOG.rdoc, Unit Test 추가
+* 검색 API wrapper 구현
+
+
+== 0.0.1, release 2008-11-22
+
+* first commit
+* no classes, methods implemented
+* 첫 번째 커밋
+* 아직 아무 것도 안 했음

data/README.rdoc

@@ -1,19 +1,69 @@
-= Daum
+= Daum 0.2.1
 
-Ruby gem for using Daum API.
+Ruby gem for using Daum OpenAPI (http://dna.daum.net/apis).
+다음 OpenAPI를 위한 루비젬입니다.
 
 
-== Install
+== Notice / 유의점
 
-	gem list
+Keyword suggestion api is not supported by this gem.
+문맥 키워드 추천 API는 이 젬에서 지원하지 않습니다.
 
+Output file formats other than RSS will cause an error.
+RSS 포맷으로만 아웃풋을 출력하셔야 합니다. 그렇지 않으면 에러가 발생할 수 있습니다.
 
-== Usage
+For using shopping detail api, you have to enter DocID instead of Query string.
+쇼핑 상품 API를 사용하실 때는 쿼리문 대신에 DocID 문자열을 넘겨주셔야 합니다.
 
-Let's say something.
 
+== Install / 설치법
 
-== License
+You can install the gem from rubyforge directly.
+루비포지에서 바로 설치하실 수 있습니다.
+	gem install daum
+
+
+== Usage / 사용법
+
+Before using this gem, you need to get your own API key. To obtain your API key, see https://apis.daum.net/register/apikey.daum.
+이 젬을 사용하기 전에 API 키를 발급 받으셔야 합니다. API 키 발급을 위해서는 https://apis.daum.net/register/apikey.daum 링크를 참고해 주세요.
+
+	require 'daum'
+	daum = Daum::Base.new(api_key)		### create a daum client / 다음 클라이언트를 생성합니다
+	daum.request("삼국지", "go", {:result => "10", :pageno => "1", :sort => "date"})		### return root node as libxml node / libxml 형식의 노드로 루트 노드를 반환합니다
+	daum.knowledge("삼국지", {:result => "10", :pageno => "1", :sort => "date"})		### return RSS object / 자체 정의된 RSS 클래스 오브젝트를 반환합니다
+	daum.knowledge("삼국지", {:re => "10", :p => "1", :so => "date"})		### It's possible to use abbreviation for each option / 검색 옵션을 넘길 때 약어를 사용 가능합니다
+	daum.knowledge("삼국지").lastBuildDate		### return lastBuildDate content in String / 스트링으로 lastBuildDate 값을 반환합니다
+	daum.knowledge("삼국지").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_daum.rb) to better understand the usage.
+보다 자세한 사용법을 이해하시길 원하시면 테스트 파일 (test/test_daum.rb)을 참고하시면 됩니다.
 
-Copyright (c) 2008 Hyunwoo Park
 
+== Search Option Abbreviation List / 검색 옵션 약어 목록
+
+The full list of abbreviation codes is the following. (You can still use full name of each parameter.)
+약어 전체 목록을 아래에 정리하였습니다. (약어를 쓰지 않으셔도 작동합니다.)
+
+	re = result
+	ra = range
+	p = pageno
+	o = output
+	s = sort
+	ta = target
+	c = condition
+	ci = cate_id
+	st = searchType
+	ts = tagsearch
+	di = docid
+	g = group
+	req = requestor
+	ti = title
+
+
+== License
+
+Copyright:: Copyright (c) 2008 Hyunwoo Park <hwpark@oksurerails.com>
+License::   MIT <http://www.opensource.org/licenses/mit-license.php>

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('daum', '0.0.1') do |p|
-	p.description		= "Ruby Gem for Daum API"
-	p.url			= "http://oksurerails.com/daum"
+Echoe.new('daum', '0.1.1') do |p|
+	p.description		= "Ruby Gem for Daum OpenAPI"
+	p.url			= "http://oksurerails.com/ruby/daum"
 	p.author		= "Hyunwoo Park"
 	p.email			= "hwpark@oksurerails.com"
 	p.ignore_pattern	= ["tmp/*", "script/*"]
-	p.development_dependencies = []
+	p.development_dependencies = ["libxml >= 0.9.2"]
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/daum.gemspec

@@ -2,30 +2,34 @@
 
 Gem::Specification.new do |s|
   s.name = %q{daum}
-  s.version = "0.0.1"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hyunwoo Park"]
-  s.date = %q{2008-11-22}
-  s.description = %q{Ruby Gem for Daum API}
+  s.date = %q{2008-12-17}
+  s.description = %q{Ruby Gem for Daum OpenAPI}
   s.email = %q{hwpark@oksurerails.com}
-  s.extra_rdoc_files = ["lib/daum.rb", "README.rdoc"]
-  s.files = ["lib/daum.rb", "Rakefile", "README.rdoc", "Manifest", "daum.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/daum/base.rb", "lib/daum/item.rb", "lib/daum/rss.rb", "lib/daum.rb", "README.rdoc"]
+  s.files = ["CHANGELOG.rdoc", "daum.gemspec", "init.rb", "lib/daum/base.rb", "lib/daum/item.rb", "lib/daum/rss.rb", "lib/daum.rb", "Manifest", "Rakefile", "README.rdoc", "test/test_daum.rb"]
   s.has_rdoc = true
-  s.homepage = %q{http://oksurerails.com/daum}
+  s.homepage = %q{http://oksurerails.com/ruby/daum}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Daum", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{daum}
   s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Ruby Gem for Daum API}
+  s.summary = %q{Ruby Gem for Daum OpenAPI}
+  s.test_files = ["test/test_daum.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<libxml>, [">= 0", "= 0.9.2"])
     else
+      s.add_dependency(%q<libxml>, [">= 0", "= 0.9.2"])
     end
   else
+    s.add_dependency(%q<libxml>, [">= 0", "= 0.9.2"])
   end
 end

data/init.rb

@@ -0,0 +1 @@
+require "daum"

data/lib/daum.rb

@@ -1,5 +1,52 @@
-puts "Hello Daum"
+# = Daum
+#   An easy interface to the Daum OpenAPI (http://dna.daum.net/apis). By Hyunwoo Park.
+#
+# Author::    Hyunwoo Park <hwpark@oksurerails.com>
+# Copyright:: Copyright (c) 2008 Hyunwoo Park <hwpark@oksurerails.com>
+# License::   MIT <http://www.opensource.org/licenses/mit-license.php>
+#
+# USAGE:
+#	  require 'daum'
+#	  daum = Daum::Base.new(api_key)		### create a naver client
+#	  daum.request("삼국지", "go", {:display => "5", :start => "1", :sort => "sim"})		### return root node as libxml node
+#		daum.knowledge("삼국지", {:display => "5", :start => "1", :sort => "sim"})		### return RSS object / 자체 정의된 RSS 클래스 오브젝트를 반환합니다
+#		daum.knowledge("삼국지", {:d => "5", :st => "5", :so => "sim"})		### It's possible to use abbreviation for each option / 검색 옵션을 넘길 때 약어를 사용 가능합니다
+#		daum.knowledge("삼국지").lastBuildDate		### return lastBuildDate content in String / 스트링으로 lastBuildDate 값을 반환합니다
+#		daum.knowledge("삼국지").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
+
+%w[cgi net/http libxml].each {|lib| require lib}
+
+$:.unshift(File.join(File.dirname(__FILE__)))
+
+require "daum/base"
+require "daum/rss"
+require "daum/item"
 
 module Daum
+  include LibXML
+
+	class NoMethod < StandardError; end
+	class NoQuery < StandardError; end
+
+	# "/search" api list
+	SEARCH_LIST = %w[knowledge board cafe blog news book vclip image]
+
+	# "/search/dic" api list
+	DIC_LIST = %w[jpdic]
+
+	# "/shopping" api list
+	SHOPPING_LIST = %w[search detail]
+
+	# Method list
+	METHOD_LIST = SEARCH_LIST + DIC_LIST + SHOPPING_LIST
+
+	# Methods returning "channel" element as a document root
+	DIFF_DOC_ROOT_LIST = %w[book jpdic]
 
+	# Abbreviation for passing options
+	ABBREVIATION = {:re => :result, :p => :pageno, :ra => :range, :o => :output, :s => :sort,
+									:ta => :target, :c => :condition, :ci => :cate_id, :st => :searchType, :ts => :tagsearch,
+									:di => :docid, :g => :group, :req => :requestor, :ti => :title}
 end

data/lib/daum/base.rb

@@ -0,0 +1,65 @@
+module Daum
+
+	# fundamental class for naver gem
+	class Base
+
+		# attributes for accessing retrieved raw xml and parsed libxml root node
+		attr_accessor :doc_root, :raw_xml
+
+		# Replace this API key with your own (see http://dna.daum.net/apis)
+		def initialize(key=nil)
+			@key = key
+			@host = 'http://apis.daum.net'
+		end
+
+		def method_missing(target, query, params={})
+			raise NoQuery if query.empty?
+			if METHOD_LIST.include?(target.to_s)
+				request(target, query, params)
+				return RSS.new(@doc_root, target)
+			else
+				raise NoMethod
+			end
+		end
+
+		# Takes a Daum API method name and set of parameters; returns an libxml object with the response
+		def request(target, query, params={})
+			response = http_get(request_url(target, query, params))
+			parser, parser.string = LibXML::XML::Parser.new, response
+			@raw_xml = parser.parse
+			@doc_root = @raw_xml.root
+		end
+
+		# Takes a Daum API method name and set of parameters; returns the correct URL for the REST API.
+		def request_url(target, query, params={})
+			url = @host
+			if SEARCH_LIST.include?(target.to_s)
+				url += "/search/#{target}"
+			elsif DIC_LIST.include?(target.to_s)
+				url += "/search/dic/#{target}"
+			elsif SHOPPING_LIST.include?(target.to_s)
+				url += "/shopping/#{target}"
+			elsif SUGGEST_LIST.include?(target.to_s)
+				url += "/suggest/#{target}"
+			end
+
+			unless target.to_s == "detail"
+				url += "?apikey=#{@key}&q=#{query}"
+			else
+				url += "?apikey=#{@key}&docid=#{query}"
+			end
+
+			params.each do |key, value|
+				key = ABBREVIATION[key] unless ABBREVIATION[key].nil?
+				url += "&#{key}=" + CGI::escape(value)
+			end unless params.nil?
+			url
+		end
+
+		# Does an HTTP GET on a given URL and returns the response body
+		def http_get(url)
+			Net::HTTP.get_response(URI.parse(URI.encode(url))).body.to_s
+		end
+
+	end
+end

data/lib/daum/item.rb

@@ -0,0 +1,16 @@
+module Daum
+
+	# contains each item's information and converts XML format to Ruby format
+  class Item
+
+		# creates Item class object from libxml node input
+    def initialize(doc)
+			if cs = doc.children
+				cs.each do |c|
+					Item.class_eval("attr_accessor :#{c.name}")
+					self.instance_variable_set("@#{c.name}", c.content)
+				end
+			end
+    end
+  end
+end

data/lib/daum/rss.rb

@@ -0,0 +1,31 @@
+module Daum
+
+	# contains RSS type return and converts XML format to Ruby format
+  class RSS
+
+		# variable for accessing items
+		attr_accessor :items
+
+		# creates RSS class object from libxml node input
+    def initialize(doc_root, target)
+			if DIFF_DOC_ROOT_LIST.include?(target.to_s)
+				channel = doc_root
+			else
+				channel = doc_root.find("channel").first
+			end
+			
+			if cs = channel.children
+				cs.each do |c|
+					next if c.name == "item"
+					RSS.class_eval("attr_accessor :#{c.name}")
+					self.instance_variable_set("@#{c.name}", c.content)
+				end
+			end
+
+			@items = []
+			channel.find("item").each do |i|
+				@items << Item.new(i)
+			end
+    end
+  end
+end

data/test/test_daum.rb

@@ -0,0 +1,23 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'daum'
+
+class TestDaum < Test::Unit::TestCase
+
+	# sets up basic setting for unit testing
+	def setup
+		# insert your own Naver API key
+		@d = Daum::Base.new('your_key')
+	end
+
+	def test_allmethod
+		@d.knowledge("삼국지").items.each do |i|
+			puts i.title
+		end
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oksure-daum
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Hyunwoo Park
@@ -9,27 +9,48 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-22 00:00:00 -08:00
+date: 2008-12-17 00:00:00 -08:00
 default_executable: 
-dependencies: []
-
-description: Ruby Gem for Daum API
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: Ruby Gem for Daum OpenAPI
 email: hwpark@oksurerails.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG.rdoc
+- lib/daum/base.rb
+- lib/daum/item.rb
+- lib/daum/rss.rb
 - lib/daum.rb
 - README.rdoc
 files: 
+- CHANGELOG.rdoc
+- daum.gemspec
+- init.rb
+- lib/daum/base.rb
+- lib/daum/item.rb
+- lib/daum/rss.rb
 - lib/daum.rb
+- Manifest
 - Rakefile
 - README.rdoc
-- Manifest
-- daum.gemspec
+- test/test_daum.rb
 has_rdoc: true
-homepage: http://oksurerails.com/daum
+homepage: http://oksurerails.com/ruby/daum
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -58,6 +79,6 @@ rubyforge_project: daum
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Ruby Gem for Daum API
-test_files: []
-
+summary: Ruby Gem for Daum OpenAPI
+test_files: 
+- test/test_daum.rb