naver-searchad-api 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8a2c4603328a963fa278a5f8d94482d003c112f
-  data.tar.gz: a25819a0b5d0ece492c6b5be61b52f86995401d7
+  metadata.gz: d573b3637886b895a912c269f9a1f4278418abd0
+  data.tar.gz: 49e9456fd4cf5796c7a28250a6fed8497aaa007e
 SHA512:
-  metadata.gz: 177d37cd338d82d3a8aa915aef548660502ffe047c099d0df7a41c537ebea85936bc8d50d4765232668f5c29cd28a807d1bcde544e1a2a47e45a05acda7ed952
-  data.tar.gz: 05307676ee81d332f74e33739ef2de713e182a0abd1c8400101724d1080ebf8d95fa4ac82f87a2e565f5cf211fb63fd7c2858b49df3a7522dfd765b61f15343f
+  metadata.gz: 274955fab04a7135c408a446193371107396b22e0c6ffaad18fa9bb6153bb011a897562adfa5ecb93f28e5f3301e27eb169ade5b8f244c95a6691585f7f107a8
+  data.tar.gz: f135af9db867879e88223646a8fda75ec3160bd176df3df69989fe85fa92263225c75334d13ac9346b64b4160914e09aa508d25d0cab97665473dea7fbd3a611

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 .DS_Store
+.gem

data/README.md

