Add static analysis and coverage tasks to Rakefile; update README for API key changes and installation instruction.

jvmvik · jvmvik · commit 6e02acd0506d · 2026-01-03T22:03:01.000-06:00
Improve coverage
diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml
@@ -18,4 +18,4 @@ jobs:
     - name: test
       run: make setup build test
       env:
-        API_KEY: ${{secrets.API_KEY}}
+        SERPAPI_KEY: ${{secrets.SERPAPI_KEY}}
diff --git a/README.md b/README.md
@@ -272,7 +272,7 @@ require 'serpapi'
 using namespace rapidjson;
 using namespace std;
 
-void info(string msg) {
+void info(const string& msg) {
     cout << "\nINFO: " << msg;
 }
 
@@ -291,7 +291,11 @@ void info(const Document& document) {
 int main()
 {
     // initialize a client
-    const char* env_p = std::getenv("API_KEY");
+    const char* env_p = std::getenv("SERPAPI_KEY");
+    if (env_p == nullptr) {
+        cout << "SERPAPI_KEY not set, skipping OOBT" << endl;
+        return 0;
+    }
     std::string apiKey(env_p);
     std::map<string, string> default_parameter;
     default_parameter["api_key"] = apiKey;
@@ -322,7 +326,7 @@ int main()
     info("   id: " + id);
 
     info("search archive with id: " + id);
-    client.searchArchive(id);
+    client.search_archive(id);
     assert(d["search_metadata"]["status"] == "Success");
     info(" search found in archive.");
     info(" test passed.\n");
@@ -423,7 +427,7 @@ The directory spec/ includes specification which serves the dual purposes of exa
 
 Set your secret API key in your shell before running a test.
 ```bash
-export API_KEY="your_secret_key"
+export SERPAPI_KEY="your_secret_key"
 ```
 Install testing dependency
 ```bash
@@ -447,30 +451,26 @@ To flush the flow.
 $ rake
 ```
 
-Open coverage report generated by `rake test`
-```sh
-open coverage/index.html
-```
 
 Open ./Rakefile for more information.
 
 Contributions are welcome. Feel to submit a pull request!
 
 // TODO
- - [] Release version 1.0.0
+ - [] Release version 1.1.0
 
 
 ## Run with Docker
 
 ```bash
-env API_KEY=API_KEY docker run --rm -it -e API_KEY --workdir /tmp/serpapi -v $PWD:/tmp/serpapi conanio/gcc10 make install_linux reset all
+env SERPAPI_KEY=SERPAPI_KEY docker run --rm -it -e SERPAPI_KEY --workdir /tmp/serpapi -v $PWD:/tmp/serpapi conanio/gcc10 make install_linux reset all
 ```
 
 This will use https://hub.docker.com/layers/conanio/gcc10 image instead
 of creating our own image for compilation on Linux.
 
 ## Get started.
- - Set an environment API_KEY=<secret>
+ - Set an environment SERPAPI_KEY=<secret>
  - Install dependency either apple or linux tested.
     - `rake install_apple`
     - `rake install_linux`
diff --git a/README.md.erb b/README.md.erb
@@ -361,7 +361,7 @@ The directory spec/ includes specification which serves the dual purposes of exa
 
 Set your secret API key in your shell before running a test.
 ```bash
-export API_KEY="your_secret_key"
+export SERPAPI_KEY="your_secret_key"
 ```
 Install testing dependency
 ```bash
@@ -385,30 +385,26 @@ To flush the flow.
 $ rake
 ```
 
-Open coverage report generated by `rake test`
-```sh
-open coverage/index.html
-```
 
 Open ./Rakefile for more information.
 
 Contributions are welcome. Feel to submit a pull request!
 
 // TODO
- - [] Release version 1.0.0
+ - [] Release version 1.1.0
 
 
 ## Run with Docker
 
 ```bash
-env API_KEY=API_KEY docker run --rm -it -e API_KEY --workdir /tmp/serpapi -v $PWD:/tmp/serpapi conanio/gcc10 make install_linux reset all
+env SERPAPI_KEY=SERPAPI_KEY docker run --rm -it -e SERPAPI_KEY --workdir /tmp/serpapi -v $PWD:/tmp/serpapi conanio/gcc10 make install_linux reset all
 ```
 
 This will use https://hub.docker.com/layers/conanio/gcc10 image instead
 of creating our own image for compilation on Linux.
 
 ## Get started.
- - Set an environment API_KEY=<secret>
+ - Set an environment SERPAPI_KEY=<secret>
  - Install dependency either apple or linux tested.
     - `rake install_apple`
     - `rake install_linux`
diff --git a/Rakefile b/Rakefile
@@ -23,6 +23,22 @@ task :test do
 	sh('ninja -C build test')
 end
 
+desc('run static analysis')
+task :lint do
+	rapidjson_inc = `pkg-config --variable=includedir rapidjson`.strip
+	sh("cppcheck src/*.cpp test/*.cpp oobt/*.cpp example/*.cpp -I src -I #{rapidjson_inc} --enable=warning,style,performance,portability --suppress='*:*/rapidjson/*' --suppress=missingIncludeSystem --suppress=unusedFunction --error-exitcode=1")
+end
+
+desc('generate coverage report')
+task :coverage do
+	sh('meson setup build --wipe -Db_coverage=true')
+	sh('ninja -C build')
+	sh('ninja -C build test')
+	# Use gcovr directly to focus on src/ and provide a cleaner report
+	sh('gcovr -r . --filter src/')
+	sh('gcovr -r . --filter src/ -s')
+end
+
 task readme: ['README.md.erb'] do
   `erb -T '-' README.md.erb > README.md`
 end
@@ -50,11 +66,11 @@ end
 namespace :install do
 	desc('install dependency on debian AARCH64 and x86 [tested]')
 	task :linux do
-		sh('sudo apt update -y && sudo apt install -f -y build-essential meson pkg-config curl cmake meson ninja-build libcurl4-openssl-dev rapidjson-dev googletest')
+		sh('sudo apt update -y && sudo apt install -f -y build-essential meson pkg-config curl cmake meson ninja-build libcurl4-openssl-dev rapidjson-dev googletest cppcheck gcovr lcov')
 	end
 
 	desc('install dependency on Apple M1 aarch64 [tested]')
 	task :apple do
-		sh('brew install meson pkg-config curl cmake meson ninja rapidjson googletest')
+		sh('brew install meson pkg-config curl cmake meson ninja rapidjson googletest cppcheck gcovr lcov')
 	end
 end
diff --git a/example/google_example.cpp b/example/google_example.cpp
@@ -19,7 +19,11 @@ using namespace std;
 int main()
 {
     // initialize a client
-    const char* env_p = std::getenv("API_KEY");
+    const char* env_p = std::getenv("SERPAPI_KEY");
+    if (env_p == nullptr) {
+        cout << "SERPAPI_KEY not set, skipping example" << endl;
+        return 0;
+    }
     std::string apiKey(env_p);
     std::map<string, string> default_parameter;
     default_parameter["engine"] = "google";
@@ -41,7 +45,7 @@ int main()
     assert(d["search_metadata"]["id"].IsString());
 
     string id = d["search_metadata"]["id"].GetString();
-    client.searchArchive(id);
+    client.search_archive(id);
     assert(d["search_metadata"]["status"] == "Success");
     info(d);
 }
diff --git a/example/helper.cpp b/example/helper.cpp
@@ -11,7 +11,7 @@
 using namespace std;
 using namespace rapidjson;
 
-void info(string msg) {
+void info(const string& msg) {
     cout << "\nINFO: " << msg << endl;
 }
 
diff --git a/example/helper.hpp b/example/helper.hpp
@@ -6,6 +6,6 @@
 
 #include "rapidjson/document.h"
 
-void info(string msg); 
+void info(const std::string& msg); 
 void info(double msg);
 void info(const rapidjson::Document& document);
diff --git a/oobt/main.cpp b/oobt/main.cpp
@@ -14,7 +14,7 @@
 using namespace rapidjson;
 using namespace std;
 
-void info(string msg) {
+void info(const string& msg) {
     cout << "\nINFO: " << msg;
 }
 
@@ -33,7 +33,11 @@ void info(const Document& document) {
 int main()
 {
     // initialize a client
-    const char* env_p = std::getenv("API_KEY");
+    const char* env_p = std::getenv("SERPAPI_KEY");
+    if (env_p == nullptr) {
+        cout << "SERPAPI_KEY not set, skipping OOBT" << endl;
+        return 0;
+    }
     std::string apiKey(env_p);
     std::map<string, string> default_parameter;
     default_parameter["api_key"] = apiKey;
@@ -64,7 +68,7 @@ int main()
     info("   id: " + id);
 
     info("search archive with id: " + id);
-    client.searchArchive(id);
+    client.search_archive(id);
     assert(d["search_metadata"]["status"] == "Success");
     info(" search found in archive.");
     info(" test passed.\n");
diff --git a/src/serpapi.cpp b/src/serpapi.cpp
@@ -9,7 +9,7 @@ namespace serpapi
 
 const static string HOST = "https://serpapi.com";
 const static string NAME = "serpapi-cpp";
-const static string VERSION = "1.0.0";
+const static string VERSION = "0.1.0";
 
 using namespace rapidjson;
 using namespace std;
@@ -19,103 +19,108 @@ struct GetResponse {
    string payload;
 };
 
-Client::Client(map<string, string> parameter)
+Client::Client(const map<string, string>& parameter)
 {
    this->parameter = parameter;
 }
 
+Client::~Client()
+{
+}
+
 /***
 * Get HTML search results
 */
-string Client::html(map<string, string> parameter)
+string Client::html(const map<string, string>& parameter)
 {
    GetResponse gr = Client::get("/search", "html", parameter);
    return gr.payload;
 }
 
-Document Client::search(map<string, string> parameter) 
+Document Client::search(const map<string, string>& parameter) 
 {
    return Client::json("/search", parameter);
 }
 
-Document Client::searchArchive(string id) 
+Document Client::search_archive(const string& id) 
 {
    return Client::json("/searches/" + id + ".json", map<string, string>());
 }
 
-Document Client::account(map<string, string> parameter) 
+Document Client::account(const map<string, string>& parameter) 
 {
    return Client::json("/account.json", parameter);
 }
 
-Document Client::location(map<string, string> parameter) 
+Document Client::location(const map<string, string>& parameter) 
 {
    return Client::json("/locations.json", parameter);
 }
 
-Document Client::json(string uri, map<string, string> parameter)
+Document Client::json(const string& uri, const map<string, string>& parameter)
 {
    GetResponse gr = get(uri, "json", parameter);
-   const char* json = gr.payload.c_str();
+   const char* json_payload = gr.payload.c_str();
    Document d;
-   d.Parse(json);
-   // if(gr.httpCode != 200 && d.HasMember("error")) {
-   //    Value entry(d);
-   //    entry.AddMember("httpCode", string(gr.httpCode), d.GetAllocator());
-   //    entry.AddMember("error", "serpapi.com did not returned any error message", d.GetAllocator());
-   // }
+   d.Parse(json_payload);
    return d;
 }
 
-string encodeUrl(map<string, string> parameter)
+string encodeUrl(CURL* curl, const map<string, string>& parameter)
 {
-   map<string, string> param(parameter);
    string s = "";
-   map<string,string>::iterator it;
-   for (it = param.begin(); it != param.end(); ++it)
+   map<string,string>::const_iterator it;
+   for (it = parameter.begin(); it != parameter.end(); ++it)
    {
       if (s != "")
       {
          s += "&";
       }
-      // encode each value in case of special character
-      s += it->first + "=" + it->second;
+      
+      char* escaped_key = curl_easy_escape(curl, it->first.c_str(), it->first.length());
+      char* escaped_value = curl_easy_escape(curl, it->second.c_str(), it->second.length());
+      
+      s += string(escaped_key) + "=" + string(escaped_value);
+      
+      curl_free(escaped_key);
+      curl_free(escaped_value);
    } 
    return s;
 }
 
-string Client::url(string output, map<string, string> parameter)
+string Client::url(CURL* curl, const string& output, const map<string, string>& parameter)
 {
    // encode parameter
-   string url = encodeUrl(parameter);
-   if(size(this->parameter) > 0) {
-      url += "&";
-      url += encodeUrl(this->parameter);
+   string url_str = encodeUrl(curl, parameter);
+   if(this->parameter.size() > 0) {
+      if (!url_str.empty()) url_str += "&";
+      url_str += encodeUrl(curl, this->parameter);
    } 
    // append output format
-   url += "&output=" + output;
+   url_str += "&output=" + output;
    // append source language
-   url += "&source="+NAME+":"+VERSION;
-   // cout << url << endl;
-   return url;
+   url_str += "&source="+NAME+":"+VERSION;
+   return url_str;
 }
 
-GetResponse Client::get(string uri, string output, map<string, string> parameter)
+GetResponse Client::get(const string& uri, const string& output, const map<string, string>& parameter)
 {
    curl_global_init(CURL_GLOBAL_DEFAULT);
-   curl = curl_easy_init();
-   const string url = HOST + uri + "?" + this->url(output, parameter);
-   curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
+   CURL* curl = curl_easy_init();
+   const string url_params = this->url(curl, output, parameter);
+   const string full_url = HOST + uri + "?" + url_params;
+   
+   curl_easy_setopt(curl, CURLOPT_URL, full_url.c_str());
    curl_easy_setopt(curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
-   curl_easy_setopt(curl, CURLOPT_TIMEOUT, timeout);
+   curl_easy_setopt(curl, CURLOPT_TIMEOUT, (long)timeout);
    curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
-   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
-   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
+   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2L);
+   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L);
 
    long httpCode(0);
-   unique_ptr<string> httpData(new string());
+   string httpData;
    curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, callback);
-   curl_easy_setopt(curl, CURLOPT_WRITEDATA, httpData.get());
+   curl_easy_setopt(curl, CURLOPT_WRITEDATA, &httpData);
 
    // execute search
    curl_easy_perform(curl);
@@ -125,7 +130,7 @@ GetResponse Client::get(string uri, string output, map<string, string> parameter
    curl_global_cleanup();
    GetResponse gr;
    gr.httpCode = httpCode;
-   gr.payload = *httpData.get();
+   gr.payload = httpData;
    return gr;
 }
 
diff --git a/src/serpapi.hpp b/src/serpapi.hpp
diff --git a/test/test_serpapi.cpp b/test/test_serpapi.cpp

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`using namespace std;`
`12`	`12`	`using namespace rapidjson;`
`13`	`13`
`14`		`-void info(string msg) {`
	`14`	`+void info(const string& msg) {`
`15`	`15`	`cout << "\nINFO: " << msg << endl;`
`16`	`16`	`}`
`17`	`17`