google_search_results 1.1.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9cec2b3a527d7088744a0189c2d57bc324b3bec
-  data.tar.gz: d9920122de8d07df6663ca0794eee0a8a4f33572
+SHA256:
+  metadata.gz: ad56c82937a90531cdebbddfa443885bb58848e8b165387263a72968e656a8aa
+  data.tar.gz: be506a5558ad74878c37faac39eb2477b377547e63cba06e631e7c4f83145806
 SHA512:
-  metadata.gz: 4096606c2a209617653af427213de99d88a419aac4e7aa6c3c5cd28ce0f43af6d716f552aa9b31b710f7a819090d74d53dfa2fc2a001160a976220ffeaaf1582
-  data.tar.gz: 35c00cc9a3c8b2a2f9387afe73f54cf2b4859a9e7565409fbfdf81448485bdd8df2fbe8e4c05a3de31428ad02f976bbc1e411cb13a684fe0f059a4d62c104b22
+  metadata.gz: b39e137c299bb240a5194af347917170b85754394ef793f57c2843d9d0dced7558aef2a37ad907e431eeebbd558fd0f93ab40212d5a214a75b66ff5b50479e47
+  data.tar.gz: cab293e5a8883b81403fe802d59a4dfcf5078e822dddd62503e5b9ea46335b186e0bb50ea1cdc4838a80bb1db434a6feb6acae6831b27c44e0cfffd83885c495

data/lib/google_search_results.rb

