google_search_results 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981326cdb315dc996ca78711369407131f295719296498613d6c8003c11afeb7
-  data.tar.gz: 0f9d30de883d5db7aff06274a098716103544696283ed1bc85e533a756b551c0
+  metadata.gz: 37245404ba2b79b279c3719ed9b0142aa8914d80564cd6cfd70af9a2dcd4f56d
+  data.tar.gz: ae3bec079837ac373d4ffa4ff862b32212d914bde417184e5cb3627de38762ea
 SHA512:
-  metadata.gz: 7519258d49f11585846f80fc7f29909faf619e86b75d1680c60e6e63e15afec7f3ff7071d960c9954b97a67e1746da90ea1ea6cdd3ba9066524123605fd774c5
-  data.tar.gz: 8a156b74c5a054b07bd8f41a8ca757ce11a8246f837987da6dd1a6545739a214f22a1b6e6cdc76e28c2cf53cf720f92064a84bea60af34e2f0d51f3879380191
+  metadata.gz: b4e94b1c4902bc506e03c0b1461564ace6052925cb286a7e135634f76fdc81e9ed62833a440d77d8a32e0699745314f4cd1e4e72e22f14499dffa4fbee9dc935
+  data.tar.gz: d3199c0440f4f68ae947617c867e5a68ec516b2d60870c763fef538762f93f88d695660f5dad98fe18100b096396941fd5d2e49e59d0c8bec709f22e2ab08078

data/lib/baidu_search_results.rb

@@ -0,0 +1,33 @@
+require_relative 'serp_api_client'
+
+# Baidu Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   q: "query",
+#   api_key: "Serp API Key"
+# }
+#
+# client = BaiduSearchResults.new(parameter)
+#
+# html_results = client.get_html
+# hash_results = client.get_hash
+# json_results = client.get_json
+#
+# ```
+# doc: https://serpapi.com/baidu-search-api
+
+class BaiduSearchResults < SerpApiClient
+
+  def initialize(params = {})
+    super(params, BING_ENGINE)
+    check_params([:q, :engine])
+  end
+
+  def get_location
+    raise 'location is not supported by Baidu'
+  end
+
+end

data/lib/bing_search_results.rb

@@ -0,0 +1,32 @@
+require_relative '../lib/bing_search_results'
+
+# Bing Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   q: "query",
+#   location: "city,state,country",
+#   api_key: "Your SERP API Key"
+# }
+#
+# client = BingSearchResults.new(parameter)
+# client.params[:location] = "Portland"
+#
+# html_results = client.get_html
+# hash_results = client.get_hash
+# json_results = client.get_json
+#
+# ```
+# 
+# doc: https://serpapi.com/bing-search-api
+
+class BingSearchResults < SerpApiClient
+
+  def initialize(params = {})
+    super(params, BING_ENGINE)
+    check_params([:q, :engine])
+  end
+
+end

data/lib/ebay_search_results.rb

@@ -0,0 +1,35 @@
+require_relative 'serp_api_client'
+
+# Ebay Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   _nkw: "query",
+#   api_key: "Your SERP API Key"
+# }
+#
+# client = EbaySearchResults.new(parameter)
+# client.params[:ebay_domain] = "ebay.com"
+#
+# html_results = client.get_html
+# hash_results = client.get_hash
+# json_results = client.get_json
+#
+# ```
+#
+# doc: https://serpapi.com/ebay-search-api
+
+class EbaySearchResults < SerpApiClient
+
+  def initialize(params = {})
+    super(params, EBAY_ENGINE)
+    check_params([:_nkw, :engine])
+  end
+
+  def get_location
+    raise 'location is not supported by ' + EBAY_ENGINE
+  end
+
+end

data/lib/google_search_results.rb

@@ -1,7 +1,10 @@
-# Google Search Result for Ruby powered by SerpAPI
+require_relative 'serp_api_client'
+
+# Google Search Result for Ruby powered by SerpApi
 #
 # Search API Usage
-# ```
+#
+# ```ruby
 # parameter = {
 #   q: "query",
 #   google_domain: "Google Domain", 
@@ -14,7 +17,7 @@
 #   start: "Pagination Offset",
 #   tbm: "to be matched field",
 #   tbs: "to be searched field",
-#   serp_api_key: "Your SERP API Key"
+#   api_key: "Your SERP API Key"
 # }
 #
 # client = GoogleSearchResults.new(parameter)
@@ -24,111 +27,13 @@
 # hash_results = client.get_hash
 # json_results = client.get_json
 # ```
-# encoding: UTF-8
-
-require 'open-uri'
-require 'json'
-
-class GoogleSearchResults
-
-  VERSION = "1.2.0"
-  BACKEND = "serpapi.com"
-
-  @@serp_api_key = nil
-
-  class << self
-    attr_accessor :serp_api_key
-  end
-
-  attr_accessor :params
+#
+# doc: https://serpapi.com/search-api
+class GoogleSearchResults < SerpApiClient
 
