Package refactoring (#92)

* move helpers to utils package * testutils * group common types * connector config moved * connector common responses * common response in connector setup tests * test fix * connector schema common types * dbt refactoring * fix examples * destinations common parts * external logging common parts * users common types * webhooks common types * teams common types * fix json marshalling * http utils package * http service base
fivetran · Oct 2, 2023 · 5015e04 · 5015e04
1 parent d40ce58
commit 5015e04
Show file tree

Hide file tree

Showing 240 changed files with 6,635 additions and 6,543 deletions.
diff --git a/certificate_connector_certificate_approve.go b/certificate_connector_certificate_approve.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	httputils "github.com/fivetran/go-fivetran/http_utils"
 )
 
 // CertificateConnectorCertificateApproveService implements the Certificate Management, Approve a connector certificate API.
@@ -66,18 +68,18 @@ func (s *CertificateConnectorCertificateApproveService) Do(ctx context.Context)
 		return response, err
 	}
 
-	r := request{
-		method:           "POST",
-		url:              url,
-		body:             reqBody,
-		queries:          nil,
-		headers:          headers,
-		client:           s.c.httpClient,
-		handleRateLimits: s.c.handleRateLimits,
-		maxRetryAttempts: s.c.maxRetryAttempts,
+	r := httputils.Request{
+		Method:           "POST",
+		Url:              url,
+		Body:             reqBody,
+		Queries:          nil,
+		Headers:          headers,
+		Client:           s.c.httpClient,
+		HandleRateLimits: s.c.handleRateLimits,
+		MaxRetryAttempts: s.c.maxRetryAttempts,
 	}
 
-	respBody, respStatus, err := r.httpRequest(ctx)
+	respBody, respStatus, err := r.Do(ctx)
 	if err != nil {
 		return response, err
 	}

diff --git a/certificate_connector_certificate_approve_test.go b/certificate_connector_certificate_approve_test.go
@@ -3,21 +3,23 @@ package fivetran_test
 import (
 	"context"
 	"testing"
+
+	testutils "github.com/fivetran/go-fivetran/test_utils"
 )
 
 func TestNewCertificateConnectorCertificateApproveE2E(t *testing.T) {
-	connectorId := CreateTempConnector(t)
-	response, err := Client.NewCertificateConnectorCertificateApprove().
+	connectorId := testutils.CreateTempConnector(t)
+	response, err := testutils.Client.NewCertificateConnectorCertificateApprove().
 		ConnectorID(connectorId).
-		Hash(CertificateHash).
-		EncodedCert(EncodedCertificate).
+		Hash(testutils.CertificateHash).
+		EncodedCert(testutils.EncodedCertificate).
 		Do(context.Background())
 
 	if err != nil {
 		t.Logf("%+v\n", response)
 		t.Error(err)
 	}
 
-	AssertEqual(t, response.Code, "Success")
-	AssertNotEmpty(t, response.Message)
+	testutils.AssertEqual(t, response.Code, "Success")
+	testutils.AssertNotEmpty(t, response.Message)
 }
diff --git a/certificate_connector_fingerprint_approve.go b/certificate_connector_fingerprint_approve.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	httputils "github.com/fivetran/go-fivetran/http_utils"
 )
 
 // CertificateConnectorFingerprintApproveService implements the Certificate Management, Approve a connector fingerprint API.
@@ -66,18 +68,18 @@ func (s *CertificateConnectorFingerprintApproveService) Do(ctx context.Context)
 		return response, err
 	}
 
