Add API key to Mentix GOCDB connector (cs3org#1834)

changelog/unreleased/add-gocdb-apikey.md

@@ -0,0 +1,5 @@
+Enhancement: Add API key to Mentix GOCDB connector
+
+The PI (programmatic interface) of the GOCDB will soon require an API key; this PR adds the ability to configure this key in Mentix.
+
+https://github.com/cs3org/reva/pull/1834

docs/content/en/docs/config/http/services/mentix/gocdb/_index.md

@@ -25,3 +25,11 @@ The scope to use for filtering sites and services.
 scope = "SM"
 {{< /highlight >}}
 {{% /dir %}}
+
+{{% dir name="apikey" type="string" default="" %}}
+The API key to use for the GOCDB PI.
+{{< highlight toml >}}
+[http.services.mentix.connectors.gocdb]
+apikey = "abc123"
+{{< /highlight >}}
+{{% /dir %}}

examples/mentix/mentix.toml

@@ -6,6 +6,7 @@ update_interval = "15m"
 
 [http.services.mentix.connectors.gocdb]
 address = "http://sciencemesh-test.uni-muenster.de"
+apikey = "abc123"
 
 # Sites can also be stored in a local file
 [http.services.mentix.connectors.localfile]

pkg/mentix/config/config.go

@@ -26,6 +26,7 @@ type Configuration struct {
 		GOCDB struct {
 			Address string `mapstructure:"address"`
 			Scope   string `mapstructure:"scope"`
+			APIKey  string `mapstructure:"apikey"`
 		} `mapstructure:"gocdb"`
 
 		LocalFile struct {

pkg/mentix/connectors/gocdb.go

@@ -92,7 +92,7 @@ func (connector *GOCDBConnector) query(v interface{}, method string, isPrivate b
 	}
 
 	// Get the data from GOCDB
-	data, err := gocdb.QueryGOCDB(connector.gocdbAddress, method, isPrivate, scope, params)
+	data, err := gocdb.QueryGOCDB(connector.gocdbAddress, method, isPrivate, scope, connector.conf.Connectors.GOCDB.APIKey, params)
 	if err != nil {
 		return err
 	}

pkg/mentix/connectors/gocdb/query.go

@@ -25,15 +25,19 @@ import (
 )
 
 // QueryGOCDB retrieves data from one of GOCDB's endpoints.
-func QueryGOCDB(address string, method string, isPrivate bool, scope string, params network.URLParams) ([]byte, error) {
+func QueryGOCDB(address string, method string, isPrivate bool, scope string, apiKey string, params network.URLParams) ([]byte, error) {
 	// The method must always be specified
 	params["method"] = method
 
-	// If a scope was specified, pass it to the endpoint as well
+	// If a scope or an API key were specified, pass them to the endpoint as well
 	if len(scope) > 0 {
 		params["scope"] = scope
 	}
 
+	if len(apiKey) > 0 {
+		params["apikey"] = apiKey
+	}
+
 	// GOCDB's public API is located at <gocdb-host>/gocdbpi/public, the private one at <gocdb-host>/gocdbpi/private
 	var path string
 	if isPrivate {
@@ -48,6 +52,7 @@ func QueryGOCDB(address string, method string, isPrivate bool, scope string, par
 		return nil, fmt.Errorf("unable to generate the GOCDB URL: %v", err)
 	}
 
+	fmt.Println(endpointURL.String())
 	data, err := network.ReadEndpoint(endpointURL, nil, true)
 	if err != nil {
 		return nil, fmt.Errorf("unable to read GOCDB endpoint: %v", err)