nopaste

README

nopaste

nopaste http server & IRC agent.

Install

$ go get github.com/kayac/nopaste/cmd/nopaste

Usage

$ nopaste -config config.yaml

nopaste will rewrite the config.yaml(irc.channels section) when join to a new IRC channel.

Configuration

base_url: http://example.com  # for IRC messages
listen: "localhost:3000"
data_dir: data
irc:
  host: localhost
  port: 6666
  secure: false
  password: secret
  nick: npbot
slack:
  webhook_url: https://hooks.slack.com/services/XXX/YYY/zzzz
channels:
- '#general'
- '#infra'

nopaste runs http server on http://#{listen}/np.

Amazon SNS http endpoint

nopaste can accept Amazon SNS notification messages.

Set environment variables.

• AWS_ACCESS_KEY_ID=XXXXXXXXXX
• AWS_SECRET_ACCESS_KEY=yyyyyyyyyyy

Add a SNS topic http(s) endpoint to http://example.com/np/amazon-sns/{channel_name}?key={message key}.

LICENCE

The MIT License (MIT)

Documentation

Index

• Constants
• Variables
• func NewSNS(ctx context.Context, region string) (*sns.Client, error)
• func Run(ctx context.Context, configFile string) error
• func RunIRCAgent(c *Config, ch chan IRCMessage)
• func RunMsgr(ctx context.Context, configFile string) error
• func RunSlackAgent(c *Config, ch chan SlackMessage)
• type Config
  • func LoadConfig(ctx context.Context, file string) (*Config, error)
  • func (c *Config) AddChannel(channel string)
  • func (c *Config) Save() error
  • func (c *Config) SetFilePath(path string)
  • func (c *Config) Storages() []Storage
• type HttpNotification
• type IRCConfig
• type IRCMessage
• type IRCMessageChan
  • func (ch IRCMessageChan) PostMsgr(req *http.Request)
  • func (ch IRCMessageChan) PostNopaste(np nopasteContent, url string)
• type LocalStorage
  • func NewLocalStorage(datadir string) *LocalStorage
  • func (s *LocalStorage) Load(_ context.Context, name string) (io.ReadCloser, error)
  • func (s *LocalStorage) Save(_ context.Context, name string, data []byte) error
• type MessageChan
• type S3Config
• type S3Storage
  • func NewS3Storage(ctx context.Context, c *S3Config) (*S3Storage, error)
  • func (s *S3Storage) Load(ctx context.Context, name string) (io.ReadCloser, error)
  • func (s *S3Storage) Save(ctx context.Context, name string, b []byte) error
• type SlackAgent
  • func (a *SlackAgent) Post(m SlackMessage) error
• type SlackConfig
• type SlackMessage
• type SlackMessageChan
  • func (ch SlackMessageChan) PostMsgr(req *http.Request)
  • func (ch SlackMessageChan) PostNopaste(np nopasteContent, url string)
• type Storage

Constants

const (
	MsgBufferLen = 100
)

const MsgrRoot = "/irc-msgr"

const Root = "/np"

const SlackMaxBackOff = 3600

Variables

var (
	SlackThrottleWindow = 1 * time.Second
	SlackInitialBackOff = 30
	Epoch               = time.Unix(0, 0)
)

var Debug = false

var (
	IRCThrottleWindow = 1 * time.Second
)

Functions

func NewSNS

func NewSNS(ctx context.Context, region string) (*sns.Client, error)

func Run

func Run(ctx context.Context, configFile string) error

func RunIRCAgent

func RunIRCAgent(c *Config, ch chan IRCMessage)

func RunMsgr

func RunMsgr(ctx context.Context, configFile string) error

func RunSlackAgent

func RunSlackAgent(c *Config, ch chan SlackMessage)

Types

type Config

type Config struct {
	BaseURL string       `yaml:"base_url"`
	Listen  string       `yaml:"listen"`
	DataDir string       `yaml:"data_dir"`
	S3      *S3Config    `yaml:"s3"`
	IRC     *IRCConfig   `yaml:"irc"`
	Slack   *SlackConfig `yaml:"slack"`

	Channels []string `yaml:"channels"`
	// contains filtered or unexported fields
}

