google_search_results 1.3.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37245404ba2b79b279c3719ed9b0142aa8914d80564cd6cfd70af9a2dcd4f56d
-  data.tar.gz: ae3bec079837ac373d4ffa4ff862b32212d914bde417184e5cb3627de38762ea
+  metadata.gz: c9850029f90956175395320f506e034bf6373397954c31452cef7e4fbe56d46d
+  data.tar.gz: '082c1dc59ab2526df21009b2bf127378c76039c828a7bee459b8efd1f8e9c58b'
 SHA512:
-  metadata.gz: b4e94b1c4902bc506e03c0b1461564ace6052925cb286a7e135634f76fdc81e9ed62833a440d77d8a32e0699745314f4cd1e4e72e22f14499dffa4fbee9dc935
-  data.tar.gz: d3199c0440f4f68ae947617c867e5a68ec516b2d60870c763fef538762f93f88d695660f5dad98fe18100b096396941fd5d2e49e59d0c8bec709f22e2ab08078
+  metadata.gz: 810293f9210d09d120d50123cf593d42c958204beb7154922f839ca217dd8d093518401fd59a1842f06e6e67b5e18b9cc16984b2df6bdd0d43a4f98508304cfa
+  data.tar.gz: e2aedc34c37f8b4779651e475c3b21011680d783686557bb562bdb546b98bf074f31256933aad066e21ce78988696bade30630e4690290e494e0d3dc291d2634

data/lib/google_search_results.rb

@@ -1,39 +1,11 @@
-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"
-# }
-#
-# client = GoogleSearchResults.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/search-api
-class GoogleSearchResults < SerpApiClient
-
-  def initialize(params = {})
-    super(params, GOOGLE_ENGINE)
-    check_params([:q, :engine])
-  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'
+require_relative 'search/youtube_search.rb'
+require_relative 'search/walmart_search.rb'
+require_relative 'search/duckduckgo_search.rb'
+require_relative 'search/homedepot_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, BAIDU_ENGINE)
+    check_params([:q, :engine])
+  end
+
+  def get_location
+    raise SerpApiException.new('location is not supported by Baidu')
+  end
+
+end

data/lib/{bing_search_results.rb → search/bing_search.rb}

@@ -1,4 +1,4 @@
-require_relative '../lib/bing_search_results'
+require_relative 'serp_api_search'
 
 # Bing Search Result for Ruby powered by SerpApi
 #
@@ -11,18 +11,18 @@ require_relative '../lib/bing_search_results'
 #   api_key: "Your SERP API Key"
 # }
 #
-# client = BingSearchResults.new(parameter)
-# client.params[:location] = "Portland"
+# search = BingSearch.new(parameter)
+# search.params[:location] = "Portland"
 #
-# html_results = client.get_html
-# hash_results = client.get_hash
-# json_results = client.get_json
+# 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
+class BingSearch < SerpApiSearch
 
   def initialize(params = {})
     super(params, BING_ENGINE)

data/lib/search/duckduckgo_search.rb

@@ -0,0 +1,29 @@
+require_relative 'serp_api_search'
+
+# Duckduckgo Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   search_query: "query",
+#   api_key: "Serp API Key"
+# }
+#
+# search = DuckduckgoSearch.new(parameter)
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+# doc: https://serpapi.com/Duckduckgo-search-api
+
+class DuckduckgoSearch < SerpApiSearch
+
+  def initialize(params = {})
+    super(params, DUCKDUCKGO_ENGINE)
+    check_params([:q, :engine])
+  end
+
+end

data/lib/{ebay_search_results.rb → search/ebay_search.rb}

@@ -1,4 +1,4 @@
-require_relative 'serp_api_client'
+require_relative 'serp_api_search'
 
 # Ebay Search Result for Ruby powered by SerpApi
 #
@@ -10,18 +10,18 @@ require_relative 'serp_api_client'
 #   api_key: "Your SERP API Key"
 # }
 #
-# client = EbaySearchResults.new(parameter)
-# client.params[:ebay_domain] = "ebay.com"
+# search = EbaySearch.new(parameter)
+# search.params[:ebay_domain] = "ebay.com"
 #
-# html_results = client.get_html
-# hash_results = client.get_hash
-# json_results = client.get_json
+# 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
+class EbaySearch < SerpApiSearch
 
   def initialize(params = {})
     super(params, EBAY_ENGINE)
@@ -29,7 +29,7 @@ class EbaySearchResults < SerpApiClient
   end
 
   def get_location
-    raise 'location is not supported by ' + EBAY_ENGINE
+    raise SerpApiException.new('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/homedepot_search.rb

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

data/lib/{serp_api_client.rb → search/serp_api_search.rb}

@@ -7,14 +7,16 @@ BING_ENGINE = 'bing'
 YAHOO_ENGINE = 'yahoo'
 YANDEX_ENGINE = 'yandex'
 EBAY_ENGINE = 'ebay'
+YOUTUBE_ENGINE = 'youtube'
+DUCKDUCKGO_ENGINE = 'duckduckgo'
+WALMART_ENGINE = 'walmart'
+HOMEDEPOT_ENGINE = 'home_depot'
 
+# Generic HTTP client for serpapi.com
+#
+class SerpApiSearch
 
-# Generic serpapi.com client
-#  which allow to custom cutting edge search service
-#   by setting the engine paremeter.
-class SerpApiClient
-
-  VERSION = "1.3.0"
+  VERSION = "2.1.0"
   BACKEND = "serpapi.com"
 
   attr_accessor :params
@@ -25,16 +27,17 @@ class SerpApiClient
   # ---
   #
   # ```ruby
-  # require 'google_search_results'
-  # client = SerpApiClient.new({q: "coffee", api_key: "secure API key"}, "google")
-  # result = client.get_json
+  # 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
-  def initialize(params, engine)
+  # @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 SerpApiException.new('engine must be defined in params or a second argument') if @params[:engine].nil?
   end
 
   # get_json 
@@ -78,7 +81,7 @@ class SerpApiClient
 
   # 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)$/
+    raise SerpApiException.new('format must be json or html') if format !~ /^(html|json)$/
     as_json(get_results("/searches/#{search_id}.#{format}"))
   end
 
@@ -117,7 +120,7 @@ class SerpApiClient
     $serp_api_key = api_key
   end
 
-  # @return [String] api_key for this client
+  # @return [String] api_key for this search
   def api_key
     @params[:api_key] || @params[:serp_api_key] || $serp_api_key
   end
@@ -131,7 +134,7 @@ class SerpApiClient
   def get_results(path)
     begin
       url = construct_url(path)
-      URI::open(url, read_timeout: 600).read
+      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}"
@@ -149,7 +152,7 @@ class SerpApiClient
   def check_params(keys = [])
     return if @params.keys == [:engine]
 