@@ -40,11 +40,17 @@ To use an API, instantiate the service. For example to use the Campaign API:
 
 ```ruby
 require 'naver/searchad/api/campaign/service'
+require 'naver/searchad/api/auth'
 
 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 all campaigns (with camelCase response)
+campaign.list_campaigns(options: { decode_snake_case: false }) do |res, err|
+  puts res
+end
+
 # Read campaigns by ids
 campaign.list_campaigns_by_ids(['campaign_id_1', 'campaign_id_2']) do |res, err|
   puts res

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

@@ -10,6 +10,11 @@ module Naver
             super('https://api.naver.com/', 'ncc/')
           end
 
+          def list_adgroups(options: nil, &block)
+            command = make_command(:get, 'adgroups', options)
+            execute_command(command, &block)
+          end
+
           def list_adgroups_by_ids(adgroup_ids, options: nil, &block)
             command = make_command(:get, 'adgroups', options)
             command.query['ids'] = adgroup_ids.join(',')

data/lib/naver/searchad/api/business-channel/service.rb

@@ -0,0 +1,21 @@
+require_relative '../core/base_service'
+
+module Naver
+  module Searchad
+    module Api
+      module BusinessChannel
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', 'ncc/')
+          end
+
+          def list_channels(options: nil, &block)
+            command = make_command(:get, 'channels', options)
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,6 +10,11 @@ module Naver
             super('https://api.naver.com/', 'ncc/')
           end
 
+          def list_campaigns(options: nil, &block)
+            command = make_command(:get, 'campaigns', options)
+            execute_command(command, &block)
+          end
+
           def list_campaigns_by_ids(campaign_ids, options: nil, &block)
             command = make_command(:get, 'campaigns/', options)
             command.query['ids'] = campaign_ids.join(',')

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

@@ -18,6 +18,13 @@ module Naver
           }
 
           attr_accessor :request_object
+          attr_accessor :decode_snake_case
+
+          def initialize(method, url, body: nil, decode_snake_case: true)
+            super(method, url, body: body)
+
+            @decode_snake_case = decode_snake_case
+          end
 
           def prepare!
             if request_object
@@ -32,7 +39,7 @@ module Naver
             return nil unless content_type.start_with?(JSON_CONTENT_TYPE)
 
             decoded_response = JSON.parse(body)
-            deep_snake_case_params!(decoded_response)
+            deep_snake_case_params!(decoded_response) if @decode_snake_case
             if decoded_response.kind_of?(Hash)
               OpenStruct.new(decoded_response)
             elsif decoded_response.kind_of?(Array)

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

@@ -4,6 +4,7 @@ require 'httpclient'
 require_relative '../options'
 require_relative '../version'
 require_relative 'api_command'
+require_relative 'download_command'
 require_relative 'logging'
 
 module Naver
@@ -42,6 +43,15 @@ module Naver
           def make_command(method, path, options = {})
             template = Addressable::Template.new(url + base_path + path)
             command = ApiCommand.new(method, template)
+            command.decode_snake_case = options.fetch(:decode_snake_case, true) if options
+            command.options = request_options.merge(options)
+            apply_command_defaults(command)
+            command
+          end
+
+          def make_download_command(method, path, options = {})
+            template = Addressable::Template.new(url + base_path + path)
+            command = DownloadCommand.new(method, template)
             command.options = request_options.merge(options)
             apply_command_defaults(command)
             command

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

@@ -0,0 +1,79 @@
+require_relative 'api_command'
+require 'addressable/uri'
+
+module Naver
+  module Searchad
+    module Api
+      module Core
+        class DownloadCommand < ApiCommand
+          OK_STATUSES = [200, 201, 206]
+
+          attr_accessor :download_dest
+
+          def prepare!
+            @state = :start
+            @download_url = nil
+            @offset = 0
+
+            if download_dest.is_a?(String)
+              @download_io = File.open(download_dest, 'wb')
+              @close_io_on_finish = true
+            else
+              @download_io = StringIO.new('', 'wb')
+              @close_io_on_finish = false
+            end
+
+            super
+          end
+
+          def release!
+            @download_io.close if @close_io_on_finish
+          end
+
+          def _execute(client)
+            request_header = {}
+            apply_request_options(request_header)
+            download_offset = nil
+
+            http_res = client.get(url.to_s,
+                                  query: nil,
+                                  header: request_header,
+                                  follow_redirect: true) do |res, chunk|
+              status = res.http_header.status_code.to_i
+              next unless OK_STATUSES.include?(status)
+
+              download_offset ||= (status == 206 ? @offset : 0)
+              download_offset += chunk.bytesize
+
+              if download_offset - chunk.bytesize == @offset
+                next_chunk = chunk
+              else
+                chunk_index = @offset - (download_offset - chunk.bytesize)
+                next_chunk = chunk.byteslice(chunk_index..-1)
+                next if next_chunk.nil?
+              end
+
+              @download_io.write(next_chunk)
+              @offset += next_chunk.bytesize
+            end
+
+            @download_io.flush
+
+            if @close_io_on_finish
+              result = nil
+            else
+              result = @download_io
+            end
+            check_status(http_res.status.to_i, http_res.header, http_res.body)
+            logger.debug("DownloadCommand: Success")
+            success(result)
+          rescue => e
+            @download_io.flush
+            logger.debug("DownloadCommand: Error - #{e.inspect}")
+            error(e)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,25 +32,20 @@ module Naver
           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)
+            _execute(client).tap do |result|
+              if block_given?
+                yield result, nil
+              end
+            end
 
-            logger.debug("Success - #{response}")
-            success(response, &block)
           rescue => e
-            logger.debug("Error - #{e.inspect}")
-            error(e, &block)
+            if block_given?
+              yield nil, e
+            else
+              raise e
+            end
+          ensure
+            release!
           end
 
           def prepare!
@@ -68,6 +63,31 @@ module Naver
             @body = '' unless body
           end
 
+          def release!
+          end
+
+          def _execute(client)
+            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)
+          rescue => e
+            logger.debug("Error - #{e.inspect}")
+            error(e)
+          end
+
           def process_response(status, header, body)
             check_status(status, header, body)
             decode_response_body(header['Content-Type'].first, body)

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

@@ -0,0 +1,21 @@
+require_relative '../core/base_service'
+
+module Naver
+  module Searchad
+    module Api
+      module Label
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', 'ncc/')
+          end
+
+          def list_labels(options: nil, &block)
+            command = make_command(:get, 'labels', options)
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/related-keyword-stat/service.rb

@@ -0,0 +1,21 @@
+require_relative '../core/base_service'
+
+module Naver
+  module Searchad
+    module Api
+      module RelatedKeywordStat
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', '')
+          end
+
+          def list_stats(options: nil, &block)
+            command = make_command(:get, 'keywordstool', options)
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/naver/searchad/api/stat-report/service.rb

@@ -0,0 +1,57 @@
+require_relative '../core/base_service'
+require 'addressable/uri'
+
+module Naver
+  module Searchad
+    module Api
+      module StatReport
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', '')
+          end
+
+          def download_report(download_url, file_path, options: {}, &block)
+            uri = Addressable::URI.parse(download_url)
+
+            command = make_download_command(:get, uri.path, options)
+            command.query['authtoken'] = uri.query_values['authtoken']
+            command.download_dest = file_path
+            execute_command(command, &block)
+          end
+
+          def get_stat_report(report_job_id, options: {}, &block)
+            command = make_command(:get, '/stat-reports/{report_job_id}', options)
+            command.params['report_job_id'] = report_job_id
+            execute_command(command, &block)
+          end
+
+          def list_stat_reports(options: {}, &block)
+            command = make_command(:get, '/stat-reports', options)
+            execute_command(command, &block)
+          end
+
+          def create_stat_report(type, date, options: {}, &block)
+            command = make_command(:post, '/stat-reports', options)
+            command.request_object = {
+              'reportTp' => type,
+              'statDt' => date
+            }
+            execute_command(command, &block)
+          end
+
+          def delete_stat_reports(options: {}, &block)
+            command = make_command(:delete, '/stat-reports', options)
+            execute_command(command, &block)
+          end
+
+          def delete_stat_report(report_job_id, options: {}, &block)
+            command = make_command(:delete, '/stat-reports/{report_job_id}', options)
+            command.params['report_job_id'] = report_job_id
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require_relative '../core/base_service'
+
+module Naver
+  module Searchad
+    module Api
+      module Stat
+        class Service < Naver::Searchad::Api::Core::BaseService
+
+          def initialize
+            super('https://api.naver.com/', '')
+          end
+
+          def get_stat_by_id(id, fields, time_range, options: {}, &block)
+            command = make_command(:get, 'stats', options)
+            command.query['id'] = id
+            command.query['fields'] = fields.to_json
+            command.query['timeRange'] = time_range.to_json
+            command.query['datePreset'] = options[:date_preset] if options[:date_preset]
+            command.query['timeIncrement'] = options[:time_increment] if options[:time_increment]
+            command.query['breakdown'] = options[:breakdown] if options[:breakdown]
+
+            execute_command(command, &block)
+          end
+
+          def get_stat_by_ids(ids, fields, time_range, options: {}, &block)
+            command = make_command(:get, 'stats', options)
+            command.query['ids'] = ids
+            command.query['fields'] = fields.to_json
+            command.query['timeRange'] = time_range.to_json
+            command.query['datePreset'] = options[:date_preset] if options[:date_preset]
+            command.query['timeIncrement'] = options[:time_increment] if options[:time_increment]
+            command.query['breakdown'] = options[:breakdown] if options[:breakdown]
+
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Naver
   module Searchad
     module Api
-      VERSION = '0.0.4'
+      VERSION = '0.0.6'
 
       OS_VERSION = begin
         if RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naver-searchad-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Min Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -136,13 +136,19 @@ files:
 - lib/naver/searchad/api/ad/service.rb
 - lib/naver/searchad/api/adgroup/service.rb
 - lib/naver/searchad/api/auth.rb
+- lib/naver/searchad/api/business-channel/service.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/download_command.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/label/service.rb
 - lib/naver/searchad/api/options.rb
+- lib/naver/searchad/api/related-keyword-stat/service.rb
+- lib/naver/searchad/api/stat-report/service.rb
+- lib/naver/searchad/api/stat/service.rb
 - lib/naver/searchad/api/version.rb
 - naver-searchad-api.gemspec
 homepage: https://github.com/forward3d/naver-searchad-api