sogou-search-api 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0b4319eb56256bda906b575a99471628c16cb52
-  data.tar.gz: d782793fda116ba744b925f2ee86e513034d958b
+  metadata.gz: 212e0b4f9985d050cfea03fab33a37fc5afeebd8
+  data.tar.gz: a93c9352ce35f492c48ab48c695e3e2d15d4997d
 SHA512:
-  metadata.gz: '0815c7bc00e9751202be2ff7f15a56ed610ebcfc55d9da8dbaef9ba074562183067fcc2becdeda5c26c388e349fe33ebb4ecedb8e6dd3750f1624965158e74b9'
-  data.tar.gz: 97ec1f5bc46fbe71520378396410617c08a60990cc464798be6a554d1bab58ccdb77b9f594fb1067c6b1738832b5ca91db7664c177eb797fffc6b8c2ac9d654e
+  metadata.gz: d10c831226a9f614729525e78cc61ff9debc9f30aab980b6464af7885beee853a70fb9dda12c0dc7bd90f7bba4860175ac3c8ad4ce31c81321da6771d6f1e9da
+  data.tar.gz: f7d0e47364f63f6409244a0f0f57f71acc0fac2e1b06cc5f37296509d433e41fb377b329488366b73cd879830335beaf17f64caca7f07aef31d8cb7544dc0316

data/README.md

@@ -45,7 +45,7 @@ include Sogou::Search::Api
 
 account = Service::Account.new
 account.authorization = Auth.get_application_default
-account.get_account_info(convert_regions_to_string: true) do |result, err|
+account.get_account_info(options: { convert_regions_to_string: true }) do |result, err|
   if err != nil
     p err
   else
