newsteam

README

Newsteam SDK

The Newsteam SDK equips developers with a comprehensive toolkit designed to integrate seamlessly with the core Newsteam APIs, facilitating both the incorporation of Newsteam's native functionalities and the importation of content from external sources.

Wire Feeds Integration

Newsteam SDK empowers developers to integrate wire feeds from any source into the Newsteam platform. By leveraging the SDK, developers can create custom extensions that enable the seamless importation of wire feeds, enhancing the versatility and functionality of the Newsteam environment.

Implementation Guide

Configuring Wire Feeds in Newsteam Desk:

To initiate the process, configure your project within Newsteam to establish a connection to a wire feed:

1. Navigate to Newsteam Desk, select your project, and click on "Feed".

Establishing a New Go Module:

For the integration, you will need to establish a Go module:

1. Create an empty directory within your workspace on your local environment.
2. Initialize the Go module by executing go mod init app in your terminal.
3. Install the Newsteam SDK with the command go get github.com/feight/newsteam-sdk.

Next, implement an importer by defining the following methods:

• ProjectId() returning a string that identifies your project.
• GetLogfiles() which retrieves log files as slices of byte slices, with a potential error return.
• ProcessLogfile([]byte) that processes each log file into a slice of *admin.ArticleInput pointers.

Create a main.go file, and initialize the wire feeds by incorporating the following snippet:

newsteam.InitializeFeeds([]newsteam.Feed{
    &cosmos.CosmosImporter{
        Project: "bd", Host: "https://businesslive.co.za/apiv1",
    },
})

Documentation

Index

• func Deploy(s *Deployment)
• func InitializeFeeds(feeds []Feed)
• func UploadImage(reader func() io.ReadCloser) *admin.Image
• func UploadImageFromUrl(url string) *admin.Image
• func UploadImageFromUrl_BasicAuth(url, username, password string) *admin.Image
• type Deployment
• type Feed
• type WireService
  • func (s *WireService) GetLogfiles(ctx context.Context, r *buf.Request[v1.GetLogfilesRequest]) (*buf.Response[v1.GetLogfilesResponse], error)
  • func (s *WireService) ProcessLogfile(ctx context.Context, r *buf.Request[v1.ProcessLogfileRequest]) (*buf.Response[v1.ProcessLogfileResponse], error)

Functions

func Deploy

func Deploy(s *Deployment)

func InitializeFeeds

func InitializeFeeds(feeds []Feed)

func UploadImage

func UploadImage(reader func() io.ReadCloser) *admin.Image

* UploadImage

func UploadImageFromUrl

func UploadImageFromUrl(url string) *admin.Image

* UploadImageFromUrl

func UploadImageFromUrl_BasicAuth

func UploadImageFromUrl_BasicAuth(url, username, password string) *admin.Image

* UploadImageFromUrl_BasicAuth

Types

type Deployment

type Deployment struct {
	Name           string
	ProjectId      string
	Path           string
	DockerfilePath string
	Environment    []string
}

type Feed

type Feed interface {
	ProjectId() string
	GetLogfiles(state *admin.Cursor) ([][]byte, error)
	ProcessLogfile(*admin.Project, []byte) []*admin.ArticleInput
}

type WireService

type WireService struct{}

func (*WireService) GetLogfiles

func (s *WireService) GetLogfiles(ctx context.Context, r *buf.Request[v1.GetLogfilesRequest]) (*buf.Response[v1.GetLogfilesResponse], error)

func (*WireService) ProcessLogfile

func (s *WireService) ProcessLogfile(ctx context.Context, r *buf.Request[v1.ProcessLogfileRequest]) (*buf.Response[v1.ProcessLogfileResponse], error)