Merge pull request #2 from wayarmy/v0.1.1

Complete v0.1.1

Author: wayarmy

.idea/.gitignore

@@ -20,6 +20,18 @@ type Acl struct {
 	Permission   string `json:"permission,omitempty"`
 }
 
+// Returns a list of ACLs that match the search criteria.
+// Parameters:
+//    cluster_id (string) – The Kafka cluster ID.
+// Query Parameters:
+//    resource_type (string) – The ACL resource type.
+//    resource_name (string) – The ACL resource name.
+//    pattern_type (string) – The ACL pattern type.
+//    principal (string) – The ACL principal.
+//    host (string) – The ACL host.
+//    operation (string) – The ACL operation.
+//    permission (string) – The ACL permission.
+// @ref https://docs.confluent.io/platform/current/kafka-rest/api.html#get--clusters-cluster_id-acls
 func (c *Client) ListAcls(clusterId string) ([]Acl, error) {
 	u := "/clusters/" + clusterId + "/" + aclsPath
 	r, err := c.DoRequest("GET", u, nil)
@@ -39,6 +51,8 @@ func (c *Client) ListAcls(clusterId string) ([]Acl, error) {
 	return body.Data, nil
 }
 
+// Creates an ACL.
+// @ref https://docs.confluent.io/platform/current/kafka-rest/api.html#post--clusters-cluster_id-acls
 func (c *Client) CreateAcl(clusterId string, aclConfig *Acl) error {
 	u := "/clusters/" + clusterId + "/" + aclsPath
 
@@ -52,6 +66,18 @@ func (c *Client) CreateAcl(clusterId string, aclConfig *Acl) error {
 	return nil
 }
 
+// Deletes the list of ACLs that matches the search criteria.
+// Parameters:
+//    cluster_id (string) – The Kafka cluster ID.
+// Query Parameters:
+//    resource_type (string) – The ACL resource type.
+//    resource_name (string) – The ACL resource name.
+//    pattern_type (string) – The ACL pattern type.
+//    principal (string) – The ACL principal.
+//    host (string) – The ACL host.
+//    operation (string) – The ACL operation.
+//    permission (string) – The ACL permission.
+// @ref https://docs.confluent.io/platform/current/kafka-rest/api.html#delete--clusters-cluster_id-acls
 func (c *Client) DeleteAcl(clusterId, resourceName string) error {
 	u := "/clusters/" + clusterId + "/" + aclsPath
 

.idea/gonfluent.iml

@@ -53,7 +53,8 @@ func TestAcls_ListAclsSuccess(t *testing.T) {
 	}
 `), 200, "200 OK", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	acls, err := c.ListAcls("cluster-1")
 	assert.NoError(t, err)
 	assert.Equal(t, 2, len(acls))
@@ -68,7 +69,8 @@ func TestAcls_CreateAclsSuccess(t *testing.T) {
 		assert.Equal(t, "/clusters/cluster-1/acls", uri)
 		return []byte(``), 201, "201", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	aclConfig := Acl{}
 	err := c.CreateAcl("cluster-1", &aclConfig)
 	assert.NoError(t, err)
@@ -115,7 +117,8 @@ func TestAcls_DeleteAclSuccess(t *testing.T) {
 		}
 `), 200, "200", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	err := c.DeleteAcl("cluster-1", "")
 	assert.NoError(t, err)
 }

.idea/modules.xml

@@ -19,7 +19,7 @@ var (
 			},
 			ResourceName: "Testing-Principal",
 			ResourceType: "Cluster",
-			Operation:    "ClusterAdmin",
+			Operation:    "DefaultSaramaClusterAdmin",
 		},
 	}
 )
@@ -37,7 +37,8 @@ func TestAuthorize_CreatePrincipalSuccess(t *testing.T) {
 		  ]
 `), 200, "200", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	newPrincipal, err := c.CreatePrincipal("User:testing", testPrincipals)
 	assert.NoError(t, err)
 	assert.Equal(t, "Testing-Principal", newPrincipal.Actions[0].ResourceName)
@@ -64,7 +65,8 @@ func TestAuthorize_CreatePrincipalFail(t *testing.T) {
 		  }
 `), 400, "400 Bad Request", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	newPrincipal, err := c.CreatePrincipal("User:testing", testPrincipals)
 	assert.NotNil(t, err)
 	assert.Nil(t, newPrincipal)

