google_search_results 1.0.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb52d55050108ccd4c76ef94af06e6b8ec9d7c2d
-  data.tar.gz: 63926f816a039a88bce029cc2df72bf74ef0d1e0
+SHA256:
+  metadata.gz: 9cf8b604485ff927dae81c9fd1a5017d92563b339bc77994e0365926a14f6192
+  data.tar.gz: 46cca48662a2bfe6d7b7c79e34b92afa931d3be9e8cf38eb139d6d086068d2c7
 SHA512:
-  metadata.gz: '091907b1665ca25e0952db05267e5946580ea3599604f052e90db773af019c4f182f8f67ec97142f2b0b7586bf40ab65fd3826bf07017bc589dd30fe2be342be'
-  data.tar.gz: 8904267d9994e0948d2ef84168d7bd47d79ce5b7de608c60ffd16c9c6eb3c23e8bc6af2f0cb8d85d4bfcb02cdf66dc041f072f5a7f1be5ee09153fd4a6e9ab38
+  metadata.gz: 6d26a044da90201b3c7e77841e7acc5bce8f0534ad7840df78b42120a7549ca79a3b787af90ad25e1062713b47a0fe7ab32b000a9ada008f27a64421ae97370c
+  data.tar.gz: 5257a57981176ee85df134f6bc89e1eebf2b16e44d0d3c90ee72a63541359b83e9ac8a69639c41c87d9f8a2eeb6571360bd223bd87b8474f90c3aa0a53b4796d

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"
+# }
+#
+# search = BaiduSearchResults.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 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"
+# }
+#
+# search = BingSearchResults.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 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"
+# }
+#
+# search = EbaySearchResults.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 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,67 +1,39 @@
-# encoding: UTF-8
-
-require 'open-uri'
-require 'json'
-require_relative 'google_search_results/hash'
-
-class GoogleSearchResults
-
-  VERSION = "1.0.1"
-  BACKEND = "serpapi.com"
-
-  @@serp_api_key = nil
-
-  class << self
-    attr_accessor :serp_api_key
-  end
-
-  attr_accessor :params
-
-  def initialize params = {}
-    @params = params
-  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
-
-  def get_results
-    begin
-      open(construct_url).read
-    rescue OpenURI::HTTPError => e
-      if error = JSON.load(e.io.read)["error"]      
-        raise error
-      else
-        raise e
-      end
-    end
-  end
-
-  def get_html
-    @params[:output] = "html"
-    get_results
-  end
-
-  def get_json
-    @params[:output] = "json"
-    get_results
-  end
-
-  def get_json_with_images
-    @params[:output] = "json_with_images"
-    get_results
-  end
-
-  def get_hash
-    JSON.load(get_json).symbolize_all_keys
-  end
-
-  def get_hash_with_images
-    JSON.load(get_json_with_images).symbolize_all_keys
-  end
-
-end 
+require_relative 'serp_api_client'
+
+# 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 = GoogleSearchResults.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 GoogleSearchResults < SerpApiClient
+
+  def initialize(params = {})
+    super(params, GOOGLE_ENGINE)
+    check_params([:q, :engine])
+  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 HTTP client for serpapi.com
+#
+class SerpApiClient
+
+  VERSION = "1.3.2"
+  BACKEND = "serpapi.com"
+
+  attr_accessor :params
+
+  # constructor
+  #
+  # Usage
+  # ---
+  #
+  # ```ruby
+  # require 'google_search_results'
+  # search = SerpApiClient.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::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"
+# }
+#
+# search = YahooSearchResults.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 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"
+# }
+#
+# search = YandexSearchResults.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 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.0.1
+  version: 1.3.2
 platform: ruby
 authors:
 - hartator
+- jvmvik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,41 +17,75 @@ 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/baidu_search_results.rb
+- lib/bing_search_results.rb
+- lib/ebay_search_results.rb
 - lib/google_search_results.rb
-- lib/google_search_results/hash.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
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -66,9 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+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