Skip to content

Commit

Permalink
version 0.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
oksure committed Dec 5, 2008
1 parent 6ac4340 commit 1d13dc1
Show file tree
Hide file tree
Showing 31 changed files with 2,799 additions and 51 deletions.
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
pkg
doc
Manifest
nbproject

nbproject
44 changes: 35 additions & 9 deletions CHANGELOG.rdoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,43 @@
== 0.3.1, release 2008-12-05

* Every search method will no longer return libxml node object. It will return self-defined RSS or Result object.
* implemented easy access to each element in RSS/XML results by calling instance variables
* added test file (You can refer this file for understanding usage of this gem.)
* added documentation files (ri, RDoc)
* fixed searching for "doc" (The name was overlapped with an instance variable.)
* revised readme file to remove important note and instruction for installing from github
* 서치 메소드들이 더 이상 libxml 노드 오브젝트를 반환하지 않습니다. 대신에, 자체 정의된 RSS 또는 Result 오브젝트를 반환합니다.
* 인스턴스 변수를 쓰는 것으로 RSS/XML 결과들의 각 엘러먼트에 쉽게 접근할 수 있도록 함
* 테스트 파일 추가 (이 파일을 참조하여 이 젬의 사용법을 이해하실 수 있습니다.)
* 문서 파일 추가 (ri, RDoc)
* "doc"에 대해서 검색이 안 되던 것을 고침 (인스턴스 변수와 이름이 중복되어 있었음)
* Readme 파일을 수정하여 중요 공지를 지우고 github로부터 설치하는 방법을 지움


== 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에만 있었음)
* converted class Naver to module Naver ("Naver.new" is no longer available)
* implemented method missing to use search target name as method
* added abbreviation hash for passing arguments
* added Korean parts of readme and changelog files
* distributed on rubyforge.org as well (originally only available on github)
* 클래스에서 모듈로 구조 변경 ("Naver.new"는 더 이상 사용 불가)
* 메소드 미싱을 구현하여 검색 타겟을 메소드로 호출할 수 있게 함
* 검색 조건 넘길 때 약어로 넘길 수 있게 함
* readme와 changelog에 한글 부분 추가
* 루비포지에서도 배포 (원래는 github에만 있었음)

== 0.1.1, release 2008-11-23

* primitive 'request' method implemented / 원시 'request' 메소드 구현
* added init.rb / init.rb 파일 추가
* primitive 'request' method implemented
* added init.rb
* 원시 'request' 메소드 구현
* init.rb 파일 추가


== 0.0.1, release 2008-11-22

* first commit / 첫 번째 커밋
* no classes, methods implemented / 아직 아무 것도 안 했음
* first commit
* no classes, methods implemented
* 첫 번째 커밋
* 아직 아무 것도 안 했음
28 changes: 11 additions & 17 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,15 @@
= Naver 0.2.1
= Naver 0.3.1

Ruby gem for using Naver OpenAPI (http://dev.naver.com/openapi/tutorial).
네이버 OpenAPI를 위한 루비젬입니다.


== 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 / 설치법

You can install the gem from rubyforge directly.
루비포지에서 바로 설치하실 수 있습니다.
gem install naver

Or, you can also install from github. The name is diffrent, which is precedented by my id on github.
아니면, github에서 설치할 수도 있습니다. 젬의 이름이 다른데, 저의 github 아이디가 앞에 붙습니다.
gem sources -a http://gems.github.com
gem install oksure-naver


== Usage / 사용법

Expand All @@ -32,11 +19,18 @@ Before using this gem, you need to get your own API key. To obtain your API key,
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 root node as libxml node / libxml 형식의 노드로 루트 노드를 반환합니다
naver.kin("go", {:d => "5", :start => "5", :so => "sim"}) ### It's possible to use abbreviation for each option / 검색 옵션을 넘길 때 약어를 사용 가능합니다
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)을 참고하시면 됩니다.


