Merge pull request #307 from openmeterio/export

Export OpenMeter as a library

openmeter/dedupe/dedupe.go

@@ -0,0 +1,13 @@
+// Package dedupe implements in-process event deduplication.
+package dedupe
+
+import (
+	"github.com/cloudevents/sdk-go/v2/event"
+
+	"github.com/openmeterio/openmeter/internal/dedupe"
+)
+
+// GetEventKey creates a unique key from an event.
+func GetEventKey(namespace string, ev event.Event) string {
+	return dedupe.GetEventKey(namespace, ev)
+}

openmeter/dedupe/memorydedupe/memorydedupe.go

@@ -0,0 +1,14 @@
+// Package memorydedupe implements in-memory event deduplication.
+package memorydedupe
+
+import (
+	"github.com/openmeterio/openmeter/internal/dedupe/memorydedupe"
+)
+
+// Deduplicator implements in-memory event deduplication.
+type Deduplicator = memorydedupe.Deduplicator
+
+// NewDeduplicator returns a new {Deduplicator}.
+func NewDeduplicator(size int) (*Deduplicator, error) {
+	return memorydedupe.NewDeduplicator(size)
+}

openmeter/dedupe/redisdedupe/redisdedupe.go

@@ -0,0 +1,9 @@
+// Package redisdedupe implements event deduplication using Redis.
+package redisdedupe
+
+import (
+	"github.com/openmeterio/openmeter/internal/dedupe/redisdedupe"
+)
+
+// Deduplicator implements event deduplication using Redis.
+type Deduplicator = redisdedupe.Deduplicator

openmeter/ingest/dedupe.go

@@ -0,0 +1,11 @@
+package ingest
+
+import (
+	"github.com/openmeterio/openmeter/internal/ingest"
+)
+
+// Deduplicator checks if an event is unique.
+type Deduplicator = ingest.Deduplicator
+
+// DeduplicatingCollector implements event deduplication at event ingestion.
+type DeduplicatingCollector = ingest.DeduplicatingCollector

openmeter/ingest/httpingest/httpingest.go

@@ -0,0 +1,14 @@
+package httpingest
+
+import (
+	"github.com/openmeterio/openmeter/internal/ingest/httpingest"
+)
+
+// Handler receives an event in CloudEvents format and forwards it to a {Collector}.
+type Handler = httpingest.Handler
+
+type HandlerConfig = httpingest.HandlerConfig
+
+func NewHandler(config HandlerConfig) (*Handler, error) {
+	return httpingest.NewHandler(config)
+}

openmeter/ingest/ingest.go

@@ -0,0 +1,9 @@
+// Package ingest implements event ingestion.
+package ingest
+
+import (
+	"github.com/openmeterio/openmeter/internal/ingest"
+)
+
+// Collector is a receiver of events that handles sending those events to some downstream broker.
+type Collector = ingest.Collector

openmeter/ingest/inmemory.go

@@ -0,0 +1,8 @@
+package ingest
+
+import (
+	"github.com/openmeterio/openmeter/internal/ingest"
+)
+
+// InMemoryCollector is a {Collector} backed by in-memory storage.
+type InMemoryCollector = ingest.InMemoryCollector

openmeter/ingest/kafkaingest/collector.go

@@ -0,0 +1,17 @@
+package kafkaingest
+
+import (
+	"context"
+	"log/slog"
+
+	"github.com/confluentinc/confluent-kafka-go/v2/kafka"
+
+	"github.com/openmeterio/openmeter/internal/ingest/kafkaingest"
+)
+
+// Collector is a receiver of events that handles sending those events to a downstream Kafka broker.
+type Collector = kafkaingest.Collector
+
+func KafkaProducerGroup(ctx context.Context, producer *kafka.Producer, logger *slog.Logger) (execute func() error, interrupt func(error)) {
+	return kafkaingest.KafkaProducerGroup(ctx, producer, logger)
+}

openmeter/ingest/kafkaingest/namespace.go

@@ -0,0 +1,8 @@
+package kafkaingest
+
+import (
+	"github.com/openmeterio/openmeter/internal/ingest/kafkaingest"
+)
+
+// NamespaceHandler is a namespace handler for Kafka ingest topics.
+type NamespaceHandler = kafkaingest.NamespaceHandler

openmeter/ingest/kafkaingest/serializer/json.go

@@ -0,0 +1,13 @@
+package serializer
+
+import (
+	_ "embed"
+
+	"github.com/openmeterio/openmeter/internal/ingest/kafkaingest/serializer"
+)
+
+type JSONSerializer = serializer.JSONSerializer
+
+func NewJSONSerializer() JSONSerializer {
+	return serializer.NewJSONSerializer()
+}

openmeter/ingest/kafkaingest/serializer/serializer.go

@@ -0,0 +1,11 @@
+package serializer
+
+import (
+	_ "embed"
+
+	"github.com/openmeterio/openmeter/internal/ingest/kafkaingest/serializer"
+)
+
+type Serializer = serializer.Serializer
+
+type CloudEventsKafkaPayload = serializer.CloudEventsKafkaPayload

openmeter/meter/inmemory.go

@@ -0,0 +1,14 @@
+package meter
+
+import (
+	"github.com/openmeterio/openmeter/internal/meter"
+	"github.com/openmeterio/openmeter/pkg/models"
+)
+
+// InMemoryRepository is an in-memory meter repository.
+type InMemoryRepository = meter.InMemoryRepository
+
+// NewInMemoryRepository returns a in-memory meter repository.
+func NewInMemoryRepository(meters []models.Meter) *InMemoryRepository {
+	return meter.NewInMemoryRepository(meters)
+}

openmeter/meter/meter.go

@@ -0,0 +1,8 @@
+package meter
+
+import (
+	"github.com/openmeterio/openmeter/internal/meter"
+)
+
+// Repository is an interface to the meter store.
+type Repository = meter.Repository

openmeter/namespace/namespace.go

@@ -0,0 +1,23 @@
+// Package namespace adds a concept of tenancy to OpenMeter allowing to segment clients.
+package namespace
+
+import (
+	"github.com/openmeterio/openmeter/internal/namespace"
+)
+
+// Manager is responsible for managing namespaces in different components.
+type Manager = namespace.Manager
+
+type ManagerConfig = namespace.ManagerConfig
+
+func NewManager(config ManagerConfig) (*Manager, error) {
+	return namespace.NewManager(config)
+}
+
+// Handler is responsible for creating a namespace in a given component.
+//
+// An empty name means a default namespace is supposed to be created.
+// The concept of a default namespace is implementation specific.
+//
+// The behavior for trying to create a namespace that already exists is unspecified at the moment.
+type Handler = namespace.Handler

openmeter/openmeter.go

@@ -0,0 +1,2 @@
+// Package openmeter is an experimental package to expose the core of OpenMeter as a library.
+package openmeter

openmeter/server/router/router.go

@@ -0,0 +1,15 @@
+package router
+
+import (
+	"github.com/openmeterio/openmeter/internal/server/router"
+)
+
+type IngestHandler = router.IngestHandler
+
+type Config = router.Config
+
+type Router = router.Router
+
+func NewRouter(config Config) (*Router, error) {
+	return router.NewRouter(config)
+}

openmeter/server/server.go

@@ -0,0 +1,13 @@
+package server
+
+import (
+	"github.com/openmeterio/openmeter/internal/server"
+)
+
+type Server = server.Server
+
+type Config = server.Config
+
+func NewServer(config *Config) (*Server, error) {
+	return server.NewServer(config)
+}

openmeter/streaming/clickhouse_connector/connector.go

@@ -0,0 +1,14 @@
+package clickhouse_connector
+
+import (
+	"github.com/openmeterio/openmeter/internal/streaming/clickhouse_connector"
+)
+
+// ClickhouseConnector implements `ingest.Connector“ and `namespace.Handler interfaces.
+type ClickhouseConnector = clickhouse_connector.ClickhouseConnector
+
+type ClickhouseConnectorConfig = clickhouse_connector.ClickhouseConnectorConfig
+
+func NewClickhouseConnector(config ClickhouseConnectorConfig) (*ClickhouseConnector, error) {
+	return clickhouse_connector.NewClickhouseConnector(config)
+}

openmeter/streaming/clickhouse_connector/model.go

@@ -0,0 +1,7 @@
+package clickhouse_connector
+
+import (
+	"github.com/openmeterio/openmeter/internal/streaming/clickhouse_connector"
+)
+
+type MeterView = clickhouse_connector.MeterView

openmeter/streaming/connector.go

@@ -0,0 +1,13 @@
+package streaming
+
+import (
+	"github.com/openmeterio/openmeter/internal/streaming"
+)
+
+type ListEventsParams = streaming.ListEventsParams
+
+type QueryParams = streaming.QueryParams
+
+type QueryResult = streaming.QueryResult
+
+type Connector = streaming.Connector