.idea/vcs.xml

@@ -14,6 +14,7 @@ const (
 // - Kafka connect cluster
 // - KSql cluster
 // - Schema Registry cluster
+// @ref https://docs.confluent.io/platform/current/kafka-rest/api.html#cluster
 type Clusters struct {
 	// Kafka cluster ID
 	KafkaCluster string `json:"kafka-cluster,omitempty"`
@@ -36,6 +37,10 @@ type Related struct {
 	Related string `json:"related"`
 }
 
+// Returns a list of known Kafka clusters. Currently both Kafka and Kafka REST Proxy are only aware
+// of the Kafka cluster pointed at by the bootstrap.servers configuration.
+// Therefore only one Kafka cluster will be returned in the response.
+// @ref https://docs.confluent.io/platform/current/kafka-rest/api.html#get--clusters
 func (c *Client) ListKafkaCluster() ([]KafkaCluster, error) {
 	resp, err := c.DoRequest("GET", clusterUri, nil)
 	if err != nil {
@@ -54,6 +59,8 @@ func (c *Client) ListKafkaCluster() ([]KafkaCluster, error) {
 	return body.Data, nil
 }
 
+// Returns the Kafka cluster with the specified cluster_id.
+// @ref https://docs.confluent.io/platform/current/kafka-rest/api.html#get--clusters-cluster_id
 func (c *Client) GetKafkaCluster(clusterId string) (*KafkaCluster, error) {
 	pathUri := clusterUri + "/" + clusterId
 	resp, err := c.DoRequest("GET", pathUri, nil)

acls.go

@@ -56,7 +56,8 @@ func TestClusters_ListKafkaCluster(t *testing.T) {
 		}
 `), 200, "200 OK", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	clusters, err := c.ListKafkaCluster()
 	if assert.NoError(t, err) {
 		assert.Equal(t, 1, len(clusters))
@@ -77,7 +78,8 @@ func TestClusters_GetNonExistingKafkaCluster(t *testing.T) {
 		}
 `), 404, "404 Not Found", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	cluster, err := c.GetKafkaCluster("cluster-1")
 	assert.Equal(t, errors.New("error with status: 404 Not Found HTTP 404 Not Found"), err)
 	assert.Nil(t, cluster)
@@ -121,7 +123,8 @@ func TestClusters_GetExistingKafkaCluster(t *testing.T) {
 		}
 `), 200, "200 OK", nil
 	}
-	c := NewClient(&mock, &mk)
+	clusterAdmin, _ := mk.NewSaramaClusterAdmin()
+	c := NewClient(&mock, &mk, clusterAdmin)
 	cluster, err := c.GetKafkaCluster("cluster-1")
 	if assert.NoError(t, err) {
 		assert.Equal(t, "cluster-1", cluster.ClusterID)

acls_test.go

@@ -24,6 +24,8 @@ type Synonyms struct {
 	Operation string `json:"operation,omitempty"`
 }
 
+// @ref https://docs.confluent.io/platform/current/kafka-rest/api.html#get--clusters-cluster_id-topics-topic_name-configs
+// Return the list of configs that belong to the specified topic.
 func (c *Client) GetTopicConfigs(clusterId string, topicName string) ([]TopicConfig, error) {
 	u := "/kafka/v3/clusters/" + clusterId + "/topics/" + topicName + "/configs"
 
@@ -42,6 +44,8 @@ func (c *Client) GetTopicConfigs(clusterId string, topicName string) ([]TopicCon
 	return res.Data, nil
 }
 
+// @ref Return the list of configs that belong to the specified topic.
+// Updates or deletes a set of topic configs.
 func (c *Client) UpdateTopicConfigs(clusterId string, topicName string, data []TopicConfig) error {
 	u := "/kafka/v3/clusters/" + clusterId + "/topics/" + topicName + "/configs:alter"