naver-sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c55ce738ad94ea471c6009f367ceeb3c218fa7f
-  data.tar.gz: 37cac2f7a5327a355f5780a6db95876407e9b552
+  metadata.gz: 169e8f3de0474b1aafd74629d97c606f721bf728
+  data.tar.gz: f4d679fdf11f3287b42c3917fac0ae6c37f11127
 SHA512:
-  metadata.gz: 7a84999ca63d2a7ee8c375fab770244789ae958d8738ff0ad1dd14d2af1f30b30b4d05af58e1fd4f7852f43d07da6344a3858757fc7fe301f256d415bea0f606
-  data.tar.gz: 3f428fc4872cc930f564fb878ca26ffb3a1cdb41638d2bab07c3461b62752b93a5206af6459bc40ec5b2653184951c334ead3b4a757bd7eb9568cb0e0e2e4d96
+  metadata.gz: 29b617d3bf7793a577969d2d025741c0a115cddc42a0b36041eb616d9f8bf73bda3feb685c87a655381fc2f56be99da314118e18552e3019a22e057179bfd98f
+  data.tar.gz: 57a587e7e8851029f32066856cd54c2f3d3fea3ad52409e15d2e6542fe77c05a82eff12b051200fa5c38578ff1646ce61e4eaf0d45c1dbeba9eb5001355a97f3

data/CHANGELOG.md

@@ -4,9 +4,14 @@ All notable changes to this project will be documented in this file.
 ## [unreleased]
 - No significant changes.
 
+## [0.4.0] - 2017-06-26
+- [breaking] JSON 출력 결과를 CamelCase 에서 underscore 변경
+- [breaking] Naver::Papago.romanization 리턴값의 key 변경. s_first_name -> first_name,
+  a_items -> items
+
 ## [0.3.0] - 2017-06-26
 - [new] 얼굴인식(Beta)
-- [breaking] `Naver::Clova::tts` renamed to `Naver::Voice::tts`.
+- [breaking] `Naver::Clova::tts` renamed to `Naver::Voice.tts`.
 - [breaking] `Naver::Shortenurl::url` renamed to `Naver::Shorturl::shorten`.
 
 ## [0.2.0] - 2017-06-25
@@ -22,4 +27,5 @@ All notable changes to this project will be documented in this file.
 [0.1.0]: https://github.com/kimsuelim/naver-sdk-ruby/releases/tag/v0.1.0
 [0.2.0]: https://github.com/kimsuelim/naver-sdk-ruby/compare/v0.1.0...v0.2.0
 [0.3.0]: https://github.com/kimsuelim/naver-sdk-ruby/compare/v0.2.0...v0.3.0
-[unreleased]: https://github.com/kimsuelim/naver-sdk-ruby/compare/v0.3.0...HEAD
+[0.4.0]: https://github.com/kimsuelim/naver-sdk-ruby/compare/v0.3.0...v0.4.0
+[unreleased]: https://github.com/kimsuelim/naver-sdk-ruby/compare/v0.4.0...HEAD

data/README.md

@@ -57,7 +57,7 @@ response = Naver::Vision.celebrity(image: "test/resources/park.png")
 # => #<Naver::ObjectifiedHash:70286633240760 {hash: {
   "info"=>{
     "size"=>{"width"=>683, "height"=>377},
-    "faceCount"=>1
+    "face_count"=>1
   },
   "faces"=>[
     {"celebrity"=>{"value"=>"박성웅", "confidence"=>1.0}}
@@ -74,16 +74,16 @@ puts response.faces[0].celebrity.value
 ```
 response = Naver::Vision.face(image: "test/resources/park.png")
 # => #<Naver::ObjectifiedHash:70286633075440 {hash: {
-  "info"=>{"size"=>{"width"=>683, "height"=>377}, "faceCount"=>1},
+  "info"=>{"size"=>{"width"=>683, "height"=>377}, "face_count"=>1},
   "faces"=>[
     {
       "roi"=>{"x"=>214, "y"=>106, "width"=>117, "height"=>117},
       "landmark"=>{
-        "leftEye"=>{"x"=>241, "y"=>137},
-        "rightEye"=>{"x"=>296, "y"=>126},
+        "left_eye"=>{"x"=>241, "y"=>137},
+        "right_eye"=>{"x"=>296, "y"=>126},
         "nose"=>{"x"=>271, "y"=>166},
-        "leftMouth"=>{"x"=>250, "y"=>195},
-        "rightMouth"=>{"x"=>309, "y"=>185}
+        "left_mouth"=>{"x"=>250, "y"=>195},
+        "right_mouth"=>{"x"=>309, "y"=>185}
       },
       "gender"=>{"value"=>"male", "confidence"=>0.999884},
       "age"=>{"value"=>"44~48", "confidence"=>0.79507},
@@ -126,8 +126,8 @@ file = File.open("tts.mp3", "wb") { |f| f.write(response) }
 ```ruby
 response = Naver::Papago.romanization(query: "김수림")
 => #<Naver::ObjectifiedHash:70284972145960 {hash: {
-  "sFirstName"=>"김",
-  "aItems"=>[
+  "first_name"=>"김",
+  "items"=>[
     {"name"=>"Kim Soorim", "score"=>"99"},
     {"name"=>"Kim Soolim", "score"=>"97"},
     {"name"=>"Kim Surim", "score"=>"78"},
@@ -135,7 +135,7 @@ response = Naver::Papago.romanization(query: "김수림")
   ]}
 }
 
