sogou-search-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5c716c3f0a2b1c807eb08265f4b9ee700ae33d7
+  data.tar.gz: c66b6cd0d0e800170161a24b8ebde867ce54fce7
+SHA512:
+  metadata.gz: 627e5d14ebd0314ecb7330761522375dff5a54fa20152d0177493120c44235ddcea00841f76b5285912a2e960afc5dfcffd49f3c2a112b12081f87fd5b1d6214
+  data.tar.gz: a944be7071287c114fc205fb730d55c8e763fd7ef57e005e94e0c32c279da5a5b75fb6d09bba2620ff1a3fd9434cb6b3c5b1419d448348b97a1fa747df6dfc54

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-present 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,8 @@
+# Sogou Search API
+
+A Client GEM for [Sogou Search API](http://apihome.sogou.com/document/ss/doc1-1.jsp)
+
+## 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.

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 "sogou/search/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/examples/account.rb

@@ -0,0 +1,22 @@
+require 'sogou/search/api/auth'
+require 'sogou/search/api/service/account'
+require 'sogou/search/api/service/plan'
+
+#
+# Set your Sogou api credentials to ENVs
+#
+# ENV['SOGOU_API_TOKEN'] = 'xxxx'
+# ENV['SOGOU_USERNAME'] = 'xxxx'
+# ENV['SOGOU_PASSWORD'] = 'xxxx'
+
+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|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end

data/examples/keyword.rb

@@ -0,0 +1,40 @@
+require 'sogou/search/api/auth'
+require 'sogou/search/api/service/plan'
+require 'sogou/search/api/service/promotion_group'
+require 'sogou/search/api/service/keyword'
+
+#
+# Set your Sogou api credentials to ENVs
+#
+# ENV['SOGOU_API_TOKEN'] = 'xxxx'
+# ENV['SOGOU_USERNAME'] = 'xxxx'
+# ENV['SOGOU_PASSWORD'] = 'xxxx'
+
+include Sogou::Search::Api
+
+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.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)
+
+keyword = Service::Keyword.new
+keyword.authorization = Auth.get_application_default
+keyword.get_cpc_by_cpc_grp_id(group_ids) do |result, err|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end
+
+keyword.get_cpc_id_by_cpc_grp_id(group_ids) do |result, err|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end

data/examples/plan.rb

@@ -0,0 +1,29 @@
+require 'sogou/search/api/auth'
+require 'sogou/search/api/service/plan'
+
+#
+# Set your Sogou api credentials to ENVs
+#
+# ENV['SOGOU_API_TOKEN'] = 'xxxx'
+# ENV['SOGOU_USERNAME'] = 'xxxx'
+# ENV['SOGOU_PASSWORD'] = 'xxxx'
+
+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|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end
+
+plan.get_all_cpc_plan_id do |result, err|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end

data/examples/promotion_group.rb

@@ -0,0 +1,43 @@
+require 'sogou/search/api/auth'
+require 'sogou/search/api/service/plan'
+require 'sogou/search/api/service/promotion_group'
+
+#
+# Set your Sogou api credentials to ENVs
+#
+# ENV['SOGOU_API_TOKEN'] = 'xxxx'
+# ENV['SOGOU_USERNAME'] = 'xxxx'
+# ENV['SOGOU_PASSWORD'] = 'xxxx'
+
+include Sogou::Search::Api
+
+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.authorization = Auth.get_application_default
+group.get_cpc_grp_by_cpc_plan_id(plan_ids) do |result, err|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end
+
+group.get_cpc_grp_id_by_cpc_plan_id(plan_ids) do |result, err|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end
+
+# Error
+group.get_cpc_grp_by_cpc_plan_id([1, 2]) do |result, err|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end

data/examples/report.rb

@@ -0,0 +1,37 @@
+require 'sogou/search/api/auth'
+require 'sogou/search/api/service/report'
+
+#
+# Set your Sogou api credentials to ENVs
+#
+# ENV['SOGOU_API_TOKEN'] = 'xxxx'
+# ENV['SOGOU_USERNAME'] = 'xxxx'
+# ENV['SOGOU_PASSWORD'] = 'xxxx'
+
+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']
+  )
+
+state = '0'
+max_try = 10
+try = 0
+
+while state != '1' && try < 10
+  sleep(5)
+  state = report.get_report_state(report_id)
+  try += 1
+end
+
+if state == '1'
+  path = report.get_report_path(report_id)
+  p path
+else
+  puts 'Timed out'
+end

data/lib/sogou/search/api.rb

@@ -0,0 +1,35 @@
+require 'sogou/search/api/version'
+require 'logger'
+
+module Sogou
+  module Search
+    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/sogou/search/api/auth.rb

