papernet

type ArxivResult struct {
	Papers     []*Paper
	Pagination Pagination
}

type ArxivSearch struct {
	Q          string
	IDs        []string
	Start      int
	MaxResults int
}

type ArxivSpider struct {
	Client *http.Client
}

type CleanFunc func(string) string

type EndPoint struct {
	// Name uniquely identifies the end point
	Name string

	// URL defines the url of the end point. It can contain parameters,
	// the form depending on the framework used for implementation
	URL string

	// Method of the endpoint. Typically GET, PUT, POST, DELETE, etc.
	Method string

	// Renderer defines the renderer used to marshal the first returned
	// value of the handler. Typically JSON, Text, etc.
	Renderer string

	// Authenticated should be set to true so the server activates
	// authentication for that route, i.e. loads the user that will
	// be available in the context.
	Authenticated bool

	// HandlerFunc is the function used to handle incoming requests on
	// that route.
	HandlerFunc HandlerFunc
}

type HandlerFunc func(*Request) (interface{}, error)

type Importer interface {
	Import(string) (*Paper, error)
}

type ImporterRegistry map[string]Importer

type MediumImporter struct {
}

type Pagination struct {
	Total  uint64 `json:"total"`
	Limit  uint64 `json:"limit"`
	Offset uint64 `json:"offset"`
}

type Paper struct {
	ID      int      `json:"id"`
	Title   string   `json:"title"`
	Summary string   `json:"summary"`
	Authors []string `json:"authors"`

	Tags       []string `json:"tags"`
	References []string `json:"references"`

	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`

	// External ids
	ArxivID string `json:"arxivId"`
}

type PaperIndex interface {
	Index(*Paper) error
	Search(PaperSearch) (PaperSearchResults, error)
	Delete(int) error
}

type PaperSearch struct {
	IDs []int  `json:"ids"`
	Q   string `json:"q"`

	Authors  []string `json:"authors"`
	Tags     []string `json:"tags"`
	ArxivIDs []string `json:"arxiv_ids"`

	Limit   uint64 `json:"limit"`
	Offset  uint64 `json:"offset"`
	OrderBy string `json:"orderBy"`
}

type PaperSearchFacets struct {
	Tags PaperSearchTagsFacet `json:"tags,omitempty"`
}

type PaperSearchResults struct {
	IDs        []int
	Facets     PaperSearchFacets
	Pagination Pagination
}

type PaperSearchTagsFacet []struct {
	Tag   string `json:"tag"`
	Count int    `json:"count"`
}

type PaperStore interface {
	Get(...int) ([]*Paper, error)
	List() ([]*Paper, error)
	Upsert(*Paper) error
	Delete(int) error
}

type PermissionManager interface {
	UserCanSee(string, int) (bool, error)
	UserCanEdit(string, int) (bool, error)

	AllowUserToSee(string, int) error
	AllowUserToEdit(string, int) error
}

type Request struct {
	*http.Request

	Params map[string]string
}

type Server interface {
	Register(EndPoint) error
	Start() error
}

type SigningKey struct {
	Key string `json:"k"`
}

type TagIndex interface {
	Index(string) error
	Search(string) ([]string, error)
}

type Team struct {
	ID   int    `json:"id"`
	Name string `json:"name"`

	Admins  []string `json:"admins"`
	Members []string `json:"members"`

	CanSee  []int `json:"canSee"`
	CanEdit []int `json:"canEdit"`
}

type TeamStore interface {
	Get(int) (Team, error)
	Upsert(*Team) error
	Delete(int) error

	List(userID string) ([]Team, error)
}

type User struct {
	ID    string `json:"id"`
	Name  string `json:"name"`
	Email string `json:"email"`

	Bookmarks []int `json:"bookmarks"`

	CanSee  []int `json:"canSee"`
	CanEdit []int `json:"canEdit"`
}

type UserStore interface {
	Get(string) (*User, error)
	Upsert(*User) error

	Search(email string) (*User, error)
}