-	r := request{
-		method:           "POST",
-		url:              url,
-		body:             reqBody,
-		queries:          nil,
-		headers:          headers,
-		client:           s.c.httpClient,
-		handleRateLimits: s.c.handleRateLimits,
-		maxRetryAttempts: s.c.maxRetryAttempts,
+	r := httputils.Request{
+		Method:           "POST",
+		Url:              url,
+		Body:             reqBody,
+		Queries:          nil,
+		Headers:          headers,
+		Client:           s.c.httpClient,
+		HandleRateLimits: s.c.handleRateLimits,
+		MaxRetryAttempts: s.c.maxRetryAttempts,
 	}
 
-	respBody, respStatus, err := r.httpRequest(ctx)
+	respBody, respStatus, err := r.Do(ctx)
 	if err != nil {
 		return response, err
 	}

diff --git a/certificate_connector_fingerprint_approve_test.go b/certificate_connector_fingerprint_approve_test.go
@@ -3,11 +3,13 @@ package fivetran_test
 import (
 	"context"
 	"testing"
+
+	testutils "github.com/fivetran/go-fivetran/test_utils"
 )
 
 func TestNewCertificateConnectorFingerprintApproveE2E(t *testing.T) {
-	connectorId := CreateTempConnector(t)
-	response, err := Client.NewCertificateConnectorFingerprintApprove().
+	connectorId := testutils.CreateTempConnector(t)
+	response, err := testutils.Client.NewCertificateConnectorFingerprintApprove().
 		ConnectorID(connectorId).
 		Hash("test_hash").
 		PublicKey("test_public_key").
@@ -18,6 +20,6 @@ func TestNewCertificateConnectorFingerprintApproveE2E(t *testing.T) {
 		t.Error(err)
 	}
 
-	AssertEqual(t, response.Code, "Success")
-	AssertNotEmpty(t, response.Message)
+	testutils.AssertEqual(t, response.Code, "Success")
+	testutils.AssertNotEmpty(t, response.Message)
 }
diff --git a/certificate_destination_certificate_approve.go b/certificate_destination_certificate_approve.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	httputils "github.com/fivetran/go-fivetran/http_utils"
 )
 
 // CertificateDestinationCertificateApproveService implements the Certificate Management, Approve a destination certificate API.
@@ -66,18 +68,18 @@ func (s *CertificateDestinationCertificateApproveService) Do(ctx context.Context
 		return response, err
 	}
 
-	r := request{
-		method:           "POST",
-		url:              url,
-		body:             reqBody,
-		queries:          nil,
-		headers:          headers,
-		client:           s.c.httpClient,
-		handleRateLimits: s.c.handleRateLimits,
-		maxRetryAttempts: s.c.maxRetryAttempts,
+	r := httputils.Request{
+		Method:           "POST",
+		Url:              url,
+		Body:             reqBody,
+		Queries:          nil,
+		Headers:          headers,
+		Client:           s.c.httpClient,
+		HandleRateLimits: s.c.handleRateLimits,
+		MaxRetryAttempts: s.c.maxRetryAttempts,
 	}
 
-	respBody, respStatus, err := r.httpRequest(ctx)
+	respBody, respStatus, err := r.Do(ctx)
 	if err != nil {
 		return response, err
 	}

diff --git a/certificate_destination_certificate_approve_test.go b/certificate_destination_certificate_approve_test.go
@@ -3,21 +3,23 @@ package fivetran_test
 import (
 	"context"
 	"testing"
+
+	testutils "github.com/fivetran/go-fivetran/test_utils"
 )
 
 func TestNewCertificateDestinationCertificateApproveE2E(t *testing.T) {
-	destinationId := CreateTempDestination(t)
-	response, err := Client.NewCertificateDestinationCertificateApprove().
+	destinationId := testutils.CreateTempDestination(t)
+	response, err := testutils.Client.NewCertificateDestinationCertificateApprove().
 		DestinationID(destinationId).
-		Hash(CertificateHash).
-		EncodedCert(EncodedCertificate).
+		Hash(testutils.CertificateHash).
+		EncodedCert(testutils.EncodedCertificate).
 		Do(context.Background())
 
 	if err != nil {
 		t.Logf("%+v\n", response)
 		t.Error(err)
 	}
 
-	AssertEqual(t, response.Code, "Success")
-	AssertNotEmpty(t, response.Message)
+	testutils.AssertEqual(t, response.Code, "Success")
+	testutils.AssertNotEmpty(t, response.Message)
 }
diff --git a/certificate_destination_fingerprint_approve.go b/certificate_destination_fingerprint_approve.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
+	httputils "github.com/fivetran/go-fivetran/http_utils"
 )
 
 // CertificateDestinationFingerprintApproveService implements the Certificate Management, Approve a destination fingerprint API.
@@ -66,18 +68,18 @@ func (s *CertificateDestinationFingerprintApproveService) Do(ctx context.Context
 		return response, err
 	}
 
