add more examples

Author: jvmvik

README.md

@@ -4,13 +4,17 @@ def snippet(format, path, demo = false)
  if demo
   buf = lines[1..-1].join
  else
+  # select test from line start to stop
+  start = 9
   stop = lines.find_index { |line| line =~ /pp results/}
-  slice = File.new(path).readlines[2..stop+1]
-  slice.reject! { |l| l =~ /expect\(/ }
-  buf = slice.map { |l| l.gsub(/(^\s\s\s\s)/, '')}.join
+  slice = File.new(path).readlines[start..stop+1]
+  slice.reject! { |l| l =~ /expect\(|^\s*describe|^\s+it|^\s*end\s*$/ }
+  slice.map! { |l| l.gsub(/(^\s\s\s\s)/, '')}
+  buf = slice.join
   buf.gsub!('# pp ', 'pp ')
+  buf.gsub!('api_key)', "ENV['API_KEY'])")
  end
- %Q(```#{format}\nrequire 'serpapi'\n#{buf}\n```\n\n * source code: [#{path}](https://github.com/serpapi/serpapi-ruby/blob/master/#{path}))
+ %Q(```#{format}\nrequire 'serpapi'\n#{buf}```\n\n * source code: [#{path}](https://github.com/serpapi/serpapi-ruby/blob/master/#{path}))
 end
 -%>
 <div align="center">
@@ -27,7 +31,8 @@ SerpApi supports Google, Google Maps, Google Shopping, Baidu, Yandex, Yahoo, eBa
 
 ## Installation
 
-Ruby 1.9.3 (or more recent), JRuby 9.1.17 (or more recent), or TruffleRuby 19.3.0 (or more recent) is required. 
+Ruby 3+ must be installed for best performance the latest version 3.4 is recommended.
+ For older version of Ruby 1.9 and 2.x or JRuby, our older library is still functional.
 
 ### Bundler
 ```ruby
@@ -75,7 +80,7 @@ params = {
   # then adds search engine specific options.
   # for example: google specific parameters: https://serpapi.com/search-api
   google_domain: "Google Domain",
-  location: "Location Requested", # example: Portland,Oregon,United States [see: Location API](#Location-API)
+  location: "Location Requested", # example: Portland,Oregon,United States [ * doc: Location API](#Location-API)
   device: "desktop|mobile|tablet",
   hl: "Google UI Language",
   gl: "Google Country",
@@ -191,48 +196,10 @@ pp data
 
 ## Basic example per search engine
 
-### Search bing
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_bing_spec.rb') %>
- * doc: [https://serpapi.com/bing-search-api](https://serpapi.com/bing-search-api)
+Here is how to calls the APIs.
 
-### Search baidu
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_baidu_spec.rb') %>
- * doc: [https://serpapi.com/baidu-search-api](https://serpapi.com/baidu-search-api)
-
-### Search yahoo
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_yahoo_spec.rb') %>
- * doc: [https://serpapi.com/yahoo-search-api](https://serpapi.com/yahoo-search-api)
-
-### Search youtube
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_youtube_spec.rb') %>
- * doc: [https://serpapi.com/youtube-search-api](https://serpapi.com/youtube-search-api)
-
-### Search walmart
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_walmart_spec.rb') %>
- * doc: [https://serpapi.com/walmart-search-api](https://serpapi.com/walmart-search-api)
-
-### Search ebay
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_ebay_spec.rb') %>
- * doc: [https://serpapi.com/ebay-search-api](https://serpapi.com/ebay-search-api)
-
-### Search naver
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_naver_spec.rb') %>
- * doc: [https://serpapi.com/naver-search-api](https://serpapi.com/naver-search-api)
-
-### Search home depot
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_home_depot_spec.rb') %>
- * doc: [https://serpapi.com/home-depot-search-api](https://serpapi.com/home-depot-search-api)
-
-### Search apple app store
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_apple_app_store_spec.rb') %>
- * doc: [https://serpapi.com/apple-app-store](https://serpapi.com/apple-app-store)
-
-### Search duckduckgo
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_duckduckgo_spec.rb') %>
- * doc: [https://serpapi.com/duckduckgo-search-api](https://serpapi.com/duckduckgo-search-api)
-
-### Search google search
-<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_search_spec.rb') %>
+### Search google
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_spec.rb') %>
  * doc: [https://serpapi.com/search-api](https://serpapi.com/search-api)
 
 ### Search google scholar
@@ -275,6 +242,82 @@ pp data
 <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_images_spec.rb') %>
  * doc: [https://serpapi.com/images-results](https://serpapi.com/images-results)
 
+### Search google lens
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_lens_spec.rb') %>
+ * doc: [https://serpapi.com/google-lens-api](https://serpapi.com/google-lens-api)
+
+### Search google images light
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_images_light_spec.rb') %>
+ * doc: [https://serpapi.com/google-images-light-api](https://serpapi.com/google-images-light-api)
+
+### Search google hotels
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_hotels_spec.rb') %>
+ * doc: [https://serpapi.com/google-hotels-api](https://serpapi.com/google-hotels-api)
+
+### Search google flights
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_flights_spec.rb') %>
+ * doc: [https://serpapi.com/google-flights-api](https://serpapi.com/google-flights-api)
+
+### Search google finance
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_finance_spec.rb') %>
+ * doc: [https://serpapi.com/google-finance-api](https://serpapi.com/google-finance-api)
+
+### Search google ai overview
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_ai_overview_spec.rb') %>
+ * doc: [https://serpapi.com/google-ai-overview-api](https://serpapi.com/google-ai-overview-api)
+
+### Search google news
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_news_spec.rb') %>
+ * doc: [https://serpapi.com/google-news-api](https://serpapi.com/google-news-api)
+
+### Search google patents
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_patents_spec.rb') %>
+ * doc: [https://serpapi.com/google-patents-api](https://serpapi.com/google-patents-api)
+
+### Search google trends
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_trends_spec.rb') %>
+ * doc: [https://serpapi.com/google-trends-api](https://serpapi.com/google-trends-api)
+
+### Search google shopping
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_shopping_spec.rb') %>
+ * doc: [https://serpapi.com/google-shopping-api](https://serpapi.com/google-shopping-api)
+
+### Search baidu
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_baidu_spec.rb') %>
+ * doc: [https://serpapi.com/baidu-search-api](https://serpapi.com/baidu-search-api)
+
+### Search yahoo
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_yahoo_spec.rb') %>
+ * doc: [https://serpapi.com/yahoo-search-api](https://serpapi.com/yahoo-search-api)
+
+### Search youtube
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_youtube_spec.rb') %>
+ * doc: [https://serpapi.com/youtube-search-api](https://serpapi.com/youtube-search-api)
+
+### Search walmart
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_walmart_spec.rb') %>
+ * doc: [https://serpapi.com/walmart-search-api](https://serpapi.com/walmart-search-api)
+
+### Search ebay
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_ebay_spec.rb') %>
+ * doc: [https://serpapi.com/ebay-search-api](https://serpapi.com/ebay-search-api)
+
+### Search naver
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_naver_spec.rb') %>
+ * doc: [https://serpapi.com/naver-search-api](https://serpapi.com/naver-search-api)
+
+### Search home depot
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_home_depot_spec.rb') %>
+ * doc: [https://serpapi.com/home-depot-search-api](https://serpapi.com/home-depot-search-api)
+
+### Search apple app store
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_apple_app_store_spec.rb') %>
+ * doc: [https://serpapi.com/apple-app-store](https://serpapi.com/apple-app-store)
+
+### Search duckduckgo
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_duckduckgo_spec.rb') %>
+ * doc: [https://serpapi.com/duckduckgo-search-api](https://serpapi.com/duckduckgo-search-api)
+
 ## Migration quick guide
 
 if you were already using (google-search-results-ruby gem)[https://github.com/serpapi/google-search-results-ruby], here are the changes.
@@ -358,7 +401,7 @@ Each search takes a few seconds before completion by SerpApi service and the sea
 Ruby versions validated by Github Actions:
  - 3.1
  - 2.6
-see: [Github Actions.](https://github.com/serpapi/serpapi-ruby/actions/workflows/ci.yml)
+ * doc: [Github Actions.](https://github.com/serpapi/serpapi-ruby/actions/workflows/ci.yml)
 
 ## Change logs
  * [2023-02-20] 1.0.0 Full API support

README.md.erb

@@ -0,0 +1,119 @@
+## Examples in ruby
+Here is how to calls the APIs
+
+    ### Search google
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_spec.rb') %>
+    see: [https://serpapi.com/search-api](https://serpapi.com/search-api)
+    
+    ### Search google scholar
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_scholar_spec.rb') %>
+    see: [https://serpapi.com/google-scholar-api](https://serpapi.com/google-scholar-api)
+    
+    ### Search google autocomplete
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_autocomplete_spec.rb') %>
+    see: [https://serpapi.com/google-autocomplete-api](https://serpapi.com/google-autocomplete-api)
+    
+    ### Search google product
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_product_spec.rb') %>
+    see: [https://serpapi.com/google-product-api](https://serpapi.com/google-product-api)
+    
+    ### Search google reverse image
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_reverse_image_spec.rb') %>
+    see: [https://serpapi.com/google-reverse-image](https://serpapi.com/google-reverse-image)
+    
+    ### Search google events
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_events_spec.rb') %>
+    see: [https://serpapi.com/google-events-api](https://serpapi.com/google-events-api)
+    
+    ### Search google local services
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_local_services_spec.rb') %>
+    see: [https://serpapi.com/google-local-services-api](https://serpapi.com/google-local-services-api)
+    
+    ### Search google maps
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_maps_spec.rb') %>
+    see: [https://serpapi.com/google-maps-api](https://serpapi.com/google-maps-api)
+    
+    ### Search google jobs
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_jobs_spec.rb') %>
+    see: [https://serpapi.com/google-jobs-api](https://serpapi.com/google-jobs-api)
+    
+    ### Search google play
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_play_spec.rb') %>
+    see: [https://serpapi.com/google-play-api](https://serpapi.com/google-play-api)
+    
+    ### Search google images
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_images_spec.rb') %>
+    see: [https://serpapi.com/images-results](https://serpapi.com/images-results)
+    
+    ### Search google lens
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_lens_spec.rb') %>
+    see: [https://serpapi.com/google-lens-api](https://serpapi.com/google-lens-api)
+    
+    ### Search google images light
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_images_light_spec.rb') %>
+    see: [https://serpapi.com/google-images-light-api](https://serpapi.com/google-images-light-api)
+    
+    ### Search google hotels
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_hotels_spec.rb') %>
+    see: [https://serpapi.com/google-hotels-api](https://serpapi.com/google-hotels-api)
+    
+    ### Search google flights
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_flights_spec.rb') %>
+    see: [https://serpapi.com/google-flights-api](https://serpapi.com/google-flights-api)
+    
+    ### Search google finance
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_finance_spec.rb') %>
+    see: [https://serpapi.com/google-finance-api](https://serpapi.com/google-finance-api)
+    
+    ### Search google news
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_news_spec.rb') %>
+    see: [https://serpapi.com/google-news-api](https://serpapi.com/google-news-api)
+    
+    ### Search google patents
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_patents_spec.rb') %>
+    see: [https://serpapi.com/google-patents-api](https://serpapi.com/google-patents-api)
+    
+    ### Search google trends
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_trends_spec.rb') %>
+    see: [https://serpapi.com/google-trends-api](https://serpapi.com/google-trends-api)
+    
+    ### Search google shopping
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_shopping_spec.rb') %>
+    see: [https://serpapi.com/google-shopping-api](https://serpapi.com/google-shopping-api)
+    
+    ### Search baidu
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_baidu_spec.rb') %>
+    see: [https://serpapi.com/baidu-search-api](https://serpapi.com/baidu-search-api)
+    
+    ### Search yahoo
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_yahoo_spec.rb') %>
+    see: [https://serpapi.com/yahoo-search-api](https://serpapi.com/yahoo-search-api)
+    
+    ### Search youtube
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_youtube_spec.rb') %>
+    see: [https://serpapi.com/youtube-search-api](https://serpapi.com/youtube-search-api)
+    
+    ### Search walmart
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_walmart_spec.rb') %>
+    see: [https://serpapi.com/walmart-search-api](https://serpapi.com/walmart-search-api)
+    
+    ### Search ebay
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_ebay_spec.rb') %>
+    see: [https://serpapi.com/ebay-search-api](https://serpapi.com/ebay-search-api)
+    
+    ### Search naver
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_naver_spec.rb') %>
+    see: [https://serpapi.com/naver-search-api](https://serpapi.com/naver-search-api)
+    
+    ### Search home depot
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_home_depot_spec.rb') %>
+    see: [https://serpapi.com/home-depot-search-api](https://serpapi.com/home-depot-search-api)
+    
+    ### Search apple app store
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_apple_app_store_spec.rb') %>
+    see: [https://serpapi.com/apple-app-store](https://serpapi.com/apple-app-store)
+    
+    ### Search duckduckgo
+    <%= snippet('ruby', 'spec/serpapi/client/example/example_search_duckduckgo_spec.rb') %>
+    see: [https://serpapi.com/duckduckgo-search-api](https://serpapi.com/duckduckgo-search-api)
+    

README_ruby_EXAMPLE_SECTION.md

@@ -2,12 +2,21 @@
 
 describe 'example: apple_app_store search' do
   it 'prints organic_results' do
-    client = SerpApi::Client.new(api_key: ENV['API_KEY'], engine: 'apple_app_store')
+    # Confirm that the environment variable for API_KEY has been set properly.
+    #  Your SerpApi key can be obtained at this URL http://serpapi.com
+    api_key = ENV['API_KEY']
+    skip('API_KEY not set. Please set your SerpApi API key.') if api_key.nil?
+
+    # initialize the serp api client
+    client = SerpApi::Client.new(engine: 'apple_app_store', api_key: api_key)
+    # run a search using serpapi service
     results = client.search({
-      'term': 'coffee'
+      term: 'coffee'
     })
-    expect(results[:organic_results]).not_to be_nil
+    expect(results[:organic_results]).not_to be_nil, "No organic results found! keys available: #{results.keys}"
+
+    # print the output of the response in formatted JSON
     # pp results[:organic_results]
-    # ENV['API_KEY'] captures the secret user API available from http://serpapi.com
+    # doc: https://serpapi.com/apple_app_store
   end
 end

spec/serpapi/client/example/example_search_apple_app_store_spec.rb

@@ -2,12 +2,21 @@
 
 describe 'example: baidu search' do
   it 'prints organic_results' do
-    client = SerpApi::Client.new(api_key: ENV['API_KEY'], engine: 'baidu')
+    # Confirm that the environment variable for API_KEY has been set properly.
+    #  Your SerpApi key can be obtained at this URL http://serpapi.com
+    api_key = ENV['API_KEY']
+    skip('API_KEY not set. Please set your SerpApi API key.') if api_key.nil?
+
+    # initialize the serp api client
+    client = SerpApi::Client.new(engine: 'baidu', api_key: api_key)
+    # run a search using serpapi service
     results = client.search({
-      'q': 'coffee'
+      q: 'coffee'
     })
-    expect(results[:organic_results]).not_to be_nil
+    expect(results[:organic_results]).not_to be_nil, "No organic results found! keys available: #{results.keys}"
+
+    # print the output of the response in formatted JSON
     # pp results[:organic_results]
-    # ENV['API_KEY'] captures the secret user API available from http://serpapi.com
+    # doc: https://serpapi.com/baidu
   end
 end

spec/serpapi/client/example/example_search_baidu_spec.rb

@@ -2,12 +2,21 @@
 
 describe 'example: duckduckgo search' do
   it 'prints organic_results' do
-    client = SerpApi::Client.new(api_key: ENV['API_KEY'], engine: 'duckduckgo')
+    # Confirm that the environment variable for API_KEY has been set properly.
+    #  Your SerpApi key can be obtained at this URL http://serpapi.com
+    api_key = ENV['API_KEY']
+    skip('API_KEY not set. Please set your SerpApi API key.') if api_key.nil?
+
+    # initialize the serp api client
+    client = SerpApi::Client.new(engine: 'duckduckgo', api_key: api_key)
+    # run a search using serpapi service
     results = client.search({
-      'q': 'coffee'
+      q: 'coffee'
     })
-    expect(results[:organic_results]).not_to be_nil
+    expect(results[:organic_results]).not_to be_nil, "No organic results found! keys available: #{results.keys}"
+
+    # print the output of the response in formatted JSON
     # pp results[:organic_results]
-    # ENV['API_KEY'] captures the secret user API available from http://serpapi.com
+    # doc: https://serpapi.com/duckduckgo
   end
 end