Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucperkins/ezpubsub
A Go library providing convenient abstractions over the Google Pub/Sub API
https://github.com/lucperkins/ezpubsub
Last synced: about 1 month ago
JSON representation
A Go library providing convenient abstractions over the Google Pub/Sub API
- Host: GitHub
- URL: https://github.com/lucperkins/ezpubsub
- Owner: lucperkins
- License: mit
- Created: 2019-05-26T11:28:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-04T06:04:48.000Z (over 4 years ago)
- Last Synced: 2024-11-07T00:48:54.533Z (3 months ago)
- Language: Go
- Homepage: https://godoc.org/github.com/lucperkins/ezpubsub
- Size: 67.4 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ezpubsub
[](https://godoc.org/github.com/lucperkins/ezpubsub)
`ezpubsub` is a set of higher-level abstractions over the Go library for [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/). It's built for convenience and intended to cover the vast majority of use cases with minimal fuss. If your use case isn't covered, you're advised to use the [official library](https://godoc.org/cloud.google.com/go/pubsub).
## Why?
The [`cloud.google.com/go/pubsub`](https://godoc.org/cloud.google.com/go/pubsub) library is well done and complete but also fairly low level. `ezpubsub` makes it easier to do the ~80% of things you're most likely to do with the library, especially when using Google Cloud Pub/Sub in development and testing environments.
`ezpubsub` features a small API surface area and doesn't require you to ever deal with context; if your use case requires context, use the core `pubsub` library.
## Core concepts
The `ezpubsub` library gives you two core constructs, **publishers** and **subscribers**:
* Subscribers listen for messages on the specified topic and respond to each message using the provided listener function.
* Publishers publish messages to the specified topic either singly or in batches.
You can see examples on the [GoDoc](https://godoc.org/github.com/lucperkins/ezpubsub) page.
## Subscribers
**Subscribers** listen on the specified topic and apply the logic specified in the [`Listener`](https://godoc.org/github.com/lucperkins/ezpubsub#Listener) function to each incoming message. Here's an example:
```go
import (
"cloud.google.com/go/pubsub"
"github.com/lucperkins/ezpubsub"
"log"
)
func main() {
subscriberConfig := &ezpubsub.SubscriberConfig{
Project: "my-project",
Topic: "user-events",
Subscription: "my-sub",
Listener: func(msg *pubsub.Message) {
log.Printf("Event received: (id: %s, payload: %s)\n", msg.ID, string(msg.Data))
msg.Ack()
},
}
subscriber, err := ezpubsub.NewSubscriber(subscriberConfig)
if err != nil {
// handle error
}
subscriber.Start()
}
```
## Publishers
**Publishers** publish messages on the specified topic and handle publishing results according to the logic specified in the [`Notifier`](https://godoc.org/github.com/lucperkins/ezpubsub#Notifier) function.
```go
import (
"cloud.google.com/go/pubsub"
"context"
"github.com/lucperkins/ezpubsub"
"time"
)
func main() {
publisherConfig := &ezpubsub.PublisherConfig{
Project: "my-project",
Topic: "user-events",
Notifier: func(res *pubsub.PublishResult) {
msgId, _ := res.Get(context.Background())
log.Printf("Message published: (id: %s)\n", id)
},
}
publisher, err := ezpubsub.NewPublisher(publisherConfig)
if err != nil {
// handle error
}
// Publish bytes
publisher.Publish([]byte("Hello world"))
// Publish a string
publisher.PublishString("Hello world")
// Publish a JSON-serializable item
event := struct {
ID int64
Timestamp int64
Message string
}{
123456,
time.Now.Uniz(),
"Something happened",
}
err = publisher.PublishObject(event)
if err != nil {
// handle error
}
}
```
## Admin
ezpubsub offers an [`Admin`](https://godoc.org/github.com/lucperkins/ezpubsub#Admin) type that enables you to perform basic administrative tasks. At the moment, `Admin` supports listing all topics in a project. More functionality will be added later.
```go
func main() {
project := "my-project"
admin, err := ezpubsub.NewAdmin(project)
if err != nil {
// handle error
}
// List topics
topics, err := admin.ListTopics()
if err != nil {
// handle error
}
fmt.Println("Listing topics:")
for _, topic := range topics {
fmt.Println(topic)
}
}
```