-	r := request{
-		method:           "POST",
-		url:              url,
-		body:             reqBody,
-		queries:          nil,
-		headers:          headers,
-		client:           s.c.httpClient,
-		handleRateLimits: s.c.handleRateLimits,
-		maxRetryAttempts: s.c.maxRetryAttempts,
+	r := httputils.Request{
+		Method:           "POST",
+		Url:              url,
+		Body:             reqBody,
+		Queries:          nil,
+		Headers:          headers,
+		Client:           s.c.httpClient,
+		HandleRateLimits: s.c.handleRateLimits,
+		MaxRetryAttempts: s.c.maxRetryAttempts,
 	}
 
-	respBody, respStatus, err := r.httpRequest(ctx)
+	respBody, respStatus, err := r.Do(ctx)
 	if err != nil {
 		return response, err
 	}

diff --git a/certificate_destination_fingerprint_approve_test.go b/certificate_destination_fingerprint_approve_test.go
@@ -3,11 +3,13 @@ package fivetran_test
 import (
 	"context"
 	"testing"
+
+	testutils "github.com/fivetran/go-fivetran/test_utils"
 )
 
 func TestNewCertificateDestinationFingerprintApproveE2E(t *testing.T) {
-	destinationId := CreateTempDestination(t)
-	response, err := Client.NewCertificateDestinationFingerprintApprove().
+	destinationId := testutils.CreateTempDestination(t)
+	response, err := testutils.Client.NewCertificateDestinationFingerprintApprove().
 		DestinationID(destinationId).
 		Hash("test_hash").
 		PublicKey("test_public_key").
@@ -18,6 +20,6 @@ func TestNewCertificateDestinationFingerprintApproveE2E(t *testing.T) {
 		t.Error(err)
 	}
 
-	AssertEqual(t, response.Code, "Success")
-	AssertNotEmpty(t, response.Message)
+	testutils.AssertEqual(t, response.Code, "Success")
+	testutils.AssertNotEmpty(t, response.Message)
 }
diff --git a/client.go b/client.go
@@ -4,20 +4,16 @@ import (
 	"encoding/base64"
 	"fmt"
 	"net/http"
-)
 
-// HttpClient performs an HTTP request. Can be implemented by mocks
-// to perform convenient unit tests
-type HttpClient interface {
-	Do(req *http.Request) (*http.Response, error)
-}
+	httputils "github.com/fivetran/go-fivetran/http_utils"
+)
 
 // Client holds client configuration
 type Client struct {
 	baseURL          string
 	authorization    string
 	customUserAgent  string
-	httpClient       HttpClient
+	httpClient       httputils.HttpClient
 	handleRateLimits bool
 	maxRetryAttempts int
 }
@@ -52,7 +48,7 @@ func (c *Client) CustomUserAgent(customUserAgent string) {
 }
 
 // SetHttpClient sets custom HTTP client to perform requests with
-func (c *Client) SetHttpClient(httpClient HttpClient) {
+func (c *Client) SetHttpClient(httpClient httputils.HttpClient) {
 	c.httpClient = httpClient
 }
 
@@ -78,3 +74,22 @@ func (c *Client) commonHeaders() map[string]string {
 		"User-Agent":    userAgent,
 	}
 }
+
+func (c *Client) commonHeadersByMethod(method string) map[string]string {
+	userAgent := defaultUserAgent
+
+	if c.customUserAgent != "" {
+		userAgent += " " + c.customUserAgent
+	}
+
+	result := map[string]string{
+		"Authorization": c.authorization,
+		"User-Agent":    userAgent,
+	}
+
+	if method == "POST" || method == "PATCH" {
+		result["Content-Type"] = "application/json"
+	}
+
+	return result
+}
diff --git a/common/common_types.go b/common/common_types.go
@@ -0,0 +1,32 @@
+package common
+
+import "encoding/json"
+
+type CommonResponse struct {
+	Code    string `json:"code"`
+	Message string `json:"message"`
+}
+
+type SetupTestResponse struct {
+	Title   string `json:"title"`
+	Status  string `json:"status"`
+	Message string `json:"message"`
+}
+
+type NullableString struct {
+	value *string
+}
+
+func (n *NullableString) MarshalJSON() ([]byte, error) {
+	return json.Marshal(n.value)
+}
+
+func NewNullableString(s *string, clear bool) *NullableString {
+	if s == nil && !clear {
+		return nil
+	}
+
+	return &NullableString{
+		value: s,
+	}
+}