archives 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+== 0.0.1, release 2008-12-12
+
+* Initial commit and search function implemented
+* 최초 커밋, 검색 기능 구현

data/Manifest

@@ -0,0 +1,11 @@
+CHANGELOG.rdoc
+init.rb
+lib/archives/base.rb
+lib/archives/item.rb
+lib/archives/rss.rb
+lib/archives.rb
+rakefile
+README.rdoc
+test/test_archives.rb
+Rakefile
+Manifest

data/README.rdoc

@@ -0,0 +1,62 @@
+= Archives 0.0.1
+
+Ruby gem for using Korea Government Archives Search OpenAPI (http://search.archives.go.kr/ArchivesHelp06.htm).
+대한민국 국가기록원 나라기록검색 OpenAPI를 위한 루비젬입니다.
+
+
+== Install / 설치법
+
+You can install the gem from rubyforge directly.
+루비포지에서 바로 설치하실 수 있습니다.
+	gem install archives
+
+
+== Usage / 사용법
+
+Before using this gem, you need to get your own API key. To obtain your API key, see http://search.archives.go.kr/ArchivesHelp06.htm.
+이 젬을 사용하기 전에 API 키를 발급 받으셔야 합니다. API 키 발급을 위해서는 http://search.archives.go.kr/ArchivesHelp06.htm 링크를 참고해 주세요.
+
+	require 'archives'
+	archives = Archives::Base.new(api_key)		### create a Archives client / Archives 클라이언트를 생성합니다
+	archives.request("한국전쟁")		### search without any options / 아무 조건 없이 쿼리만으로 검색할 수 있습니다
+	archives.request("한국전쟁", {:rc_type => "rfile", :prod_year_start => "2005"})		### return RSS object defined in this gem / 자체 정의된 RSS 클래스 오브젝트를 반환합니다
+	archives.request("한국전쟁", {:rt => "rfile", :pys => "2005"})		### you can use abbreviation
+	archives.request("한국전쟁").title		### return title of RSS object
+	archives.request("한국전쟁").items.each do |i|		### iteration over items
+		i.title		### title of each item
+	end
+
+You may want to take a look at the test file (test/test_archives.rb) to better understand the usage.
+보다 자세한 사용법을 이해하시길 원하시면 테스트 파일 (test/test_archives.rb)을 참고하시면 됩니다.
+
+
+== Search Option Abbreviation List / 검색 옵션 약어 목록
+
+The full list of abbreviation codes is the following. (You can still use full name of each parameter.)
+약어 전체 목록을 아래에 정리하였습니다. (약어를 쓰지 않으셔도 작동합니다.)
+
+	rt = rc_type
+	pys = prod_year_start
+	pye = prod_year_end
+	pc = prod_code
+	pdc = prod_dir_code
+	io = is_open
+	or = online_reading
+	ret = record_type
+	dt = doc_type
+	mo = mgt_organ
+	s = sort
+	o = order
+	d = display
+	p = pageno
+	qp = query_phrase
+	qo = query_or
+	qe = query_exclude
+	qt = query_type
+	qf = query_field
+
+
+== License
+
+Copyright:: Copyright (c) 2008 Hyunwoo Park <hwpark@oksurerails.com>
+License::   MIT <http://www.opensource.org/licenses/mit-license.php>

data/Rakefile

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

data/archives.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{archives}
+  s.version = "0.0.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-12-11}
+  s.description = %q{Ruby Gem for Korea Government Archives Search OpenAPI}
+  s.email = %q{hwpark@oksurerails.com}
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/archives/base.rb", "lib/archives/item.rb", "lib/archives/rss.rb", "lib/archives.rb", "README.rdoc"]
+  s.files = ["CHANGELOG.rdoc", "init.rb", "lib/archives/base.rb", "lib/archives/item.rb", "lib/archives/rss.rb", "lib/archives.rb", "rakefile", "README.rdoc", "test/test_archives.rb", "Rakefile", "Manifest", "archives.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://oksurerails.com/ruby/archives}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Archives", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{archives}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby Gem for Korea Government Archives Search OpenAPI}
+  s.test_files = ["test/test_archives.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-ruby>, [">= 0.9.2"])
+    else
+      s.add_dependency(%q<libxml-ruby>, [">= 0.9.2"])
+    end
+  else
+    s.add_dependency(%q<libxml-ruby>, [">= 0.9.2"])
+  end
+end

data/init.rb

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

data/lib/archives.rb

@@ -0,0 +1,35 @@
+# = Archives
+#   An easy interface to the Korea Government Archives Search 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 <http://www.opensource.org/licenses/mit-license.php>
+#
+# USAGE:
+#  require 'archives'
+#  archives = Archives::Base.new('api_key')		### create a archives client
+#  archives.request("한국전쟁")		### search without any options
+#  archives.request("한국전쟁", {:rc_type => "rfile", :prod_year_start => "2005"})		### return RSS object defined in this gem
+#  archives.request("한국전쟁", {:rt => "rfile", :pys => "2005"})		### you can use abbreviation
+#  archives.request("한국전쟁").title		### return title of RSS object
+#  archives.request("한국전쟁").items.each do |i|		### iteration over items
+#    i.title		### title of each item
+#  end
+
+%w[cgi net/http libxml].each {|lib| require lib}
+
+$:.unshift(File.join(File.dirname(__FILE__)))
+
+require "archives/base"
+require "archives/rss"
+require "archives/item"
+
+module Archives
+  include LibXML
+
+	# Abbreviation for passing options
+	ABBREVIATION = {:rt => :rc_type, :pys => :prod_year_start, :pye => :prod_year_end, :pc => :prod_code, :pdc => :prod_dir_code,
+									:io => :is_open, :or => :online_reading, :ret => :record_type, :dt => :doc_type, :mo => :mgt_organ,
+									:s => :sort, :o => :order, :d => :display, :p => :pageno, :qp => :query_phrase, :qo => :query_or,
+									:qe => :query_exclude, :qt => :query_type, :qf => :query_field}
+end

data/lib/archives/base.rb

@@ -0,0 +1,41 @@
+module Archives
+
+	# 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://dev.naver.com/openapi/register)
+		def initialize(key=nil)
+			@key = key
+			@host = 'http://search.archives.go.kr/openapi'
+			@api = '/search.arc'
+		end
+
+		# Takes a Archives API method name and set of parameters; returns an RSS object with the response
+		def request(query, params={})
+			response = http_get(request_url(query, params))
+			parser, parser.string = LibXML::XML::Parser.new, response
+			@raw_xml = parser.parse
+			@doc_root = @raw_xml.root
+			RSS.new(@doc_root)
+		end
+
+		# Takes a Archives API method name and set of parameters; returns the correct URL for the REST API.
+		def request_url(query, params={})
+			url = "#{@host}#{@api}?key=#{@key}&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(URI.encode(url))).body.to_s
+		end
+
+	end
+end

data/lib/archives/item.rb

@@ -0,0 +1,16 @@
+module Archives
+
+	# 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/archives/rss.rb

@@ -0,0 +1,23 @@
+module Archives
+
+	# 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)
+      channel = doc_root.find("//rss/channel").first
+			%w[title total].each do |f|
+				RSS.class_eval("attr_accessor :#{f}")
+				self.instance_variable_set("@#{f}", channel.find(f).first.content)
+			end
+
+			@items = []
+			channel.find("item").each do |i|
+				@items << Item.new(i)
+			end
+    end
+  end
+end

data/rakefile

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

data/test/test_archives.rb

@@ -0,0 +1,66 @@
+# == IMPORTANT!
+# This test consumes about 5 query quota of your API key.
+# == 중요!
+# 이 테스트 파일은 사용자 API Key에 할당된 분량 중, 약 5회 정도의 쿼리 수량을 소모합니다.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'archives'
+
+class TestArchives < Test::Unit::TestCase
+
+	# sets up basic setting for unit testing
+	def setup
+		# insert your own Archives API key
+		@a = Archives::Base.new('your_key')
+	end
+
+	# test printing basic elements
+	def test_basic_element
+		a = @a.request("한국전쟁")
+		puts a.title
+		puts a.total
+	end
+
+	# test passing options
+	def test_passing_options
+		a = @a.request("한국전쟁", {:rc_type => "rfile", :prod_year_start => "2005"})
+		puts a.title
+		puts a.total
+	end
+
+	# test passing options in abbreviation
+	def test_passing_options_abbreviation
+		a = @a.request("한국전쟁", {:rt => "rfile", :pys => "2005"})
+		puts a.title
+		puts a.total
+	end
+
+	# test iteration over items
+	def test_iteration_items
+		a = @a.request("한국전쟁")
+		a.items.each do |i|
+			puts i.title
+		end
+	end
+
+	# test all output fields
+	def test_all_output_fields
+		a = @a.request("한국전쟁")
+		i = a.items.first
+		puts i.rc_type
+		puts i.rc_code
+		puts i.rc_rfile_no
+		puts i.rc_ritem_no
+		puts i.title
+		puts i.mgt_org_name
+		puts i.prod_name
+		puts i.prod_year
+		puts i.is_open
+		puts i.arcave_type
+		puts i.doc_type
+		puts i.online_reading
+		puts i.link
+	end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: archives
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Hyunwoo Park
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: Ruby Gem for Korea Government Archives Search OpenAPI
+email: hwpark@oksurerails.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- lib/archives/base.rb
+- lib/archives/item.rb
+- lib/archives/rss.rb
+- lib/archives.rb
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- init.rb
+- lib/archives/base.rb
+- lib/archives/item.rb
+- lib/archives/rss.rb
+- lib/archives.rb
+- rakefile
+- README.rdoc
+- test/test_archives.rb
+- Rakefile
+- Manifest
+- archives.gemspec
+has_rdoc: true
+homepage: http://oksurerails.com/ruby/archives
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Archives
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: archives
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Ruby Gem for Korea Government Archives Search OpenAPI
+test_files: 
+- test/test_archives.rb