@@ -62,7 +62,7 @@ returning the result from the call or raising the error. Example:
 
 ```ruby
 # Read account info
-account.get_account_info(convert_regions_to_string: true) do |result, err|
+account.get_account_info(options: { convert_regions_to_string: true }) do |result, err|
   if err
     # Handle error
   else

data/examples/account.rb

@@ -13,7 +13,7 @@ include Sogou::Search::Api
 
 account = Service::Account.new
 account.authorization = Auth.get_application_default
-account.get_account_info(convert_regions_to_string: true) do |result, err|
+account.get_account_info(options: {convert_regions_to_string: true}) do |result, err|
   if err != nil
     p err
   else

data/examples/{promotion_group.rb → group.rb}

@@ -1,6 +1,6 @@
 require 'sogou/search/api/auth'
 require 'sogou/search/api/service/plan'
-require 'sogou/search/api/service/promotion_group'
+require 'sogou/search/api/service/group'
 
 #
 # Set your Sogou api credentials to ENVs
@@ -15,7 +15,7 @@ plan = Service::Plan.new
 plan.authorization = Auth.get_application_default
 plan_ids = plan.get_all_cpc_plan_id.slice(0, 2)
 
-group = Service::PromotionGroup.new
+group = Service::Group.new
 group.authorization = Auth.get_application_default
 group.get_cpc_grp_by_cpc_plan_id(plan_ids) do |result, err|
   if err != nil

data/examples/keyword.rb

@@ -1,6 +1,6 @@
 require 'sogou/search/api/auth'
 require 'sogou/search/api/service/plan'
-require 'sogou/search/api/service/promotion_group'
+require 'sogou/search/api/service/group'
 require 'sogou/search/api/service/keyword'
 
 #
@@ -16,7 +16,7 @@ plan = Service::Plan.new
 plan.authorization = Auth.get_application_default
 plan_ids = plan.get_all_cpc_plan_id.slice(0, 2)
 
-group = Service::PromotionGroup.new
+group = Service::Group.new
 group.authorization = Auth.get_application_default
 group_ids = group.get_cpc_grp_id_by_cpc_plan_id(plan_ids).
               map { |id| id['cpc_grp_ids'] }.flatten.slice(0, 2)

data/examples/plan.rb

@@ -12,7 +12,7 @@ include Sogou::Search::Api
 
 plan = Service::Plan.new
 plan.authorization = Auth.get_application_default
-plan.get_all_cpc_plan(convert_regions_to_string: true) do |result, err|
+plan.get_all_cpc_plan(options: {convert_regions_to_string: true}) do |result, err|
   if err != nil
     p err
   else

data/examples/report.rb

@@ -12,12 +12,15 @@ include Sogou::Search::Api
 
 report = Service::Report.new
 report.authorization = Auth.get_application_default
-report_id = report.get_report_id(
-  '2018-02-20T00:00:00',
-  '2018-02-20T23:59:59',
-  1,
-  ['cost', 'cpc', 'click', 'ctr', 'position']
-  )
+
+request = Service::ReportRequest.new
+request.fields = %w[cost cpc click ctr impression position]
+request.start_date = '2018-02-20T00:00:00'
+request.end_date = '2018-02-20T23:59:59'
+request.type = 2
+request.platform = 2
+
+report_id = report.get_report_id(request)
 
 state = '0'
 max_try = 10

data/lib/sogou/search/api/service/account.rb

@@ -9,7 +9,7 @@ module Sogou
             super('AccountService')
           end
 
-          def get_account_info(options = {}, &block)
+          def get_account_info(options: {}, &block)
             command = make_command(:get_account_info, options: options)
             execute_command(command, &block)
           end

data/lib/sogou/search/api/service/{promotion_group.rb → group.rb}

@@ -4,12 +4,12 @@ module Sogou
   module Search
     module Api
       module Service
-        class PromotionGroup < Core::BaseService
+        class Group < Core::BaseService
           def initialize
             super('CpcGrpService')
           end
 
-          def get_cpc_grp_by_cpc_plan_id(plan_ids, options = {}, &block)
+          def get_cpc_grp_by_cpc_plan_id(plan_ids, options: {}, &block)
             command = make_command(
               :get_cpc_grp_by_cpc_plan_id,
               params: { cpc_plan_ids: plan_ids },
@@ -18,7 +18,7 @@ module Sogou
             execute_command(command, &block)
           end
 
-          def get_cpc_grp_id_by_cpc_plan_id(plan_ids, options = {}, &block)
+          def get_cpc_grp_id_by_cpc_plan_id(plan_ids, options: {}, &block)
             command = make_command(
               :get_cpc_grp_id_by_cpc_plan_id,
               params: { cpc_plan_ids: plan_ids },

data/lib/sogou/search/api/service/keyword.rb

@@ -9,7 +9,7 @@ module Sogou
             super('CpcService')
           end
 
-          def get_cpc_by_cpc_grp_id(grp_ids, valid_keyword_only = true, options = {}, &block)
+          def get_cpc_by_cpc_grp_id(grp_ids, valid_keyword_only: true, options: {}, &block)
             command = make_command(
               :get_cpc_by_cpc_grp_id,
               params: {
@@ -21,7 +21,7 @@ module Sogou
             execute_command(command, &block)
           end
 
-          def get_cpc_id_by_cpc_grp_id(grp_ids, valid_keyword_only = true, options = {}, &block)
+          def get_cpc_id_by_cpc_grp_id(grp_ids, valid_keyword_only: true, options: {}, &block)
             command = make_command(
               :get_cpc_id_by_cpc_grp_id,
               params: {

data/lib/sogou/search/api/service/plan.rb

@@ -9,12 +9,12 @@ module Sogou
             super('CpcPlanService')
           end
 
-          def get_all_cpc_plan_id(options = {}, &block)
+          def get_all_cpc_plan_id(options: {}, &block)
             command = make_command(:get_all_cpc_plan_id, options: options)
             execute_command(command, &block)
           end
 
-          def get_all_cpc_plan(options = {}, &block)
+          def get_all_cpc_plan(options: {}, &block)
             command = make_command(:get_all_cpc_plan, options: options)
             execute_command(command, &block)
           end

data/lib/sogou/search/api/service/report.rb

@@ -4,28 +4,45 @@ module Sogou
   module Search
     module Api
       module Service
+        ReportRequest = Struct.new(
+          :fields,
+          :start_date,
+          :end_date,
+          :type,
+          :platform,
+          :stat_range,
+          :format
+        )
+
         class Report < Core::BaseService
           def initialize
             super('ReportService')
           end
 
-          def get_report_id(start_date, end_date, type, fields, options = {}, &block)
+          def get_report_id(request, options: {}, &block)
+            unless request.fields && request.start_date && request.end_date && request.type
+              raise ArgumentError, 'fields, start_date, end_date, and type cannot be nil'
+            end
+
+            report_request = {
+              performance_data: request.fields,
+              start_date: request.start_date,
+              end_date: request.end_date,
+              report_type: request.type,
+            }
+            report_request.merge!(platform: request.platform) if request.platform
+            report_request.merge!(format: request.format) if request.format
+            report_request.merge!(stat_range: request.stat_range) if request.stat_range
+
             command = make_command(
               :get_report_id,
-              params: {
-                report_request_type: {
-                  performance_data: fields,
-                  start_date: start_date,
-                  end_date: end_date,
-                  report_type: type
-                }
-              },
+              params: { report_request_type: report_request },
               options: options
             )
             execute_command(command, &block)
           end
 
-          def get_report_state(report_id, options = {}, &block)
+          def get_report_state(report_id, options: {}, &block)
             command = make_command(
               :get_report_state,
               params: { report_id: report_id },
@@ -34,7 +51,7 @@ module Sogou
             execute_command(command, &block)
           end
 
-          def get_report_path(report_id, options = {}, &block)
+          def get_report_path(report_id, options: {}, &block)
             command = make_command(
               :get_report_path,
               params: { report_id: report_id },

data/lib/sogou/search/api/version.rb

@@ -1,7 +1,7 @@
 module Sogou
   module Search
     module Api
-      VERSION = '0.0.2'
+      VERSION = '1.0.0'
 
       OS_VERSION = begin
         if RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sogou-search-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Min Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -96,9 +96,9 @@ files:
 - bin/console
 - bin/setup
 - examples/account.rb
+- examples/group.rb
 - examples/keyword.rb
 - examples/plan.rb
-- examples/promotion_group.rb
 - examples/report.rb
 - lib/sogou/search/api.rb
 - lib/sogou/search/api/auth.rb
@@ -109,9 +109,9 @@ files:
 - lib/sogou/search/api/errors.rb
 - lib/sogou/search/api/options.rb
 - lib/sogou/search/api/service/account.rb
+- lib/sogou/search/api/service/group.rb
 - lib/sogou/search/api/service/keyword.rb
 - lib/sogou/search/api/service/plan.rb
-- lib/sogou/search/api/service/promotion_group.rb
 - lib/sogou/search/api/service/report.rb
 - lib/sogou/search/api/version.rb
 - sogou-search-api.gemspec
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Sogou Search API ruby client