feat:Add Lemlist Metadata Connector

Author: Jkarage

providers/lemlist/connnector.go

@@ -0,0 +1,46 @@
+package lemlist
+
+import (
+	"github.com/amp-labs/connectors/common"
+	"github.com/amp-labs/connectors/internal/components"
+	"github.com/amp-labs/connectors/internal/components/operations"
+	"github.com/amp-labs/connectors/internal/components/schema"
+	"github.com/amp-labs/connectors/providers"
+)
+
+const (
+	restAPIPrefix = "api"
+	object        = "object"
+	list          = "list"
+)
+
+type Connector struct {
+	// Basic connector
+	*components.Connector
+
+	// Require authenticated client
+	common.RequireAuthenticatedClient
+
+	// Supported operations
+	components.SchemaProvider
+}
+
+func NewConnector(params common.Parameters) (*Connector, error) {
+	return components.Initialize(providers.Lemlist, params, constructor)
+}
+
+func constructor(base *components.Connector) (*Connector, error) {
+	connector := &Connector{Connector: base}
+
+	// Set the metadata provider for the connector
+	connector.SchemaProvider = schema.NewObjectSchemaProvider(
+		connector.HTTPClient().Client,
+		schema.FetchModeParallel,
+		operations.SingleObjectMetadataHandlers{
+			BuildRequest:  connector.buildSingleObjectMetadataRequest,
+			ParseResponse: connector.parseSingleObjectMetadataResponse,
+		},
+	)
+
+	return connector, nil
+}

providers/lemlist/handlers.go

@@ -0,0 +1,112 @@
+package lemlist
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	"github.com/amp-labs/connectors/common"
+	"github.com/amp-labs/connectors/common/naming"
+	"github.com/amp-labs/connectors/common/urlbuilder"
+)
+
+func (c *Connector) buildSingleObjectMetadataRequest(ctx context.Context, objectName string) (*http.Request, error) {
+	url, err := urlbuilder.New(c.ProviderInfo().BaseURL, restAPIPrefix, objectName)
+	if err != nil {
+		return nil, err
+	}
+
+	url.WithQueryParam("version", "v2")
+
+	return http.NewRequestWithContext(ctx, http.MethodGet, url.String(), nil)
+}
+
+func (c *Connector) parseSingleObjectMetadataResponse(
+	ctx context.Context,
+	objectName string,
+	request *http.Request,
+	response *common.JSONHTTPResponse,
+) (*common.ObjectMetadata, error) {
+	var (
+		firstRecord map[string]any
+		err         error
+	)
+
+	objectMetadata := common.ObjectMetadata{
+		FieldsMap:   make(map[string]string),
+		DisplayName: naming.CapitalizeFirstLetterEveryWord(objectName),
+	}
+
+	schema, fld := responseSchema(objectName)
+
+	switch schema {
+	case object:
+		firstRecord, err = parseObject(response, fld)
+		if err != nil {
+			return nil, err
+		}
+
+	case list:
+		firstRecord, err = parseList(response)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	for fld := range firstRecord {
+		objectMetadata.FieldsMap[fld] = fld
+	}
+
+	return &objectMetadata, nil
+}
+
+func parseObject(response *common.JSONHTTPResponse, fld string) (map[string]any, error) {
+	// We're unmarshaling the data to map[string]any,
+	// all supported objects returns this data type.
+	data, err := common.UnmarshalJSON[map[string]any](response)
+	if err != nil {
+		return nil, common.ErrFailedToUnmarshalBody
+	}
+
+	if len(*data) == 0 {
+		return nil, common.ErrMissingExpectedValues
+	}
+
+	firstRecord := *data
+
+	if fld != "" {
+		// If this is the case, we're expecting the data in a certain field
+		// in this current map.
+		records, okay := (*data)[fld].([]any)
+		if !okay {
+			return nil, fmt.Errorf("couldn't convert the data response field data to an array: %w", common.ErrMissingExpectedValues) // nolint:lll
+		}
+
+		if len(records) == 0 {
+			return nil, fmt.Errorf("%w: could not find a record to sample fields from", common.ErrMissingExpectedValues)
+		}
+
+		// Iterate over the first record.
+		firstRecord, okay = records[0].(map[string]any)
+		if !okay {
+			return nil, fmt.Errorf("couldn't convert the first record data to a map: %w", common.ErrMissingExpectedValues)
+		}
+	}
+
+	return firstRecord, nil
+}
+
+func parseList(response *common.JSONHTTPResponse) (map[string]any, error) {
+	// We're unmarshaling the data to []map[string]any,
+	// all supported objects returns this data type.
+	data, err := common.UnmarshalJSON[[]map[string]any](response)
+	if err != nil {
+		return nil, common.ErrFailedToUnmarshalBody
+	}
+
+	if len(*data) == 0 {
+		return nil, common.ErrMissingExpectedValues
+	}
+
+	return (*data)[0], nil
+}

providers/lemlist/supports.go

@@ -0,0 +1,22 @@
+package lemlist
+
+func responseSchema(objectName string) (string, string) {
+	// team --> an object
+	// api/team/senders --> an array of objects
+	// api/team/credits -->object
+	// api/campaigns --> object campaigns array
+	// api/activities --> an array of objects
+	// api/unsubscirbes --> an array of objects
+	// api/hooks --> an array of objects
+	// api/database/filters -->array of objects
+	// api/schema/people --> an object
+	// api/schema/companies --> an object
+	switch objectName {
+	case "campaigns", "schedules":
+		return object, objectName
+	case "team/senders", "activities", "unsubscirbes", "hooks", "database/filters":
+		return list, ""
+	default:
+		return object, ""
+	}
+}

test/lemlist/connector.go

@@ -0,0 +1,30 @@
+package lemlist
+
+import (
+	"context"
+
+	"github.com/amp-labs/connectors/common"
+	"github.com/amp-labs/connectors/common/scanning/credscanning"
+	"github.com/amp-labs/connectors/providers"
+	"github.com/amp-labs/connectors/providers/lemlist"
+	"github.com/amp-labs/connectors/test/utils"
+)
+
+func GetLemlistConnector(ctx context.Context) *lemlist.Connector {
+	filePath := credscanning.LoadPath(providers.Lemlist)
+	reader := utils.MustCreateProvCredJSON(filePath, false, false)
+
+	client, err := common.NewApiKeyQueryParamAuthHTTPClient(ctx, "access_token", reader.Get(credscanning.Fields.ApiKey))
+	if err != nil {
+		utils.Fail("error creating client", "error", err)
+	}
+
+	conn, err := lemlist.NewConnector(
+		common.Parameters{AuthenticatedClient: client},
+	)
+	if err != nil {
+		utils.Fail("error creating connector", "error", err)
+	}
+
+	return conn
+}

test/lemlist/metadata/main.go

@@ -0,0 +1,31 @@
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/amp-labs/connectors/test/lemlist"
+	"github.com/amp-labs/connectors/test/utils"
+)
+
+func main() {
+	if err := run(); err != nil {
+		utils.Fail(err.Error())
+	}
+}
+
+func run() error {
+	ctx := context.Background()
+	connector := lemlist.GetLemlistConnector(ctx)
+
+	m, err := connector.ListObjectMetadata(ctx, []string{"campaigns", "team", "schedules", "schema/people"})
+	if err != nil {
+		return err
+	}
+
+	// Print the results
+	fmt.Println("Results: ", m.Result)
+	fmt.Println("Errors: ", m.Errors)
+
+	return nil
+}