naver-sdk 0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "naver/sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/naver/client.rb

@@ -0,0 +1,42 @@
+module Naver # :nodoc:
+  # Common functionality across Naver API objects.
+  class Client
+    # The connection object being used to communicate with Naver.
+    # @return [Naver::Connection] the connection
+    def connection
+      self.class.connection
+    end
+
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      if body.is_a?(Hash)
+        ObjectifiedHash.new(body)
+      elsif body.is_a?(Array)
+        body.collect! { |e| ObjectifiedHash.new(e) }
+      elsif body
+        true
+      elsif !body
+        false
+      elsif body.nil?
+        false
+      else
+        raise Naver::Error.new("Couldn't parse a response body")
+      end
+    end
+
+    class << self
+      # The connection object being used to communicate with Naver.
+      # @return [Naver::Connection] the connection
+      def connection
+        @@connection ||= Connection.new
+      end
+
+      # Assign a default connection object.
+      # @param conn [Naver::Connection] the connection
+      # @return [Naver::Connection] the connection
+      def connection=(conn)
+        @@connection = conn
+      end
+    end
+  end
+end

data/lib/naver/config.rb

@@ -0,0 +1,24 @@
+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/connection.rb

@@ -0,0 +1,75 @@
+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)
+      @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|
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.response :logger if Naver.debug
+        faraday.adapter :net_http
+      end
+    end
+
+    # Perform a GET request.
+    # @param path [String] The path at which to make ther request.
+    # @param params [Hash] A hash of request parameters.
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    # Perform a PUT request.
+    # @param path [String] The path at which to make ther request.
+    # @param params [Hash] A hash of request parameters.
+    def put(path, params = {})
+      request(:put, path, params)
+    end
+
+    # Perform a POST request.
+    # @param path [String] The path at which to make ther request.
+    # @param params [Hash] A hash of request parameters.
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    # Perform a DELETE request.
+    # @param path [String] The path at which to make ther request.
+    # @param params [Hash] A hash of request parameters.
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    private
+
+    def request(verb, path, params = {})
+      raise ArgumentError.new "Invalid http verb #{verb}" if ![: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)
+        body = JSON.parse(response.body)
+        raise Naver::Error.new(body)
+      end
+
+      response
+    end
+
+    def public_auth_header
+      {
+        "X-Naver-Client-Id" => @client_id,
+        "X-Naver-Client-Secret" => @client_secret
+      }
+    end
+  end
+end

data/lib/naver/error.rb

@@ -0,0 +1,4 @@
+module Naver # :nodoc:
+  # Raised when there is an error communicating with Naver.
+  class Error < StandardError; end
+end

data/lib/naver/map.rb

@@ -0,0 +1,19 @@
+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"]["items"])
+      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"])
+      end
+    end
+  end
+end

data/lib/naver/oauth.rb

@@ -0,0 +1,68 @@
+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)
+      @client_id     = Naver.client_id
+      @client_secret = Naver.client_secret
+      @oauth_base_uri = oauth_base_uri
+      @redirect_uri = redirect_uri
+
+      headers = { user_agent: "NAVER Ruby SDK Gem #{ Naver::Sdk::VERSION}" }
+      @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
+        http.response :logger if Naver.debug
+        http.adapter :net_http
+      end
+    end
+
+    # Get OAuth URL for user authentication and authorization.
+    # @param requested_scopes [Array] An array of permission scopes being requested.
+    # @return [String] The authorization URL.
+    def authorization_url(requested_scopes: ["public"])
+      @oauth.auth_code.authorize_url(
+        redirect_uri: @redirect_uri,
+        scope: requested_scopes.join("")
+      )
+    end
+
+    # Generate an access token given an auth code received from NAVER.
+    # This is used internally to authenticate and authorize future user actions.
+    # @param auth_code [String] The OAuth authentication code from NAVER.
+    def authorize!(auth_code)
+      @oauth_token = @oauth.auth_code.get_token(auth_code, redirect_uri: @redirect_uri)
+      # TODO check if it succeeded
+    end
+
+    # Extract hash with OAuth token attributes. Extracted token attributes can
+    # be used with create_and_assign_token to prevent the need for
+    # reauthorization.
+    # @return [Hash, nil] @oauth_token converted to a hash.
+    def extract_token
+      @oauth_token.to_hash if @oauth_token
+    end
+
+    # Create and assign new access token from extracted token. To be used with
+    # extract_token to reauthorize app without api call.
+    # @param token_extract [Hash] OAuth token hash from #extract_token.
+    # @return [OAuth2::AccessToken, nil] New access token object.
+    def create_and_assign_token(token_extract)
+      unless token_extract.nil?
+        @oauth_token = OAuth2::AccessToken.from_hash(@oauth, token_extract)
+      end
+    end
+
+    private
+
+    def refresh_token!
+      return if !@oauth_token.expired?
+      @oauth_token = @oauth_token.refresh_token
+    end
+  end
+end
+