-    raise 'keys must be a list of String or Symbol' unless keys.class == Array
+    raise SerpApiException.new('keys must be a list of String or Symbol') unless keys.class == Array
     missing = []
     keys.each do |key|
       case key.class.to_s
@@ -166,13 +169,19 @@ class SerpApiClient
           end
         end
       else
-        raise 'keys must contains Symbol or String'
+        raise SerpApiException.new('keys must contains Symbol or String')
       end
     end
     if !missing.empty?
-      raise "missing required keys in params.\n #{missing.join(',')}"
+      raise SerpApiException.new("missing required keys in params.\n #{missing.join(',')}")
     end
   end
 
 end
 
+# Standard SerpApiException for anything related to the client
+class SerpApiException < StandardError
+  def initialize(message)
+    super(message)
+  end
+end

data/lib/search/walmart_search.rb

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

data/lib/{yahoo_search_results.rb → search/yahoo_search.rb}

@@ -1,4 +1,4 @@
-require_relative 'serp_api_client'
+require_relative 'serp_api_search'
 
 # Yahoo Search Result for Ruby powered by SerpApi
 #
@@ -10,18 +10,18 @@ require_relative 'serp_api_client'
 #   api_key: "Your SERP API Key"
 # }
 #
-# client = YahooSearchResults.new(parameter)
-# client.params[:yahoo_domain] = "fr"
+# search = YahooSearch.new(parameter)
+# search.params[:yahoo_domain] = "fr"
 #
-# html_results = client.get_html
-# hash_results = client.get_hash
-# json_results = client.get_json
+# 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
+class YahooSearch < SerpApiSearch
 
   def initialize(params = {})
     super(params, YAHOO_ENGINE)
@@ -29,7 +29,7 @@ class YahooSearchResults < SerpApiClient
   end
 
   def get_location
-    raise 'location is not supported by ' + YAHOO_ENGINE
+    raise SerpApiException.new('location is not supported by ' + YAHOO_ENGINE)
   end
 
 end

data/lib/{yandex_search_results.rb → search/yandex_search.rb}

@@ -1,4 +1,4 @@
-require_relative 'serp_api_client'
+require_relative 'serp_api_search'
 
 # Yandex Search Result for Ruby powered by SerpApi
 #
@@ -10,18 +10,18 @@ require_relative 'serp_api_client'
 #   api_key: "Your SERP API Key"
 # }
 #
-# client = YandexSearchResults.new(parameter)
-# client.params[:yandex_domain] = "yandex.com"
+# search = YandexSearch.new(parameter)
+# search.params[:yandex_domain] = "yandex.com"
 #
-# html_results = client.get_html
-# hash_results = client.get_hash
-# json_results = client.get_json
+# 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
+class YandexSearch < SerpApiSearch
 
   def initialize(params = {})
     super(params, YANDEX_ENGINE)
@@ -29,7 +29,7 @@ class YandexSearchResults < SerpApiClient
   end
 
   def get_location
-    raise 'location is not supported by ' + YAHOO_ENGINE
+    raise SerpApiException.new('location is not supported by ' + YAHOO_ENGINE)
   end
 
 end

data/lib/search/youtube_search.rb

@@ -0,0 +1,29 @@
+require_relative 'serp_api_search'
+
+# Youtube Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   search_query: "query",
+#   api_key: "Serp API Key"
+# }
+#
+# search = YoutubeSearch.new(parameter)
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+# doc: https://serpapi.com/youtube-search-api
+
+class YoutubeSearch < SerpApiSearch
+
+  def initialize(params = {})
+    super(params, YOUTUBE_ENGINE)
+    check_params([:search_query, :engine])
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_search_results
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.1.0
 platform: ruby
 authors:
 - hartator
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        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
@@ -74,13 +74,18 @@ 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
+- lib/search/baidu_search.rb
+- lib/search/bing_search.rb
+- lib/search/duckduckgo_search.rb
+- lib/search/ebay_search.rb
+- lib/search/google_search.rb
+- lib/search/homedepot_search.rb
+- lib/search/serp_api_search.rb
+- lib/search/walmart_search.rb
+- lib/search/yahoo_search.rb
+- lib/search/yandex_search.rb
+- lib/search/youtube_search.rb
 homepage: https://github.com/serpapi/google-search-results-ruby
 licenses:
 - MIT
@@ -101,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Get Google, Bing, Baidu, Ebay, Yahoo, Yandex Search Results via SerpApi.com

data/lib/baidu_search_results.rb

@@ -1,33 +0,0 @@
-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