@@ -1,102 +1,7 @@
-# Google Search Result for Ruby
-#  powered by SerpApi.com
-#
-# Usage
-# ```
-#query_params = {
-#   q: "query",
-#   google_domain: "Google Domain", 
-#   location: "Location Requested", 
-#   device: device,
-#   hl: "Google UI Language",
-#   gl: "Google Country",
-#   safe: "Safe Search Flag",
-#   num: "Number of Results",
-#   start: "Pagination Offset",
-#   serp_api_key: "Your SERP API Key"
-# }
-#
-# query = GoogleSearchResults.new(query_params)
-# query.params[:location] = "Portland"
-#
-# html_results = query.get_html
-# hash_results = query.get_hash
-# json_results = query.get_json
-# ```
-# encoding: UTF-8
-
-require 'open-uri'
-require 'json'
-require_relative 'google_search_results/hash'
-
-class GoogleSearchResults
-
-  VERSION = "1.1.0"
-  BACKEND = "serpapi.com"
-
-  @@serp_api_key = nil
-
-  class << self
-    attr_accessor :serp_api_key
-  end
-
-  attr_accessor :params
-
-  # constructor
-  #
-  # Usage
-  # ---
-  # ```require 'google_search_results'
-  # query = GoogleSearchResults.new({q: "coffee", serp_api_key: "Your SERP API Key")
-  # result = query.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
-  end
-
-  # get_html 
-  # @return [String] raw html
-  def get_html
-    @params[:output] = "html"
-    get_results
-  end
-
-  # get_html
-  # @return [Hash] search result Ruby hash
-  #  where keys are Symbol
-  def get_hash
-    JSON.load(get_json).symbolize_all_keys
-  end
-
-  def construct_url
-    @params[:source] = "ruby"
-    if @params[:serp_api_key].nil? and GoogleSearchResults.serp_api_key
-      @params[:serp_api_key] = GoogleSearchResults.serp_api_key
-    end
-    URI::HTTPS.build(host: BACKEND, path: '/search', query: URI.encode_www_form(@params))
-  end
-
-  private
-
-  def get_results
-    begin
-      open(construct_url, 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
-
+require_relative 'search/serp_api_search.rb'
+require_relative 'search/baidu_search.rb'
+require_relative 'search/bing_search.rb'
+require_relative 'search/ebay_search.rb'
+require_relative 'search/google_search.rb'
+require_relative 'search/yahoo_search.rb'
+require_relative 'search/yandex_search.rb'

data/lib/search/baidu_search.rb

@@ -0,0 +1,33 @@
+require_relative 'serp_api_search'
+
+# Baidu Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   q: "query",
+#   api_key: "Serp API Key"
+# }
+#
+# search = BaiduSearch.new(parameter)
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+# doc: https://serpapi.com/baidu-search-api
+
+class BaiduSearch < SerpApiSearch
+
+  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/search/bing_search.rb

@@ -0,0 +1,32 @@
+require_relative 'serp_api_search'
+
+# 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"
+# }
+#
+# search = BingSearch.new(parameter)
+# search.params[:location] = "Portland"
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+# 
+# doc: https://serpapi.com/bing-search-api
+
+class BingSearch < SerpApiSearch
+
+  def initialize(params = {})
+    super(params, BING_ENGINE)
+    check_params([:q, :engine])
+  end
+
+end

data/lib/search/ebay_search.rb

@@ -0,0 +1,35 @@
+require_relative 'serp_api_search'
+
+# Ebay Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   _nkw: "query",
+#   api_key: "Your SERP API Key"
+# }
+#
+# search = EbaySearch.new(parameter)
+# search.params[:ebay_domain] = "ebay.com"
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+#
+# doc: https://serpapi.com/ebay-search-api
+
+class EbaySearch < SerpApiSearch
+
+  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/search/google_search.rb

@@ -0,0 +1,39 @@
+require_relative 'serp_api_search'
+
+# Google Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   q: "query",
+#   google_domain: "Google Domain", 
+#   location: "Location Requested", 
+#   device: device,
+#   hl: "Google UI Language",
+#   gl: "Google Country",
+#   safe: "Safe Search Flag",
+#   num: "Number of Results",
+#   start: "Pagination Offset",
+#   tbm: "to be matched field",
+#   tbs: "to be searched field",
+#   api_key: "Your SERP API Key"
+# }
+#
+# search = GoogleSearch.new(parameter)
+# search.params[:location] = "Portland"
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+# ```
+#
+# doc: https://serpapi.com/search-api
+class GoogleSearch < SerpApiSearch
+
+  def initialize(params = {})
+    super(params, GOOGLE_ENGINE)
+    check_params([:q, :engine])
+  end
+
+end

data/lib/search/serp_api_search.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 HTTP client for serpapi.com
+#
+class SerpApiSearch
+
+  VERSION = "2.0.1"
+  BACKEND = "serpapi.com"
+
+  attr_accessor :params
+
+  # constructor
+  #
+  # Usage
+  # ---
+  #
+  # ```ruby
+  # require 'google_search'
+  # search = SerpApiSearch.new({q: "coffee", api_key: "secure API key", engine: "google"})
+  # result = search.get_json
+  # ```
+  #
+  # @param [Hash] params contains requested parameter
+  # @param [String] engine google|baidu|google|bing|ebay|yandex (optional or can be set in params)
+  def initialize(params, engine = nil)
+    @params = params
+    @params[:engine] ||= engine
+    raise 'engine must be defined in params or a second argument' if @params[:engine].nil?
+  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 search
+  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(url).open(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/search/yahoo_search.rb

@@ -0,0 +1,35 @@
+require_relative 'serp_api_search'
+
+# Yahoo Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   p: "query",
+#   api_key: "Your SERP API Key"
+# }
+#
+# search = YahooSearch.new(parameter)
+# search.params[:yahoo_domain] = "fr"
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+#
+# doc: https://serpapi.com/yahoo-search-api
+
+class YahooSearch < SerpApiSearch
+
+  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/search/yandex_search.rb

@@ -0,0 +1,35 @@
+require_relative 'serp_api_search'
+
+# Yandex Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   text: "query",
+#   api_key: "Your SERP API Key"
+# }
+#
+# search = YandexSearch.new(parameter)
+# search.params[:yandex_domain] = "yandex.com"
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+#
+# doc: https://serpapi.com/yandex-search-api
+
+class YandexSearch < SerpApiSearch
+
+  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.1.0
+  version: 2.0.1
 platform: ruby
 authors:
 - hartator
-autorequire: 
+- jvmvik
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,43 +17,77 @@ 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: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
-description: Get Google Search Results via SERP API. Hash, JSON, and HTML outputs
-  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.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+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/google_search_results.rb
-- lib/google_search_results/hash.rb
+- lib/search/baidu_search.rb
+- lib/search/bing_search.rb
+- lib/search/ebay_search.rb
+- lib/search/google_search.rb
+- lib/search/serp_api_search.rb
+- lib/search/yahoo_search.rb
+- lib/search/yandex_search.rb
 homepage: https://github.com/serpapi/google-search-results-ruby
 licenses:
 - MIT
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+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: []

data/lib/google_search_results/hash.rb

@@ -1,18 +0,0 @@
-class Hash
-  def symbolize_all_keys(hash=self)
-    symbolized_hash = {}
-    return hash if hash.is_a?(String)
-    hash.each do |k, v|
-      if v.is_a?(Array)
-        symbolized_hash[k.to_sym] = v.map do |e|
-          symbolize_all_keys(e)
-        end
-      elsif v.is_a?(Hash)
-        symbolized_hash[k.to_sym] = symbolize_all_keys(v)
-      else
-        symbolized_hash[k.to_sym] = v
-      end
-    end
-    symbolized_hash
-  end
-end