naver-sdk 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 169e8f3de0474b1aafd74629d97c606f721bf728
-  data.tar.gz: f4d679fdf11f3287b42c3917fac0ae6c37f11127
+  metadata.gz: d16fe3d0b77daf05e8f77f8e5caa2d42aac547e5
+  data.tar.gz: ccb0b9772ebf335765d967f0f5caf81e0dd52a4d
 SHA512:
-  metadata.gz: 29b617d3bf7793a577969d2d025741c0a115cddc42a0b36041eb616d9f8bf73bda3feb685c87a655381fc2f56be99da314118e18552e3019a22e057179bfd98f
-  data.tar.gz: 57a587e7e8851029f32066856cd54c2f3d3fea3ad52409e15d2e6542fe77c05a82eff12b051200fa5c38578ff1646ce61e4eaf0d45c1dbeba9eb5001355a97f3
+  metadata.gz: 3380b8d54040b9838c56551fe04a1fc38237a1e6d16903fecec117ba3264c03a98d44b930c89401a2d9b2dfd4dcb28456ac32ecb324e9951e61259eaa7620ea4
+  data.tar.gz: 398dfd1d1342c8072fc2d39d223095cb5cd6d3496fbc0ce37e38549ddd17010660d44d1db0c1e65445d7580b2455ba0ecd5ef6ff16461d03fe94b58f158e2251

data/CHANGELOG.md

@@ -2,7 +2,10 @@
 All notable changes to this project will be documented in this file.
 
 ## [unreleased]
-- No significant changes.
+
+## [0.5.0] - 2017-07-09
+- improve configration
+- core_ext/hash/keys
 
 ## [0.4.0] - 2017-06-26
 - [breaking] JSON 출력 결과를 CamelCase 에서 underscore 변경
