add more examples

fix broken links in the example

Author: jvmvik

README.md

@@ -251,7 +251,7 @@ pp client.account
 ```
 
 It prints your account information as:
-``json
+```ruby
 {
  account_id: "1234567890",
  api_key: "your_secret_key",
@@ -274,124 +274,153 @@ It prints your account information as:
 ## Basic example per search engine
 
 ### Search google
+
 <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_spec.rb') %>
- * doc: [https://serpapi.com/search-api](https://serpapi.com/search-api)
+see: [https://serpapi.com/search-api](https://serpapi.com/search-api)
+
+### Search google light
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_light_spec.rb') %>
+see: [https://serpapi.com/google-light-api](https://serpapi.com/google-light-api)
 
 ### Search google scholar
 <%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_scholar_spec.rb') %>
- * doc: [https://serpapi.com/google-scholar-api](https://serpapi.com/google-scholar-api)
+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') %>
- * doc: [https://serpapi.com/google-autocomplete-api](https://serpapi.com/google-autocomplete-api)
+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') %>
- * doc: [https://serpapi.com/google-product-api](https://serpapi.com/google-product-api)
+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') %>
- * doc: [https://serpapi.com/google-reverse-image](https://serpapi.com/google-reverse-image)
+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') %>
- * doc: [https://serpapi.com/google-events-api](https://serpapi.com/google-events-api)
+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') %>
- * doc: [https://serpapi.com/google-local-services-api](https://serpapi.com/google-local-services-api)
+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') %>
- * doc: [https://serpapi.com/google-maps-api](https://serpapi.com/google-maps-api)
+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') %>
- * doc: [https://serpapi.com/google-jobs-api](https://serpapi.com/google-jobs-api)
+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') %>
- * doc: [https://serpapi.com/google-play-api](https://serpapi.com/google-play-api)
+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') %>
- * doc: [https://serpapi.com/images-results](https://serpapi.com/images-results)
+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') %>
- * doc: [https://serpapi.com/google-lens-api](https://serpapi.com/google-lens-api)
+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') %>
- * doc: [https://serpapi.com/google-images-light-api](https://serpapi.com/google-images-light-api)
+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') %>
- * doc: [https://serpapi.com/google-hotels-api](https://serpapi.com/google-hotels-api)
+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') %>
- * doc: [https://serpapi.com/google-flights-api](https://serpapi.com/google-flights-api)
+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') %>
- * doc: [https://serpapi.com/google-finance-api](https://serpapi.com/google-finance-api)
+see: [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)
+see: [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)
+see: [https://serpapi.com/google-news-api](https://serpapi.com/google-news-api)
+
+### Search google news light
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_news_light_spec.rb') %>
+see: [https://serpapi.com/google-news-light-api](https://serpapi.com/google-news-light-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)
+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') %>
- * doc: [https://serpapi.com/google-trends-api](https://serpapi.com/google-trends-api)
+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') %>
- * doc: [https://serpapi.com/google-shopping-api](https://serpapi.com/google-shopping-api)
+see: [https://serpapi.com/google-shopping-api](https://serpapi.com/google-shopping-api)
+
+### Search google immersive product
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_immersive_product_spec.rb') %>
+see: [https://serpapi.com/google-immersive-product-api](https://serpapi.com/google-immersive-product-api)
+
+### Search google videos
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_google_videos_spec.rb') %>
+see: [https://serpapi.com/google-videos-api](https://serpapi.com/google-videos-api)
+
+### Search amazon
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_amazon_spec.rb') %>
+see: [https://serpapi.com/amazon-search-api](https://serpapi.com/amazon-search-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)
+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') %>
- * doc: [https://serpapi.com/yahoo-search-api](https://serpapi.com/yahoo-search-api)
+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') %>
- * doc: [https://serpapi.com/youtube-search-api](https://serpapi.com/youtube-search-api)
+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') %>
- * doc: [https://serpapi.com/walmart-search-api](https://serpapi.com/walmart-search-api)
+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') %>
- * doc: [https://serpapi.com/ebay-search-api](https://serpapi.com/ebay-search-api)
+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') %>
- * doc: [https://serpapi.com/naver-search-api](https://serpapi.com/naver-search-api)
+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') %>
- * doc: [https://serpapi.com/home-depot-search-api](https://serpapi.com/home-depot-search-api)
+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') %>
- * doc: [https://serpapi.com/apple-app-store](https://serpapi.com/apple-app-store)
+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') %>
- * doc: [https://serpapi.com/duckduckgo-search-api](https://serpapi.com/duckduckgo-search-api)
+see: [https://serpapi.com/duckduckgo-search-api](https://serpapi.com/duckduckgo-search-api)
+
+### Search yandex
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_yandex_spec.rb') %>
+see: [https://serpapi.com/yandex-search-api](https://serpapi.com/yandex-search-api)
+
+### Search yelp
+<%= snippet('ruby', 'spec/serpapi/client/example/example_search_yelp_spec.rb') %>
+see: [https://serpapi.com/yelp-search-api](https://serpapi.com/yelp-search-api)
 
 ## Migration quick guide
 

README.md.erb

@@ -1,6 +1,7 @@
-# Module includes SerpApi exception
+# Module includes SerpApi error handling.
+# frozen_string_literal: true
 module SerpApi
-  # SerpApiException wraps any errors related to the SerpApi client.
+  # SerpApiError wraps any errors related to the SerpApi client.
   class SerpApiError < StandardError
     # List the specific types of errors handled by the Error class.
     #  - HTTP response errors from SerpApi.com

README_ruby_EXAMPLE_SECTION.md

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'example: amazon search' do
+  it 'prints organic_results' do
+    # Confirm that the environment variable for SERPAPI_KEY has been set properly.
+    #  Your SerpApi key can be obtained at this URL http://serpapi.com
+    api_key = ENV['SERPAPI_KEY']
+    skip('SERPAPI_KEY not set. Please set your SerpApi API key.') if api_key.nil?
+
+    # initialize the serp api client
+    client = SerpApi::Client.new(engine: 'amazon', api_key: api_key)
+    # run a search using serpapi service
+    results = client.search({
+      q: 'coffee'
+    })
+    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]
+    # doc: https://serpapi.com/amazon-search-api
+  end
+end

lib/serpapi/error.rb

@@ -17,6 +17,6 @@
 
     # print the output of the response in formatted JSON
     # pp results[:organic_results]
-    # doc: https://serpapi.com/apple_app_store
+    # doc: https://serpapi.com/apple-app-store
   end
 end

spec/serpapi/client/example/example_search_amazon_spec.rb

@@ -17,6 +17,6 @@
 
     # print the output of the response in formatted JSON
     # pp results[:organic_results]
-    # doc: https://serpapi.com/baidu
+    # doc: https://serpapi.com/baidu-search-api
   end
 end

spec/serpapi/client/example/example_search_apple_app_store_spec.rb

@@ -17,6 +17,6 @@
 
     # print the output of the response in formatted JSON
     # pp results[:organic_results]
-    # doc: https://serpapi.com/duckduckgo
+    # doc: https://serpapi.com/duckduckgo-search-api
   end
 end

spec/serpapi/client/example/example_search_baidu_spec.rb

@@ -17,6 +17,6 @@
 
     # print the output of the response in formatted JSON
     # pp results[:organic_results]
-    # doc: https://serpapi.com/ebay
+    # doc: https://serpapi.com/ebay-search-api
   end
 end

spec/serpapi/client/example/example_search_duckduckgo_spec.rb

@@ -17,6 +17,6 @@
 
     # print the output of the response in formatted JSON
     # pp results[:ai_overview]
-    # doc: https://serpapi.com/google_ai_overview
+    # doc: https://serpapi.com/google-ai-overview-api
   end
 end