fix: stablelise the repo

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-pellared@hotmail.com.
+tom@moulard.org.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

FUNDING.yml

@@ -0,0 +1,2 @@
+github: [tommoulard]
+custom: ["https://www.paypal.me/tommoulard"]

README.md

@@ -8,10 +8,63 @@
 [![Build Status](https://img.shields.io/github/actions/workflow/status/tomMoulard/sendbird-go/build.yml?branch=main)](https://github.com/tomMoulard/sendbird-go/actions?query=workflow%3Abuild+branch%3Amain)
 [![Go Report Card](https://goreportcard.com/badge/github.com/tomMoulard/sendbird-go)](https://goreportcard.com/report/github.com/tomMoulard/sendbird-go)
 
+Yet another go client for the [Sendbird](https://sendbird.com) chat API.
+
 ⭐ `Star` this repository if you find it valuable and worth maintaining.
 
 👁 `Watch` this repository to get notified about new releases, issues, etc.
 
+## User Guide
+
+### Installation
+
+```bash
+go get github.com/tomMoulard/sendbird-go
+```
+
+### Usage
+
+```go
+package main
+
+import (
+ "context"
+ "fmt"
+ "log"
+ "os"
+
+ "github.com/tomMoulard/sendbird-go/pkg/client"
+ "github.com/tomMoulard/sendbird-go/pkg/user"
+)
+
+func main() {
+ opts := []client.Option{
+ client.WithAPPID(os.Getenv("SENDBIRD_APP_ID")),
+ client.WithAPIKey(os.Getenv("SENDBIRD_API_KEY")),
+ }
+ client := client.NewClient(opts...)
+
+ // To create a user
+ userClient := user.NewUser(client)
+
+ u := user.CreateUserRequest{
+ UserID: "user-id",
+ Nickname: "nickname",
+ }
+ createdUser, err := userClient.Create(context.Background(), u)
+ if err != nil {
+ if errors.Is(err, client.ErrTooManyRequests) {
+ log.Fatalf("rate limit exceeded: %v", err)
+ return
+ }
+ log.Fatalf("failed to create user: %v", err)
+ }
+ fmt.Printf("created user: %v\n", createdUser)
+}
+```
+
+See available methods in the corresponding package documentation.
+
 ## Build
 
 ### Terminal

SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported |
+| ------- | ------------------ |
+| 0.0.x | :white_check_mark: |
+
+<!-- ## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.
+-->

TODO.md

@@ -0,0 +1,14 @@
+# API
+- [X] channel
+ - [X] CreateGroupChannel
+ - [X] UpdateGroupChannel
+ - [ ] GetGroupChannels -> ListGroupChannels
+- [X] message
+ - [X] SendMessage
+ - [X] GetMessages -> ListMessages
+- [X] user
+ - [X] CreateUser
+ - [X] UpdateUser
+ - [X] GetSessionToken
+ - [X] GetUserUnreadMessages
+ - [X] GetUserJoinedChannelCount

pkg/channel/channel.go

@@ -1,3 +1,6 @@
+// Package channel package provides the interface for the channel service.
+// It provides the methods to interact with the sendbird API.
+// See https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview.
 package channel
 
 import (

pkg/channel/list.go

@@ -6,7 +6,7 @@ import (
  "net/url"
  "strconv"
 
- "github.com/tomMoulard/sendbird-go/pkg/utils/strings"
+ strconvStlice "github.com/tomMoulard/sendbird-go/pkg/utils/strconv"
 )
 
 // https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/list-group-channels
@@ -311,7 +311,7 @@ func ListChannelRequestToMap(lcr ListChannelRequest) map[string]string {
  }
 
  if len(lcr.ChannelURLs) > 0 {
- m["channel_urls"] = strings.SliceToCSV(lcr.ChannelURLs)
+ m["channel_urls"] = strconvStlice.FormatSliceToCSV(lcr.ChannelURLs)
  }
 
  if lcr.Name != "" {
@@ -351,7 +351,7 @@ func ListChannelRequestToMap(lcr ListChannelRequest) map[string]string {
  }
 
  if len(lcr.MetadataValues) > 0 {
- m["metadata_values"] = strings.SliceToCSV(lcr.MetadataValues)
+ m["metadata_values"] = strconvStlice.FormatSliceToCSV(lcr.MetadataValues)
  }
 
  if lcr.MetadataValueStartswith != "" {
@@ -363,7 +363,7 @@ func ListChannelRequestToMap(lcr ListChannelRequest) map[string]string {
  }
 
  if len(lcr.MetacounterValues) > 0 {
- m["metacounter_values"] = strings.SliceToCSV(lcr.MetacounterValues)
+ m["metacounter_values"] = strconvStlice.FormatSliceToCSV(lcr.MetacounterValues)
  }
 
  if lcr.MetacounterValuesGT != "" {

pkg/client/client.go

@@ -1,4 +1,5 @@
-// This package is for the client of the sendbird API
+// Package client package provides the interface for the client of the sendbird
+// API. It provides the methods to call the sendbird API.
 package client
 
 import (

pkg/client/config.go

@@ -102,3 +102,12 @@ func WithAPIToken(apiToken string) Option {
  return client
  }
 }
+
+// WithAPPID is the option for the app id of the client.
+func WithAPPID(appID string) Option {
+ return func(client *client) *client {
+ client.baseURL.Host = fmt.Sprintf("api-%s.sendbird.com", appID)
+
+ return client
+ }
+}

pkg/client/config_test.go

@@ -96,3 +96,13 @@ func TestWithAPIToken(t *testing.T) {
  assert.Equal(t, "api-token", client.header.Get("api-token"))
  assert.Len(t, client.header, 2)
 }
+
+func TestWithAPPID(t *testing.T) {
+ t.Parallel()
+
+ client := &client{}
+ client.SetDefault()
+
+ client = WithAPPID("api-id")(client)
+ assert.Equal(t, "api-api-id.sendbird.com", client.baseURL.Host)
+}

pkg/message/list_messages.go

@@ -6,7 +6,7 @@ import (
  "net/url"
  "strconv"
 
- "github.com/tomMoulard/sendbird-go/pkg/utils/strings"
+ strconvSlice "github.com/tomMoulard/sendbird-go/pkg/utils/strconv"
 )
 
 // https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/list-messages
@@ -157,7 +157,7 @@ func listMessagesRequestToMap(lmr ListMessagesRequest) map[string]string {
  }
 
  if len(lmr.SenderIDs) > 0 {
- m["sender_ids"] = strings.SliceToCSV(lmr.SenderIDs)
+ m["sender_ids"] = strconvSlice.FormatSliceToCSV(lmr.SenderIDs)
  }
 
  if lmr.OperatorFilter != "" {

pkg/message/message.go

@@ -1,3 +1,6 @@
+// Package message package provides the interface for the message service.
+// It provides the methods to interact with the sendbird API.
+// See https://sendbird.com/docs/chat/platform-api/v3/message/message-overview.
 package message
 
 import (

pkg/user/user.go

@@ -1,3 +1,6 @@
+// Package user package provides the interface for the user service.
+// It provides the methods to interact with the sendbird API.
+// See https://sendbird.com/docs/chat/platform-api/v3/user/user-overview.
 package user
 
 import (

pkg/utils/strconv/slice.go

@@ -0,0 +1,18 @@
+// Package strconv formats primitive types to strings.
+package strconv
+
+// FormatSliceToCSV converts a slice of strings to a Comma Separated Values
+// string.
+func FormatSliceToCSV(s []string) string {
+ var csvString string
+
+ for i, v := range s {
+ if i > 0 {
+ csvString += ","
+ }
+
+ csvString += v
+ }
+
+ return csvString
+}

pkg/utils/strings/slice_test.go → pkg/utils/strconv/slice_test.go

@@ -1,4 +1,4 @@
-package strings
+package strconv
 
 import (
  "fmt"
@@ -7,14 +7,14 @@ import (
  "github.com/stretchr/testify/assert"
 )
 
-func ExampleSliceToCSV() {
+func ExampleFormatSliceToCSV() {
  s := []string{"foo", "bar", "baz"}
- csv := SliceToCSV(s)
+ csv := FormatSliceToCSV(s)
  fmt.Println(csv)
  // Output: foo,bar,baz
 }
 
-func TestSliceToCSVStrings(t *testing.T) {
+func TestFormatSliceToCSV(t *testing.T) {
  t.Parallel()
 
  tests := []struct {
@@ -43,7 +43,7 @@ func TestSliceToCSVStrings(t *testing.T) {
  t.Run(test.name, func(t *testing.T) {
  t.Parallel()
 
- actual := SliceToCSV(test.s)
+ actual := FormatSliceToCSV(test.s)
  assert.Equal(t, test.expected, actual)
  })
  }