data/lib/naver/objectified_hash.rb

@@ -0,0 +1,35 @@
+module Naver
+  # Converts hashes to the objects.
+  class ObjectifiedHash
+    # Creates a new ObjectifiedHash object.
+    def initialize(hash)
+      @hash = hash
+      @data = hash.inject({}) do |data, (key, value)|
+        value = ObjectifiedHash.new(value) if value.is_a?(Hash)
+        value = value.collect { |e| ObjectifiedHash.new(e) } if value.is_a?(Array)
+        data[key.to_s] = value
+        data
+      end
+    end
+
+    # @return [Hash] The original hash.
+    def to_hash
+      @hash
+    end
+    alias_method :to_h, :to_hash
+
+    # @return [String] Formatted string with the class name, object id and original hash.
+    def inspect
+      "#<#{self.class}:#{object_id} {hash: #{@hash.inspect}}"
+    end
+
+    # Delegate to ObjectifiedHash.
+    def method_missing(key)
+      @data.key?(key.to_s) ? @data[key.to_s] : nil
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+    end
+  end
+end

data/lib/naver/papago.rb

@@ -0,0 +1,18 @@
+module Naver # :nodoc:
+  # Naver Papago API
+  class Papago < Client
+    class << self
+      # 기계번역(Beta)
+      # @param params [Hash] Params for the translate
+      def translate(params = {})
+        parse(JSON.parse(connection.post("/v1/language/translate", params).body)["message"]["result"])
+      end
+
+      # 한글인명 - 로마자 변환
+      # @param params [Hash] Params for the translate
+      def romanization(params = {})
+        parse(JSON.parse(connection.get("/v1/krdict/romanization", params).body)["aResult"][0])
+      end
+    end
+  end
+end

data/lib/naver/profile.rb

@@ -0,0 +1,11 @@
+module Naver # :nodoc:
+  # 네이버 회원 프로필 조회
+  class Profile < Client
+    class << self
+      # 회원 프로필
+      def me
+        parse(JSON.parse(connection.get("/v1/nid/me").body)["response"])
+      end
+    end
+  end
+end

data/lib/naver/sdk/version.rb

@@ -0,0 +1,5 @@
+module Naver
+  module Sdk
+    VERSION = "0.1.0"
+  end
+end

data/lib/naver/sdk.rb

@@ -0,0 +1,23 @@
+require "oauth2"
+require "faraday"
+
+require "naver/sdk/version"
+require "naver/config"
+require "naver/connection"
+require "naver/client"
+require "naver/error"
+require "naver/oauth"
+require "naver/objectified_hash"
+
+require "naver/map"
+require "naver/papago"
+require "naver/profile"
+require "naver/search"
+require "naver/shortenurl"
+
+module Naver
+  extend Config
+
+  module Sdk
+  end
+end

data/lib/naver/search.rb