-puts response.aItems[0].name
+puts response.items[0].name
 # => "Kim Soorim"
 ```
 
@@ -148,11 +148,11 @@ response = Naver::Papago.translate(
   text: "기술이 인간을 대체하는 것이 아니라 인간은 기술의 도움으로 더욱 창조적으로 될 것이라는 믿는다."
 )
 # => #<Naver::ObjectifiedHash:70362563050680 {hash: {
-  "translatedText"=>"To replace the technology not believe that humans are more creatively with the help of technology."
+  "translated_text"=>"To replace the technology not believe that humans are more creatively with the help of technology."
   }
 }
 
-puts response.translatedText
+puts response.translated_text
 # => "To replace the technology not believe that humans are more creatively with the help of technology."
 ```
 
@@ -162,10 +162,11 @@ puts response.translatedText
 
 ```ruby
 response = Naver::Map.geocode(query: "불정로 6")
+# => <Naver::ObjectifiedHash:70145842773600 {hash: {:total=>1, :userquery=>"불정로 6", :items=>[{:address=>"경기도 성남시 분당구 불정로  6 NAVER그린팩토리", :addrdetail=>{:country=>"대한민국", :sido=>"경기도", :sigugun=>"성남시 분당구", :dongmyun=>"불정로", :rest=>" 6 NAVER그린팩토리"}, :is_road_address=>true, :point=>{:x=>127.1052133, :y=>37.3595316}}]}}
 # => [#<Naver::ObjectifiedHash:70284981985920 {hash: {
   "address"=>"경기도 성남시 분당구 불정로  6 NAVER그린팩토리",
   "addrdetail"=>{"country"=>"대한민국", "sido"=>"경기도", "sigugun"=>"성남시 분당구", "dongmyun"=>"불정로", "rest"=>" 6 NAVER그린팩토리"},
-  "isRoadAddress"=>true,
+  "is_road_address"=>true,
   "point"=>{"x"=>127.1052133, "y"=>37.3595316}}}
 ]
 
@@ -183,8 +184,8 @@ response = Naver::Map.reverse_geocode(lat: "127.1141382", lng: "37.3599968")
 # => [#<Naver::ObjectifiedHash:70284981856220 {hash: {
   "address"=>"경기도 성남시 분당구 정자동 257-1",
   "addrdetail"=>{"country"=>"대한민국", "sido"=>"경기도", "sigugun"=>"성남시 분당구", "dongmyun"=>"정자동", "rest"=>"257-1"},
-  "isAdmAddress"=>false,
-  "isRoadAddress"=>false,
+  "is_adm_address"=>false,
+  "is_road_address"=>false,
   "point"=>{"x"=>127.1164925, "y"=>37.3597611}}
   },
   ...
@@ -205,7 +206,7 @@ response = Naver::Shorturl.shorten(url: "https://github.com/kimsuelim")
 # => #<Naver::ObjectifiedHash:70284972276780 {hash: {
   "hash"=>"Fr4K6WFj",
   "url"=>"http://me2.do/Fr4K6WFj",
-  "orgUrl"=>"https://github.com/kimsuelim"}
+  "org_url"=>"https://github.com/kimsuelim"}
 }
 
 puts response.url
@@ -226,7 +227,7 @@ Naver::Share.url(url: "https://github.com/kimsuelim", title: "The unofficial NAV
 ```ruby
 search_results = Naver::Search.blog(query: "블로그")
 # => <Naver::ObjectifiedHash:70284981057980 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 19:11:02 +0900", "total"=>26223046, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 19:11:02 +0900", "total"=>26223046, "start"=>1, "display"=>10,
   "items"=>[
      {
        "title"=>"<b>블로그</b>마케팅교육 어떻게 시작해야 할까요?",
@@ -251,14 +252,14 @@ puts search_results.items[0].bloggername
 ```ruby
 search_results = Naver::Search.news(query: "뉴스")
 # => #<Naver::ObjectifiedHash:70284981108020 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 19:17:32 +0900", "total"=>31804178, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 19:17:32 +0900", "total"=>31804178, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"'믿듣맘무' 마마무, 걸그룹 음원차트 평정… 멜론 누적 이용자수 94만명 돌파",
       "originallink"=>"http://enews24.tving.com/news/article.asp?nsID=1221358",
       "link"=>"http://news.naver.com/main/read.nhn?mode=LSD&mid=sec&sid1=106&oid=404&aid=0000180862",
       "description"=>"녹아져 있는, 밉지 않은 귀여운 허세가 인상적인 큐티 허세송이다. 한편 마마무는 24일 MBC '쇼! 음악중심' 무대에 오른다. 사진 = RBW 제공 이지영 기자 [Copyright ⓒ Asia No.1 연예<b>뉴스</b> enews24.net 무단전재 및 재배포 금지]",
-      "pubDate"=>"Sat, 24 Jun 2017 19:15:00 +0900"
+      "pub_date"=>"Sat, 24 Jun 2017 19:15:00 +0900"
     },
     ...
   ]
@@ -272,7 +273,7 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.book(query: "책")
 # => #<Naver::ObjectifiedHash:70284982544600 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:08:46 +0900", "total"=>555896, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:08:46 +0900", "total"=>555896, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"너의 이름은",
@@ -309,7 +310,7 @@ puts response.adult
 ```ruby
 search_results = Naver::Search.encyc(query: "백과 사전")
 # => #<Naver::ObjectifiedHash:70284982397080 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:12:58 +0900", "total"=>4332, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:12:58 +0900", "total"=>4332, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"<b>백과사전</b>",
@@ -329,17 +330,17 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.movie(query: "킬빌")
 # => #<Naver::ObjectifiedHash:70284982296880 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:15:41 +0900", "total"=>3, "start"=>1, "display"=>3,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:15:41 +0900", "total"=>3, "start"=>1, "display"=>3,
   "items"=>[
     {
       "title"=>"<b>킬 빌</b> - 2부",
       "link"=>"http://movie.naver.com/movie/bi/mi/basic.nhn?code=37493",
       "image"=>"http://imgmovie.naver.com/mdi/mit110/0374/C7493-00.jpg",
       "subtitle"=>"Kill Bill: Vol. 2",
-      "pubDate"=>"2004",
+      "pub_date"=>"2004",
       "director"=>"쿠엔틴 타란티노|",
       "actor"=>"우마 서먼|데이빗 캐러딘|",
-      "userRating"=>"7.48"
+      "user_rating"=>"7.48"
     },
     ...
   ]
@@ -353,7 +354,7 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.cafearticle(query: "카페글")
 # => #<Naver::ObjectifiedHash:70284982183260 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:17:56 +0900", "total"=>216425, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:17:56 +0900", "total"=>216425, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"예전 <b>카페글</b> 복습하기",
@@ -374,7 +375,7 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.kin(query: "지식인")
 # => #<Naver::ObjectifiedHash:70284982086840 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:20:19 +0900", "total"=>6931274, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:20:19 +0900", "total"=>6931274, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"<b>지식인</b> 디렉토리 변경",
@@ -393,7 +394,7 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.local(query: "제주도")
 # => #<Naver::ObjectifiedHash:70284981059020 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:51:22 +0900", "total"=>75791, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:51:22 +0900", "total"=>75791, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"제주특별자치도청",
@@ -402,7 +403,7 @@ search_results = Naver::Search.local(query: "제주도")
       "description"=>"제주 뉴스, 생활민원, 여권발급, 문화, <b>제주도</b> 관광, 산업경제, 복지, 여성 정보 수록.",
       "telephone"=>"",
       "address"=>"제주특별자치도 제주시 연동 312-1 ",
-      "roadAddress"=>"제주특별자치도 제주시 문연로 6 ",
+      "road_address"=>"제주특별자치도 제주시 문연로 6 ",
       "mapx"=>"260641",
       "mapy"=>"100237"
     },
@@ -429,7 +430,7 @@ puts response.errata
 ```ruby
 search_results = Naver::Search.webkr(query: "웹문서")
 # => #<Naver::ObjectifiedHash:70284981547180 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:53:29 +0900", "total"=>1904994, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:53:29 +0900", "total"=>1904994, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"카카오톡 <b>웹문서</b> 수집 인정 &quot;다음 검색 연동 중단&quot; - 오마이뉴스",
@@ -448,7 +449,7 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.image(query: "이미지")
 # => #<Naver::ObjectifiedHash:70284981346800 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:54:58 +0900", "total"=>1627087, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:54:58 +0900", "total"=>1627087, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"볼매뿌뿌's StyleShare",
@@ -469,7 +470,7 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.shop(query: "쇼핑")
 # => #<Naver::ObjectifiedHash:70284981152140 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:56:19 +0900", "total"=>8895965, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:56:19 +0900", "total"=>8895965, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"팩앤롤 접이식 휴대용 핸드 <b>쇼핑</b>카트",
@@ -478,8 +479,8 @@ search_results = Naver::Search.shop(query: "쇼핑")
       "lprice"=>"10400",
       "hprice"=>"0",
       "mallName"=>"베이직기프트",
-      "productId"=>"11449581836",
-      "productType"=>"2"
+      "product_id"=>"11449581836",
+      "product_type"=>"2"
     },
     ...
   ]
@@ -493,7 +494,7 @@ puts search_results.items[0].title
 ```ruby
 search_results = Naver::Search.doc(query: "전문자료")
 # => #<Naver::ObjectifiedHash:70284980468480 {hash: {
-  "lastBuildDate"=>"Sat, 24 Jun 2017 20:57:34 +0900", "total"=>41554, "start"=>1, "display"=>10,
+  "last_build_date"=>"Sat, 24 Jun 2017 20:57:34 +0900", "total"=>41554, "start"=>1, "display"=>10,
   "items"=>[
     {
       "title"=>"이미지 검색 기능을 가진 문서간 <b>전문자료</b>의 유사도 검색 시스템",

data/lib/naver/client.rb

@@ -10,8 +10,10 @@ module Naver # :nodoc:
     # Converts the response body to an ObjectifiedHash.
     def self.parse(body)
       if body.is_a?(Hash)
+        body = body.to_underscore_keys
         ObjectifiedHash.new(body)
       elsif body.is_a?(Array)
+        body = body.to_underscore_keys
         body.collect! { |e| ObjectifiedHash.new(e) }
       elsif body
         true

data/lib/naver/ext/hash/to_underscore_keys.rb

@@ -0,0 +1,40 @@
+# Hash.to_underscore_keys
+class Hash
+  # Recursively converts CamelCase hash keys to underscore
+  def to_underscore_keys(value = self)
+    case value
+    when Array
+      value.map { |v| to_underscore_keys(v) }
+    when Hash
+      underscore_hash(value)
+    else
+      value
+    end
+  end
+
+  private
+
+  def underscore_hash(value)
+    Hash[value.map { |k, v| [underscore_key(k), to_underscore_keys(v)] }]
+  end
+
+  def underscore_key(key)
+    if key.is_a?(Symbol)
+      underscore(key.to_s).to_sym
+    elsif key.is_a?(String)
+      underscore(key)
+    else
+      key # can't snakify anything except strings and symbols
+    end
+  end
+
+  def underscore(camel_cased_word)
+    return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+    word = camel_cased_word.to_s.gsub("::".freeze, "/".freeze)
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2'.freeze)
+    word.gsub!(/([a-z\d])([A-Z])/, '\1_\2'.freeze)
+    word.tr!("-".freeze, "_".freeze)
+    word.downcase!
+    word
+  end
+end

data/lib/naver/map.rb

@@ -5,14 +5,14 @@ module Naver # :nodoc:
       # 주소 -> 좌표 변환
       # @param params [Hash] Params for the search
       def geocode(params = {})
-        parse(JSON.parse(connection.get("/v1/map/geocode", params).body)["result"]["items"])
+        parse(JSON.parse(connection.get("/v1/map/geocode", params).body)["result"])
       end
 
       # 좌표 -> 주소 변환
       # @param params [Hash] Params for the search
       def reverse_geocode(params = {})
         params = { query: "#{params[:lat]}, #{params[:lng]}" }
-        parse(JSON.parse(connection.get("/v1/map/reversegeocode", params).body)["result"]["items"])
+        parse(JSON.parse(connection.get("/v1/map/reversegeocode", params).body)["result"])
       end
     end
   end

data/lib/naver/papago.rb

@@ -17,7 +17,12 @@ module Naver # :nodoc:
       # @return [Hash] 변환 결과
       def romanization(query:)
         params = { query: query }
-        parse(JSON.parse(connection.get("/v1/krdict/romanization", params).body)["aResult"][0])
+        result = JSON.parse(connection.get("/v1/krdict/romanization", params).body)["aResult"][0]
+        if result
+          result["firstName"] = result.delete("sFirstName")
+          result["items"] = result.delete("aItems")
+        end
+        parse(result)
       end
     end
   end

data/lib/naver/sdk.rb

@@ -2,6 +2,7 @@ require "oauth2"
 require "faraday"
 
 require "naver/sdk/version"
+require "naver/ext/hash/to_underscore_keys"
 require "naver/config"
 require "naver/connection"
 require "naver/client"

data/lib/naver/sdk/version.rb

@@ -1,5 +1,5 @@
 module Naver
   module Sdk
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naver-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Surim Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,7 @@ files:
 - lib/naver/config.rb
 - lib/naver/connection.rb
 - lib/naver/error.rb
+- lib/naver/ext/hash/to_underscore_keys.rb
 - lib/naver/map.rb
 - lib/naver/oauth.rb
 - lib/naver/objectified_hash.rb