sn

README

sn-goapi

Package for stacker.news API access

Install via go get github.com/ekzyis/sn-goapi

Supports:

• Post of type ...
  • ... Discussion
  • ... Link
  • ... Bounty
  • ... Poll
• Reply (comments)
• Tips
• Checking dupes
• Checking notifications

SN_AUTH_COOKIE must be set with a valid session cookie.

Documentation

Overview

Package for stacker.news API access

Index

• Variables
• func CheckForErrors(graphqlErrors []GraphQLError) error
• func CheckNotifications() (bool, error)
• func CreateComment(parentId int, text string) (int, error)
• func Dupes(url string) (*[]Dupe, error)
• func FormatLink(id int) string
• func MakeStackerNewsRequest(body GraphQLPayload) (*http.Response, error)
• func PostLink(url string, title string, sub string) (int, error)
• func RefreshSession() error
• type Comment
• type CreateCommentsResponse
• type Dupe
• type DupesError
  • func (e *DupesError) Error() string
• type DupesResponse
• type GraphQLError
• type GraphQLPayload
• type HasNewNotesResponse
• type Item
• type ItemsCursor
  • func Items(query *ItemsQuery) (*ItemsCursor, error)
• type ItemsQuery
• type ItemsResponse
• type Rss
  • func RssFeed() (*Rss, error)
• type RssAuthor
• type RssChannel
• type RssDate
  • func (c *RssDate) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
• type RssItem
• type UpsertLinkResponse
• type User

Variables

var (
	// stacker.news URL
	SnUrl = "https://stacker.news"
	// stacker.news API URL
	SnApiUrl = "https://stacker.news/api/graphql"
	// stacker.news session cookie
	SnAuthCookie string
)

var (
	StackerNewsRssFeedUrl = "https://stacker.news/rss"
)

Functions

func CheckForErrors

func CheckForErrors(graphqlErrors []GraphQLError) error

Returns error if any error was found

func CheckNotifications

func CheckNotifications() (bool, error)

Check for new notifications

func CreateComment

func CreateComment(parentId int, text string) (int, error)

Create a new comment

func Dupes

func Dupes(url string) (*[]Dupe, error)

Fetch dupes

func FormatLink

func FormatLink(id int) string

Format item id as link

func MakeStackerNewsRequest

func MakeStackerNewsRequest(body GraphQLPayload) (*http.Response, error)

Make GraphQL request using raw payload

func PostLink

func PostLink(url string, title string, sub string) (int, error)

Create a new LINK post

func RefreshSession

func RefreshSession() error

Types

type Comment

type Comment struct {
	Id        int       `json:"id,string"`
	ParentId  int       `json:"parentId,string"`
	CreatedAt time.Time `json:"createdAt"`
	Text      string    `json:"text"`
	User      User      `json:"user"`
	Comments  []Comment `json:"comments"`
}

type CreateCommentsResponse

type CreateCommentsResponse struct {
	Errors []GraphQLError `json:"errors"`
	Data   struct {
		CreateComment Comment `json:"createComment"`
	} `json:"data"`
}

type Dupe

type Dupe struct {
	Id        int       `json:"id,string"`
	Url       string    `json:"url"`
	Title     string    `json:"title"`
	User      User      `json:"user"`
	CreatedAt time.Time `json:"createdAt"`
	Sats      int       `json:"sats"`
	NComments int       `json:"ncomments"`
}

type DupesError

type DupesError struct {
	Url   string
	Dupes []Dupe
}

func (*DupesError) Error

func (e *DupesError) Error() string

type DupesResponse

type DupesResponse struct {
	Errors []GraphQLError `json:"errors"`
	Data   struct {
		Dupes []Dupe `json:"dupes"`
	} `json:"data"`
}

type GraphQLError

type GraphQLError struct {
	Message string `json:"message"`
}

type GraphQLPayload

type GraphQLPayload struct {
	Query     string                 `json:"query"`
	Variables map[string]interface{} `json:"variables,omitempty"`
}

type HasNewNotesResponse

type HasNewNotesResponse struct {
	Errors []GraphQLError `json:"errors"`
	Data   struct {
		HasNewNotes bool `json:"hasNewNotes"`
	} `json:"data"`
}

type Item

type Item struct {
	Id        int       `json:"id,string"`
	ParentId  int       `json:"parentId,string"`
	Title     string    `json:"title"`
	Url       string    `json:"url"`
	Sats      int       `json:"sats"`
	CreatedAt time.Time `json:"createdAt"`
	Comments  []Comment `json:"comments"`
	NComments int       `json:"ncomments"`
	User      User      `json:"user"`
}

type ItemsCursor

type ItemsCursor struct {
	Items  []Item `json:"items"`
	Cursor string `json:"cursor"`
}

func Items

func Items(query *ItemsQuery) (*ItemsCursor, error)

type ItemsQuery

type ItemsQuery struct {
	Sub    string
	Sort   string
	Type   string
	Cursor string
	Name   string
	When   string
	By     string
	Limit  int
}

type ItemsResponse

type ItemsResponse struct {
	Errors []GraphQLError `json:"errors"`
	Data   struct {
		Items ItemsCursor `json:"items"`
	} `json:"data"`
}

type Rss

type Rss struct {
	Channel RssChannel `xml:"channel"`
}

func RssFeed

func RssFeed() (*Rss, error)

Fetch RSS feed

type RssAuthor

type RssAuthor struct {
	Name string `xml:"name"`
}

type RssChannel

type RssChannel struct {
	Title         string    `xml:"title"`
	Description   string    `xml:"description"`
	Link          string    `xml:"link"`
	Items         []RssItem `xml:"item"`
	LastBuildDate RssDate   `xml:"lastBuildDate"`
}

type RssDate

type RssDate struct {
	time.Time
}

func (*RssDate) UnmarshalXML

func (c *RssDate) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type RssItem

type RssItem struct {
	Guid        string    `xml:"guid"`
	Title       string    `xml:"title"`
	Link        string    `xml:"link"`
	Description string    `xml:"description"`
	PubDate     RssDate   `xml:"pubDate"`
	Author      RssAuthor `xml:"author"`
}

type UpsertLinkResponse

type UpsertLinkResponse struct {
	Errors []GraphQLError `json:"errors"`
	Data   struct {
		UpsertLink Item `json:"upsertLink"`
	} `json:"data"`
}

type User

type User struct {
	Id   int    `json:"id,string"`
	Name string `json:"name"`
}