@@ -0,0 +1,54 @@
+module Sogou
+  module Search
+    module Api
+      module Auth
+        class V1AcccountCredentials
+          USERNAME_HEADER = 'v1:username'.freeze
+          PASSWORD_HEADER = 'v1:password'.freeze
+          API_TOKEN_HEADER = 'v1:token'.freeze
+          AUTH_HEADER = 'v1:AuthHeader'.freeze
+
+          attr_reader :api_token
+          attr_reader :username
+          attr_reader :password
+
+          def initialize(api_token, username, password)
+            @api_token = api_token
+            @username = username
+            @password = password
+          end
+
+          def apply(hash)
+            hash ||= {}
+            hash[AUTH_HEADER] = {
+              USERNAME_HEADER => username,
+              PASSWORD_HEADER => password,
+              API_TOKEN_HEADER => api_token
+            }
+            hash
+          end
+        end
+
+        class DefaultCredentials
+          API_TOKEN_ENV_VAR = 'SOGOU_API_TOKEN'.freeze
+          USERNAME_ENV_VAR = 'SOGOU_USERNAME'.freeze
+          PASSWORD_ENV_VAR = 'SOGOU_PASSWORD'.freeze
+
+          def self.from_env
+            V1AcccountCredentials.new(
+              ENV[API_TOKEN_ENV_VAR],
+              ENV[USERNAME_ENV_VAR],
+              ENV[PASSWORD_ENV_VAR]
+              )
+          end
+        end
+
+        def get_application_default
+          DefaultCredentials.from_env
+        end
+
+        module_function :get_application_default
+      end
+    end
+  end
+end

data/lib/sogou/search/api/core/api_command.rb

@@ -0,0 +1,114 @@
+require_relative '../errors'
+require_relative 'logging'
+require_relative 'regions'
+
+module Sogou
+  module Search
+    module Api
+      module Core
+        class ApiCommand
+          include Logging
+          include Regions
+
+          attr_accessor :operation
+          attr_accessor :options
+          attr_accessor :params
+
+          def initialize(operation)
+            @operation = operation
+            @params = {}
+            @options = {}
+          end
+
+          def execute(client, &block)
+            logger.debug("Executing SOAP #{operation}")
+
+            resp = client.call(@operation, message: @params)
+            result = process_response(resp)
+
+            logger.debug("Success - #{result}")
+            success(result, &block)
+          rescue => e
+            logger.debug("Error - #{e.inspect}")
+            error(e, &block)
+          end
+
+          def process_response(response)
+            check_status(response)
+            decode_response_body(response.body)
+          end
+
+          def check_status(response)
+            logger.debug("Response Header - #{response.header}")
+            res_header = response.header['res_header']
+            check_error_code(res_header['failures']) if res_header['desc'] != 'success'
+          end
+
+          def decode_response_body(body)
+            result = body["#{@operation}_response"]
+            if result
+              result = result.is_a?(Hash) ? result.values[0] : result
+              result = convert_regions_to_string(result) if options[:convert_regions_to_string]
+              result
+            end
+          end
+
+          #
+          # More error codes and descriptions can be found here
+          # http://apihome.sogou.com/document/ss/doc11.jsp
+          #
+          def check_error_code(header, raise_error = true)
+            res_header = header.is_a?(Array) ? header[0] : header
+            error_klass = case res_header['code'].to_i
+                          when 6 # Invalid username
+                            InvalidUserNameError
+                          when 8 # Wrong password
+                            WrongPasswordError
+                          when 10 # Token is invalid
+                            InvalidTokenError
+                          when 18 # Insufficient quotas
+                            RateLimitError
+                          when 1000011 # Plan ID does not exist
+                            PlanIDNotExistError
+                          when 1000012 # Promotion group ID does not exist
+                            PromotionGroupIDNotExistError
+                          when 1000013 # Keyword ID does not exist
+                            KeywordIDNotExistError
+                          else
+                            UnknownError
+                          end
+
+            exception = error_klass.new(
+              res_header.fetch('message', 'Unknown error'),
+              code: res_header['code'],
+              header: header
+            )
+            raise_error ? (raise exception) : exception
+          end
+
+          private
+
+          def success(result)
+            yield(result, nil)  if block_given?
+            result
+          end
+
+          def error(err)
+            if err.is_a?(Net::ReadTimeout) || err.is_a?(SocketError)
+              err = TransmissionError.new(err)
+            end
+
+            if block_given?
+              if err.respond_to?(:header) && err.header.is_a?(Array)
+                err = err.header.map { |h| check_error_code(h, false) }
+              end
+              yield(nil, err)
+            else
+              raise err
+            end
+          end
+        end
+      end
+    end
+  end
+end