🎨 Move all package types to method files by context
Page structure to CreatePage method, Account to CreateAccont and etc.
This commit is contained in:
parent
30db9dbebf
commit
21c48af1de
25
content.go
25
content.go
|
@ -8,8 +8,29 @@ import (
|
|||
"golang.org/x/net/html"
|
||||
)
|
||||
|
||||
// ContentFormat transforms data to a DOM-based format to represent the
|
||||
// content of the page.
|
||||
type (
|
||||
// Node is abstract object represents a DOM Node. It can be a String which represents a DOM text
|
||||
// node or a NodeElement object.
|
||||
Node interface{}
|
||||
|
||||
// NodeElement represents a DOM element node.
|
||||
NodeElement struct {
|
||||
// Name of the DOM element.
|
||||
// Available tags: a, aside, b, blockquote, br, code, em, figcaption, figure, h3, h4, hr, i,
|
||||
// iframe, img, li, ol, p, pre, s, strong, u, ul, video.
|
||||
Tag string `json:"tag"`
|
||||
|
||||
// Attributes of the DOM element. Key of object represents name of attribute, value
|
||||
// represents value of attribute.
|
||||
// Available attributes: href, src.
|
||||
Attrs map[string]string `json:"attrs,omitempty"` // optional
|
||||
|
||||
// List of child nodes for the DOM element.
|
||||
Children []Node `json:"children,omitempty"` // optional
|
||||
}
|
||||
)
|
||||
|
||||
// ContentFormat transforms data to a DOM-based format to represent the content of the page.
|
||||
func ContentFormat(data interface{}) ([]Node, error) {
|
||||
var doc html.Node
|
||||
switch dst := data.(type) {
|
||||
|
|
|
@ -7,11 +7,36 @@ import (
|
|||
http "github.com/valyala/fasthttp"
|
||||
)
|
||||
|
||||
// CreateAccount create a new Telegraph account. Most users only need one
|
||||
// account, but this can be useful for channel administrators who would like
|
||||
// to keep individual author names and profile links for each of their
|
||||
// channels. On success, returns an Account object with the regular fields and
|
||||
// an additional access_token field.
|
||||
// Account represents a Telegraph account.
|
||||
type Account struct {
|
||||
// Only returned by the createAccount and revokeAccessToken method. Access token of the Telegraph
|
||||
// account.
|
||||
AccessToken string `json:"access_token"` // optional
|
||||
|
||||
// URL to authorize a browser on telegra.ph and connect it to a Telegraph account. This URL is
|
||||
// valid for only one use and for 5 minutes only.
|
||||
AuthURL string `json:"auth_url,omitempty"` // optional
|
||||
|
||||
// Account name, helps users with several accounts remember which they are currently using.
|
||||
// Displayed to the user above the "Edit/Publish" button on Telegra.ph, other users don't see
|
||||
// this name.
|
||||
ShortName string `json:"short_name"`
|
||||
|
||||
// Default author name used when creating new articles.
|
||||
AuthorName string `json:"author_name"`
|
||||
|
||||
// Profile link, opened when users click on the author's name below the title. Can be any link,
|
||||
// not necessarily to a Telegram profile or channel.
|
||||
AuthorURL string `json:"author_url"`
|
||||
|
||||
// Number of pages belonging to the Telegraph account.
|
||||
PageCount int `json:"page_count,omitempty"` // optional
|
||||
}
|
||||
|
||||
// CreateAccount create a new Telegraph account. Most users only need one account, but this can be
|
||||
// useful for channel administrators who would like to keep individual author names and profile links
|
||||
// for each of their channels. On success, returns an Account object with the regular fields and an
|
||||
// additional access_token field.
|
||||
func CreateAccount(account *Account) (*Account, error) {
|
||||
var args http.Args
|
||||
|
||||
|
|
|
@ -8,6 +8,40 @@ import (
|
|||
http "github.com/valyala/fasthttp"
|
||||
)
|
||||
|
||||
// Page represents a page on Telegraph.
|
||||
type Page struct {
|
||||
// Path to the page.
|
||||
Path string `json:"path"`
|
||||
|
||||
// URL of the page.
|
||||
URL string `json:"url"`
|
||||
|
||||
// Title of the page.
|
||||
Title string `json:"title"`
|
||||
|
||||
// Description of the page.
|
||||
Description string `json:"description"`
|
||||
|
||||
// Name of the author, displayed below the title.
|
||||
AuthorName string `json:"author_name,omitempty"` // optional
|
||||
|
||||
// Profile link, opened when users click on the author's name below the title. Can be any link,
|
||||
// not necessarily to a Telegram profile or channel.
|
||||
AuthorURL string `json:"author_url,omitempty"` // optional
|
||||
|
||||
// Image URL of the page.
|
||||
ImageURL string `json:"image_url,omitempty"` // optional
|
||||
|
||||
// Content of the page.
|
||||
Content []Node `json:"content,omitempty"` // optional
|
||||
|
||||
// Number of page views for the page.
|
||||
Views int `json:"views"`
|
||||
|
||||
// Only returned if access_token passed. True, if the target Telegraph account can edit the page.
|
||||
CanEdit bool `json:"can_edit,omitempty"` // optional
|
||||
}
|
||||
|
||||
// CreatePage create a new Telegraph page. On success, returns a Page object.
|
||||
func (account *Account) CreatePage(page *Page, returnContent bool) (*Page, error) {
|
||||
var args http.Args
|
||||
|
|
|
@ -8,8 +8,18 @@ import (
|
|||
http "github.com/valyala/fasthttp"
|
||||
)
|
||||
|
||||
// GetPageList get a list of pages belonging to a Telegraph account. Returns
|
||||
// a PageList object, sorted by most recently created pages first.
|
||||
// PageList represents a list of Telegraph articles belonging to an account. Most recently created
|
||||
// articles first.
|
||||
type PageList struct {
|
||||
// Total number of pages belonging to the target Telegraph account.
|
||||
TotalCount int `json:"total_count"`
|
||||
|
||||
// Requested pages of the target Telegraph account.
|
||||
Pages []*Page `json:"pages"`
|
||||
}
|
||||
|
||||
// GetPageList get a list of pages belonging to a Telegraph account. Returns a PageList object, sorted
|
||||
// by most recently created pages first.
|
||||
func (account *Account) GetPageList(offset, limit int) (*PageList, error) {
|
||||
var args http.Args
|
||||
|
||||
|
|
11
get_views.go
11
get_views.go
|
@ -8,9 +8,14 @@ import (
|
|||
http "github.com/valyala/fasthttp"
|
||||
)
|
||||
|
||||
// GetViews get the number of views for a Telegraph article. By default, the
|
||||
// total number of page views will be returned. Returns a PageViews object
|
||||
// on success.
|
||||
// PageViews represents the number of page views for a Telegraph article.
|
||||
type PageViews struct {
|
||||
// Number of page views for the target page.
|
||||
Views int `json:"views"`
|
||||
}
|
||||
|
||||
// GetViews get the number of views for a Telegraph article. By default, the total number of page
|
||||
// views will be returned. Returns a PageViews object on success.
|
||||
func GetViews(path string, hour, day, month, year int) (*PageViews, error) {
|
||||
var args http.Args
|
||||
|
||||
|
|
116
types.go
116
types.go
|
@ -1,116 +0,0 @@
|
|||
package telegraph
|
||||
|
||||
import "encoding/json"
|
||||
|
||||
type (
|
||||
// Account represents a Telegraph account.
|
||||
Account struct {
|
||||
// Only returned by the createAccount and revokeAccessToken method.
|
||||
// Access token of the Telegraph account.
|
||||
AccessToken string `json:"access_token"` // optional
|
||||
|
||||
// URL to authorize a browser on telegra.ph and connect it to a
|
||||
// Telegraph account. This URL is valid for only one use and for 5
|
||||
// minutes only.
|
||||
AuthURL string `json:"auth_url,omitempty"` // optional
|
||||
|
||||
// Account name, helps users with several accounts remember which they
|
||||
// are currently using. Displayed to the user above the "Edit/Publish"
|
||||
// button on Telegra.ph, other users don't see this name.
|
||||
ShortName string `json:"short_name"`
|
||||
|
||||
// Default author name used when creating new articles.
|
||||
AuthorName string `json:"author_name"`
|
||||
|
||||
// Profile link, opened when users click on the author's name below the
|
||||
// title. Can be any link, not necessarily to a Telegram profile or
|
||||
// channel.
|
||||
AuthorURL string `json:"author_url"`
|
||||
|
||||
// Number of pages belonging to the Telegraph account.
|
||||
PageCount int `json:"page_count,omitempty"` // optional
|
||||
}
|
||||
|
||||
// PageList represents a list of Telegraph articles belonging to an
|
||||
// account. Most recently created articles first.
|
||||
PageList struct {
|
||||
// Total number of pages belonging to the target Telegraph account.
|
||||
TotalCount int `json:"total_count"`
|
||||
|
||||
// Requested pages of the target Telegraph account.
|
||||
Pages []*Page `json:"pages"`
|
||||
}
|
||||
|
||||
// Page represents a page on Telegraph.
|
||||
Page struct {
|
||||
// Path to the page.
|
||||
Path string `json:"path"`
|
||||
|
||||
// URL of the page.
|
||||
URL string `json:"url"`
|
||||
|
||||
// Title of the page.
|
||||
Title string `json:"title"`
|
||||
|
||||
// Description of the page.
|
||||
Description string `json:"description"`
|
||||
|
||||
// Name of the author, displayed below the title.
|
||||
AuthorName string `json:"author_name,omitempty"` // optional
|
||||
|
||||
// Profile link, opened when users click on the author's name below
|
||||
// the title. Can be any link, not necessarily to a Telegram profile
|
||||
// or channel.
|
||||
AuthorURL string `json:"author_url,omitempty"` // optional
|
||||
|
||||
// Image URL of the page.
|
||||
ImageURL string `json:"image_url,omitempty"` // optional
|
||||
|
||||
// Content of the page.
|
||||
Content []Node `json:"content,omitempty"` // optional
|
||||
|
||||
// Number of page views for the page.
|
||||
Views int `json:"views"`
|
||||
|
||||
// Only returned if access_token passed. True, if the target Telegraph
|
||||
// account can edit the page.
|
||||
CanEdit bool `json:"can_edit,omitempty"` // optional
|
||||
}
|
||||
|
||||
// PageViews represents the number of page views for a Telegraph article.
|
||||
PageViews struct {
|
||||
// Number of page views for the target page.
|
||||
Views int `json:"views"`
|
||||
}
|
||||
|
||||
// Node is abstract object represents a DOM Node. It can be a String which
|
||||
// represents a DOM text node or a NodeElement object.
|
||||
Node interface{}
|
||||
|
||||
// NodeElement represents a DOM element node.
|
||||
NodeElement struct {
|
||||
// Name of the DOM element. Available tags: a, aside, b, blockquote,
|
||||
// br, code, em, figcaption, figure, h3, h4, hr, i, iframe, img, li,
|
||||
// ol, p, pre, s, strong, u, ul, video.
|
||||
Tag string `json:"tag"`
|
||||
|
||||
// Attributes of the DOM element. Key of object represents name of
|
||||
// attribute, value represents value of attribute. Available
|
||||
// attributes: href, src.
|
||||
Attrs map[string]string `json:"attrs,omitempty"` // optional
|
||||
|
||||
// List of child nodes for the DOM element.
|
||||
Children []Node `json:"children,omitempty"` // optional
|
||||
}
|
||||
|
||||
// Response represents a response from the Telegram API with the result
|
||||
// stored raw. If ok equals true, the request was successful, and the
|
||||
// result of the query can be found in the result field. In case of an
|
||||
// unsuccessful request, ok equals false, and the error is explained in
|
||||
// the error field (e.g. SHORT_NAME_REQUIRED).
|
||||
Response struct {
|
||||
Ok bool `json:"ok"`
|
||||
Error string `json:"error"`
|
||||
Result *json.RawMessage `json:"result"`
|
||||
}
|
||||
)
|
Loading…
Reference in New Issue