google_search_results 1.3.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cf8b604485ff927dae81c9fd1a5017d92563b339bc77994e0365926a14f6192
-  data.tar.gz: 46cca48662a2bfe6d7b7c79e34b92afa931d3be9e8cf38eb139d6d086068d2c7
+  metadata.gz: f00191ba840fc5fdcde18b6e46293dca43ddd5cff4fa4896d72efc65544d92d2
+  data.tar.gz: 23c60e7e337ccc23fe9d4f7b3b5d1cb9257b877490042c79eccfaaa46ba51ac3
 SHA512:
-  metadata.gz: 6d26a044da90201b3c7e77841e7acc5bce8f0534ad7840df78b42120a7549ca79a3b787af90ad25e1062713b47a0fe7ab32b000a9ada008f27a64421ae97370c
-  data.tar.gz: 5257a57981176ee85df134f6bc89e1eebf2b16e44d0d3c90ee72a63541359b83e9ac8a69639c41c87d9f8a2eeb6571360bd223bd87b8474f90c3aa0a53b4796d
+  metadata.gz: 327808805373bc9aa99c38c1255e031b728b6c59737b6bed6332a70efa9d2a534787621ba162d176204c14e49521f45c1950b95db0098f80be48150b0a2fab43
+  data.tar.gz: 6f55bb911ae9c9620e5cb41de6d0ed36a13c82c883202af8228817be6500eab2dee3678b83bee0cca3ce648052604c3b9cbd48bc825194e53d31d2dcc06a17b5

data/lib/google_search_results.rb

@@ -1,39 +1,13 @@
-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
+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'
+require_relative 'search/apple_store_search.rb'
+require_relative 'search/naver_search.rb'

data/lib/search/apple_store_search.rb

@@ -0,0 +1,34 @@
+require_relative 'serp_api_search'
+
+# Apple Store Search Result for Ruby powered by SerpApi
+#
+# Search API Usage
+#
+# ```ruby
+# parameter = {
+#   term: "laptop",
+#   api_key: "Your SERP API Key"
+# }
+#
+# search = AppleStoreSearch.new(parameter)
+#
+# html_results = search.get_html
+# hash_results = search.get_hash
+# json_results = search.get_json
+#
+# ```
+# 
+# doc: https://serpapi.com/bing-search-api
+
+class AppleStoreSearch < SerpApiSearch
+
+  def initialize(params = {})
+    super(params, APPLE_STORE_ENGINE)
+    check_params([:term, :engine])
+  end
+
+  def get_location
+    raise SerpApiException.new('location is not supported by ' + APPLE_STORE_ENGINE)
+  end
+
+end

data/lib/{baidu_search_results.rb → search/baidu_search.rb}

@@ -1,4 +1,4 @@
-require_relative 'serp_api_client'
+require_relative 'serp_api_search'
 
 # Baidu Search Result for Ruby powered by SerpApi
 #
@@ -10,7 +10,7 @@ require_relative 'serp_api_client'
 #   api_key: "Serp API Key"
 # }
 #
-# search = BaiduSearchResults.new(parameter)
+# search = BaiduSearch.new(parameter)
 #
 # html_results = search.get_html
 # hash_results = search.get_hash
@@ -19,15 +19,15 @@ require_relative 'serp_api_client'
 # ```
 # doc: https://serpapi.com/baidu-search-api
 
-class BaiduSearchResults < SerpApiClient
+class BaiduSearch < SerpApiSearch
 
   def initialize(params = {})
-    super(params, BING_ENGINE)
+    super(params, BAIDU_ENGINE)
     check_params([:q, :engine])
   end
 
   def get_location
-    raise 'location is not supported by Baidu'
+    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,7 +11,7 @@ require_relative '../lib/bing_search_results'
 #   api_key: "Your SERP API Key"
 # }
 #
-# search = BingSearchResults.new(parameter)
+# search = BingSearch.new(parameter)
 # search.params[:location] = "Portland"
 #
 # html_results = search.get_html
@@ -22,7 +22,7 @@ require_relative '../lib/bing_search_results'
 # 
 # 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,7 +10,7 @@ require_relative 'serp_api_client'
 #   api_key: "Your SERP API Key"
 # }
 #
-# search = EbaySearchResults.new(parameter)
+# search = EbaySearch.new(parameter)
 # search.params[:ebay_domain] = "ebay.com"
 #
 # html_results = search.get_html
@@ -21,7 +21,7 @@ require_relative 'serp_api_client'
 #
 # 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/search/naver_search.rb

@@ -0,0 +1,36 @@
+require_relative 'serp_api_search'
+
+# Naver 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 = NaverSearch.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 NaverSearch < SerpApiSearch
+
+  def initialize(params = {})
+    super(params, NAVER_ENGINE)
+    check_params([:query, :engine])
+  end
+
+  def get_location
+    raise SerpApiException.new('location is not supported by ' + NAVER_ENGINE)
+  end
+
+end

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

@@ -7,13 +7,18 @@ 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'
+APPLE_STORE_ENGINE = 'apple_app_store'
+NAVER_ENGINE = 'naver'
 
 # Generic HTTP client for serpapi.com
 #
-class SerpApiClient
+class SerpApiSearch
 
-  VERSION = "1.3.2"
+  VERSION = "2.2.0"
   BACKEND = "serpapi.com"
 
   attr_accessor :params
@@ -24,8 +29,8 @@ class SerpApiClient
   # ---
   #
   # ```ruby
-  # require 'google_search_results'
-  # search = SerpApiClient.new({q: "coffee", api_key: "secure API key", engine: "google"})
+  # require 'google_search'
+  # search = SerpApiSearch.new({q: "coffee", api_key: "secure API key", engine: "google"})
   # result = search.get_json
   # ```
   #
@@ -34,7 +39,7 @@ class SerpApiClient
   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?
+    raise SerpApiException.new('engine must be defined in params or a second argument') if @params[:engine].nil?
   end
 
   # get_json 
@@ -78,7 +83,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
 
@@ -131,7 +136,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 +154,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 +171,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("\n -")}")
     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,7 +10,7 @@ require_relative 'serp_api_client'
 #   api_key: "Your SERP API Key"
 # }
 #
-# search = YahooSearchResults.new(parameter)
+# search = YahooSearch.new(parameter)
 # search.params[:yahoo_domain] = "fr"
 #
 # html_results = search.get_html
@@ -21,7 +21,7 @@ require_relative 'serp_api_client'
 #
 # 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,7 +10,7 @@ require_relative 'serp_api_client'
 #   api_key: "Your SERP API Key"
 # }
 #
-# search = YandexSearchResults.new(parameter)
+# search = YandexSearch.new(parameter)
 # search.params[:yandex_domain] = "yandex.com"
 #
 # html_results = search.get_html
@@ -21,7 +21,7 @@ require_relative 'serp_api_client'
 #
 # 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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: google_search_results
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.2.0
 platform: ruby
 authors:
 - hartator
 - jvmvik
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,19 +74,26 @@ 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/apple_store_search.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/naver_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
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,8 +108,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
-summary: Get Google, Bing, Baidu, Ebay, Yahoo, Yandex Search Results via SerpApi.com
+summary: Get Google, Bing, Baidu, Ebay, Yahoo, Yandex, Home depot, Naver, Apple, Duckduckgo,
+  Youtube search results via SerpApi.com
 test_files: []