func LoadConfig

func LoadConfig(ctx context.Context, file string) (*Config, error)

func (*Config) AddChannel

func (c *Config) AddChannel(channel string)

func (*Config) Save

func (c *Config) Save() error

func (*Config) SetFilePath

func (c *Config) SetFilePath(path string)

func (*Config) Storages

func (c *Config) Storages() []Storage

type HttpNotification

type HttpNotification struct {
	Type             string    `json:"Type"`
	MessageId        string    `json:"MessageId"`
	Token            string    `json:"Token"` // Only for subscribe and unsubscribe
	TopicArn         string    `json:"TopicArn"`
	Subject          string    `json:"Subject"` // Only for Notification
	Message          string    `json:"Message"`
	SubscribeURL     string    `json:"SubscribeURL"` // Only for subscribe and unsubscribe
	Timestamp        time.Time `json:"Timestamp"`
	SignatureVersion string    `json:"SignatureVersion"`
	Signature        string    `json:"Signature"`
	SigningCertURL   string    `json:"SigningCertURL"`
	UnsubscribeURL   string    `json:"UnsubscribeURL"` // Only for notifications
}

https://docs.aws.amazon.com/sns/latest/dg/json-formats.html

type IRCConfig

type IRCConfig struct {
	Host     string `yaml:"host"`
	Port     int    `yaml:"port"`
	Secure   bool   `yaml:"secure"`
	Debug    bool   `yaml:"debug"`
	Password string `yaml:"password"`
	Nick     string `yaml:"nick"`
}

type IRCMessage

type IRCMessage struct {
	Channel string
	Notice  bool
	Text    string
}

type IRCMessageChan

type IRCMessageChan chan IRCMessage

func (IRCMessageChan) PostMsgr

func (ch IRCMessageChan) PostMsgr(req *http.Request)

func (IRCMessageChan) PostNopaste

func (ch IRCMessageChan) PostNopaste(np nopasteContent, url string)

type LocalStorage

type LocalStorage struct {
	DataDir string
}

func NewLocalStorage

func NewLocalStorage(datadir string) *LocalStorage

func (*LocalStorage) Load

func (s *LocalStorage) Load(_ context.Context, name string) (io.ReadCloser, error)

func (*LocalStorage) Save

func (s *LocalStorage) Save(_ context.Context, name string, data []byte) error

type MessageChan

type MessageChan interface {
	PostNopaste(np nopasteContent, url string)
	PostMsgr(np *http.Request)
}

type S3Config

type S3Config struct {
	Bucket    string `yaml:"bucket"`
	KeyPrefix string `yaml:"key_prefix"`
}

type S3Storage

type S3Storage struct {
	Bucket    string
	KeyPrefix string
	// contains filtered or unexported fields
}

func NewS3Storage

func NewS3Storage(ctx context.Context, c *S3Config) (*S3Storage, error)

func (*S3Storage) Load

func (s *S3Storage) Load(ctx context.Context, name string) (io.ReadCloser, error)

func (*S3Storage) Save

func (s *S3Storage) Save(ctx context.Context, name string, b []byte) error

type SlackAgent

type SlackAgent struct {
	WebhookURL string
	// contains filtered or unexported fields
}

func (*SlackAgent) Post

func (a *SlackAgent) Post(m SlackMessage) error

type SlackConfig

type SlackConfig struct {
	WebhookURL string `yaml:"webhook_url"`
}

type SlackMessage

type SlackMessage struct {
	Channel   string `json:"channel"`
	Text      string `json:"text"`
	IconEmoji string `json:"icon_emoji,omitempty"`
	IconURL   string `json:"icon_url,omitempty"`
	Username  string `json:"username"`
	LinkNames int    `json:"link_names,omitempty"`
}

type SlackMessageChan

type SlackMessageChan chan SlackMessage

func (SlackMessageChan) PostMsgr

func (ch SlackMessageChan) PostMsgr(req *http.Request)

func (SlackMessageChan) PostNopaste

func (ch SlackMessageChan) PostNopaste(np nopasteContent, url string)

type Storage

type Storage interface {
	Save(context.Context, string, []byte) error
	Load(context.Context, string) (io.ReadCloser, error)
}