naver-searchad-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33ea00d32f02d980670575aa962514ce94a1358b
+  data.tar.gz: ffdc63d9829036d32449d0e9b6530174d4116f65
+SHA512:
+  metadata.gz: ab19d8d053206588737c1d1935fcd25c52193a96d0380c471be96673fde68a28a3fe7c9992feffaf099f739543dc930f0da43a06719462ab52466f6a83454789
+  data.tar.gz: cc778485156e7db9484c908ce917d356dd696d52c48d4463712bca53cd5e2e2d5cc8ac18b20f76bacee442b764647be05694c621b5aa6b201ff86dabefb05fe1

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - 2.2.0
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in naver-searchad-api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Forward3D
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# Naver Searchad API
+
+A Client GEM for [Naver Searchad API](http://naver.github.io/searchad-apidoc/#/guides)
+
+## Alpha
+
+This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible
+changes when necessary.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'naver-searchad-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install naver-searchad-api
+
+## Compatibility
+
+naver-searchad-api supports the following Ruby implementations:
+
+* MRI 2.0
+* MRI 2.1
+* MRI 2.2
+* MRI 2.3
+
+## Usage
+
+### Basic usage
+
+To use an API, instantiate the service. For example to use the Campaign API:
+
+```ruby
+require 'naver/searchad/api/campaign/service'
+
+Campaign = Naver::Searchad::Api::Campaign # Alias the module
+campaign = Campaign::Service.new
+campaign.authorization = Naver::Searchad::Api::Auth.get_application_default # See Below Authorization
+
+# Read campaigns by ids
+campaign.list_campaigns_by_ids(['campaign_id_1', 'campaign_id_2']) do |res, err|
+  puts res
+end
+
+# Create a campaign
+campaign = { ..... }
+campaign.create_campaign(campaign) do |res, err|
+  puts res
+end
+
+# Delete
+campaign_id = ... # A campaign id to delete
+campaign.delete_campaign(campaign_id)
+```
+
+### Naming conventions vs JSON representation
+
+Object properties in the ruby client use the standard ruby convention for naming -- snake_case. This differs from the underlying JSON representation which typically uses camelCase for properties.
+
+
+### Callbacks
+
+A block can be specified when making calls. If present, the block will be called with the result or error, rather than
+returning the result from the call or raising the error. Example:
+
+```ruby
+# Read a campaign
+campaign.get_campaign('campaign_id_1') do |res, err|
+  if err
+    # Handle error
+  else
+    # Handle response
+  end
+end
+```
+
+## Authorization
+
+[Naver Searchad API authorization](http://naver.github.io/searchad-apidoc/#/samples) is used to authorize applications.
+
+### Authorization using environment variables
+
+The [Naver Searchad API Auth](https://github.com/forward3d/naver-searchad-api/blob/master/lib/naver/searchad/api/auth.rb) also supports authorization via
+environment variables. Simply set the following variables for your application:
+
+```sh
+NAVER_API_KEY="YOUR NAVER DEVELOPER API KEY"
+NAVER_API_SECRET="YOUR NAVER DEVELOPER API SECRET"
+NAVER_API_CLIENT_ID="YOUR NAVER DEVELOPER CLIENT ID"
+```
+
+## Logging
+
+The client includes a `Logger` instance that can be used to capture debugging information.
+
+To set the logging level for the client:
+
+```ruby
+Naver::Searchad::Api.logger.level = Logger::DEBUG
+```
+
+When running in a Rails environment, the client will default to using `::Rails.logger`. If you
+prefer to use a separate logger instance for API calls, this can be changed via one of two ways.
+
+The first is to provide a new logger instance:
+
+```ruby
+Naver::Searchad::Api.logger = Logger.new(STDERR)
+```
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/forward3d/naver-searchad-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+We encourage contributors to follow [Bozhidar's ruby style guide](https://github.com/bbatsov/ruby-style-guide) in this project.
+
+Pull requests (with tests) are appreciated. Please help with:
+
+* Reporting bugs
+* Suggesting features
+* Writing or improving documentation
+* Fixing typos
+* Cleaning whitespace
+* Refactoring code
+* Adding tests
+
+If you report a bug and don't include a fix, please include a failing test.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "naver/searchad/api"
+
+# 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/searchad/api.rb

@@ -0,0 +1,35 @@
+require 'naver/searchad/api/version'
+require 'logger'
+
+module Naver
+  module Searchad
+    module Api
+      ROOT = File.expand_path('..', File.dirname(__dir__))
+
+      def self.logger
+        @logger ||= (rails_logger || default_logger)
+      end
+
+      class << self
+        attr_writer :logger
+      end
+
+      private
+
+      def self.default_logger
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::WARN
+        logger
+      end
+
+      def self.rails_logger
+        if defined?(::Rails) && ::Rails.respond_to?(:logger) &&
+          !::Rails.logger.nil?
+          ::Rails.logger
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/ad-keyword/service.rb

@@ -0,0 +1,78 @@
+module Naver
+  module Searchad
+    module Api
+      module AdKeyword
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', 'ncc/')
+          end
+
+          def list_ad_keywords_by_ids(ad_keyword_ids, options: nil, &block)
+            command = make_command(:get, 'keywords', options)
+            command.query['ids'] = ad_keyword_ids.join(',')
+            execute_command(command, &block)
+          end
+
+          def list_ad_keywords_by_adgroup_id(adgroup_id, options: nil, &block)
+            command = make_command(:get, 'keywords', options)
+            command.query['nccAdgroupId'] = adgroup_id
+            execute_command(command, &block)
+          end
+
+          def list_ad_keywords_by_label_id(label_id, options: nil, &block)
+            command = make_command(:get, 'keywords', options)
+            command.query['nccLabelId'] = label_id
+            execute_command(command, &block)
+          end
+
+          def get_ad_keyword(ad_keyword_id, options: nil, &block)
+            command = make_command(:get, 'keywords/{ad_keyword_id}', options)
+            command.params['ad_keyword_id'] = ad_keyword_id
+            execute_command(command, &block)
+          end
+
+          def create_ad_keywords(ad_keywords, adgroup_id, options: nil, &block)
+            ad_keywords.each { |kw| validates_presence_of(%w[keyword], kw) }
+
+            command = make_command(:post, 'keywords', options)
+            command.query['nccAdgroupId'] = adgroup_id
+            command.request_object = ad_keywords
+            execute_command(command, &block)
+          end
+
+          def update_ad_keyword(ad_keyword, field: '', options: nil, &block)
+            validates_presence_of(%w[nccKeywordId nccAdgroupId], ad_keyword)
+
+            command = make_command(:put, 'keywords/{ad_keyword_id}', options)
+            command.params['ad_keyword_id'] = ad_keyword['nccKeywordId']
+            command.query['fields'] = field
+            command.request_object = ad_keyword
+            execute_command(command, &block)
+          end
+
+          def update_ad_keywords(ad_keywords, field: '', options: nil, &block)
+            ad_keywords.each { |kw| validates_presence_of(%w[nccKeywordId nccAdgroupId], kw) }
+
+            command = make_command(:put, 'keywords', options)
+            command.query['fields'] = field
+            command.request_object = ad_keywords
+            execute_command(command, &block)
+          end
+
+          def delete_ad_keyword(ad_keyword_id, options: nil, &block)
+            command = make_command(:delete, 'keywords/{ad_keyword_id}', options)
+            command.params['ad_keyword_id'] = ad_keyword_id
+            execute_command(command, &block)
+          end
+
+          def delete_ad_keywords(ad_keyword_ids, options: nil, &block)
+            command = make_command(:delete, 'keywords', options)
+            command.query['ids'] = ad_keyword_ids.join(',')
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/ad/service.rb

@@ -0,0 +1,64 @@
+module Naver
+  module Searchad
+    module Api
+      module Ad
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', 'ncc/')
+          end
+
+          def list(ad_ids, options: nil, &block)
+            command = make_command(:get, 'ads', options)
+            command.query['ids'] = ad_ids.join(',')
+            execute_command(command, &block)
+          end
+
+          def list_by_adgroup_id(adgroup_id, options: nil, &block)
+            command = make_command(:get, 'ads', options)
+            command.query['nccAdgroupId'] = adgroup_id
+            execute_command(command, &block)
+          end
+
+          def get_ad(ad_id, options: nil, &block)
+            command = make_command(:get, 'ads/{ad_id}', options)
+            command.params['ad_id'] = ad_id
+            execute_command(command, &block)
+          end
+
+          def create_ad(ad, options: nil, &block)
+            validates_presence_of(%w[ad nccAdgroupId type], ad)
+
+            command = make_command(:post, 'ads', options)
+            command.request_object = ad
+            execute_command(command, &block)
+          end
+
+          def update_ad(ad, field: '', options: nil, &block)
+            validates_presence_of(%w[nccAdId adAttr], ad)
+
+            command = make_command(:put, 'ads/{ad_id}', options)
+            command.params['ad_id'] = ad['nccAdId']
+            command.query['fields'] = field
+            command.request_object = ad
+            execute_command(command, &block)
+          end
+
+          def delete_ad(ad_id, options: nil, &block)
+            command = make_command(:delete, 'ads/{ad_id}', options)
+            command.params['ad_id'] = ad_id
+            execute_command(command, &block)
+          end
+
+          def copy_ads(ad_ids, target_ad_group_id, user_lock, options: nil, &block)
+            command = make_command(:put, 'ads', options)
+            command.query['ids'] = ad_ids.join(',')
+            command.query['targetAdgroupId'] = target_ad_group_id
+            command.query['userLock'] = user_lock
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/adgroup/service.rb

@@ -0,0 +1,62 @@
+module Naver
+  module Searchad
+    module Api
+      module Adgroup
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', 'ncc/')
+          end
+
+          def list_adgroups_by_ids(adgroup_ids, options: nil, &block)
+            command = make_command(:get, 'adgroups', options)
+            command.query['ids'] = adgroup_ids.join(',')
+            execute_command(command, &block)
+          end
+
+          def list_adgroups_by_campaign_id(campaign_id, options: nil, &block)
+            command = make_command(:get, 'adgroups', options)
+            command.query['nccCampaignId'] = campaign_id
+            execute_command(command, &block)
+          end
+
+          def list_adgroups_by_label_id(label_id, options: nil, &block)
+            command = make_command(:get, 'adgroups', options)
+            command.query['nccLabelId'] = label_id
+            execute_command(command, &block)
+          end
+
+          def get_adgroup(adgroup_id, options: nil, &block)
+            command = make_command(:get, 'adgroups/{adgroup_id}', options)
+            command.params['adgroup_id'] = adgroup_id
+            execute_command(command, &block)
+          end
+
+          def create_adgroup(adgroup, options: nil, &block)
+            validates_presence_of(%w[nccCampaignId pcChannelId mobileChannelId name], adgroup)
+
+            command = make_command(:post, 'adgroups', options)
+            command.request_object = adgroup
+            execute_command(command, &block)
+          end
+
+          def update_adgroup(adgroup, field: nil, options: nil, &block)
+            validates_presence_of(%w[nccAdgroupId], adgroup)
+
+            command = make_command(:put, 'adgroups/{adgroup_id}', options)
+            command.params['adgroup_id'] = adgroup['nccAdgroupId']
+            command.query['fields'] = field if field
+            command.request_object = adgroup
+            execute_command(command, &block)
+          end
+
+          def delete_adgroup(adgroup_id, options: nil, &block)
+            command = make_command(:delete, 'adgroups/{adgroup_id}', options)
+            command.params['adgroup_id'] = adgroup_id
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/auth.rb

@@ -0,0 +1,65 @@
+module Naver
+  module Searchad
+    module Api
+      module Auth
+        class CustomerAcccountCredentials
+          TIMESTAMP_HEADER = 'X-Timestamp'.freeze
+          API_KEY_HEADER = 'X-API-KEY'.freeze
+          CUSTOMER_HEADER = 'X-Customer'.freeze
+          SIGNATURE_HEADER = 'X-Signature'.freeze
+
+          attr_reader :api_key
+          attr_reader :api_secret
+          attr_reader :customer_id
+
+          def initialize(api_key, api_secret, customer_id)
+            @api_key = api_key
+            @api_secret = api_secret
+            @customer_id = customer_id
+          end
+
+          def apply(hash, request_uri, method)
+            timestamp = Time.now.to_i
+
+            hash[TIMESTAMP_HEADER] = timestamp
+            hash[API_KEY_HEADER] = api_key
+            hash[CUSTOMER_HEADER] = customer_id
+            hash[SIGNATURE_HEADER] = generate_signature(api_secret, request_uri, method, timestamp)
+          end
+
+          private
+
+          def generate_signature(secret, request_uri, method, timestamp)
+            method = method.to_s.upcase if method.is_a?(Symbol)
+
+            Base64.encode64(OpenSSL::HMAC.digest(
+              OpenSSL::Digest::SHA256.new,
+              secret,
+              [timestamp, method, request_uri].join('.')
+            )).gsub("\n", '')
+          end
+        end
+
+        class DefaultCredentials
+          API_KEY_ENV_VAR = 'NAVER_API_KEY'.freeze
+          API_SECRET_ENV_VAR = 'NAVER_API_SECRET'.freeze
+          CUSTOMER_ID_ENV_VAR = 'NAVER_API_CLIENT_ID'.freeze
+
+          def self.from_env
+            CustomerAcccountCredentials.new(
+              ENV[API_KEY_ENV_VAR],
+              ENV[API_SECRET_ENV_VAR],
+              ENV[CUSTOMER_ID_ENV_VAR]
+              )
+          end
+        end
+
+        def get_application_default
+          DefaultCredentials.from_env
+        end
+
+        module_function :get_application_default
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/campaign/service.rb

@@ -0,0 +1,52 @@
+require_relative '../core/base_service'
+
+module Naver
+  module Searchad
+    module Api
+      module Campaign
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', 'ncc/')
+          end
+
+          def list_campaigns_by_ids(campaign_ids, options: nil, &block)
+            command = make_command(:get, 'campaigns/', options)
+            command.query['ids'] = campaign_ids.join(',')
+            execute_command(command, &block)
+          end
+
+          def get_campaign(campaign_id, options: nil, &block)
+            command = make_command(:get, 'campaigns/{campaign_id}', options)
+            command.params['campaign_id'] = campaign_id
+            execute_command(command, &block)
+          end
+
+          def create_campaign(campaign, options: nil, &block)
+            validates_presence_of(%w[campaignTp name customerId], campaign)
+
+            command = make_command(:post, 'campaigns', options)
+            command.request_object = campaign
+            execute_command(command, &block)
+          end
+
+          def update_campaign(campaign, field: nil, options: nil, &block)
+            validates_presence_of(%w[nccCampaignId], campaign)
+
+            command = make_command(:put, 'campaigns/{campaign_id}', options)
+            command.params['campaign_id'] = campaign['nccCampaignId']
+            command.query['fields'] = field if field
+            command.request_object = campaign
+            execute_command(command, &block)
+          end
+
+          def delete_campaign(campaign_id, options: nil, &block)
+            command = make_command(:delete, 'campaigns/{campaign_id}', options)
+            command.params['campaign_id'] = campaign_id
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/core/api_command.rb

@@ -0,0 +1,96 @@
+require_relative 'http_command'
+
+module Naver
+  module Searchad
+    module Api
+      module Core
+        class ApiCommand < HttpCommand
+          JSON_CONTENT_TYPE = 'application/json'.freeze
+          #
+          # More error codes can be found at the below url
+          # https://github.com/naver/searchad-apidoc/blob/master/NaverSA_API_Error_Code_MAP.md
+          #
+          ERROR_CODE_MAPPING = {
+            '1002' => Naver::Searchad::Api::InvalidRequestError,
+            '1018' => Naver::Searchad::Api::NotEnoughPermissionError,
+            '3506' => Naver::Searchad::Api::DuplicatedCampaignNameError,
+            '3710' => Naver::Searchad::Api::DuplicatedAdgroupNameError,
+          }
+
+          attr_accessor :request_object
+
+          def prepare!
+            if request_object
+              self.header['Content-Type'] ||= JSON_CONTENT_TYPE
+              self.body = request_object.to_json
+            end
+            super
+          end
+
+          def decode_response_body(content_type, body)
+            return super unless content_type
+            return nil unless content_type.start_with?(JSON_CONTENT_TYPE)
+
+            decoded_response = JSON.parse(body)
+            deep_snake_case_params!(decoded_response)
+            if decoded_response.kind_of?(Hash)
+              OpenStruct.new(decoded_response)
+            elsif decoded_response.kind_of?(Array)
+              decoded_response.map { |h| OpenStruct.new(h) }
+            end
+          end
+
+          def check_status(status, header = nil, body = nil, message = nil)
+            case status
+            when 400, 402..500
+              code, message = parse_error(body)
+              raise ERROR_CODE_MAPPING[code].new(
+                message,
+                status_code: status,
+                header: header,
+                body: body
+              ) if ERROR_CODE_MAPPING.key?(code)
+            end
+
+            super(status, header, body, message)
+          end
+
+          private
+
+          def deep_snake_case_params!(val)
+            case val
+            when Array
+              val.map {|v| deep_snake_case_params! v }
+            when Hash
+              val.keys.each do |k, v = val[k]|
+                val.delete k
+                val[to_snake_case(k)] = deep_snake_case_params!(v)
+              end
+              val
+            else
+              val
+            end
+          end
+
+          def to_snake_case(str)
+            str.gsub(/::/, '/').
+              gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+                gsub(/([a-z\d])([A-Z])/,'\1_\2').
+                  tr("-", "_").
+                    downcase
+          end
+
+          def parse_error(body)
+            obj = JSON.parse(body)
+            message = obj['title']
+            message << ", #{obj['detail']}" if obj['detail']
+
+            [obj['code'].to_s, message]
+          rescue
+            [nil, nil]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/core/base_service.rb

@@ -0,0 +1,91 @@
+require 'addressable/uri'
+require 'addressable/template'
+require 'httpclient'
+require_relative '../options'
+require_relative '../version'
+require_relative 'api_command'
+require_relative 'logging'
+
+module Naver
+  module Searchad
+    module Api
+      module Core
+        class BaseService
+          include Logging
+
+          attr_reader :request_options
+          attr_reader :client_options
+          attr_reader :url
+          attr_reader :base_path
+
+          def initialize(url, base_path = '')
+            @url = url
+            @base_path = base_path
+            @request_options = RequestOptions.default.dup
+            @client_options = ClientOptions.default.dup
+          end
+
+          def authorization=(authorization)
+            @request_options.authorization = authorization
+          end
+
+          def authorization
+            request_options.authorization
+          end
+
+          def client
+            @client ||= new_client
+          end
+
+          protected
+
+          def make_command(method, path, options = {})
+            template = Addressable::Template.new(url + base_path + path)
+            command = ApiCommand.new(method, template)
+            command.options = request_options.merge(options)
+            apply_command_defaults(command)
+            command
+          end
+
+          def execute_command(command, &block)
+            command.execute(client, &block)
+          end
+
+          def apply_command_defaults(command)
+            # To be implemented by subclasses
+          end
+
+          def validates_presence_of(fields, object)
+            fields.each do |key|
+              unless object.key?(key)
+                raise MissingRequiredAttributeError.new(
+                  "Require #{key} attribute in object")
+              end
+            end
+          end
+
+          private
+
+          def new_client
+            HTTPClient.new.tap do |client|
+              client.transparent_gzip_decompression = true
+              client.proxy = client_options.proxy_url if client_options.proxy_url
+              client.connect_timeout = client_options.open_timeout_sec if client_options.open_timeout_sec
+              client.receive_timeout = client_options.read_timeout_sec if client_options.read_timeout_sec
+              client.send_timeout = client_options.send_timeout_sec if client_options.send_timeout_sec
+              client.follow_redirect_count = 5
+              client.default_header = { 'User-Agent' => user_agent }
+              client.debug_dev = logger if client_options.log_http_requests
+            end
+          end
+
+          def user_agent
+            "#{client_options.application_name}/#{client_options.application_version} "\
+            "naver-searchad-api/#{Naver::Searchad::Api::VERSION} "\
+            "#{Naver::Searchad::Api::OS_VERSION} (gzip)"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/core/http_command.rb

@@ -0,0 +1,145 @@
+require 'addressable/uri'
+require 'addressable/template'
+require_relative '../errors'
+require_relative '../options'
+require_relative 'logging'
+
+module Naver
+  module Searchad
+    module Api
+      module Core
+        class HttpCommand
+          include Logging
+
+          attr_reader :url
+          attr_reader :method
+          attr_accessor :body
+          attr_accessor :header
+          attr_accessor :options
+          attr_accessor :query
+          attr_accessor :params
+
+          def initialize(method, url, body: nil)
+            @options = RequestOptions.default.dup
+            @url = url.is_a?(String) ? Addressable::Template.new(url) : url
+            @method = method
+            @header = {}
+            @body = body
+            @query = {}
+            @params = {}
+          end
+
+          def execute(client, &block)
+            prepare!
+
+            logger.debug("Executing HTTP #{method} #{url}")
+            request_header = {}
+            apply_request_options(request_header)
+
+            http_res = client.request(method.to_s.upcase,
+                                      url.to_s,
+                                      query: nil,
+                                      body: body,
+                                      header: request_header,
+                                      follow_redirect: true)
+
+            logger.debug("Returned status(#{http_res.status}) and #{http_res.inspect}")
+            response = process_response(http_res.status.to_i, http_res.header, http_res.body)
+
+            logger.debug("Success - #{response}")
+            success(response, &block)
+          rescue => e
+            logger.debug("Error - #{e.inspect}")
+            error(e, &block)
+          end
+
+          def prepare!
+            normalize_unicode = true
+            if options
+              @header.merge!(options.header) if options.header
+              normalize_unicode = options.normalize_unicode
+            end
+
+            if url.is_a?(Addressable::Template)
+              @url = url.expand(params, nil, normalize_unicode)
+              @url.query_values = query.merge(url.query_values || {})
+            end
+
+            @body = '' unless body
+          end
+
+          def process_response(status, header, body)
+            check_status(status, header, body)
+            decode_response_body(header['Content-Type'].first, body)
+          end
+
+          def check_status(status, header = nil, body = nil, message = nil)
+            case status
+            when 200...300
+              nil
+            when 301, 302, 303, 307
+              message ||= "Redirect to #{header['Location']}"
+              raise Naver::Searchad::Api::RedirectError.new(
+                message, status_code: status, header: header, body: body)
+            when 401
+              message ||= 'Unauthorized'
+              raise Naver::Searchad::Api::AuthorizationError.new(
+                message, status_code: status, header: header, body: body)
+            when 429
+              message ||= 'Rate limit exceeded'
+              raise Naver::Searchad::Api::RateLimitError.new(
+                message, status_code: status, header: header, body: body)
+            when 400, 402...500
+              message ||= 'Invalid request'
+              raise Naver::Searchad::Api::RequestError.new(
+                message, status_code: status, header: header, body: body)
+            when 500...600
+              message ||= 'Server error'
+              raise Naver::Searchad::Api::ServerError.new(
+                message, status_code: status, header: header, body: body)
+            else
+              logger.warn("Encountered unexpected status code #{status}")
+              message ||= 'Unknown error'
+              raise Naver::Searchad::Api::UnknownError.new(
+                message, status_code: status, header: header, body: body)
+            end
+          end
+
+          def decode_response_body(content_type, body)
+            body
+          end
+
+          private
+
+          def apply_request_options(req_header)
+            options.authorization.apply(req_header, url.path, method) if options.authorization.respond_to?(:apply)
+            req_header.merge!(header)
+          end
+
+          def success(result, &block)
+            block.call(result, nil) if block_given?
+            result
+          end
+
+          def error(err, &block)
+            if err.is_a?(HTTPClient::BadResponseError)
+              begin
+                res = err.res
+                check_status(res.status.to_i, res.header, res.body)
+              rescue Naver::Searchad::Api::Error => e
+                err = e
+              end
+            elsif err.is_a?(HTTPClient::TimeoutError) || err.is_a?(SocketError)
+              err = Naver::Searchad::Api::TransmissionError.new(err)
+            end
+            if block_given?
+              block.call(nil, err)
+            else
+              raise err
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/core/logging.rb

@@ -0,0 +1,15 @@
+require 'naver/searchad/api'
+
+module Naver
+  module Searchad
+    module Api
+      module Core
+        module Logging
+          def logger
+            Naver::Searchad::Api.logger
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/errors.rb

@@ -0,0 +1,57 @@
+module Naver
+  module Searchad
+    module Api
+      class Error < StandardError
+        attr_reader :status_code
+        attr_reader :header
+        attr_reader :body
+
+        def initialize(err, status_code: nil, header: nil, body: nil)
+          @cause = nil
+
+          if err.respond_to?(:backtrace)
+            super(err.message)
+            @cause = err
+          else
+            super(err.to_s)
+          end
+          @status_code = status_code
+          @header = header unless header.nil?
+          @body = body
+        end
+
+        def backtrace
+          if @cause
+            @cause.backtrace
+          else
+            super
+          end
+        end
+      end # Error
+
+      RedirectError = Class.new(Error)
+
+      AuthorizationError = Class.new(Error)
+
+      RequestError = Class.new(Error)
+
+      RateLimitError = Class.new(Error)
+
+      ServerError = Class.new(Error)
+
+      UnknownError = Class.new(Error)
+
+      TransmissionError = Class.new(Error)
+
+      NotEnoughPermissionError = Class.new(RequestError)
+
+      MissingRequiredAttributeError = Class.new(RequestError)
+
+      InvalidRequestError = Class.new(RequestError)
+
+      DuplicatedCampaignNameError = Class.new(RequestError)
+
+      DuplicatedAdgroupNameError = Class.new(RequestError)
+    end
+  end
+end

data/lib/naver/searchad/api/options.rb

@@ -0,0 +1,49 @@
+module Naver
+  module Searchad
+    module Api
+      RequestOptions = Struct.new(
+        :authorization,
+        :header,
+        :normalize_unicode
+      )
+
+      ClientOptions = Struct.new(
+        :application_name,
+        :application_version,
+        :proxy_url,
+        :open_timeout_sec,
+        :read_timeout_sec,
+        :send_timeout_sec,
+        :log_http_requests
+      )
+
+      class ClientOptions
+        def self.default
+          @options ||= ClientOptions.new
+        end
+      end
+
+      class RequestOptions
+        def self.default
+          @options ||= RequestOptions.new
+        end
+
+        def merge(options)
+          return self unless options
+
+          new_options = dup
+          members.each do |opt|
+            opt = opt.to_sym
+            new_options[opt] = options[opt] unless options[opt].nil?
+          end
+          new_options
+        end
+      end
+
+      ClientOptions.default.log_http_requests = false
+      ClientOptions.default.application_name = 'naver-searchad-api'
+      ClientOptions.default.application_version = '0.0.0'
+      RequestOptions.default.normalize_unicode = false
+    end
+  end
+end

data/lib/naver/searchad/api/version.rb

@@ -0,0 +1,24 @@
+module Naver
+  module Searchad
+    module Api
+      VERSION = '0.0.1'
+
+      OS_VERSION = begin
+        if RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/
+          `ver`.sub(/\s*\[Version\s*/, '/').sub(']', '').strip
+        elsif RUBY_PLATFORM =~ /darwin/i
+          "Mac OS X/#{`sw_vers -productVersion`}"
+        elsif RUBY_PLATFORM == 'java'
+          require 'java'
+          name = java.lang.System.getProperty('os.name')
+          version = java.lang.System.getProperty('os.version')
+          "#{name}/#{version}"
+        else
+          `uname -sr`.sub(' ', '/')
+        end
+      rescue
+        RUBY_PLATFORM
+      end.gsub("\n", '')
+    end
+  end
+end

data/naver-searchad-api.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'naver/searchad/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'naver-searchad-api'
+  spec.version       = Naver::Searchad::Api::VERSION
+  spec.authors       = ['Min Kim']
+  spec.email         = %w[developers@forward3d.com min.kim@forward3d.com]
+
+  spec.summary       = %q(Naver Searchad API ruby client)
+  spec.description   = %q(Naver Searchad API ruby client)
+  spec.homepage      = 'http://forward3d.com'
+  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_runtime_dependency 'httpclient', '>= 2.8.1', '< 3.0'
+  spec.add_runtime_dependency 'addressable', '~> 2.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'factory_json', '~> 0.1.1'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: naver-searchad-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Min Kim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: factory_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: Naver Searchad API ruby client
+email:
+- developers@forward3d.com
+- min.kim@forward3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/naver/searchad/api.rb
+- lib/naver/searchad/api/ad-keyword/service.rb
+- lib/naver/searchad/api/ad/service.rb
+- lib/naver/searchad/api/adgroup/service.rb
+- lib/naver/searchad/api/auth.rb
+- lib/naver/searchad/api/campaign/service.rb
+- lib/naver/searchad/api/core/api_command.rb
+- lib/naver/searchad/api/core/base_service.rb
+- lib/naver/searchad/api/core/http_command.rb
+- lib/naver/searchad/api/core/logging.rb
+- lib/naver/searchad/api/errors.rb
+- lib/naver/searchad/api/options.rb
+- lib/naver/searchad/api/version.rb
+- naver-searchad-api.gemspec
+homepage: http://forward3d.com
+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.10
+signing_key: 
+specification_version: 4
+summary: Naver Searchad API ruby client
+test_files: []