-  # constructor
-  #
-  # Usage
-  # ---
-  # ```require 'google_search_results'
-  # client = GoogleSearchResults.new({q: "coffee", serp_api_key: "Your SERP API Key")
-  # result = client.get_json```
-  #
   def initialize(params = {})
-    @params = params
-  end
-
-  # get_json 
-  # @return [Hash] search result "json like"
-  #  where keys are String
-  def get_json
-    @params[:output] = "json"
-    get_results('/search')
-  end
-
-  # get_html 
-  # @return [String] raw html
-  def get_html
-    @params[:output] = "html"
-    get_results('/search')
-  end
-
-  # get_html
-  # @return [Hash] search result Ruby hash
-  #  where keys are Symbol
-  def get_hash
-    JSON.parse(get_json, {symbolize_names: true})
+    super(params, GOOGLE_ENGINE)
+    check_params([:q, :engine])
   end
 
-  # alias for get_hash
-  # @deprecated
-  def get_hash_with_images
-    get_hash
-  end
-
-  # alias for get_json
-  # @deprecated
-  def get_json_with_images
-    get_json
-  end
-
-  # Get location using Location API
-  def get_location
-    JSON.parse(get_results('/locations.json'), {symbolize_names: true})
-  end
-
-  # Retrieve search result from the Search Archive API
-  def get_search_archive(search_id, format = 'json')
-    raise 'format must be json or html' if format !~ /^(html|json)$/
-    JSON.parse(get_results("/searches/#{search_id}.#{format}"), {symbolize_names: true})
-  end
-
-   # Get account information using Account API
-   def get_account
-    JSON.parse(get_results('/account'), {symbolize_names: true})
-  end
-
-  def construct_url(path)
-    @params[:source] = "ruby"
-    if GoogleSearchResults.serp_api_key
-      @params[:serp_api_key] ||= GoogleSearchResults.serp_api_key
-    end
-    if @params[:serp_api_key].nil?
-      @params.delete(:serp_api_key)
-    end
-
-    URI::HTTPS.build(host: BACKEND, path: path, query: URI.encode_www_form(@params))
-  end
-
-  private
-
-  def get_results(path)
-    begin
-      open(construct_url(path), read_timeout: 600).read
-    rescue OpenURI::HTTPError => e
-      if error = JSON.load(e.io.read)["error"]
-        raise error
-      else
-        raise e
-      end
-    end
-  end
-
-end
-
+end

data/lib/serp_api_client.rb

