README.md

GO-GETSTREAM

Golang pkg for getstream.io. The goal of this package is to provide server-side support for getstream and to generate client-side tokens.

Examples :

Server Side

client, err := getstream.New("APIKey", "APISecret", "AppID", "Region")
if err != nil {
  fmt.Println(err)
  return
}

feed, err := client.FlatFeed("FeedSlug", "UserID")
if err != nil {
  fmt.Println(err)
  return
}

activity, err := feed.AddActivity(&Activity{
  Verb:      "post",
  ForeignID: uuid.New(),
  Object:    FeedID("flat:eric"),
  Actor:     FeedID("flat:john"),
})
if err != nil {
  fmt.Println(err)
}

Client Side Token

client, err := getstream.New("APIKey", "APISecret", "AppID", "Region")
if err != nil {
  fmt.Println(err)
  return
}

feed, err := client.FlatFeed("FeedSlug", "UserID")
if err != nil {
  fmt.Println(err)
  return
}

token, err := client.Signer.GenerateFeedScopeToken(getstream.ScopeContextFeed, getstream.ScopeActionRead, feed)
if err != nil {
  fmt.Println(err)
}

clientSideClient, err := getstream.NewWithToken("APIKey", token, "AppID", "Region")
if err != nil {
  fmt.Println(err)
}

Supported :

• Flat Feed

  • Add
  • Add Multiple
  • Remove
  • Remove By ForeignID
  • List
  • Follow
  • UnFollow
  • Followers
  • Following

• Aggregated Feed

  • Add
  • Add Multiple
  • Remove
  • Remove By ForeignID
  • List
  • Follow
  • UnFollow
  • Following

• Notification Feed

  • Add
  • Add Multiple
  • Remove
  • Remove By ForeignID
  • List
  • Follow
  • UnFollow
  • Following
  • Mark Read
  • Mark Seen

• Client Side Tokens :

  • fully implemented

Structure :

• Follows getstream API standards for all request payloads
• data : Statically typed payloads as json.RawMessage
• metadata : Top-level key/value pairs

You can/should use data to send golang structures through getstream. This will give you the benefit of golang's static type system. If you can't know the contents of an Activity you can use metadata which is a map[string]string, encoding to json will move these values to the top-level. This means that keys which conflict with standard getstream keys will be overwritten. The benefit of this structure is that these key/value pairs will be exposed to getstream internals such as ranking,...

Design Choices :

• Flat / Aggregated / Notification Feeds have separate structures and methods to prevent the impact of future getstream changes. If two types of feeds grow farther apart this can be incorporated in this client without breaking everything.

Credits :

This pkg started out as a fork from https://github.com/hyperworks/go-getstream and still borrows snippets (token & errors) from the original. I decided to make this a separate repo entirely because drastic changes were made to the interface and internal workings.

We received great support from getstream while creating this pkg for which we are very grateful and we also want to thank them for creating getstream in the first place.