integrations

README

Integrations Service

This service handles connections and communication with all the third-party platforms like Github and Vercel with whom we want to sync our secrets with.

Note: Always abide by clean code architecture and implement proper abstractions between different layers of business logic.

Style Guide

Mandatory files:

• routes.go contains API routes.
• handler.go contains handlers for every route.
• default.go sets and gets the default initialized service.
• init.go initializes the default service at startup.

Contribution Guide

To add a new integration:

1. Register it's unique Type constant in commons.go. For example:

   const Github IntegrationType = "github"
   

2. Create an independent package in /internal directory for all operations of that integration. This package cannot be referenced outside the service level definitions. Take inspiration from github package.
3. Call your new integration's functions from the service by adding it to all the relevant switch cases in service.go file.

Documentation

Index

• Variables
• func SetService(svc Service)
• type DefaultService
  • func (*DefaultService) Get(ctx context.ServiceContext, client *clients.GQLClient, id string) (*Integration, error)
  • func (*DefaultService) List(ctx context.ServiceContext, client *clients.GQLClient, ...) (*Integrations, error)
  • func (*DefaultService) ListEntities(ctx context.ServiceContext, client *clients.GQLClient, integrationType Type, ...) (interface{}, error)
  • func (*DefaultService) ListSubEntities(ctx context.ServiceContext, client *clients.GQLClient, integrationType Type, ...) (interface{}, error)
  • func (*DefaultService) Setup(ctx context.ServiceContext, client *clients.GQLClient, integrationType Type, ...) (*Integration, error)
  • func (d *DefaultService) Sync(ctx context.ServiceContext, client *clients.GQLClient, options *SyncOptions) error
• type Entities
• type Entity
• type Integration
  • func (i *Integration) GetDescription() string
  • func (i *Integration) GetSubtitle() string
  • func (i *Integration) GetTitle() string
• type Integrations
• type ListEntitiesRequest
• type ListEntitiesRequestOptions
• type ListIntegrationFilters
• type Service
  • func GetService() Service
• type SetupOptions
• type SyncOptions
• type Type
  • func (t *Type) IsValid() bool

Variables

var (
	AllowedIntegrations = []Type{Github, Gitlab, Vercel, ASM, CircleCI, GSM, Supabase, Netlify, Railway, Hasura, Nhost, Heroku}
)

Functions

func SetService

func SetService(svc Service)

Types

type DefaultService

type DefaultService struct{}

func (*DefaultService) Get

func (*DefaultService) Get(ctx context.ServiceContext, client *clients.GQLClient, id string) (*Integration, error)

func (*DefaultService) List

func (*DefaultService) List(ctx context.ServiceContext, client *clients.GQLClient, options *ListIntegrationFilters) (*Integrations, error)

func (*DefaultService) ListEntities

func (*DefaultService) ListEntities(ctx context.ServiceContext, client *clients.GQLClient, integrationType Type, integrationID string, options map[string]interface{}) (interface{}, error)

func (*DefaultService) ListSubEntities

func (*DefaultService) ListSubEntities(ctx context.ServiceContext, client *clients.GQLClient, integrationType Type, integrationID string, params url.Values) (interface{}, error)

func (*DefaultService) Setup

func (*DefaultService) Setup(ctx context.ServiceContext, client *clients.GQLClient, integrationType Type, options *SetupOptions) (*Integration, error)

func (*DefaultService) Sync

func (d *DefaultService) Sync(ctx context.ServiceContext, client *clients.GQLClient, options *SyncOptions) error

type Entities

type Entities []Entity

type Entity

type Entity struct {
	ID             string `json:"id"`
	Slug           string `json:"slug"`
	ParentName     string `json:"parent_name"`
	Name           string `json:"name"`
	URL            string `json:"url"`
	InstallationID string `json:"installation_id"`
	Type           Type   `json:"type"`
}

type Integration

type Integration struct {
	ID             string    `json:"id,omitempty"`
	CreatedAt      time.Time `json:"created_at,omitempty"`
	UpdatedAt      time.Time `json:"updated_at,omitempty"`
	UserID         string    `json:"user_id,omitempty"`
	OrgID          string    `json:"org_id"`
	InstallationID string    `json:"installation_id"`
	Type           Type      `json:"type"`
	Credentials    string    `json:"credentials,omitempty"`
}

func (*Integration) GetDescription

func (i *Integration) GetDescription() string

Get the description of the integration by it's type.

func (*Integration) GetSubtitle

func (i *Integration) GetSubtitle() string

Get the subtitle of the integration by it's type.

func (*Integration) GetTitle

func (i *Integration) GetTitle() string

Get the title of the integration by it's type.

type Integrations

type Integrations []Integration

type ListEntitiesRequest

type ListEntitiesRequest struct {
	OrgID string `json:"org_id"`
	Type  Type   `json:"type"`
}

type ListEntitiesRequestOptions

type ListEntitiesRequestOptions struct {
	OrgID          string `json:"org_id"`
	Type           Type   `json:"type"`
	InstallationID string `json:"installation_id"`
}

type ListIntegrationFilters

type ListIntegrationFilters struct {
	OrgID string `json:"org_id"`
	Type  Type   `json:"type"`
}

type Service

type Service interface {
	Get(context.ServiceContext, *clients.GQLClient, string) (*Integration, error)
	List(context.ServiceContext, *clients.GQLClient, *ListIntegrationFilters) (*Integrations, error)
	ListEntities(context.ServiceContext, *clients.GQLClient, Type, string, map[string]interface{}) (interface{}, error)
	ListSubEntities(context.ServiceContext, *clients.GQLClient, Type, string, url.Values) (interface{}, error)
	Setup(context.ServiceContext, *clients.GQLClient, Type, *SetupOptions) (*Integration, error)
	Sync(context.ServiceContext, *clients.GQLClient, *SyncOptions) error
}

func GetService

func GetService() Service

type SetupOptions

type SetupOptions struct {
	Options map[string]interface{} `json:"options"`
	OrgID   string                 `json:"org_id"`
}

type SyncOptions

type SyncOptions struct {
	EventID       string                 `json:"event_id"`
	IntegrationID string                 `json:"integration_id"`
	EntityDetails map[string]interface{} `json:"entity_details"`
	Data          *keypayload.KPMap      `json:"data"`
}

type Type

type Type string

const (
	Github   Type = "github"
	Gitlab   Type = "gitlab"
	Vercel   Type = "vercel"
	ASM      Type = "asm"
	GSM      Type = "gsm"
	CircleCI Type = "circleci"
	Supabase Type = "supabase"
	Netlify  Type = "netlify"
	Railway  Type = "railway"
	Hasura   Type = "hasura"
	Nhost    Type = "nhost"
	Heroku   Type = "heroku"
)

func (*Type) IsValid

func (t *Type) IsValid() bool