== Abbreviation List / 약어 목록
== Search Option Abbreviation List / 검색 옵션 약어 목록

The full list of abbreviation codes is the following. (You can still use full name of each parameter.)
약어 전체 목록을 아래에 정리하였습니다. (약어를 쓰지 않으셔도 작동합니다.)
Expand Down
4 changes: 2 additions & 2 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ require 'rubygems'
require 'rake'
require 'echoe'

Echoe.new('naver', '0.2.1') do |p|
Echoe.new('naver', '0.3.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"]
p.development_dependencies = ["libxml-ruby >=0.9.2"]
end

Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
Expand Down
188 changes: 188 additions & 0 deletions doc/classes/Naver.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: Naver</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[

function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}

function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;

elemStyle = elem.style;

if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}

return true;
}

// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )

// ]]>
</script>

</head>
<body>



<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">Naver</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/naver/base_rb.html">
lib/naver/base.rb
</a>
<br />
<a href="../files/lib/naver/item_rb.html">
lib/naver/item.rb
</a>
<br />
<a href="../files/lib/naver/result_rb.html">
lib/naver/result.rb
</a>
<br />
<a href="../files/lib/naver/rss_rb.html">
lib/naver/rss.rb
</a>
<br />
<a href="../files/lib/naver_rb.html">
lib/naver.rb
</a>
<br />
</td>
</tr>

</table>
</div>
<!-- banner header -->

<div id="bodyContent">



<div id="contextContent">



</div>


</div>


<!-- if includes -->
<div id="includes">
<h3 class="section-bar">Included Modules</h3>

<div id="includes-list">
<span class="include-name">LibXML</span>
</div>
</div>

<div id="section">

<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>

Class <a href="Naver/Base.html" class="link">Naver::Base</a><br />
Class <a href="Naver/Item.html" class="link">Naver::Item</a><br />
Class <a href="Naver/NoMethod.html" class="link">Naver::NoMethod</a><br />
Class <a href="Naver/NoQuery.html" class="link">Naver::NoQuery</a><br />
Class <a href="Naver/RSS.html" class="link">Naver::RSS</a><br />
Class <a href="Naver/Result.html" class="link">Naver::Result</a><br />

</div>

<div id="constants-list">
<h3 class="section-bar">Constants</h3>

<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">RSS_LIST</td>
<td>=</td>
<td class="context-item-value">%w[kin video image doc book book_adv local shop encyc krdic endic jpdic blog cafe cafearticle webkr news]</td>
<td width="3em">&nbsp;</td>
<td class="context-item-desc">
Searches that returns results in <a href="Naver/RSS.html">RSS</a> format

</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">XML_LIST</td>
<td>=</td>
<td class="context-item-value">%w[rank ranktheme recmd adult errata shortcut]</td>
<td width="3em">&nbsp;</td>
<td class="context-item-desc">
Searches that returns results in Non-<a href="Naver/RSS.html">RSS</a> but
XML format

</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">METHOD_LIST</td>
<td>=</td>
<td class="context-item-value">RSS_LIST.concat(XML_LIST)</td>
<td width="3em">&nbsp;</td>
<td class="context-item-desc">
Whole available search list

</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">ABBREVIATION</td>
<td>=</td>
<td class="context-item-value">{:d =&gt; :display, :st =&gt; :start, :so =&gt; :sort, :f =&gt; :filter, :p =&gt; :payment, :dt =&gt; :d_titl, :da =&gt; :d_auth, :dco =&gt; :d_cont, :di =&gt; :d_isbn, :dp =&gt; :d_publ, :ddaf =&gt; :d_dafr, :ddat =&gt; :d_dato, :dca =&gt; :d_catg}</td>
<td width="3em">&nbsp;</td>
<td class="context-item-desc">
Abbreviation for passing options

</td>
</tr>
</table>
</div>
</div>






<!-- if method_list -->


</div>


<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>
Loading

0 comments on commit 1d13dc1

Please sign in to comment.