@@ -28,4 +31,5 @@ All notable changes to this project will be documented in this file.
 [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
 [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
+[0.5.0]: https://github.com/kimsuelim/naver-sdk-ruby/compare/v0.4.0...v0.5.0
+[unreleased]: https://github.com/kimsuelim/naver-sdk-ruby/compare/v0.5.0...HEAD

data/README.md

@@ -1,10 +1,10 @@
-# NAVER SDK for Ruby
+# 네이버 루비 SDK (NAVER SDK for Ruby) 
 
 [![Build Status](https://travis-ci.org/kimsuelim/naver-sdk-ruby.svg?branch=master)](https://travis-ci.org/kimsuelim/naver-sdk-ruby)
 [![Coverage Status](https://coveralls.io/repos/github/kimsuelim/naver-sdk-ruby/badge.svg?branch=master)](https://coveralls.io/github/kimsuelim/naver-sdk-ruby?branch=master)
 [![Gem Version](https://badge.fury.io/rb/naver-sdk.svg)](https://badge.fury.io/rb/naver-sdk)
 
-A ruby client for the NAVER API. [https://developers.naver.com](https://developers.naver.com)
+네이버 오픈API 루비 클라이언트 (A ruby client for the NAVER API)
 
 ## Links of Interest
 
@@ -145,15 +145,15 @@ puts response.items[0].name
 response = Naver::Papago.translate(
   source: "ko",
   target: "en",
-  text: "기술이 인간을 대체하는 것이 아니라 인간은 기술의 도움으로 더욱 창조적으로 될 것이라는 믿는다."
+  text: "기술은 사람을 대체하는 것이 아니라 기술의 도움으로 사람을 더 창조적으로 만들 것이라 믿는다."
 )
 # => #<Naver::ObjectifiedHash:70362563050680 {hash: {
-  "translated_text"=>"To replace the technology not believe that humans are more creatively with the help of technology."
+  "translated_text"=>"It is to replace the technology is more creative with the help of technology, not believe that it would make."
   }
 }
 
 puts response.translated_text
-# => "To replace the technology not believe that humans are more creatively with the help of technology."
+# => "It is to replace the technology is more creative with the help of technology, not believe that it would make."
 ```
 
 ## 지도
@@ -162,7 +162,6 @@ puts response.translated_text
 
 ```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그린팩토리"},

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/lib/naver/client.rb

@@ -10,10 +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
+        body = body.deep_underscore_keys
         ObjectifiedHash.new(body)
       elsif body.is_a?(Array)
-        body = body.to_underscore_keys
+        body = body.deep_underscore_keys
         body.collect! { |e| ObjectifiedHash.new(e) }
       elsif body
         true

data/lib/naver/configration.rb

@@ -0,0 +1,30 @@
+module Naver
+  # Defines constants and methods related to configuration.
+  module Configration
+    # An array of valid keys in the options hash when configuring a Naver::Client.
+    OPTION_KEYS = [:client_id, :client_secret, :redirect_uri, :timeout, :debug].freeze
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "NAVER Ruby SDK Gem #{Naver::Sdk::VERSION}".freeze
+
+    # Base URI for the NAVER API.
+    DEFAULT_API_BASE_URI = "https://openapi.naver.com".freeze
+
+    # Base URI for NAVER OAuth.
+    DEFAULT_OAUTH_BASE_URI = "https://nid.naver.com".freeze
+
+    attr_accessor *OPTION_KEYS
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield(self)
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      options = {}
+      OPTION_KEYS.each { |key| options[key] = send(key) }
+      options
+    end
+  end
+end

data/lib/naver/connection.rb

@@ -1,17 +1,12 @@
 module Naver
   class Connection
-    # Base URI for the NAVER API..
-    DEFAULT_API_BASE_URI   = "https://openapi.naver.com"
-
     # Create a Connection object.
-    # @param api_base_uri [String] Base URI at which to make API calls.
-    def initialize(api_base_uri: DEFAULT_API_BASE_URI)
+    def initialize
       @client_id     = Naver.client_id
       @client_secret = Naver.client_secret
-      @api_base_uri  = api_base_uri
-
-      headers = { user_agent: "NAVER Ruby SDK Gem #{ Naver::Sdk::VERSION}" }
-      @connection = Faraday.new(url: @api_base_uri, headers: headers) do |faraday|
+      @api_base_uri  = Configration::DEFAULT_API_BASE_URI
+      @headers = { user_agent: Configration::DEFAULT_USER_AGENT }
+      @connection = Faraday.new(url: @api_base_uri, headers: @headers) do |faraday|
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.response :logger if Naver.debug
@@ -50,14 +45,14 @@ module Naver
     private
 
     def request(verb, path, params = {})
-      raise ArgumentError.new "Invalid http verb #{verb}" if ![:get, :post, :put, :delete].include?(verb)
+      raise ArgumentError.new "Invalid http verb #{verb}" unless [:get, :post, :put, :delete].include?(verb)
 
       response = @connection.run_request(verb, path, params, public_auth_header) do |request|
         request.params.update(params) if verb == :get && params
         yield(request) if block_given?
       end
 
-      if !(200..299).include?(response.status)
+      unless (200..299).include?(response.status)
         body = JSON.parse(response.body)
         raise Naver::Error.new(body)
       end

data/lib/naver/core_ext/hash/keys.rb

@@ -0,0 +1,116 @@
+class Hash
+  # Returns a new hash with all keys converted to underscore strings.
+  #
+  #   hash = { firstName: "Rob", lastName: "Bob" }
+  #
+  #   hash.underscore_keys
+  #   # => {:first_name=>"Rob", :last_name=>"Bob"}
+  def underscore_keys
+    transform_keys { |key| underscore_key(key) }
+  end
+
+  # Returns a new hash with all keys converted to camelcase strings.
+  #
+  #   hash = { first_name: "Rob", last_name: "Bob" }
+  #
+  #   hash.camelize_keys
+  #   # => {:firstName=>"Rob", :lastName=>"Bob"}
+  def camelize_keys
+    transform_keys { |key| camelize_key(key) }
+  end
+
+  # Returns a new hash with all keys converted to underscore strings.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #  hash = { person: { firstName: "Rob", lastName: "Bob" } }
+  #
+  #  hash.deep_underscore_keys
+  #  # => {:person=>{:first_name=>"Rob", :last_name=>"Bob"}}
+  def deep_underscore_keys
+    deep_transform_keys_in_object(self) { |key| underscore_key(key) }
+  end
+
+  # Returns a new hash with all keys converted to camelcase strings.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #  hash = { person: { first_name: "Rob", last_name: "Bob" } }
+  #
+  #  hash.deep_camelize_keys
+  #  # => {:person=>{:firstName=>"Rob", :lastName=>"Bob"}}
+  def deep_camelize_keys
+    deep_transform_keys_in_object(self) { |key| camelize_key(key) }
+  end
+
+  private
+
+  # Returns a new hash with all keys converted using the +block+ operation.
+  def transform_keys
+    return enum_for(:transform_keys) { size } unless block_given?
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  # support methods for deep transforming nested hashes and arrays
+  def deep_transform_keys_in_object(object, &block)
+    case object
+    when Array
+      object.map { |e| deep_transform_keys_in_object(e, &block) }
+    when Hash
+      object.each_with_object({}) do |(key, value), result|
+        result[yield(key)] = deep_transform_keys_in_object(value, &block)
+      end
+      # Hash[object.map { |key, value| [yield(key), deep_transform_keys_in_object(value, &block)] }]
+    else
+      object
+    end
+  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
+    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
+
+  def camelize_key(key)
+    if key.is_a?(Symbol)
+      camelize(key.to_s, :lower).to_sym
+    elsif key.is_a?(String)
+      camelize(key, :lower)
+    else
+      key
+    end
+  end
+
+  def camelize(underscore_word, first_letter = :upper)
+    word = underscore_word.to_s
+    case first_letter
+    when :upper
+      word = word.sub(/^[a-z\d]*/) { $&.capitalize }
+    when :lower
+      word = word.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+    end
+
+    word.gsub!(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }
+    word.gsub!(/\//, "::".freeze)
+    word
+  end
+end

data/lib/naver/map.rb

@@ -2,18 +2,25 @@ module Naver # :nodoc:
   # Naver Map API
   class Map < Client
     class << self
-      # 주소 -> 좌표 변환
+      # 주소를 좌표로 변환
       # @param params [Hash] Params for the search
       def geocode(params = {})
         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"])
       end
+
+      # StaticMap
+      # 지정된 좌표의 네이버 지도 이미지를 출력
+      # @param params [Hash] Params for the search
+      def static_map(params = {})
+        connection.get("/v1/map/staticmap.bin", params).body
+      end
     end
   end
 end

data/lib/naver/oauth.rb

@@ -1,18 +1,14 @@
 module Naver
   class Oauth
-    # Base URI for NAVER OAuth.
-    # DEFAULT_OAUTH_BASE_URI = "https://nid.naver.com/oauth2.0"
-    DEFAULT_OAUTH_BASE_URI = "https://nid.naver.com"
-
-    # Create a Oauth object.
-    # @param oauth_base_uri [String] Base URI at which to make API calls.
-    def initialize(oauth_base_uri: DEFAULT_OAUTH_BASE_URI, redirect_uri: Naver.redirect_uri)
+    # Create a OAuth object.
+    # @param redirect_uri [String] OAuth redirect_uri
+    def initialize(redirect_uri: Naver.redirect_uri)
       @client_id     = Naver.client_id
       @client_secret = Naver.client_secret
-      @oauth_base_uri = oauth_base_uri
+      @oauth_base_uri = Configration::DEFAULT_OAUTH_BASE_URI
       @redirect_uri = redirect_uri
 
-      headers = { user_agent: "NAVER Ruby SDK Gem #{ Naver::Sdk::VERSION}" }
+      headers = { user_agent: Configration::DEFAULT_USER_AGENT }
       @oauth = OAuth2::Client.new(@client_id, @client_secret, site: @oauth_base_uri, authorize_url: "/oauth2.0/authorize", token_url: "/oauth2.0/token", headers: headers) do |http|
         http.request :multipart
         http.request :url_encoded
@@ -60,9 +56,8 @@ module Naver
     private
 
     def refresh_token!
-      return if !@oauth_token.expired?
+      return unless @oauth_token.expired?
       @oauth_token = @oauth_token.refresh_token
     end
   end
 end
-

data/lib/naver/papago.rb

@@ -6,7 +6,7 @@ module Naver # :nodoc:
       # @param source [String] 번역 소스 텍스트의 언어 설정: (ko:한국어, en:영어, ja:일본어, zh-CN:중국어(간체), zh-TW:중국어(번체)
       # @param target [String] 번역 대상 언어, 가능한 값은 source 파라미터와 동일
       # @param text [String] 번역할 문장이며 UTF-8만 지원
-      # @return [Hash] 번역된 문장
+      # @return [ObjectifiedHash] 번역된 문장
       def translate(source:, target:, text:)
         params = method(__method__).parameters.map(&:last).map { |p| [p, eval(p.to_s)] }.to_h
         parse(JSON.parse(connection.post("/v1/language/translate", params).body)["message"]["result"])
@@ -14,7 +14,7 @@ module Naver # :nodoc:
 
       # 한글인명 - 로마자 변환
       # @param query [String] 로마자로 바꾸려는 한글 이름
-      # @return [Hash] 변환 결과
+      # @return [ObjectifiedHash] 변환 결과
       def romanization(query:)
         params = { query: query }
         result = JSON.parse(connection.get("/v1/krdict/romanization", params).body)["aResult"][0]

data/lib/naver/sdk.rb

@@ -2,8 +2,8 @@ require "oauth2"
 require "faraday"
 
 require "naver/sdk/version"
-require "naver/ext/hash/to_underscore_keys"
-require "naver/config"
+require "naver/core_ext/hash/keys"
+require "naver/configration"
 require "naver/connection"
 require "naver/client"
 require "naver/error"
@@ -20,8 +20,5 @@ require "naver/vision"
 require "naver/voice"
 
 module Naver
-  extend Config
-
-  module Sdk
-  end
+  extend Configration
 end

data/lib/naver/sdk/version.rb

@@ -1,5 +1,5 @@
 module Naver
   module Sdk
-    VERSION = "0.4.0"
+    VERSION = "0.5.0".freeze
   end
 end

data/lib/naver/search.rb

@@ -11,7 +11,7 @@ module Naver # :nodoc:
       # Search > News (검색 > 뉴스)
       # @param params [Hash] Params for the search
       def news(params = {})
-       parse(JSON.parse(connection.get("/v1/search/news", params).body))
+        parse(JSON.parse(connection.get("/v1/search/news", params).body))
       end
 
       # Search > Book (검색 > 책)

data/lib/naver/vision.rb

@@ -4,7 +4,7 @@ module Naver # :nodoc:
     class << self
       # 유명인 얼굴인식(Beta)
       # @param image [Binary] 얼굴이 포함된 이미지 (최대 2MB)
-      # @return [Hash] 인식결과
+      # @return [ObjectifiedHash] 인식결과
       def celebrity(image:)
         params = {}
         params[:image] = Faraday::UploadIO.new(image, "image/jpeg")
@@ -13,7 +13,7 @@ module Naver # :nodoc:
 
       # 얼굴 감지(Beta)
       # @param image [Binary] 얼굴이 포함된 이미지 (최대 2MB)
-      # @return [Hash] 인식결과
+      # @return [ObjectifiedHash] 인식결과
       def face(image:)
         params = {}
         params[:image] = Faraday::UploadIO.new(image, "image/jpeg")

data/naver-sdk.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.2.2"
+
   spec.add_dependency "faraday", [">= 0.8", "< 1.0"]
   spec.add_dependency "oauth2",   "~> 1.0"
 
@@ -28,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rubocop",  "~> 0.49.0"
-  spec.add_development_dependency "coveralls", '~> 0.8.21'
+  spec.add_development_dependency "coveralls", "~> 0.8.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naver-sdk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Surim Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2017-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -133,10 +133,10 @@ files:
 - bin/console
 - bin/setup
 - lib/naver/client.rb
-- lib/naver/config.rb
+- lib/naver/configration.rb
 - lib/naver/connection.rb
+- lib/naver/core_ext/hash/keys.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
@@ -162,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/naver/config.rb

@@ -1,24 +0,0 @@
-module Naver
-  module Config
-    OPTION_KEYS = [
-      :client_id,
-      :client_secret,
-      :redirect_uri,
-      :timeout,
-      :debug
-    ]
-
-    attr_accessor *OPTION_KEYS
-
-    def configure
-      yield self
-      self
-    end
-
-    def options
-      options = {}
-      OPTION_KEYS.each{ |key| options[key] = send(key) }
-      options
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# 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