oksure-naver 0.1.1 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,9 +1,17 @@
+== 0.2.1, release 2008-12-04
+
+* converted class Naver to module Naver ("Naver.new" is no longer available) / 클래스에서 모듈로 구조 변경 ("Naver.new"는 더 이상 사용 불가)
+* implemented method missing to use search target name as method / 메소드 미싱을 구현하여 검색 타겟을 메소드로 호출할 수 있게 함
+* added abbreviation hash for passing arguments / 검색 조건 넘길 때 약어로 넘길 수 있게 함
+* added Korean parts of readme and changelog files / readme와 changelog에 한글 부분 추가
+* distributed on rubyforge.org as well (originally only available on github) / 루비포지에서도 배포 (원래는 github에만 있었음)
+
 == 0.1.1, release 2008-11-23
 
-* primitive 'request' method implemented
-* added init.rb
+* primitive 'request' method implemented / 원시 'request' 메소드 구현
+* added init.rb / init.rb 파일 추가
 
 == 0.0.1, release 2008-11-22
 
-* first commit
-* no classes, methods implemented
+* first commit / 첫 번째 커밋
+* no classes, methods implemented / 아직 아무 것도 안 했음

data/README.rdoc

@@ -1,21 +1,53 @@
-= Naver
+= Naver 0.2.1
 
 Ruby gem for using Naver OpenAPI (http://dev.naver.com/openapi/tutorial).
+네이버 OpenAPI를 위한 루비젬입니다.
 
 
-== Install
+== IMPORTANT NOTE / 중요 공지
+
+Since this is still in development stage, every method or usage may be deprecated in future versions without any prior notice. (I will try to keep track of changes in CHANGELOG.rdoc, though.)
+Although I read the Rational Versioning Policy, I would change the middle number when some old codes might not work well with updates since Naver gem is still in development stage. When this gem considered stable, I will follow the RVP.
+현재 초기 작업 단계이기 때문에, 사전 공지 없이 모든 메소드나 사용법이 미래 버전에서는 사용하게 없게 될 수도 있습니다. (물론 CHANGELOG.rdoc에 변화 사항들을 기록하려고 노력은 하겠습니다만)
+Rational Versioning Policy에 대해서 읽기는 했습니다만, 역시 아직 초기 개발 단계라서 과거 버전과 compatible하지 않은 버전을 릴리즈할 경우에 버전의 첫째 자리가 아닌 중간 자리 숫자를 변경할 생각입니다.
+
+
+== Install / 설치법
 
 	gem sources -a http://gems.github.com
 	gem install oksure-naver
 
 
-== Usage
+== Usage / 사용법
 
 Before using this gem, you need to get your own API key. To obtain your API key, see http://dev.naver.com/openapi/register.
+이 젬을 사용하기 전에 API 키를 발급 받으셔야 합니다. API 키 발급을 위해서는 http://dev.naver.com/openapi/register 링크를 참고해 주세요.
 
 	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
+	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 root node as libxml node / libxml 형식의 노드로 루트 노드를 반환합니다
+	naver.kin("go", {:d => "5", :start => "5", :so => "sim"})		### It's possible to use abbreviation for each option / 검색 옵션을 넘길 때 약어를 사용 가능합니다
+
+
+== Abbreviation List / 약어 목록
+
+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
 
 
 == License

data/Rakefile

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

data/lib/naver/base.rb

@@ -0,0 +1,47 @@
+module Naver
+  include LibXML
+
+	class Base
+
+		attr_accessor :doc, :raw_xml
+
+		# Replace this API key with your own (see http://dev.naver.com/openapi/register)
+		def initialize(key=nil)
+			@key = key
+			@host = 'http://openapi.naver.com'
+			@api = '/search'
+		end
+
+		def method_missing(target, query, params={})
+			if METHOD_LIST.include?(target.to_s)
+				request(target, query, params)
+			else
+				raise NoMethod
+			end
+		end
+
+		# Takes a Naver 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 = @raw_xml.root
+		end
+
+		# Takes a Naver API method name and set of parameters; returns the correct URL for the REST API.
+		def request_url(target, query, params={})
+			url = "#{@host}#{@api}?key=#{@key}&target=#{target}&query=#{query}"
+			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(url)).body.to_s
+		end
+
+	end
+end