@@ -0,0 +1,90 @@
+module Naver # :nodoc:
+  # Naver Search API
+  class Search < Client
+    class << self
+      # Search > Blog (검색 > 블로그)
+      # @param params [Hash] Params for the search
+      def blog(params = {})
+        parse(JSON.parse(connection.get("/v1/search/blog", params).body))
+      end
+
+      # Search > News (검색 > 뉴스)
+      # @param params [Hash] Params for the search
+      def news(params = {})
+       parse(JSON.parse(connection.get("/v1/search/news", params).body))
+      end
+
+      # Search > Book (검색 > 책)
+      # @param params [Hash] Params for the search
+      def book(params = {})
+        parse(JSON.parse(connection.get("/v1/search/book", params).body))
+      end
+
+      # Search > Adult (검색 > 성인 검색어 판별)
+      # @param params [Hash] Params for the search
+      def adult(params = {})
+        parse(JSON.parse(connection.get("/v1/search/adult", params).body))
+      end
+
+      # Search > Encyc (검색 > 백과 사전)
+      # @param params [Hash] Params for the search
+      def encyc(params = {})
+        parse(JSON.parse(connection.get("/v1/search/encyc", params).body))
+      end
+
+      # Search > Movie (검색 > 영화)
+      # @param params [Hash] Params for the search
+      def movie(params = {})
+        parse(JSON.parse(connection.get("/v1/search/movie", params).body))
+      end
+
+      # Search > Cafearticle (검색 > 카페글)
+      # @param params [Hash] Params for the search
+      def cafearticle(params = {})
+        parse(JSON.parse(connection.get("/v1/search/cafearticle", params).body))
+      end
+
+      # Search > Kin (검색 > 지식 iN)
+      # @param params [Hash] Params for the search
+      def kin(params = {})
+        parse(JSON.parse(connection.get("/v1/search/kin", params).body))
+      end
+
+      # Search > Local (검색 > 지역)
+      # @param params [Hash] Params for the search
+      def local(params = {})
+        parse(JSON.parse(connection.get("/v1/search/local", params).body))
+      end
+
+      # Search > Errata (검색 > 오타변환)
+      # @param params [Hash] Params for the search
+      def errata(params = {})
+        parse(JSON.parse(connection.get("/v1/search/errata", params).body))
+      end
+
+      # Search > Webkr (검색 > 웹문서)
+      # @param params [Hash] Params for the search
+      def webkr(params = {})
+        parse(JSON.parse(connection.get("/v1/search/webkr", params).body))
+      end
+
+      # Search > Image (검색 > 이미지)
+      # @param params [Hash] Params for the search
+      def image(params = {})
+        parse(JSON.parse(connection.get("/v1/search/image", params).body))
+      end
+
+      # Search > Shop (검색 > 쇼핑)
+      # @param params [Hash] Params for the search
+      def shop(params = {})
+        parse(JSON.parse(connection.get("/v1/search/shop", params).body))
+      end
+
+      # Search > Doc (검색 > 전문자료)
+      # @param params [Hash] Params for the search
+      def doc(params = {})
+        parse(JSON.parse(connection.get("/v1/search/doc", params).body))
+      end
+    end
+  end
+end

data/lib/naver/shortenurl.rb

@@ -0,0 +1,12 @@
+module Naver # :nodoc:
+  # Naver Shortenurl API
+  class Shortenurl < Client
+    class << self
+      # 단축URL
+      # @param params [Hash] Params for the origin url
+      def url(params = {})
+        parse(JSON.parse(connection.post("/v1/util/shorturl", params).body)["result"])
+      end
+    end
+  end
+end

data/naver-sdk.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "naver/sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "naver-sdk"
+  spec.version       = Naver::Sdk::VERSION
+  spec.authors       = ["Surim Kim"]
+  spec.email         = ["kimsuelim@gmail.com"]
+
+  spec.summary       = "NAVER SDK for Ruby"
+  spec.description   = "The unofficial NAVER SDK for Ruby. Provides both resource oriented interfaces and API clients for NAVER services."
+  spec.homepage      = "https://github.com/kimsuelim/naver-sdk-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", [">= 0.8", "< 1.0"]
+  spec.add_dependency "oauth2",   "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  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'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: naver-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Surim Kim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+description: The unofficial NAVER SDK for Ruby. Provides both resource oriented interfaces
+  and API clients for NAVER services.
+email:
+- kimsuelim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/naver/client.rb
+- lib/naver/config.rb
+- lib/naver/connection.rb
+- lib/naver/error.rb
+- lib/naver/map.rb
+- lib/naver/oauth.rb
+- lib/naver/objectified_hash.rb
+- lib/naver/papago.rb
+- lib/naver/profile.rb
+- lib/naver/sdk.rb
+- lib/naver/sdk/version.rb
+- lib/naver/search.rb
+- lib/naver/shortenurl.rb
+- naver-sdk.gemspec
+homepage: https://github.com/kimsuelim/naver-sdk-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: NAVER SDK for Ruby
+test_files: []