integrate feedback from #4

Author: jvmvik

README.md

@@ -126,20 +126,23 @@ require 'serpapi'
 
 company_list = %w[meta amazon apple netflix google]
 client = SerpApi::Client.new(engine: 'google', async: true, persistent: true, api_key: ENV.fetch('SERPAPI_KEY', nil))
-search_queue = Queue.new
+schedule_search = Queue.new
+result = nil
 company_list.each do |company|
   result = client.search({ q: company })
   puts "#{company}: search results found in cache for: #{company}" if result[:search_metadata][:status] =~ /Cached/
 
-  search_queue.push(result[:search_metadata][:id])
+  schedule_search.push(result[:search_metadata][:id])
 end
 
-puts 'wait for all requests to be completed'
+puts "Last search submited at: #{result[:search_metadata][:created_at]}"
+
+puts 'wait 10s for all requests to be completed '
 sleep(10)
 
 puts 'wait until all searches are cached or success'
-until search_queue.empty?
-  search_id = search_queue.pop
+until schedule_search.empty?
+  search_id = schedule_search.pop
 
   search_archived = client.search_archive(search_id)
 
@@ -150,10 +153,10 @@ until search_queue.empty?
     next
   end
 
-  search_queue.push(result)
+  schedule_search.push(result)
 end
 
-search_queue.close
+schedule_search.close
 puts 'done'
 ```
 
@@ -1023,12 +1026,13 @@ The class SerpApi::Client (client side / ruby):
 Et voila!
 
 ## Continuous integration
-We love "true open source" and "continuous integration", and Test Drive Development (TDD).
- We are using RSpec to test [our infrastructure around the clock]) using Github Action to achieve the best QoS (Quality Of Service).
+We love [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) and [Test-Driven Development](https://en.wikipedia.org/wiki/Test-driven_development) (TDD) at SerpApi. 
+ We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients.
 
 The directory spec/ includes specification which serves the dual purposes of examples and functional tests.
 
-Set your secret API key in your shell before running a test.
+Set your secret API key in your shell before running a test. 
+ The SerpApi key can be obtained from [serpapi.com/signup](https://serpapi.com/users/sign_up?plan=free).
 ```bash
 export SERPAPI_KEY="your_secret_key"
 ```
@@ -1044,19 +1048,29 @@ Check code quality using Lint.
 $ rake lint
 ```
 
-Run regression.
+Run basic test
 ```bash
 $ rake test
 ```
 
-To flush the flow.
-```bash
-$ rake
+Review coverage report generated by `rake test`
+```sh
+open coverage/index.html
 ```
 
-Open coverage report generated by `rake test`
+Review documentation generated by `rake doc`
 ```sh
-open coverage/index.html
+open doc/index.html
+```
+
+Run full regression test suite on the examples.
+```bash
+rake regression
+```
+
+Test the actuall packaged gem locally using the demo scripts.
+```bash
+$ rake oobt
 ```
 
 Open ./Rakefile for more information.

README.md.erb

@@ -538,12 +538,13 @@ The class SerpApi::Client (client side / ruby):
 Et voila!
 
 ## Continuous integration
-We love "true open source" and "continuous integration", and Test Drive Development (TDD).
- We are using RSpec to test [our infrastructure around the clock]) using Github Action to achieve the best QoS (Quality Of Service).
+We love [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) and [Test-Driven Development](https://en.wikipedia.org/wiki/Test-driven_development) (TDD) at SerpApi. 
+ We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients.
 
 The directory spec/ includes specification which serves the dual purposes of examples and functional tests.
 
-Set your secret API key in your shell before running a test.
+Set your secret API key in your shell before running a test. 
+ The SerpApi key can be obtained from [serpapi.com/signup](https://serpapi.com/users/sign_up?plan=free).
 ```bash
 export SERPAPI_KEY="your_secret_key"
 ```
@@ -559,19 +560,29 @@ Check code quality using Lint.
 $ rake lint
 ```
 
-Run regression.
+Run basic test
 ```bash
 $ rake test
 ```
 
-To flush the flow.
-```bash
-$ rake
+Review coverage report generated by `rake test`
+```sh
+open coverage/index.html
 ```
 
-Open coverage report generated by `rake test`
+Review documentation generated by `rake doc`
 ```sh
-open coverage/index.html
+open doc/index.html
+```
+
+Run full regression test suite on the examples.
+```bash
+rake regression
+```
+
+Test the actuall packaged gem locally using the demo scripts.
+```bash
+$ rake oobt
 ```
 
 Open ./Rakefile for more information.

demo/demo_async.rb

@@ -33,25 +33,28 @@
 # target MAANG companies
 company_list = %w[meta amazon apple netflix google]
 client = SerpApi::Client.new(engine: 'google', async: true, persistent: true, api_key: ENV.fetch('SERPAPI_KEY', nil))
-search_queue = Queue.new
+schedule_search = Queue.new
+result = nil
 company_list.each do |company|
-  # store request into a search_queue - no-blocker
+  # store request into a schedule_search - no-blocker
   result = client.search({ q: company })
   puts "#{company}: search results found in cache for: #{company}" if result[:search_metadata][:status] =~ /Cached/
 
   # add results to the client queue
-  search_queue.push(result[:search_metadata][:id])
+  schedule_search.push(result[:search_metadata][:id])
 end
 
+puts "Last search submited at: #{result[:search_metadata][:created_at]}"
+
 # wait for all requests to be completed
-puts 'wait for all requests to be completed'
+puts 'wait 10s for all requests to be completed '
 # wait for 10 seconds to allow all requests to be processed
 sleep(10)
 
 puts 'wait until all searches are cached or success'
-until search_queue.empty?
+until schedule_search.empty?
   # extract client id
-  search_id = search_queue.pop
+  search_id = schedule_search.pop
 
   # retrieve client from the archive - blocker
   search_archived = client.search_archive(search_id)
@@ -67,9 +70,9 @@
 
   # add results back to the client queue
   #  if the search is still in progress
-  search_queue.push(result)
+  schedule_search.push(result)
 end
 
 # destroy the queue
-search_queue.close
+schedule_search.close
 puts 'done'