@@ -0,0 +1,178 @@
+require 'open-uri'
+require 'json'
+
+GOOGLE_ENGINE = 'google'
+BAIDU_ENGINE = 'baidu'
+BING_ENGINE = 'bing'
+YAHOO_ENGINE = 'yahoo'
+YANDEX_ENGINE = 'yandex'
+EBAY_ENGINE = 'ebay'
+
+
+# Generic serpapi.com client
+#  which allow to custom cutting edge search service
+#   by setting the engine paremeter.
+class SerpApiClient
+
+  VERSION = "1.3.0"
+  BACKEND = "serpapi.com"
+
+  attr_accessor :params
+
+  # constructor
+  #
+  # Usage
+  # ---
+  #
+  # ```ruby
+  # require 'google_search_results'
+  # client = SerpApiClient.new({q: "coffee", api_key: "secure API key"}, "google")
+  # result = client.get_json
+  # ```
+  #
+  # @param [Hash] params contains requested parameter
+  # @param [String] engine google|baidu|google|bing|ebay|yandex
+  def initialize(params, engine)
+    @params = params
+    @params[:engine] ||= engine
+  end
+
+  # get_json 
+  # @return [Hash] search result "json like"
+  #  where keys are String
+  def get_json
+    @params[:output] = "json"
+    get_results('/search')
+  end
+
+  # get_html 
+  # @return [String] raw html
+  def get_html
+    @params[:output] = "html"
+    get_results('/search')
+  end
+
+  # get_html
+  # @return [Hash] search result Ruby hash
+  #  where keys are Symbol
+  def get_hash
+    JSON.parse(get_json, {symbolize_names: true})
+  end
+
+  # alias for get_hash
+  # @deprecated
+  def get_hash_with_images
+    get_hash
+  end
+
+  # alias for get_json
+  # @deprecated
+  def get_json_with_images
+    get_json
+  end
+
+  # Get location using Location API
+  def get_location
+    as_json(get_results('/locations.json'))
+  end
+
+  # Retrieve search result from the Search Archive API
+  def get_search_archive(search_id, format = 'json')
+    raise 'format must be json or html' if format !~ /^(html|json)$/
+    as_json(get_results("/searches/#{search_id}.#{format}"))
+  end
+
+   # Get account information using Account API
+  def get_account
+    as_json(get_results('/account'))
+  end
+
+  # @return [String] current search engine
+  def engine
+    @params[:engine]
+  end
+
+  def construct_url(path)
+    @params[:source] = "ruby"
+    if !$serp_api_key.nil?
+      @params[:api_key] = $serp_api_key
+    end
+
+    @params.delete_if { |_, value| value.nil? }
+
+    URI::HTTPS.build(host: BACKEND, path: path, query: URI.encode_www_form(@params))
+  end
+
+  # serp_api_key
+  # legacy implementation.
+  #
+  # @param [String] api_key set user secret API key (copy/paste from https://serpapi.com/dashboard)
+  def self.serp_api_key=(api_key)
+    self.api_key = api_key
+  end
+
+  # api_key
+  # @param [String] api_key set user secret API key (copy/paste from https://serpapi.com/dashboard)
+  def self.api_key=(api_key)
+    $serp_api_key = api_key
+  end
+
+  # @return [String] api_key for this client
+  def api_key
+    @params[:api_key] || @params[:serp_api_key] || $serp_api_key
+  end
+
+  private
+
+  def as_json(data)
+    JSON.parse(data, symbolize_names: true)
+  end
+
+  def get_results(path)
+    begin
+      url = construct_url(path)
+      URI::open(url, read_timeout: 600).read
+    rescue OpenURI::HTTPError => e
+      if error = JSON.load(e.io.read)["error"]
+        puts "server returns error for url: #{url}"
+        raise error
+      else
+        puts "fail: fetch url: #{url}"
+        raise e
+      end
+    rescue => e
+      puts "fail: fetch url: #{url}"
+      raise e
+    end
+  end
+
+  def check_params(keys = [])
+    return if @params.keys == [:engine]
+
+    raise 'keys must be a list of String or Symbol' unless keys.class == Array
+    missing = []
+    keys.each do |key|
+      case key.class.to_s
+      when 'String'
+        if @params[key].nil?
+          if @params[key.to_sym].nil?
+            missing << key.to_s
+          end
+        end
+      when 'Symbol'
+        if @params[key].nil?
+          if @params[key.to_s].nil?
+            missing << key.to_s
+          end
+        end
+      else
+        raise 'keys must contains Symbol or String'
+      end
+    end
+    if !missing.empty?
+      raise "missing required keys in params.\n #{missing.join(',')}"
+    end
+  end
+
+end
+

data/lib/yahoo_search_results.rb

@@ -0,0 +1,35 @@
+require_relative 'serp_api_client'
+
+# Yahoo Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   p: "query",
+#   api_key: "Your SERP API Key"
+# }
+#
+# client = YahooSearchResults.new(parameter)
+# client.params[:yahoo_domain] = "fr"
+#
+# html_results = client.get_html
+# hash_results = client.get_hash
+# json_results = client.get_json
+#
+# ```
+#
+# doc: https://serpapi.com/yahoo-search-api
+
+class YahooSearchResults < SerpApiClient
+
+  def initialize(params = {})
+    super(params, YAHOO_ENGINE)
+    check_params([:p, :engine])
+  end
+
+  def get_location
+    raise 'location is not supported by ' + YAHOO_ENGINE
+  end
+
+end

data/lib/yandex_search_results.rb

@@ -0,0 +1,35 @@
+require_relative 'serp_api_client'
+
+# Yandex Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   text: "query",
+#   api_key: "Your SERP API Key"
+# }
+#
+# client = YandexSearchResults.new(parameter)
+# client.params[:yandex_domain] = "yandex.com"
+#
+# html_results = client.get_html
+# hash_results = client.get_hash
+# json_results = client.get_json
+#
+# ```
+#
+# doc: https://serpapi.com/yandex-search-api
+
+class YandexSearchResults < SerpApiClient
+
+  def initialize(params = {})
+    super(params, YANDEX_ENGINE)
+    check_params([:text, :engine])
+  end
+
+  def get_location
+    raise 'location is not supported by ' + YAHOO_ENGINE
+  end
+
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: google_search_results
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - hartator
+- jvmvik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,35 +17,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.2'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.2'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-description: Get Google Search Results via SERP API. Hash, JSON, and HTML format supported.
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+description: Scape localized search results from search engine using SerpApi.com and
+  returns Hash, JSON, raw HTML
 email: hartator@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/baidu_search_results.rb
+- lib/bing_search_results.rb
+- lib/ebay_search_results.rb
 - lib/google_search_results.rb
+- lib/serp_api_client.rb
+- lib/yahoo_search_results.rb
+- lib/yandex_search_results.rb
 homepage: https://github.com/serpapi/google-search-results-ruby
 licenses:
 - MIT
@@ -65,8 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Google Search Results via SERP API.
+summary: Get Google, Bing, Baidu, Ebay, Yahoo, Yandex Search Results via SerpApi.com
 test_files: []