sogou-search-api 0.0.1

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

@@ -0,0 +1,50 @@
+module Sogou
+  module Search
+    module Api
+      class Error < StandardError
+        attr_reader :code
+        attr_reader :message
+        attr_reader :header
+
+        def initialize(err, code: nil, header: nil)
+          @cause = nil
+
+          if err.respond_to?(:backtrace)
+            super(err.message)
+            @cause = err
+          else
+            super(err.to_s)
+          end
+          @code = code
+          @header = header unless header.nil?
+        end
+
+        def backtrace
+          if @cause
+            @cause.backtrace
+          else
+            super
+          end
+        end
+      end # Error
+
+      InvalidTokenError = Class.new(Error)
+
+      InvalidUserNameError = Class.new(Error)
+
+      WrongPasswordError = Class.new(Error)
+
+      RateLimitError = Class.new(Error)
+
+      UnknownError = Class.new(Error)
+
+      TransmissionError = Class.new(Error)
+
+      PlanIDNotExistError = Class.new(Error)
+
+      PromotionGroupIDNotExistError = Class.new(Error)
+
+      KeywordIDNotExistError = Class.new(Error)
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Sogou
+  module Search
+    module Api
+      ClientOptions = Struct.new(
+        :proxy_url,
+        :open_timeout_sec,
+        :read_timeout_sec,
+      )
+
+      class ClientOptions
+        def self.default
+          @options ||= ClientOptions.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative '../core/base_service'
+
+module Sogou
+  module Search
+    module Api
+      module Service
+        class Account < Core::BaseService
+          def initialize
+            super('AccountService')
+          end
+
+          def get_account_info(options = {}, &block)
+            command = make_command(:get_account_info, options: options)
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require_relative '../core/base_service'
+
+module Sogou
+  module Search
+    module Api
+      module Service
+        class Keyword < Core::BaseService
+          def initialize
+            super('CpcService')
+          end
+
+          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: {
+                cpc_grp_ids: grp_ids,
+                get_temp: valid_keyword_only(valid_keyword_only)
+              },
+              options: options
+            )
+            execute_command(command, &block)
+          end
+
+          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: {
+                cpc_grp_ids: grp_ids,
+                get_temp: valid_keyword_only(valid_keyword_only)
+              },
+              options: options
+            )
+            execute_command(command, &block)
+          end
+
+          private
+
+          def valid_keyword_only(only)
+            only ? 0 : 1
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative '../core/base_service'
+
+module Sogou
+  module Search
+    module Api
+      module Service
+        class Plan < Core::BaseService
+          def initialize
+            super('CpcPlanService')
+          end
+
+          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)
+            command = make_command(:get_all_cpc_plan, options: options)
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require_relative '../core/base_service'
+
+module Sogou
+  module Search
+    module Api
+      module Service
+        class PromotionGroup < Core::BaseService
+          def initialize
+            super('CpcGrpService')
+          end
+
+          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 },
+              options: options
+            )
+            execute_command(command, &block)
+          end
+
+          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 },
+              options: options
+            )
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require_relative '../core/base_service'
+
+module Sogou
+  module Search
+    module Api
+      module Service
+        class Report < Core::BaseService
+          def initialize
+            super('ReportService')
+          end
+
+          def get_report_id(start_date, end_date, type, fields, options = {}, &block)
+            command = make_command(
+              :get_report_id,
+              params: {
+                report_request_type: {
+                  performance_data: fields,
+                  start_date: start_date,
+                  end_date: end_date,
+                  report_type: type
+                }
+              },
+              options: options
+            )
+            execute_command(command, &block)
+          end
+
+          def get_report_state(report_id, options = {}, &block)
+            command = make_command(
+              :get_report_state,
+              params: { report_id: report_id },
+              options: options
+            )
+            execute_command(command, &block)
+          end
+
+          def get_report_path(report_id, options = {}, &block)
+            command = make_command(
+              :get_report_path,
+              params: { report_id: report_id },
+              options: options
+            )
+            execute_command(command, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Sogou
+  module Search
+    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/sogou-search-api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sogou/search/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sogou-search-api'
+  spec.version       = Sogou::Search::Api::VERSION
+  spec.authors       = ['Min Kim']
+  spec.email         = %w[developers@forward3d.com min.kim@forward3d.com]
+
+  spec.summary       = %q(Sogou Search API ruby client)
+  spec.description   = %q(Sogou Search API ruby client)
+  spec.homepage      = 'https://github.com/forward3d/sogou-search-api'
+  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 'savon', '~> 2.12'
+
+  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'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: sogou-search-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Min Kim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !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'
+description: Sogou Search API ruby client
+email:
+- developers@forward3d.com
+- min.kim@forward3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/account.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
+- lib/sogou/search/api/core/api_command.rb
+- lib/sogou/search/api/core/base_service.rb
+- lib/sogou/search/api/core/logging.rb
+- lib/sogou/search/api/core/regions.rb
+- lib/sogou/search/api/errors.rb
+- lib/sogou/search/api/options.rb
+- lib/sogou/search/api/service/account.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
+homepage: https://github.com/forward3d/sogou-search-api
+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.14
+signing_key: 
+specification_version: 4
+summary: Sogou Search API ruby client
+test_files: []