Added new saved query endpoints

datadotworld · Jul 9, 2019 · e34f0b9 · e34f0b9
1 parent 48786ff
commit e34f0b9
Show file tree

Hide file tree

Showing 14 changed files with 359 additions and 83 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,11 @@
+linters:
+  enable-all: true
+  disable:
+    - bodyclose
+    - gochecknoglobals
+    - goconst
+
+issues:
+  exclude-rules:
+    - text: G201
+      linters: gosec
diff --git a/.gometalinter.json b/.gometalinter.json
diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ fmtcheck:
 	@gofmt -l -s ./$(PKG_NAME)
 
 lint:
-	@gometalinter ./$(PKG_NAME)
+	@golangci-lint run ./$(PKG_NAME)
 
 test: fmtcheck
 	@go test ./$(PKG_NAME) -timeout=30s -parallel=4 -cover

diff --git a/dwapi/api.go b/dwapi/api.go
@@ -109,7 +109,7 @@ func (c *Client) encodeBody(body interface{}) (io.Reader, error) {
 	return b, nil
 }
 
-func (c *Client) rawRequest(headers *headers, body io.Reader) (io.Reader, error) {
+func (c *Client) rawRequest(headers *headers, body io.Reader) (io.ReadCloser, error) {
 	url := c.BaseURL + headers.Endpoint
 
 	r, err := http.NewRequest(headers.Method, url, body)
@@ -139,7 +139,6 @@ func (c *Client) rawRequest(headers *headers, body io.Reader) (io.Reader, error)
 	if response.StatusCode != http.StatusOK {
 		return nil, errors.New(response.Status)
 	}
-
 	return response.Body, nil
 }
 
@@ -154,7 +153,9 @@ func (c *Client) request(headers *headers, body, response interface{}) (err erro
 		return
 	}
 
-	return c.unmarshal(r, response)
+	err = c.unmarshal(r, response)
+	r.Close()
+	return
 }
 
 func (c *Client) requestMultiplePages(endpoint string, response interface{}) error {

diff --git a/dwapi/datasets.go b/dwapi/datasets.go
@@ -26,15 +26,17 @@ type DatasetService struct {
 	client *Client
 }
 
-func (s *DatasetService) AddFilesFromURLs(owner, datasetid string, body *FileCreateRequest) (response SuccessResponse, err error) {
+func (s *DatasetService) AddFilesFromURLs(owner, datasetid string, body *FileCreateRequest) (
+	response SuccessResponse, err error) {
 	return s.client.File.AddFilesFromURLs(owner, datasetid, body)
 }
 
 func (s *DatasetService) AssociateDOI(owner, datasetid, doi string) (response SuccessResponse, err error) {
 	return s.client.DOI.Associate(owner, datasetid, doi)
 }
 
-func (s *DatasetService) AssociateDOIWithVersion(owner, datasetid, versionid, doi string) (response SuccessResponse, err error) {
+func (s *DatasetService) AssociateDOIWithVersion(owner, datasetid, versionid, doi string) (
+	response SuccessResponse, err error) {
 	return s.client.DOI.AssociateWithVersion(owner, datasetid, versionid, doi)
 }
 
@@ -49,7 +51,8 @@ func (s *DatasetService) Create(owner string, body *DatasetCreateRequest) (respo
 	return
 }
 
-func (s *DatasetService) CreateOrReplace(owner, id string, body *DatasetReplaceRequest) (response SuccessResponse, err error) {
+func (s *DatasetService) CreateOrReplace(owner, id string, body *DatasetReplaceRequest) (
+	response SuccessResponse, err error) {
 	endpoint := fmt.Sprintf("/datasets/%s/%s", owner, id)
 	headers := s.client.buildHeaders(PUT, endpoint)
 	err = s.client.request(headers, body, &response)
@@ -67,15 +70,17 @@ func (s *DatasetService) DeleteDOI(owner, datasetid, doi string) (response Succe
 	return s.client.DOI.Delete(owner, datasetid, doi)
 }
 
-func (s *DatasetService) DeleteDOIAssociatedWithVersion(owner, datasetid, versionid, doi string) (response SuccessResponse, err error) {
+func (s *DatasetService) DeleteDOIAssociatedWithVersion(owner, datasetid, versionid, doi string) (
+	response SuccessResponse, err error) {
 	return s.client.DOI.DeleteAssociatedWithVersion(owner, datasetid, versionid, doi)
 }
 
 func (s *DatasetService) DownloadFile(owner, datasetid, filename string) (response io.Reader, err error) {
 	return s.client.File.Download(owner, datasetid, filename)
 }
 
-func (s *DatasetService) DownloadAndSaveFile(owner, datasetid, filename, path string) (response SuccessResponse, err error) {
+func (s *DatasetService) DownloadAndSaveFile(owner, datasetid, filename, path string) (
+	response SuccessResponse, err error) {
 	return s.client.File.DownloadAndSave(owner, datasetid, filename, path)
 }
 
@@ -106,7 +111,8 @@ func (s *DatasetService) Retrieve(owner, datasetid string) (response DatasetSumm
 	return
 }
 
-func (s *DatasetService) RetrieveVersion(owner, datasetid, versionid string) (response DatasetSummaryResponse, err error) {
+func (s *DatasetService) RetrieveVersion(owner, datasetid, versionid string) (
+	response DatasetSummaryResponse, err error) {
 	endpoint := fmt.Sprintf("/datasets/%s/%s/v/%s", owner, datasetid, versionid)
 	headers := s.client.buildHeaders(GET, endpoint)
 	err = s.client.request(headers, nil, &response)
@@ -124,6 +130,7 @@ func (s *DatasetService) Update(owner, id string, body *DatasetUpdateRequest) (r
 	return
 }
 
-func (s *DatasetService) UploadFile(owner, id, filename, path string, expandArchive bool) (response SuccessResponse, err error) {
+func (s *DatasetService) UploadFile(owner, id, filename, path string, expandArchive bool) (
+	response SuccessResponse, err error) {
 	return s.client.File.Upload(owner, id, filename, path, expandArchive)
 }
diff --git a/dwapi/dois.go b/dwapi/dois.go
@@ -32,7 +32,8 @@ func (s *DoiService) Associate(owner, datasetid, doi string) (response SuccessRe
 	return
 }
 
-func (s *DoiService) AssociateWithVersion(owner, datasetid, versionid, doi string) (response SuccessResponse, err error) {
+func (s *DoiService) AssociateWithVersion(owner, datasetid, versionid, doi string) (
+	response SuccessResponse, err error) {
 	endpoint := fmt.Sprintf("/datasets/%s/%s/v/%s/dois/%s", owner, datasetid, versionid, doi)
 	headers := s.client.buildHeaders(PUT, endpoint)
 	err = s.client.request(headers, nil, &response)
@@ -46,7 +47,8 @@ func (s *DoiService) Delete(owner, datasetid, doi string) (response SuccessRespo
 	return
 }
 
-func (s *DoiService) DeleteAssociatedWithVersion(owner, datasetid, versionid, doi string) (response SuccessResponse, err error) {
+func (s *DoiService) DeleteAssociatedWithVersion(owner, datasetid, versionid, doi string) (
+	response SuccessResponse, err error) {
 	endpoint := fmt.Sprintf("/datasets/%s/%s/v/%s/dois/%s", owner, datasetid, versionid, doi)
 	headers := s.client.buildHeaders(DELETE, endpoint)
 	err = s.client.request(headers, nil, &response)

diff --git a/dwapi/files.go b/dwapi/files.go
@@ -27,7 +27,8 @@ type FileService struct {
 	client *Client
 }
 
-func (s *FileService) AddFilesFromURLs(owner, id string, body *FileCreateRequest) (response SuccessResponse, err error) {
+func (s *FileService) AddFilesFromURLs(owner, id string, body *FileCreateRequest) (
+	response SuccessResponse, err error) {
 	endpoint := fmt.Sprintf("/datasets/%s/%s/files", owner, id)
 	headers := s.client.buildHeaders(POST, endpoint)
 	err = s.client.request(headers, body, &response)
@@ -41,7 +42,7 @@ func (s *FileService) Delete(owner, id, filename string) (response SuccessRespon
 	return
 }
 
-func (s *FileService) Download(owner, id, filename string) (response io.Reader, err error) {
+func (s *FileService) Download(owner, id, filename string) (response io.ReadCloser, err error) {
 	endpoint := fmt.Sprintf("/file_download/%s/%s/%s", owner, id, filename)
 	headers := s.client.buildHeaders(GET, endpoint)
 	return s.client.rawRequest(headers, nil)
@@ -62,7 +63,7 @@ func (s *FileService) DownloadAndSave(owner, id, filename, path string) (respons
 	}, nil
 }
 
-func (s *FileService) DownloadDataset(owner, id string) (response io.Reader, err error) {
+func (s *FileService) DownloadDataset(owner, id string) (response io.ReadCloser, err error) {
 	endpoint := fmt.Sprintf("/download/%s/%s", owner, id)
 	headers := s.client.buildHeaders(GET, endpoint)
 	return s.client.rawRequest(headers, nil)
@@ -90,11 +91,12 @@ func (s *FileService) Sync(owner, id string) (response SuccessResponse, err erro
 	return
 }
 
-func (s *FileService) UploadStream(owner, id, filename string, body io.Reader, expandArchive bool) (response SuccessResponse, err error) {
+func (s *FileService) UploadStream(owner, id, filename string, body io.Reader, expandArchive bool) (
+	response SuccessResponse, err error) {
 	endpoint := fmt.Sprintf("/uploads/%s/%s/files/%s", owner, id, filename)
 
 	if expandArchive {
-		endpoint = endpoint + "?expandArchive=true"
+		endpoint += "?expandArchive=true"
 	}
 
 	headers := s.client.buildHeaders(PUT, endpoint)
@@ -106,10 +108,12 @@ func (s *FileService) UploadStream(owner, id, filename string, body io.Reader, e
 	}
 
 	err = s.client.unmarshal(r, &response)
+	r.Close()
 	return
 }
 
-func (s *FileService) Upload(owner, id, filename, path string, expandArchive bool) (response SuccessResponse, err error) {
+func (s *FileService) Upload(owner, id, filename, path string, expandArchive bool) (
+	response SuccessResponse, err error) {
 	f, err := os.Open(path)
 	if err != nil {
 		return

diff --git a/dwapi/insights.go b/dwapi/insights.go
@@ -25,7 +25,8 @@ type InsightService struct {
 	client *Client
 }
 
-func (s *InsightService) Create(owner, projectid string, body *InsightCreateRequest) (response InsightCreateResponse, err error) {
+func (s *InsightService) Create(owner, projectid string, body *InsightCreateRequest) (
+	response InsightCreateResponse, err error) {
 	endpoint := fmt.Sprintf("/insights/%s/%s", owner, projectid)
 	headers := s.client.buildHeaders(POST, endpoint)
 	err = s.client.request(headers, body, &response)
@@ -47,7 +48,8 @@ func (s *InsightService) List(owner, projectid string) (response []InsightSummar
 	return
 }
 
-func (s *InsightService) Replace(owner, projectid, insightid string, body *InsightReplaceRequest) (response SuccessResponse, err error) {
+func (s *InsightService) Replace(owner, projectid, insightid string, body *InsightReplaceRequest) (
+	response SuccessResponse, err error) {
 	endpoint := fmt.Sprintf("/insights/%s/%s/%s", owner, projectid, insightid)
 	headers := s.client.buildHeaders(PUT, endpoint)
 	err = s.client.request(headers, body, &response)
@@ -61,14 +63,16 @@ func (s *InsightService) Retrieve(owner, projectid, insightid string) (response
 	return
 }
 
-func (s *InsightService) RetrieveVersion(owner, projectid, insightid, versionid string) (response InsightSummaryResponse, err error) {
+func (s *InsightService) RetrieveVersion(owner, projectid, insightid, versionid string) (
+	response InsightSummaryResponse, err error) {
 	endpoint := fmt.Sprintf("/insights/%s/%s/%s/v/%s", owner, projectid, insightid, versionid)
 	headers := s.client.buildHeaders(GET, endpoint)
 	err = s.client.request(headers, nil, &response)
 	return
 }
 
-func (s *InsightService) Update(owner, projectid, insightid string, body *InsightUpdateRequest) (response SuccessResponse, err error) {
+func (s *InsightService) Update(owner, projectid, insightid string, body *InsightUpdateRequest) (
+	response SuccessResponse, err error) {
 	endpoint := fmt.Sprintf("/insights/%s/%s/%s", owner, projectid, insightid)
 	headers := s.client.buildHeaders(PATCH, endpoint)
 	err = s.client.request(headers, body, &response)

diff --git a/dwapi/models.go b/dwapi/models.go
@@ -238,28 +238,47 @@ type ProjectSummaryResponse struct {
 	Visibility     string                         `json:"visibility"`
 }
 
+type QueryCreateRequest struct {
+	Name      string `json:"name"`
+	Content   string `json:"content"`
+	Language  string `json:"language"`
+	Published bool   `json:"published,omitempty"`
+}
+
+type QueryParameter struct {
+	Type     string `json:"type,omitempty"`
+	Datatype string `json:"datatype,omitempty"`
+}
+
 type QuerySummaryResponse struct {
-	Body     string `json:"body,omitempty"`
-	Created  string `json:"created,omitempty"`
-	ID       string `json:"id,omitempty"`
-	Language string `json:"language,omitempty"`
-	Name     string `json:"name,omitempty"`
-	Owner    string `json:"owner,omitempty"`
-	Updated  string `json:"updated,omitempty"`
-	Version  string `json:"version,omitempty"`
+	Body       string                    `json:"body,omitempty"`
+	Created    string                    `json:"created,omitempty"`
+	ID         string                    `json:"id,omitempty"`
+	Language   string                    `json:"language,omitempty"`
+	Name       string                    `json:"name,omitempty"`
+	Owner      string                    `json:"owner,omitempty"`
+	Updated    string                    `json:"updated,omitempty"`
+	Version    string                    `json:"version,omitempty"`
+	Parameters map[string]QueryParameter `json:"parameters,omitempty"`
+}
+
+type QueryUpdateRequest struct {
+	Name      string `json:"name"`
+	Content   string `json:"content"`
+	Published bool   `json:"published,omitempty"`
 }
 
 type SavedQueryExecutionRequest struct {
-	Parameters         interface{} `json:"parameters,omitempty"`
-	IncludeTableSchema bool        `json:"includeTableSchema,omitempty"`
-	MaxRows            float64     `json:"maxRows,omitempty"`
+	Parameters         map[string]string `json:"parameters,omitempty"`
+	IncludeTableSchema bool              `json:"includeTableSchema,omitempty"`
+	MaxRows            float64           `json:"maxRows,omitempty"`
 }
 
-type SparqlQueryRequest struct {
+type SPARQLQueryRequest struct {
 	Query string `json:"query"`
 }
 
-type SqlQueryRequest struct {
+type SQLQueryRequest struct {
 	Query              string `json:"query"`
 	IncludeTableSchema bool   `json:"includeTableSchema,omitempty"`
 }