google_search_results 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9cec2b3a527d7088744a0189c2d57bc324b3bec
-  data.tar.gz: d9920122de8d07df6663ca0794eee0a8a4f33572
+SHA256:
+  metadata.gz: 981326cdb315dc996ca78711369407131f295719296498613d6c8003c11afeb7
+  data.tar.gz: 0f9d30de883d5db7aff06274a098716103544696283ed1bc85e533a756b551c0
 SHA512:
-  metadata.gz: 4096606c2a209617653af427213de99d88a419aac4e7aa6c3c5cd28ce0f43af6d716f552aa9b31b710f7a819090d74d53dfa2fc2a001160a976220ffeaaf1582
-  data.tar.gz: 35c00cc9a3c8b2a2f9387afe73f54cf2b4859a9e7565409fbfdf81448485bdd8df2fbe8e4c05a3de31428ad02f976bbc1e411cb13a684fe0f059a4d62c104b22
+  metadata.gz: 7519258d49f11585846f80fc7f29909faf619e86b75d1680c60e6e63e15afec7f3ff7071d960c9954b97a67e1746da90ea1ea6cdd3ba9066524123605fd774c5
+  data.tar.gz: 8a156b74c5a054b07bd8f41a8ca757ce11a8246f837987da6dd1a6545739a214f22a1b6e6cdc76e28c2cf53cf720f92064a84bea60af34e2f0d51f3879380191

data/lib/google_search_results.rb

@@ -1,9 +1,8 @@
-# Google Search Result for Ruby
-#  powered by SerpApi.com
+# Google Search Result for Ruby powered by SerpAPI
 #
-# Usage
+# Search API Usage
 # ```
-#query_params = {
+# parameter = {
 #   q: "query",
 #   google_domain: "Google Domain", 
 #   location: "Location Requested", 
@@ -13,25 +12,26 @@
 #   safe: "Safe Search Flag",
 #   num: "Number of Results",
 #   start: "Pagination Offset",
+#   tbm: "to be matched field",
+#   tbs: "to be searched field",
 #   serp_api_key: "Your SERP API Key"
 # }
 #
-# query = GoogleSearchResults.new(query_params)
-# query.params[:location] = "Portland"
+# client = GoogleSearchResults.new(parameter)
+# client.params[:location] = "Portland"
 #
-# html_results = query.get_html
-# hash_results = query.get_hash
-# json_results = query.get_json
+# html_results = client.get_html
+# hash_results = client.get_hash
+# json_results = client.get_json
 # ```
 # encoding: UTF-8
 
 require 'open-uri'
 require 'json'
-require_relative 'google_search_results/hash'
 
 class GoogleSearchResults
 
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
   BACKEND = "serpapi.com"
 
   @@serp_api_key = nil
@@ -47,8 +47,8 @@ class GoogleSearchResults
   # Usage
   # ---
   # ```require 'google_search_results'
-  # query = GoogleSearchResults.new({q: "coffee", serp_api_key: "Your SERP API Key")
-  # result = query.get_json```
+  # client = GoogleSearchResults.new({q: "coffee", serp_api_key: "Your SERP API Key")
+  # result = client.get_json```
   #
   def initialize(params = {})
     @params = params
@@ -59,36 +59,68 @@ class GoogleSearchResults
   #  where keys are String
   def get_json
     @params[:output] = "json"
-    get_results
+    get_results('/search')
   end
 
   # get_html 
   # @return [String] raw html
   def get_html
     @params[:output] = "html"
-    get_results
+    get_results('/search')
   end
 
   # get_html
   # @return [Hash] search result Ruby hash
   #  where keys are Symbol
   def get_hash
-    JSON.load(get_json).symbolize_all_keys
+    JSON.parse(get_json, {symbolize_names: true})
   end
 
-  def construct_url
+  # 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 @params[:serp_api_key].nil? and GoogleSearchResults.serp_api_key
-      @params[:serp_api_key] = GoogleSearchResults.serp_api_key
+    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: '/search', query: URI.encode_www_form(@params))
+
+    URI::HTTPS.build(host: BACKEND, path: path, query: URI.encode_www_form(@params))
   end
 
   private
 
-  def get_results
+  def get_results(path)
     begin
-      open(construct_url, read_timeout: 600).read
+      open(construct_url(path), read_timeout: 600).read
     rescue OpenURI::HTTPError => e
       if error = JSON.load(e.io.read)["error"]
         raise error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_search_results
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - hartator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,28 +25,26 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '3.8'
   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.8'
+description: Get Google Search Results via SERP API. Hash, JSON, and HTML format supported.
 email: hartator@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/google_search_results.rb
-- lib/google_search_results/hash.rb
 homepage: https://github.com/serpapi/google-search-results-ruby
 licenses:
 - MIT
@@ -67,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Google Search Results via SERP API.

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