client

Documentation

Index

• Variables
• func MockTestHelper(t *testing.T, table *schema.Table, ...)
• func New(logger zerolog.Logger, spec Spec, hnClient *hackernews.Client, ...) (schema.ClientMeta, error)
• func UnixTimeResolver(fieldName string) schema.ColumnResolver
• type Backend
• type Client
  • func (*Client) ID() string
  • func (c *Client) Logger() *zerolog.Logger
  • func (c *Client) RetryOnError(ctx context.Context, tableName string, f func() error) error
• type NopBackend
  • func (*NopBackend) Close(ctx context.Context) error
  • func (*NopBackend) Get(ctx context.Context, table, clientID string) (string, error)
  • func (*NopBackend) Set(ctx context.Context, table, clientID, value string) error
• type Spec
  • func (s *Spec) SetDefaults()
  • func (s *Spec) Validate() error
• type TestOptions

Variables

var JSONSchema string

Functions

func MockTestHelper

func MockTestHelper(t *testing.T, table *schema.Table, builder func(*testing.T, *gomock.Controller) services.HackernewsClient, opts TestOptions)

func New

func New(logger zerolog.Logger, spec Spec, hnClient *hackernews.Client, backend state.Client) (schema.ClientMeta, error)

func UnixTimeResolver

func UnixTimeResolver(fieldName string) schema.ColumnResolver

Types

type Backend

type Backend struct {
	Table      string `json:"table"`
	Connection string `json:"connection"`
}

type Client

type Client struct {
	Spec       Spec
	HackerNews services.HackernewsClient
	Backend    state.Client
	// contains filtered or unexported fields
}

func (*Client) ID

func (*Client) ID() string

func (*Client) Logger

func (c *Client) Logger() *zerolog.Logger

func (*Client) RetryOnError

func (c *Client) RetryOnError(ctx context.Context, tableName string, f func() error) error

RetryOnError will run the given resolver function and retry on rate limit exceeded errors or other retryable errors (like internal server errors) after waiting some amount of time.

type NopBackend

type NopBackend struct{}

func (*NopBackend) Close

func (*NopBackend) Close(ctx context.Context) error

func (*NopBackend) Get

func (*NopBackend) Get(ctx context.Context, table, clientID string) (string, error)

func (*NopBackend) Set

func (*NopBackend) Set(ctx context.Context, table, clientID, value string) error

type Spec

type Spec struct {
	// The number of items to fetch concurrently
	ItemConcurrency int `json:"item_concurrency" jsonschema:"minimum=1,default=100"`
	// RFC3339 formatted timestamp. Syncing will begin with posts after this date. If not specified, the plugin will fetch all items.
	StartTime string `json:"start_time" jsonschema:"format=date-time"`
}

func (*Spec) SetDefaults

func (s *Spec) SetDefaults()

func (*Spec) Validate

func (s *Spec) Validate() error

type TestOptions

type TestOptions struct {
	StartTime time.Time
	Backend   state.Client
}