data/lib/naver.rb

@@ -9,40 +9,34 @@
 #  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
-
+#
+# To Do:
+#  local search implementation
 
 require "cgi"
 require "net/http"
-require "xml"
-
-class Naver
-
-	# Replace this API key with your own (see http://dev.naver.com/openapi/register)
-	def initialize(key=nil)
-		@key = key
-		@host = 'http://openapi.naver.com'
-		@api = '/search'
-	end
-
-  # Takes a Naver 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 = XML::Parser.new
-		parser.string = response
-	  doc = parser.parse
-		doc.root
-  end
-
-  # Takes a Naver API method name and set of parameters; returns the correct URL for the REST API.
-  def request_url(target, query, params={})
-    url = "#{@host}#{@api}?key=#{@key}&target=#{target}&query=#{query}"
-		params.each { |key, value| url += "&#{key}=" + CGI::escape(value) } 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(url)).body.to_s
-  end
+require "libxml"
+
+$:.unshift(File.join(File.dirname(__FILE__)))
+require "naver/base"
+
+module Naver
+	class NoMethod < StandardError; end
+
+	# Searches that returns results in RSS format
+	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 Non-RSS but XML format
+	XML_LIST = %w[rank rankthem recmd adult errata shortcut]
+
+	# Whole available search list
+	METHOD_LIST = RSS_LIST.concat(XML_LIST)
+
+	# Abbreviation for passing options
+	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}
 
+  SourceName = 'navergem'
+	
 end

data/naver.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{naver}
-  s.version = "0.1.1"
+  s.version = "0.2.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-23}
+  s.date = %q{2008-12-04}
   s.description = %q{Ruby Gem for Naver OpenAPI}
   s.email = %q{hwpark@oksurerails.com}
-  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/naver.rb", "README.rdoc"]
-  s.files = ["CHANGELOG.rdoc", "init.rb", "lib/naver.rb", "Manifest", "naver.gemspec", "nbproject/private/config.properties", "nbproject/private/private.properties", "nbproject/private/private.xml", "nbproject/private/rake-d.txt", "nbproject/project.properties", "nbproject/project.xml", "Rakefile", "README.rdoc"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/naver/base.rb", "lib/naver.rb", "README.rdoc"]
+  s.files = ["CHANGELOG.rdoc", "init.rb", "lib/naver/base.rb", "lib/naver.rb", "Manifest", "rakefile", "README.rdoc", "Rakefile", "naver.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://oksurerails.com/naver}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Naver", "--main", "README.rdoc"]
@@ -24,11 +24,11 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<libxml-ruby>, [">= 0.9.2"])
+      s.add_development_dependency(%q<libxml-ruby>, [">= 0"])
     else
-      s.add_dependency(%q<libxml-ruby>, [">= 0.9.2"])
+      s.add_dependency(%q<libxml-ruby>, [">= 0"])
     end
   else
-    s.add_dependency(%q<libxml-ruby>, [">= 0.9.2"])
+    s.add_dependency(%q<libxml-ruby>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oksure-naver
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Hyunwoo Park
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-23 00:00:00 -08:00
+date: 2008-12-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.2
+        version: "0"
     version: 
 description: Ruby Gem for Naver OpenAPI
 email: hwpark@oksurerails.com
@@ -29,22 +29,19 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG.rdoc
+- lib/naver/base.rb
 - lib/naver.rb
 - README.rdoc
 files: 
 - CHANGELOG.rdoc
 - init.rb
+- lib/naver/base.rb
 - lib/naver.rb
 - Manifest
-- naver.gemspec
-- nbproject/private/config.properties
-- nbproject/private/private.properties
-- nbproject/private/private.xml
-- nbproject/private/rake-d.txt
-- nbproject/project.properties
-- nbproject/project.xml
-- Rakefile
+- rakefile
 - README.rdoc
+- Rakefile
+- naver.gemspec
 has_rdoc: true
 homepage: http://oksurerails.com/naver
 post_install_message: