firesert

README

firesert

Create Go microservices that receive Pub/Sub push messages and insert their data into Firestore collections.

Very easy to use, create a working service by adding just one line of code to your main method:

firesert.Run()

Examples

Try working examples of firesert here

Getting started

Create a new Go project

mkdir firesert-example
cd firesert-example
go mod init firesert/example

Get firesert

go get github.com/jonnyorman/firesert

Add a main.go file with the following

package main

import "github.com/jonnyorman/firesert"

func main() {
	firesert.Run()
}

Add a firesert-config.json file with the following

{
    "projectID": "your-firebase-project",
    "collectionName": "FirestoreCollection"
}

Tidy and run with access to a Firebase project or emulator

    go mod tidy
    go run .

Submit a POST to the service with a Pub/Sub push body. You will see the data get inserted in the FirestoreCollection collection in your Firestore.

You can also create a struct with the data you want to insert into Firestore. Create a struct and use it:

package main

import "github.com/jonnyorman/firesert"

type DocumentModel struct {
	Prop1 string
	Prop2 int
}

func main() {
	firesert.RunTyped[DocumentModel]()
}

Environment configuration

The configuration can also be provided by the environment with the following keys:

• projectID - PROJECT_ID
• collectionName - COLLECTION_NAME

A combination of the firesert-config.json file and environment variables can be used. For example, the project ID could be provided as the PROJECT_ID environment variable, while the collection name is provided with the following configuration file:

{
    "collectionName": "FirestoreCollection"
}

If a configuration value is provided in both firesert-config.json and the environment, then the configuration file with take priority. For example, if the PROJECT_ID envronment varialbe has value "env-project-id" and the following firesert-config.json file is provided:

{
    "projectID": "config-project-id",
    "collectionName": "FirestoreCollection"
}

then the project ID will be "config-project-id".

Documentation

Index

• func Run()
• func RunTyped[T any]()
• type Application
  • func BuildApplication[T any]() Application
  • func NewApplication(router *gin.Engine) *Application
  • func (this Application) Run()
• type ApplicationConfigurationLoader
  • func NewApplicationConfigurationLoader(projectIDProvider ValueProvider, collectionNameProvider ValueProvider) *ApplicationConfigurationLoader
  • func (this ApplicationConfigurationLoader) Load() Configuration
• type Configuration
  • func NewConfiguration(projectID string, collectionName string) *Configuration
• type ConfigurationFilePathProvider
  • func NewConfigurationFilePathProvider(fileName string) *ConfigurationFilePathProvider
  • func (this ConfigurationFilePathProvider) Get() string
• type ConfigurationFileReader
  • func NewConfigurationFileReader(filePathProvider FilePathProvider) *ConfigurationFileReader
  • func (this ConfigurationFileReader) Read() []byte
• type ConfigurationJsonFileReader
  • func NewConfigurationJsonFileReader(configurationFileReader FileReader) *ConfigurationJsonFileReader
  • func (this ConfigurationJsonFileReader) Read() map[string]interface{}
• type ConfigurationLoader
• type ConfigurationValueProvider
  • func CreateConfigurationValueProvider(jsonKey string, environmentKey string, ...) ConfigurationValueProvider
  • func (this ConfigurationValueProvider) Get() (string, bool)
• type DataDeserialiser
• type DataInserter
• type DataReader
• type EnvironmentValueProvider
  • func NewEnvironmentValueProvider(key string) *EnvironmentValueProvider
  • func (this EnvironmentValueProvider) Get() (string, bool)
• type FilePathProvider
• type FileReader
• type FirestoreDataInserter
  • func NewFirestoreDataInserter[T any](configuration Configuration) *FirestoreDataInserter[T]
  • func (this FirestoreDataInserter[T]) Insert(data T)
• type GinPubSubBodyReader
  • func NewGinPubSubBodyReader(reader Reader, pubSubBodyDeserialiser DataDeserialiser[PubSubBody]) *GinPubSubBodyReader
  • func (this GinPubSubBodyReader) Read(ginContext *gin.Context) PubSubBody
• type GinRouterBuilder
  • func NewGinRouterBuilder[T any](requestHandler RequestHandler[T]) *GinRouterBuilder[T]
  • func (this GinRouterBuilder[T]) Build() *gin.Engine
• type HttpRequestBodyDataReader
  • func NewHttpRequestBodyDataReader[T any](pubSubBodyReader PubSubBodyReader, dataDeserialiser DataDeserialiser[T]) *HttpRequestBodyDataReader[T]
  • func (this HttpRequestBodyDataReader[T]) Read(ginContext *gin.Context) T
• type IoReaderGenerator
• type IoutilReader
  • func (this IoutilReader) Read(ioReader io.Reader) []byte
• type JsonDataDeserialiser
  • func (this JsonDataDeserialiser[T]) Deserialise(data []byte) T
• type JsonReader
• type JsonValueProvider
  • func NewJsonValueProvider(key string) *JsonValueProvider
  • func (this JsonValueProvider) Get() (string, bool)
• type PubSubBody
• type PubSubBodyReader
• type PubSubPushRequestHandler
  • func (this PubSubPushRequestHandler[T]) Handle(ginContext *gin.Context)
• type Reader
• type RequestHandler
• type RouterBuilder
• type ValueProvider

Functions

func Run

func Run()

func RunTyped

func RunTyped[T any]()

Types

type Application

type Application struct {
	// contains filtered or unexported fields
}

func BuildApplication

func BuildApplication[T any]() Application

func NewApplication

func NewApplication(router *gin.Engine) *Application

func (Application) Run

func (this Application) Run()

type ApplicationConfigurationLoader

type ApplicationConfigurationLoader struct {
	// contains filtered or unexported fields
}

func NewApplicationConfigurationLoader

func NewApplicationConfigurationLoader(
	projectIDProvider ValueProvider,
	collectionNameProvider ValueProvider,
) *ApplicationConfigurationLoader

func (ApplicationConfigurationLoader) Load

func (this ApplicationConfigurationLoader) Load() Configuration

type Configuration

type Configuration struct {
	ProjectID      string
	CollectionName string
}

func NewConfiguration

func NewConfiguration(projectID string, collectionName string) *Configuration

type ConfigurationFilePathProvider

type ConfigurationFilePathProvider struct {
	// contains filtered or unexported fields
}

func NewConfigurationFilePathProvider

func NewConfigurationFilePathProvider(fileName string) *ConfigurationFilePathProvider

func (ConfigurationFilePathProvider) Get

func (this ConfigurationFilePathProvider) Get() string

type ConfigurationFileReader

type ConfigurationFileReader struct {
	// contains filtered or unexported fields
}

func NewConfigurationFileReader

func NewConfigurationFileReader(filePathProvider FilePathProvider) *ConfigurationFileReader

func (ConfigurationFileReader) Read

func (this ConfigurationFileReader) Read() []byte

type ConfigurationJsonFileReader

type ConfigurationJsonFileReader struct {
	// contains filtered or unexported fields
}

func NewConfigurationJsonFileReader

func NewConfigurationJsonFileReader(configurationFileReader FileReader) *ConfigurationJsonFileReader

func (ConfigurationJsonFileReader) Read

func (this ConfigurationJsonFileReader) Read() map[string]interface{}

type ConfigurationLoader

type ConfigurationLoader interface {
	Load() Configuration
}

type ConfigurationValueProvider

type ConfigurationValueProvider struct {
	// contains filtered or unexported fields
}

func CreateConfigurationValueProvider

func CreateConfigurationValueProvider(
	jsonKey string,
	environmentKey string,
	configurationJson map[string]interface{}) ConfigurationValueProvider

func (ConfigurationValueProvider) Get

func (this ConfigurationValueProvider) Get() (string, bool)

type DataDeserialiser

type DataDeserialiser[T any] interface {
	Deserialise(data []byte) T
}

type DataInserter

type DataInserter[T any] interface {
	Insert(data T)
}

type DataReader

type DataReader[T any] interface {
	Read(ginContext *gin.Context) T
}

type EnvironmentValueProvider

type EnvironmentValueProvider struct {
	// contains filtered or unexported fields
}

func NewEnvironmentValueProvider

func NewEnvironmentValueProvider(key string) *EnvironmentValueProvider

func (EnvironmentValueProvider) Get

func (this EnvironmentValueProvider) Get() (string, bool)

type FilePathProvider

type FilePathProvider interface {
	Get() string
}

type FileReader

type FileReader interface {
	Read() []byte
}

type FirestoreDataInserter

type FirestoreDataInserter[T any] struct {
	// contains filtered or unexported fields
}

func NewFirestoreDataInserter

func NewFirestoreDataInserter[T any](configuration Configuration) *FirestoreDataInserter[T]

func (FirestoreDataInserter[T]) Insert

func (this FirestoreDataInserter[T]) Insert(data T)

type GinPubSubBodyReader

type GinPubSubBodyReader struct {
	// contains filtered or unexported fields
}

func NewGinPubSubBodyReader

func NewGinPubSubBodyReader(
	reader Reader,
	pubSubBodyDeserialiser DataDeserialiser[PubSubBody]) *GinPubSubBodyReader

func (GinPubSubBodyReader) Read

func (this GinPubSubBodyReader) Read(ginContext *gin.Context) PubSubBody

type GinRouterBuilder

type GinRouterBuilder[T any] struct {
	// contains filtered or unexported fields
}

func NewGinRouterBuilder

func NewGinRouterBuilder[T any](requestHandler RequestHandler[T]) *GinRouterBuilder[T]

func (GinRouterBuilder[T]) Build

func (this GinRouterBuilder[T]) Build() *gin.Engine

type HttpRequestBodyDataReader

type HttpRequestBodyDataReader[T any] struct {
	// contains filtered or unexported fields
}

func NewHttpRequestBodyDataReader

func NewHttpRequestBodyDataReader[T any](
	pubSubBodyReader PubSubBodyReader,
	dataDeserialiser DataDeserialiser[T]) *HttpRequestBodyDataReader[T]

func (HttpRequestBodyDataReader[T]) Read

func (this HttpRequestBodyDataReader[T]) Read(ginContext *gin.Context) T

type IoReaderGenerator

type IoReaderGenerator interface {
	Generate(payload string) io.Reader
}

type IoutilReader

type IoutilReader struct{}

func (IoutilReader) Read

func (this IoutilReader) Read(ioReader io.Reader) []byte

type JsonDataDeserialiser

type JsonDataDeserialiser[T any] struct{}

func (JsonDataDeserialiser[T]) Deserialise

func (this JsonDataDeserialiser[T]) Deserialise(data []byte) T

type JsonReader

type JsonReader interface {
	Read() map[string]interface{}
}

type JsonValueProvider

type JsonValueProvider struct {
	// contains filtered or unexported fields
}

func NewJsonValueProvider

func NewJsonValueProvider(key string) *JsonValueProvider

func (JsonValueProvider) Get

func (this JsonValueProvider) Get() (string, bool)

type PubSubBody

type PubSubBody struct {
	Message      pubsub.Message
	Subscription string
}

type PubSubBodyReader

type PubSubBodyReader interface {
	Read(ginContext *gin.Context) PubSubBody
}

type PubSubPushRequestHandler

type PubSubPushRequestHandler[T any] struct {
	// contains filtered or unexported fields
}

func (PubSubPushRequestHandler[T]) Handle

func (this PubSubPushRequestHandler[T]) Handle(ginContext *gin.Context)

type Reader

type Reader interface {
	Read(ioReader io.Reader) []byte
}

type RequestHandler

type RequestHandler[T any] interface {
	Handle(ginContext *gin.Context)
}

type RouterBuilder

type RouterBuilder interface {
	Build() *gin.Engine
}

type ValueProvider

type ValueProvider interface {
	Get() (string, bool)
}