Finish code refractoring for 3.0

  - align to naming Go naming convention
  - update documentation

Author: jvmvik

.github/workflows/go.yml

@@ -30,9 +30,6 @@ jobs:
             dep ensure
         fi
 
-    - name: Build
-      run: go build -v .
-
     - name: Test
       run: go test -v .
       env:

.gitignore

@@ -1,3 +1,4 @@
 tmp/
 *.iml
 .idea/
+go.mod

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 SerpApi
+Copyright (c) 2018-2020 SerpApi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -2,11 +2,23 @@ version=3.0
 
 all: test
 
+check:
+	go vet .
+	go fmt .
+
 test:
 	go test -v .
 
+# check that everything is pushed
+package:
+	git status | grep "Nothing"
+
 oobt:
-	cd demo ; go run demo.go
+	mkdir -p /tmp/oobt
+	cp demo/demo.go /tmp/oobt
+	cd /tmp/oobt ; \
+		go get -u github.com/serpapi/google_search_results_golang ; \
+		go run demo.go
 
 release: oobt
 	git tag -a ${version}

README.md

@@ -48,8 +48,8 @@ parameter := map[string]string{
     "location":     "Portland"
 }
 
-query := NewGoogleClient(parameter, api)
-// Many clients available: bing, yahoo, baidu, googemaps, googleproduct, googlescholar
+query := NewGoogleSearch(parameter, api)
+// Many search engine available: bing, yahoo, baidu, googemaps, googleproduct, googlescholar, ebay, walmart, youtube..
 
 rsp, err := query.json()
 results := rsp["organic_results"].([]interface{})
@@ -108,7 +108,7 @@ api_key := "your personal API key"
 engine := "yahoo"
 
 // define the search search
-search := NewSerpApiSearch(engine, parameter, api_key)
+search := NewSearch(engine, parameter, api_key)
 
 // override an existing parameter
 search.parameter["location"] = "Portland,Oregon,United States"
@@ -129,16 +129,14 @@ see below for more hands on examples.
 ### Example by specification
 
 We love true open source, continuous integration and Test Drive Development (TDD). 
- We are using "go test" [our infrastructure around the clock](https://travis-ci.org/serpapi/google-search-results-golang) to achieve the best QoS (Quality Of Service).
+ We are using "go test" to test our infrastructure around the clock
+  to achieve the best QoS (Quality Of Service).
 
 The directory test/ includes specification/examples.
 
-Set your api key.
+To run the test from bash using make
 ```bash
 export API_KEY="your secret key"
-```
-
-```bash
 make test
 ```
 
@@ -165,7 +163,7 @@ parameter := map[string]string{
   "location": "Portland"
   }
 
-search := NewGoogleClient(parameter, "your user key")
+search := NewGoogleSearch(parameter, "your user key")
 rsp, err := search.GetJSON()
 
 if err != nil {
@@ -190,7 +188,7 @@ it prints the search ID from the archive.
 
 ### Account API
 ```go
-var data SerpResponse
+var data SearchResult
 var err error
 data, err = search.GetAccount()
 

client.go

@@ -0,0 +1,84 @@
+package search
+
+import (
+	"encoding/json"
+	"errors"
+	"io"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+)
+
+// decodeJson response
+func (search *Search) decodeJSON(body io.ReadCloser) (SearchResult, error) {
+	// Decode JSON from response body
+	decoder := json.NewDecoder(body)
+
+	// Response data
+	var rsp SearchResult
+	err := decoder.Decode(&rsp)
+	if err != nil {
+		return nil, errors.New("fail to decode")
+	}
+
+	// check error message
+	errorMessage, derror := rsp["error"].(string)
+	if derror {
+		return nil, errors.New(errorMessage)
+	}
+	return rsp, nil
+}
+
+// decodeJSONArray decodes response body to SearchResultArray
+func (search *Search) decodeJSONArray(body io.ReadCloser) (SearchResultArray, error) {
+	decoder := json.NewDecoder(body)
+	var rsp SearchResultArray
+	err := decoder.Decode(&rsp)
+	if err != nil {
+		return nil, errors.New("fail to decode array")
+	}
+	return rsp, nil
+}
+
+// decodeHTML decodes response body to html string
+func (search *Search) decodeHTML(body io.ReadCloser) (*string, error) {
+	buffer, err := ioutil.ReadAll(body)
+	if err != nil {
+		return nil, err
+	}
+	text := string(buffer)
+	return &text, nil
+}
+
+// execute HTTP get reuqest and returns http response
+func (search *Search) execute(path string, output string) (*http.Response, error) {
+	query := url.Values{}
+	if search.Parameter != nil {
+		for k, v := range search.Parameter {
+			query.Add(k, v)
+		}
+	}
+
+	// api_key
+	if len(search.ApiKey) != 0 {
+		query.Add("api_key", search.ApiKey)
+	}
+
+	// engine
+	if len(query.Get("engine")) == 0 {
+		query.Set("engine", search.Engine)
+	}
+
+	// source programming language
+	query.Add("source", "go")
+
+	// set output
+	query.Add("output", output)
+
+	endpoint := "https://serpapi.com" + path + "?" + query.Encode()
+	rsp, err := search.HttpSearch.Get(endpoint)
+	if err != nil {
+		return nil, err
+	}
+	return rsp, nil
+}

demo/demo.go

@@ -8,7 +8,7 @@ import (
 )
 
 /***
- * demo how to create a search for SerpApi
+ * Demonstrate how to search on Google
  *
  * go get -u github.com/serpapi/google_search_results_golang
  */

go.mod

@@ -1,5 +1,3 @@
-module github.com/serpapi/google_search_results_golang
+module github.com/serpapi/google-search-results-golang
 
 go 1.13
-
-require github.com/serpapi/google-search-results-golang v0.0.0-20200705022805-f5cfa820f3aa // indirect