benpate / activitystream

Simple ActivityStream handling for Go

ActivityStream 🏞

Welcome to the Fediverse

This is a personal experiment to explore Activity Streams. This library is BRAND NEW, and is not ready for use by anyone, for any reason, at any time. Check out https://github.com/go-fed for a library that's ready for prime time.

This is an Experiment

ActivityStreams is so hard to work with in a "strongly typed", "idiomatic go" way, because the W3C spec is so loose with types. So, I'm revisiting this idea of loosely typed data that's encapsulated by strongly typed constructors. This technique works great with databases like MongoDB, so I'm giving it another go for ActivityStreams. This (may?) also help with extendability, as new constructors can be defined outside of the primary Activity Vocabulary.

There are separate libraries for Reading and Writing ActivityStreams data. They will work something like this:

// WRITING ActivityStreams
writer.Announce(
    writer.Actor().Name("John Doe").ID("[e-mail]").URL("john.doe.com"),
    writer.Document().URL("https://me.website.com/document-name"),
    nil
)

// READING ActivityStreams
object, err := New(`{
    "@context": "https://www.w3.org/ns/activitystreams",
    "name": "Foo",
    "id": "http://example.org/foo"
    }`)

object.Name() // "foo"
object.ID() // "http://example.org/foo"

Pull Requests Welcome

This library is a work in progress, and will benefit from your experience reports, use cases, and contributions. If you have an idea for making this library better, send in a pull request. We're all in this together! 🏞