plugins

Documentation

Index

• func GetBuiltinOutputPlugins() map[string]model.OutputPlugin
• func GetOutputPlugin() (op model.OutputPlugin, err error)
• func GetPluginSpec() model.PluginSpec
• type Article
• type ArticleForm
• type ArticlesResponse
• type EmailOutputPlugin
  • func (p *EmailOutputPlugin) Build(def *model.OutputDef) (model.Output, error)
  • func (p *EmailOutputPlugin) Spec() model.Spec
• type EmailOutputProvider
  • func (op *EmailOutputProvider) GetDef() model.OutputDef
  • func (op *EmailOutputProvider) Send(article *model.Article) (bool, error)
• type HTTPOutputPlugin
  • func (p *HTTPOutputPlugin) Build(def *model.OutputDef) (model.Output, error)
  • func (p *HTTPOutputPlugin) Spec() model.Spec
• type HTTPOutputProvider
  • func (op *HTTPOutputProvider) GetDef() model.OutputDef
  • func (op *HTTPOutputProvider) Send(article *model.Article) (bool, error)
• type ReadflowOutputPlugin
  • func (p *ReadflowOutputPlugin) Build(def *model.OutputDef) (model.Output, error)
  • func (p *ReadflowOutputPlugin) Spec() model.Spec
• type ReadflowOutputProvider
  • func (op *ReadflowOutputProvider) GetDef() model.OutputDef
  • func (op *ReadflowOutputProvider) Send(article *model.Article) (bool, error)
• type StdOutputProvider
  • func (op *StdOutputProvider) GetDef() model.OutputDef
  • func (op *StdOutputProvider) Send(article *model.Article) (bool, error)
• type StdoutOutputPlugin
  • func (p *StdoutOutputPlugin) Build(def *model.OutputDef) (model.Output, error)
  • func (p *StdoutOutputPlugin) Spec() model.Spec

Functions

func GetBuiltinOutputPlugins

func GetBuiltinOutputPlugins() map[string]model.OutputPlugin

GetBuiltinOutputPlugins get builtin plugins list

func GetOutputPlugin

func GetOutputPlugin() (op model.OutputPlugin, err error)

GetOutputPlugin return output plugin instance

func GetPluginSpec

func GetPluginSpec() model.PluginSpec

GetPluginSpec return plugin informations

Types

type Article

type Article struct {
	ID        uint       `json:"id,omitempty"`
	Title     string     `json:"title,omitempty"`
	CreatedAt *time.Time `json:"created_at,omitempty"`
}

Article structure definition

type ArticleForm

type ArticleForm struct {
	Title       string     `json:"title,omitempty"`
	Text        *string    `json:"text,omitempty"`
	HTML        *string    `json:"html,omitempty"`
	URL         *string    `json:"url,omitempty"`
	Image       *string    `json:"image,omitempty"`
	PublishedAt *time.Time `json:"published_at,omitempty"`
	Tags        *string    `json:"tags,omitempty"`
}

ArticleForm is a Readflow article form structure

type ArticlesResponse

type ArticlesResponse struct {
	Articles []*Article
	Errors   []error
}

ArticlesResponse is the JSON response of readflow creation API

type EmailOutputPlugin

type EmailOutputPlugin struct{}

EmailOutputPlugin is the STDOUT output plugin

func (*EmailOutputPlugin) Build

func (p *EmailOutputPlugin) Build(def *model.OutputDef) (model.Output, error)

Build creates output provider instance

func (*EmailOutputPlugin) Spec

func (p *EmailOutputPlugin) Spec() model.Spec

Spec returns plugin spec

type EmailOutputProvider

type EmailOutputProvider struct {
	// contains filtered or unexported fields
}

EmailOutputProvider STDOUT output provider

func (*EmailOutputProvider) GetDef

func (op *EmailOutputProvider) GetDef() model.OutputDef

GetDef return output provider definition

func (*EmailOutputProvider) Send

func (op *EmailOutputProvider) Send(article *model.Article) (bool, error)

Send article to STDOUT.

type HTTPOutputPlugin

type HTTPOutputPlugin struct{}

HTTPOutputPlugin is the HTTP output plugin

func (*HTTPOutputPlugin) Build

func (p *HTTPOutputPlugin) Build(def *model.OutputDef) (model.Output, error)

Build creates output provider instance

func (*HTTPOutputPlugin) Spec

func (p *HTTPOutputPlugin) Spec() model.Spec

Spec returns plugin spec

type HTTPOutputProvider

type HTTPOutputProvider struct {
	// contains filtered or unexported fields
}

HTTPOutputProvider HTTP output provider

func (*HTTPOutputProvider) GetDef

func (op *HTTPOutputProvider) GetDef() model.OutputDef

GetDef return output provider definition

func (*HTTPOutputProvider) Send

func (op *HTTPOutputProvider) Send(article *model.Article) (bool, error)

Send article to HTTP endpoint.

type ReadflowOutputPlugin

type ReadflowOutputPlugin struct{}

ReadflowOutputPlugin is the Readflow output plugin

func (*ReadflowOutputPlugin) Build

func (p *ReadflowOutputPlugin) Build(def *model.OutputDef) (model.Output, error)

Build creates Readflow output provider instance

func (*ReadflowOutputPlugin) Spec

func (p *ReadflowOutputPlugin) Spec() model.Spec

Spec returns plugin spec

type ReadflowOutputProvider

type ReadflowOutputProvider struct {
	// contains filtered or unexported fields
}

ReadflowOutputProvider output provider to send articles to Readflow

func (*ReadflowOutputProvider) GetDef

func (op *ReadflowOutputProvider) GetDef() model.OutputDef

GetDef return output definition

func (*ReadflowOutputProvider) Send

func (op *ReadflowOutputProvider) Send(article *model.Article) (bool, error)

Send article to a Readflow instance.

type StdOutputProvider

type StdOutputProvider struct {
	// contains filtered or unexported fields
}

StdOutputProvider STDOUT output provider

func (*StdOutputProvider) GetDef

func (op *StdOutputProvider) GetDef() model.OutputDef

GetDef return output provider definition

func (*StdOutputProvider) Send

func (op *StdOutputProvider) Send(article *model.Article) (bool, error)

Send article to STDOUT.

type StdoutOutputPlugin

type StdoutOutputPlugin struct{}

StdoutOutputPlugin is the STDOUT output plugin

func (*StdoutOutputPlugin) Build

func (p *StdoutOutputPlugin) Build(def *model.OutputDef) (model.Output, error)

Build creates output provider instance

func (*StdoutOutputPlugin) Spec

func (p *StdoutOutputPlugin) Spec() model.Spec

Spec returns plugin spec