|
@@ -4,9 +4,11 @@
|
|
|
package client // import "miniflux.app/v2/client"
|
|
package client // import "miniflux.app/v2/client"
|
|
|
|
|
|
|
|
import (
|
|
import (
|
|
|
|
|
+ "context"
|
|
|
"encoding/json"
|
|
"encoding/json"
|
|
|
"fmt"
|
|
"fmt"
|
|
|
"io"
|
|
"io"
|
|
|
|
|
+ "net/http"
|
|
|
"net/url"
|
|
"net/url"
|
|
|
"strconv"
|
|
"strconv"
|
|
|
"strings"
|
|
"strings"
|
|
@@ -26,22 +28,45 @@ func New(endpoint string, credentials ...string) *Client {
|
|
|
|
|
|
|
|
// NewClient returns a new Miniflux client.
|
|
// NewClient returns a new Miniflux client.
|
|
|
func NewClient(endpoint string, credentials ...string) *Client {
|
|
func NewClient(endpoint string, credentials ...string) *Client {
|
|
|
- // Trim trailing slashes and /v1 from the endpoint.
|
|
|
|
|
- endpoint = strings.TrimSuffix(endpoint, "/")
|
|
|
|
|
- endpoint = strings.TrimSuffix(endpoint, "/v1")
|
|
|
|
|
switch len(credentials) {
|
|
switch len(credentials) {
|
|
|
case 2:
|
|
case 2:
|
|
|
- return &Client{request: &request{endpoint: endpoint, username: credentials[0], password: credentials[1]}}
|
|
|
|
|
|
|
+ return NewClientWithOptions(endpoint, WithCredentials(credentials[0], credentials[1]))
|
|
|
case 1:
|
|
case 1:
|
|
|
- return &Client{request: &request{endpoint: endpoint, apiKey: credentials[0]}}
|
|
|
|
|
|
|
+ return NewClientWithOptions(endpoint, WithAPIKey(credentials[0]))
|
|
|
default:
|
|
default:
|
|
|
- return &Client{request: &request{endpoint: endpoint}}
|
|
|
|
|
|
|
+ return NewClientWithOptions(endpoint)
|
|
|
}
|
|
}
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
|
|
+// NewClientWithOptions returns a new Miniflux client with options.
|
|
|
|
|
+func NewClientWithOptions(endpoint string, options ...Option) *Client {
|
|
|
|
|
+ // Trim trailing slashes and /v1 from the endpoint.
|
|
|
|
|
+ endpoint = strings.TrimSuffix(endpoint, "/")
|
|
|
|
|
+ endpoint = strings.TrimSuffix(endpoint, "/v1")
|
|
|
|
|
+ request := &request{endpoint: endpoint, client: http.DefaultClient}
|
|
|
|
|
+
|
|
|
|
|
+ for _, option := range options {
|
|
|
|
|
+ option(request)
|
|
|
|
|
+ }
|
|
|
|
|
+
|
|
|
|
|
+ return &Client{request: request}
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+func withDefaultTimeout() (context.Context, func()) {
|
|
|
|
|
+ ctx, cancel := context.WithTimeout(context.Background(), defaultTimeout)
|
|
|
|
|
+ return ctx, cancel
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
// Healthcheck checks if the application is up and running.
|
|
// Healthcheck checks if the application is up and running.
|
|
|
func (c *Client) Healthcheck() error {
|
|
func (c *Client) Healthcheck() error {
|
|
|
- body, err := c.request.Get("/healthcheck")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.HealthcheckContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// HealthcheckContext checks if the application is up and running.
|
|
|
|
|
+func (c *Client) HealthcheckContext(ctx context.Context) error {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/healthcheck")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return fmt.Errorf("miniflux: unable to perform healthcheck: %w", err)
|
|
return fmt.Errorf("miniflux: unable to perform healthcheck: %w", err)
|
|
|
}
|
|
}
|
|
@@ -61,7 +86,14 @@ func (c *Client) Healthcheck() error {
|
|
|
|
|
|
|
|
// Version returns the version of the Miniflux instance.
|
|
// Version returns the version of the Miniflux instance.
|
|
|
func (c *Client) Version() (*VersionResponse, error) {
|
|
func (c *Client) Version() (*VersionResponse, error) {
|
|
|
- body, err := c.request.Get("/v1/version")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.VersionContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// VersionContext returns the version of the Miniflux instance.
|
|
|
|
|
+func (c *Client) VersionContext(ctx context.Context) (*VersionResponse, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/version")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -77,7 +109,14 @@ func (c *Client) Version() (*VersionResponse, error) {
|
|
|
|
|
|
|
|
// Me returns the logged user information.
|
|
// Me returns the logged user information.
|
|
|
func (c *Client) Me() (*User, error) {
|
|
func (c *Client) Me() (*User, error) {
|
|
|
- body, err := c.request.Get("/v1/me")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.MeContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// MeContext returns the logged user information.
|
|
|
|
|
+func (c *Client) MeContext(ctx context.Context) (*User, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/me")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -93,7 +132,14 @@ func (c *Client) Me() (*User, error) {
|
|
|
|
|
|
|
|
// Users returns all users.
|
|
// Users returns all users.
|
|
|
func (c *Client) Users() (Users, error) {
|
|
func (c *Client) Users() (Users, error) {
|
|
|
- body, err := c.request.Get("/v1/users")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UsersContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UsersContext returns all users.
|
|
|
|
|
+func (c *Client) UsersContext(ctx context.Context) (Users, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/users")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -109,7 +155,14 @@ func (c *Client) Users() (Users, error) {
|
|
|
|
|
|
|
|
// UserByID returns a single user.
|
|
// UserByID returns a single user.
|
|
|
func (c *Client) UserByID(userID int64) (*User, error) {
|
|
func (c *Client) UserByID(userID int64) (*User, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/users/%d", userID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UserByIDContext(ctx, userID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UserByIDContext returns a single user.
|
|
|
|
|
+func (c *Client) UserByIDContext(ctx context.Context, userID int64) (*User, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/users/%d", userID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -125,7 +178,14 @@ func (c *Client) UserByID(userID int64) (*User, error) {
|
|
|
|
|
|
|
|
// UserByUsername returns a single user.
|
|
// UserByUsername returns a single user.
|
|
|
func (c *Client) UserByUsername(username string) (*User, error) {
|
|
func (c *Client) UserByUsername(username string) (*User, error) {
|
|
|
- body, err := c.request.Get("/v1/users/" + username)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UserByUsernameContext(ctx, username)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UserByUsernameContext returns a single user.
|
|
|
|
|
+func (c *Client) UserByUsernameContext(ctx context.Context, username string) (*User, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/users/"+username)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -141,7 +201,14 @@ func (c *Client) UserByUsername(username string) (*User, error) {
|
|
|
|
|
|
|
|
// CreateUser creates a new user in the system.
|
|
// CreateUser creates a new user in the system.
|
|
|
func (c *Client) CreateUser(username, password string, isAdmin bool) (*User, error) {
|
|
func (c *Client) CreateUser(username, password string, isAdmin bool) (*User, error) {
|
|
|
- body, err := c.request.Post("/v1/users", &UserCreationRequest{
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CreateUserContext(ctx, username, password, isAdmin)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CreateUserContext creates a new user in the system.
|
|
|
|
|
+func (c *Client) CreateUserContext(ctx context.Context, username, password string, isAdmin bool) (*User, error) {
|
|
|
|
|
+ body, err := c.request.Post(ctx, "/v1/users", &UserCreationRequest{
|
|
|
Username: username,
|
|
Username: username,
|
|
|
Password: password,
|
|
Password: password,
|
|
|
IsAdmin: isAdmin,
|
|
IsAdmin: isAdmin,
|
|
@@ -161,7 +228,14 @@ func (c *Client) CreateUser(username, password string, isAdmin bool) (*User, err
|
|
|
|
|
|
|
|
// UpdateUser updates a user in the system.
|
|
// UpdateUser updates a user in the system.
|
|
|
func (c *Client) UpdateUser(userID int64, userChanges *UserModificationRequest) (*User, error) {
|
|
func (c *Client) UpdateUser(userID int64, userChanges *UserModificationRequest) (*User, error) {
|
|
|
- body, err := c.request.Put(fmt.Sprintf("/v1/users/%d", userID), userChanges)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UpdateUserContext(ctx, userID, userChanges)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UpdateUserContext updates a user in the system.
|
|
|
|
|
+func (c *Client) UpdateUserContext(ctx context.Context, userID int64, userChanges *UserModificationRequest) (*User, error) {
|
|
|
|
|
+ body, err := c.request.Put(ctx, fmt.Sprintf("/v1/users/%d", userID), userChanges)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -177,12 +251,26 @@ func (c *Client) UpdateUser(userID int64, userChanges *UserModificationRequest)
|
|
|
|
|
|
|
|
// DeleteUser removes a user from the system.
|
|
// DeleteUser removes a user from the system.
|
|
|
func (c *Client) DeleteUser(userID int64) error {
|
|
func (c *Client) DeleteUser(userID int64) error {
|
|
|
- return c.request.Delete(fmt.Sprintf("/v1/users/%d", userID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.DeleteUserContext(ctx, userID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// DeleteUserContext removes a user from the system.
|
|
|
|
|
+func (c *Client) DeleteUserContext(ctx context.Context, userID int64) error {
|
|
|
|
|
+ return c.request.Delete(ctx, fmt.Sprintf("/v1/users/%d", userID))
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// APIKeys returns all API keys for the authenticated user.
|
|
// APIKeys returns all API keys for the authenticated user.
|
|
|
func (c *Client) APIKeys() (APIKeys, error) {
|
|
func (c *Client) APIKeys() (APIKeys, error) {
|
|
|
- body, err := c.request.Get("/v1/api-keys")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.APIKeysContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// APIKeysContext returns all API keys for the authenticated user.
|
|
|
|
|
+func (c *Client) APIKeysContext(ctx context.Context) (APIKeys, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/api-keys")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -198,7 +286,14 @@ func (c *Client) APIKeys() (APIKeys, error) {
|
|
|
|
|
|
|
|
// CreateAPIKey creates a new API key for the authenticated user.
|
|
// CreateAPIKey creates a new API key for the authenticated user.
|
|
|
func (c *Client) CreateAPIKey(description string) (*APIKey, error) {
|
|
func (c *Client) CreateAPIKey(description string) (*APIKey, error) {
|
|
|
- body, err := c.request.Post("/v1/api-keys", &APIKeyCreationRequest{
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CreateAPIKeyContext(ctx, description)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CreateAPIKeyContext creates a new API key for the authenticated user.
|
|
|
|
|
+func (c *Client) CreateAPIKeyContext(ctx context.Context, description string) (*APIKey, error) {
|
|
|
|
|
+ body, err := c.request.Post(ctx, "/v1/api-keys", &APIKeyCreationRequest{
|
|
|
Description: description,
|
|
Description: description,
|
|
|
})
|
|
})
|
|
|
if err != nil {
|
|
if err != nil {
|
|
@@ -216,18 +311,39 @@ func (c *Client) CreateAPIKey(description string) (*APIKey, error) {
|
|
|
|
|
|
|
|
// DeleteAPIKey removes an API key for the authenticated user.
|
|
// DeleteAPIKey removes an API key for the authenticated user.
|
|
|
func (c *Client) DeleteAPIKey(apiKeyID int64) error {
|
|
func (c *Client) DeleteAPIKey(apiKeyID int64) error {
|
|
|
- return c.request.Delete(fmt.Sprintf("/v1/api-keys/%d", apiKeyID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.DeleteAPIKeyContext(ctx, apiKeyID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// DeleteAPIKeyContext removes an API key for the authenticated user.
|
|
|
|
|
+func (c *Client) DeleteAPIKeyContext(ctx context.Context, apiKeyID int64) error {
|
|
|
|
|
+ return c.request.Delete(ctx, fmt.Sprintf("/v1/api-keys/%d", apiKeyID))
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// MarkAllAsRead marks all unread entries as read for a given user.
|
|
// MarkAllAsRead marks all unread entries as read for a given user.
|
|
|
func (c *Client) MarkAllAsRead(userID int64) error {
|
|
func (c *Client) MarkAllAsRead(userID int64) error {
|
|
|
- _, err := c.request.Put(fmt.Sprintf("/v1/users/%d/mark-all-as-read", userID), nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.MarkAllAsReadContext(ctx, userID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// MarkAllAsReadContext marks all unread entries as read for a given user.
|
|
|
|
|
+func (c *Client) MarkAllAsReadContext(ctx context.Context, userID int64) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, fmt.Sprintf("/v1/users/%d/mark-all-as-read", userID), nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// IntegrationsStatus fetches the integrations status for the logged user.
|
|
// IntegrationsStatus fetches the integrations status for the logged user.
|
|
|
func (c *Client) IntegrationsStatus() (bool, error) {
|
|
func (c *Client) IntegrationsStatus() (bool, error) {
|
|
|
- body, err := c.request.Get("/v1/integrations/status")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.IntegrationsStatusContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// IntegrationsStatusContext fetches the integrations status for the logged user.
|
|
|
|
|
+func (c *Client) IntegrationsStatusContext(ctx context.Context) (bool, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/integrations/status")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return false, err
|
|
return false, err
|
|
|
}
|
|
}
|
|
@@ -246,7 +362,14 @@ func (c *Client) IntegrationsStatus() (bool, error) {
|
|
|
|
|
|
|
|
// Discover try to find subscriptions from a website.
|
|
// Discover try to find subscriptions from a website.
|
|
|
func (c *Client) Discover(url string) (Subscriptions, error) {
|
|
func (c *Client) Discover(url string) (Subscriptions, error) {
|
|
|
- body, err := c.request.Post("/v1/discover", map[string]string{"url": url})
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.DiscoverContext(ctx, url)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// DiscoverContext tries to find subscriptions from a website.
|
|
|
|
|
+func (c *Client) DiscoverContext(ctx context.Context, url string) (Subscriptions, error) {
|
|
|
|
|
+ body, err := c.request.Post(ctx, "/v1/discover", map[string]string{"url": url})
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -262,7 +385,14 @@ func (c *Client) Discover(url string) (Subscriptions, error) {
|
|
|
|
|
|
|
|
// Categories gets the list of categories.
|
|
// Categories gets the list of categories.
|
|
|
func (c *Client) Categories() (Categories, error) {
|
|
func (c *Client) Categories() (Categories, error) {
|
|
|
- body, err := c.request.Get("/v1/categories")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CategoriesContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CategoriesContext gets the list of categories.
|
|
|
|
|
+func (c *Client) CategoriesContext(ctx context.Context) (Categories, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/categories")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -278,7 +408,14 @@ func (c *Client) Categories() (Categories, error) {
|
|
|
|
|
|
|
|
// CategoriesWithCounters fetches the categories with their respective feed and unread counts.
|
|
// CategoriesWithCounters fetches the categories with their respective feed and unread counts.
|
|
|
func (c *Client) CategoriesWithCounters() (Categories, error) {
|
|
func (c *Client) CategoriesWithCounters() (Categories, error) {
|
|
|
- body, err := c.request.Get("/v1/categories?counts=true")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CategoriesWithCountersContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CategoriesWithCountersContext fetches the categories with their respective feed and unread counts.
|
|
|
|
|
+func (c *Client) CategoriesWithCountersContext(ctx context.Context) (Categories, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/categories?counts=true")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -294,7 +431,14 @@ func (c *Client) CategoriesWithCounters() (Categories, error) {
|
|
|
|
|
|
|
|
// CreateCategory creates a new category.
|
|
// CreateCategory creates a new category.
|
|
|
func (c *Client) CreateCategory(title string) (*Category, error) {
|
|
func (c *Client) CreateCategory(title string) (*Category, error) {
|
|
|
- body, err := c.request.Post("/v1/categories", &CategoryCreationRequest{
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CreateCategoryContext(ctx, title)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CreateCategoryContext creates a new category.
|
|
|
|
|
+func (c *Client) CreateCategoryContext(ctx context.Context, title string) (*Category, error) {
|
|
|
|
|
+ body, err := c.request.Post(ctx, "/v1/categories", &CategoryCreationRequest{
|
|
|
Title: title,
|
|
Title: title,
|
|
|
})
|
|
})
|
|
|
if err != nil {
|
|
if err != nil {
|
|
@@ -312,7 +456,14 @@ func (c *Client) CreateCategory(title string) (*Category, error) {
|
|
|
|
|
|
|
|
// CreateCategoryWithOptions creates a new category with options.
|
|
// CreateCategoryWithOptions creates a new category with options.
|
|
|
func (c *Client) CreateCategoryWithOptions(createRequest *CategoryCreationRequest) (*Category, error) {
|
|
func (c *Client) CreateCategoryWithOptions(createRequest *CategoryCreationRequest) (*Category, error) {
|
|
|
- body, err := c.request.Post("/v1/categories", createRequest)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CreateCategoryWithOptionsContext(ctx, createRequest)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CreateCategoryWithOptionsContext creates a new category with options.
|
|
|
|
|
+func (c *Client) CreateCategoryWithOptionsContext(ctx context.Context, createRequest *CategoryCreationRequest) (*Category, error) {
|
|
|
|
|
+ body, err := c.request.Post(ctx, "/v1/categories", createRequest)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -327,7 +478,14 @@ func (c *Client) CreateCategoryWithOptions(createRequest *CategoryCreationReques
|
|
|
|
|
|
|
|
// UpdateCategory updates a category.
|
|
// UpdateCategory updates a category.
|
|
|
func (c *Client) UpdateCategory(categoryID int64, title string) (*Category, error) {
|
|
func (c *Client) UpdateCategory(categoryID int64, title string) (*Category, error) {
|
|
|
- body, err := c.request.Put(fmt.Sprintf("/v1/categories/%d", categoryID), &CategoryModificationRequest{
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UpdateCategoryContext(ctx, categoryID, title)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UpdateCategoryContext updates a category.
|
|
|
|
|
+func (c *Client) UpdateCategoryContext(ctx context.Context, categoryID int64, title string) (*Category, error) {
|
|
|
|
|
+ body, err := c.request.Put(ctx, fmt.Sprintf("/v1/categories/%d", categoryID), &CategoryModificationRequest{
|
|
|
Title: SetOptionalField(title),
|
|
Title: SetOptionalField(title),
|
|
|
})
|
|
})
|
|
|
if err != nil {
|
|
if err != nil {
|
|
@@ -345,7 +503,14 @@ func (c *Client) UpdateCategory(categoryID int64, title string) (*Category, erro
|
|
|
|
|
|
|
|
// UpdateCategoryWithOptions updates a category with options.
|
|
// UpdateCategoryWithOptions updates a category with options.
|
|
|
func (c *Client) UpdateCategoryWithOptions(categoryID int64, categoryChanges *CategoryModificationRequest) (*Category, error) {
|
|
func (c *Client) UpdateCategoryWithOptions(categoryID int64, categoryChanges *CategoryModificationRequest) (*Category, error) {
|
|
|
- body, err := c.request.Put(fmt.Sprintf("/v1/categories/%d", categoryID), categoryChanges)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UpdateCategoryWithOptionsContext(ctx, categoryID, categoryChanges)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UpdateCategoryWithOptionsContext updates a category with options.
|
|
|
|
|
+func (c *Client) UpdateCategoryWithOptionsContext(ctx context.Context, categoryID int64, categoryChanges *CategoryModificationRequest) (*Category, error) {
|
|
|
|
|
+ body, err := c.request.Put(ctx, fmt.Sprintf("/v1/categories/%d", categoryID), categoryChanges)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -361,13 +526,27 @@ func (c *Client) UpdateCategoryWithOptions(categoryID int64, categoryChanges *Ca
|
|
|
|
|
|
|
|
// MarkCategoryAsRead marks all unread entries in a category as read.
|
|
// MarkCategoryAsRead marks all unread entries in a category as read.
|
|
|
func (c *Client) MarkCategoryAsRead(categoryID int64) error {
|
|
func (c *Client) MarkCategoryAsRead(categoryID int64) error {
|
|
|
- _, err := c.request.Put(fmt.Sprintf("/v1/categories/%d/mark-all-as-read", categoryID), nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.MarkCategoryAsReadContext(ctx, categoryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// MarkCategoryAsReadContext marks all unread entries in a category as read.
|
|
|
|
|
+func (c *Client) MarkCategoryAsReadContext(ctx context.Context, categoryID int64) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, fmt.Sprintf("/v1/categories/%d/mark-all-as-read", categoryID), nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// CategoryFeeds gets feeds of a category.
|
|
// CategoryFeeds gets feeds of a category.
|
|
|
func (c *Client) CategoryFeeds(categoryID int64) (Feeds, error) {
|
|
func (c *Client) CategoryFeeds(categoryID int64) (Feeds, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/categories/%d/feeds", categoryID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CategoryFeedsContext(ctx, categoryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CategoryFeedsContext gets feeds of a category.
|
|
|
|
|
+func (c *Client) CategoryFeedsContext(ctx context.Context, categoryID int64) (Feeds, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/categories/%d/feeds", categoryID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -383,18 +562,39 @@ func (c *Client) CategoryFeeds(categoryID int64) (Feeds, error) {
|
|
|
|
|
|
|
|
// DeleteCategory removes a category.
|
|
// DeleteCategory removes a category.
|
|
|
func (c *Client) DeleteCategory(categoryID int64) error {
|
|
func (c *Client) DeleteCategory(categoryID int64) error {
|
|
|
- return c.request.Delete(fmt.Sprintf("/v1/categories/%d", categoryID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.DeleteCategoryContext(ctx, categoryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// DeleteCategoryContext removes a category.
|
|
|
|
|
+func (c *Client) DeleteCategoryContext(ctx context.Context, categoryID int64) error {
|
|
|
|
|
+ return c.request.Delete(ctx, fmt.Sprintf("/v1/categories/%d", categoryID))
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// RefreshCategory refreshes a category.
|
|
// RefreshCategory refreshes a category.
|
|
|
func (c *Client) RefreshCategory(categoryID int64) error {
|
|
func (c *Client) RefreshCategory(categoryID int64) error {
|
|
|
- _, err := c.request.Put(fmt.Sprintf("/v1/categories/%d/refresh", categoryID), nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.RefreshCategoryContext(ctx, categoryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// RefreshCategoryContext refreshes a category.
|
|
|
|
|
+func (c *Client) RefreshCategoryContext(ctx context.Context, categoryID int64) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, fmt.Sprintf("/v1/categories/%d/refresh", categoryID), nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// Feeds gets all feeds.
|
|
// Feeds gets all feeds.
|
|
|
func (c *Client) Feeds() (Feeds, error) {
|
|
func (c *Client) Feeds() (Feeds, error) {
|
|
|
- body, err := c.request.Get("/v1/feeds")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FeedsContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FeedsContext gets all feeds.
|
|
|
|
|
+func (c *Client) FeedsContext(ctx context.Context) (Feeds, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/feeds")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -410,7 +610,14 @@ func (c *Client) Feeds() (Feeds, error) {
|
|
|
|
|
|
|
|
// Export creates OPML file.
|
|
// Export creates OPML file.
|
|
|
func (c *Client) Export() ([]byte, error) {
|
|
func (c *Client) Export() ([]byte, error) {
|
|
|
- body, err := c.request.Get("/v1/export")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.ExportContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// ExportContext creates OPML file.
|
|
|
|
|
+func (c *Client) ExportContext(ctx context.Context) ([]byte, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/export")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -426,13 +633,27 @@ func (c *Client) Export() ([]byte, error) {
|
|
|
|
|
|
|
|
// Import imports an OPML file.
|
|
// Import imports an OPML file.
|
|
|
func (c *Client) Import(f io.ReadCloser) error {
|
|
func (c *Client) Import(f io.ReadCloser) error {
|
|
|
- _, err := c.request.PostFile("/v1/import", f)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.ImportContext(ctx, f)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// ImportContext imports an OPML file.
|
|
|
|
|
+func (c *Client) ImportContext(ctx context.Context, f io.ReadCloser) error {
|
|
|
|
|
+ _, err := c.request.PostFile(ctx, "/v1/import", f)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// Feed gets a feed.
|
|
// Feed gets a feed.
|
|
|
func (c *Client) Feed(feedID int64) (*Feed, error) {
|
|
func (c *Client) Feed(feedID int64) (*Feed, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/feeds/%d", feedID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FeedContext(ctx, feedID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FeedContext gets a feed.
|
|
|
|
|
+func (c *Client) FeedContext(ctx context.Context, feedID int64) (*Feed, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/feeds/%d", feedID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -448,7 +669,14 @@ func (c *Client) Feed(feedID int64) (*Feed, error) {
|
|
|
|
|
|
|
|
// CreateFeed creates a new feed.
|
|
// CreateFeed creates a new feed.
|
|
|
func (c *Client) CreateFeed(feedCreationRequest *FeedCreationRequest) (int64, error) {
|
|
func (c *Client) CreateFeed(feedCreationRequest *FeedCreationRequest) (int64, error) {
|
|
|
- body, err := c.request.Post("/v1/feeds", feedCreationRequest)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CreateFeedContext(ctx, feedCreationRequest)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CreateFeedContext creates a new feed.
|
|
|
|
|
+func (c *Client) CreateFeedContext(ctx context.Context, feedCreationRequest *FeedCreationRequest) (int64, error) {
|
|
|
|
|
+ body, err := c.request.Post(ctx, "/v1/feeds", feedCreationRequest)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return 0, err
|
|
return 0, err
|
|
|
}
|
|
}
|
|
@@ -468,7 +696,14 @@ func (c *Client) CreateFeed(feedCreationRequest *FeedCreationRequest) (int64, er
|
|
|
|
|
|
|
|
// UpdateFeed updates a feed.
|
|
// UpdateFeed updates a feed.
|
|
|
func (c *Client) UpdateFeed(feedID int64, feedChanges *FeedModificationRequest) (*Feed, error) {
|
|
func (c *Client) UpdateFeed(feedID int64, feedChanges *FeedModificationRequest) (*Feed, error) {
|
|
|
- body, err := c.request.Put(fmt.Sprintf("/v1/feeds/%d", feedID), feedChanges)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UpdateFeedContext(ctx, feedID, feedChanges)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UpdateFeedContext updates a feed.
|
|
|
|
|
+func (c *Client) UpdateFeedContext(ctx context.Context, feedID int64, feedChanges *FeedModificationRequest) (*Feed, error) {
|
|
|
|
|
+ body, err := c.request.Put(ctx, fmt.Sprintf("/v1/feeds/%d", feedID), feedChanges)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -484,30 +719,65 @@ func (c *Client) UpdateFeed(feedID int64, feedChanges *FeedModificationRequest)
|
|
|
|
|
|
|
|
// MarkFeedAsRead marks all unread entries of the feed as read.
|
|
// MarkFeedAsRead marks all unread entries of the feed as read.
|
|
|
func (c *Client) MarkFeedAsRead(feedID int64) error {
|
|
func (c *Client) MarkFeedAsRead(feedID int64) error {
|
|
|
- _, err := c.request.Put(fmt.Sprintf("/v1/feeds/%d/mark-all-as-read", feedID), nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.MarkFeedAsReadContext(ctx, feedID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// MarkFeedAsReadContext marks all unread entries of the feed as read.
|
|
|
|
|
+func (c *Client) MarkFeedAsReadContext(ctx context.Context, feedID int64) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, fmt.Sprintf("/v1/feeds/%d/mark-all-as-read", feedID), nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// RefreshAllFeeds refreshes all feeds.
|
|
// RefreshAllFeeds refreshes all feeds.
|
|
|
func (c *Client) RefreshAllFeeds() error {
|
|
func (c *Client) RefreshAllFeeds() error {
|
|
|
- _, err := c.request.Put("/v1/feeds/refresh", nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.RefreshAllFeedsContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// RefreshAllFeedsContext refreshes all feeds.
|
|
|
|
|
+func (c *Client) RefreshAllFeedsContext(ctx context.Context) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, "/v1/feeds/refresh", nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// RefreshFeed refreshes a feed.
|
|
// RefreshFeed refreshes a feed.
|
|
|
func (c *Client) RefreshFeed(feedID int64) error {
|
|
func (c *Client) RefreshFeed(feedID int64) error {
|
|
|
- _, err := c.request.Put(fmt.Sprintf("/v1/feeds/%d/refresh", feedID), nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.RefreshFeedContext(ctx, feedID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// RefreshFeedContext refreshes a feed.
|
|
|
|
|
+func (c *Client) RefreshFeedContext(ctx context.Context, feedID int64) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, fmt.Sprintf("/v1/feeds/%d/refresh", feedID), nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// DeleteFeed removes a feed.
|
|
// DeleteFeed removes a feed.
|
|
|
func (c *Client) DeleteFeed(feedID int64) error {
|
|
func (c *Client) DeleteFeed(feedID int64) error {
|
|
|
- return c.request.Delete(fmt.Sprintf("/v1/feeds/%d", feedID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.DeleteFeedContext(ctx, feedID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// DeleteFeedContext removes a feed.
|
|
|
|
|
+func (c *Client) DeleteFeedContext(ctx context.Context, feedID int64) error {
|
|
|
|
|
+ return c.request.Delete(ctx, fmt.Sprintf("/v1/feeds/%d", feedID))
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// FeedIcon gets a feed icon.
|
|
// FeedIcon gets a feed icon.
|
|
|
func (c *Client) FeedIcon(feedID int64) (*FeedIcon, error) {
|
|
func (c *Client) FeedIcon(feedID int64) (*FeedIcon, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/feeds/%d/icon", feedID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FeedIconContext(ctx, feedID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FeedIconContext gets a feed icon.
|
|
|
|
|
+func (c *Client) FeedIconContext(ctx context.Context, feedID int64) (*FeedIcon, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/feeds/%d/icon", feedID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -523,7 +793,14 @@ func (c *Client) FeedIcon(feedID int64) (*FeedIcon, error) {
|
|
|
|
|
|
|
|
// FeedEntry gets a single feed entry.
|
|
// FeedEntry gets a single feed entry.
|
|
|
func (c *Client) FeedEntry(feedID, entryID int64) (*Entry, error) {
|
|
func (c *Client) FeedEntry(feedID, entryID int64) (*Entry, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/feeds/%d/entries/%d", feedID, entryID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FeedEntryContext(ctx, feedID, entryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FeedEntryContext gets a single feed entry.
|
|
|
|
|
+func (c *Client) FeedEntryContext(ctx context.Context, feedID, entryID int64) (*Entry, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/feeds/%d/entries/%d", feedID, entryID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -539,7 +816,14 @@ func (c *Client) FeedEntry(feedID, entryID int64) (*Entry, error) {
|
|
|
|
|
|
|
|
// CategoryEntry gets a single category entry.
|
|
// CategoryEntry gets a single category entry.
|
|
|
func (c *Client) CategoryEntry(categoryID, entryID int64) (*Entry, error) {
|
|
func (c *Client) CategoryEntry(categoryID, entryID int64) (*Entry, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/categories/%d/entries/%d", categoryID, entryID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CategoryEntryContext(ctx, categoryID, entryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CategoryEntryContext gets a single category entry.
|
|
|
|
|
+func (c *Client) CategoryEntryContext(ctx context.Context, categoryID, entryID int64) (*Entry, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/categories/%d/entries/%d", categoryID, entryID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -555,7 +839,14 @@ func (c *Client) CategoryEntry(categoryID, entryID int64) (*Entry, error) {
|
|
|
|
|
|
|
|
// Entry gets a single entry.
|
|
// Entry gets a single entry.
|
|
|
func (c *Client) Entry(entryID int64) (*Entry, error) {
|
|
func (c *Client) Entry(entryID int64) (*Entry, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/entries/%d", entryID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.EntryContext(ctx, entryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// EntryContext gets a single entry.
|
|
|
|
|
+func (c *Client) EntryContext(ctx context.Context, entryID int64) (*Entry, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/entries/%d", entryID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -571,9 +862,16 @@ func (c *Client) Entry(entryID int64) (*Entry, error) {
|
|
|
|
|
|
|
|
// Entries fetch entries.
|
|
// Entries fetch entries.
|
|
|
func (c *Client) Entries(filter *Filter) (*EntryResultSet, error) {
|
|
func (c *Client) Entries(filter *Filter) (*EntryResultSet, error) {
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.EntriesContext(ctx, filter)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// EntriesContext fetches entries.
|
|
|
|
|
+func (c *Client) EntriesContext(ctx context.Context, filter *Filter) (*EntryResultSet, error) {
|
|
|
path := buildFilterQueryString("/v1/entries", filter)
|
|
path := buildFilterQueryString("/v1/entries", filter)
|
|
|
|
|
|
|
|
- body, err := c.request.Get(path)
|
|
|
|
|
|
|
+ body, err := c.request.Get(ctx, path)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -589,9 +887,16 @@ func (c *Client) Entries(filter *Filter) (*EntryResultSet, error) {
|
|
|
|
|
|
|
|
// FeedEntries fetch feed entries.
|
|
// FeedEntries fetch feed entries.
|
|
|
func (c *Client) FeedEntries(feedID int64, filter *Filter) (*EntryResultSet, error) {
|
|
func (c *Client) FeedEntries(feedID int64, filter *Filter) (*EntryResultSet, error) {
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FeedEntriesContext(ctx, feedID, filter)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FeedEntriesContext fetches feed entries.
|
|
|
|
|
+func (c *Client) FeedEntriesContext(ctx context.Context, feedID int64, filter *Filter) (*EntryResultSet, error) {
|
|
|
path := buildFilterQueryString(fmt.Sprintf("/v1/feeds/%d/entries", feedID), filter)
|
|
path := buildFilterQueryString(fmt.Sprintf("/v1/feeds/%d/entries", feedID), filter)
|
|
|
|
|
|
|
|
- body, err := c.request.Get(path)
|
|
|
|
|
|
|
+ body, err := c.request.Get(ctx, path)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -607,9 +912,16 @@ func (c *Client) FeedEntries(feedID int64, filter *Filter) (*EntryResultSet, err
|
|
|
|
|
|
|
|
// CategoryEntries fetch entries of a category.
|
|
// CategoryEntries fetch entries of a category.
|
|
|
func (c *Client) CategoryEntries(categoryID int64, filter *Filter) (*EntryResultSet, error) {
|
|
func (c *Client) CategoryEntries(categoryID int64, filter *Filter) (*EntryResultSet, error) {
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.CategoryEntriesContext(ctx, categoryID, filter)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// CategoryEntriesContext fetches category entries.
|
|
|
|
|
+func (c *Client) CategoryEntriesContext(ctx context.Context, categoryID int64, filter *Filter) (*EntryResultSet, error) {
|
|
|
path := buildFilterQueryString(fmt.Sprintf("/v1/categories/%d/entries", categoryID), filter)
|
|
path := buildFilterQueryString(fmt.Sprintf("/v1/categories/%d/entries", categoryID), filter)
|
|
|
|
|
|
|
|
- body, err := c.request.Get(path)
|
|
|
|
|
|
|
+ body, err := c.request.Get(ctx, path)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -625,18 +937,32 @@ func (c *Client) CategoryEntries(categoryID int64, filter *Filter) (*EntryResult
|
|
|
|
|
|
|
|
// UpdateEntries updates the status of a list of entries.
|
|
// UpdateEntries updates the status of a list of entries.
|
|
|
func (c *Client) UpdateEntries(entryIDs []int64, status string) error {
|
|
func (c *Client) UpdateEntries(entryIDs []int64, status string) error {
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UpdateEntriesContext(ctx, entryIDs, status)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UpdateEntriesContext updates the status of a list of entries.
|
|
|
|
|
+func (c *Client) UpdateEntriesContext(ctx context.Context, entryIDs []int64, status string) error {
|
|
|
type payload struct {
|
|
type payload struct {
|
|
|
EntryIDs []int64 `json:"entry_ids"`
|
|
EntryIDs []int64 `json:"entry_ids"`
|
|
|
Status string `json:"status"`
|
|
Status string `json:"status"`
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
- _, err := c.request.Put("/v1/entries", &payload{EntryIDs: entryIDs, Status: status})
|
|
|
|
|
|
|
+ _, err := c.request.Put(ctx, "/v1/entries", &payload{EntryIDs: entryIDs, Status: status})
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// UpdateEntry updates an entry.
|
|
// UpdateEntry updates an entry.
|
|
|
func (c *Client) UpdateEntry(entryID int64, entryChanges *EntryModificationRequest) (*Entry, error) {
|
|
func (c *Client) UpdateEntry(entryID int64, entryChanges *EntryModificationRequest) (*Entry, error) {
|
|
|
- body, err := c.request.Put(fmt.Sprintf("/v1/entries/%d", entryID), entryChanges)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UpdateEntryContext(ctx, entryID, entryChanges)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UpdateEntryContext updates an entry.
|
|
|
|
|
+func (c *Client) UpdateEntryContext(ctx context.Context, entryID int64, entryChanges *EntryModificationRequest) (*Entry, error) {
|
|
|
|
|
+ body, err := c.request.Put(ctx, fmt.Sprintf("/v1/entries/%d", entryID), entryChanges)
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -652,19 +978,40 @@ func (c *Client) UpdateEntry(entryID int64, entryChanges *EntryModificationReque
|
|
|
|
|
|
|
|
// ToggleStarred toggles entry starred value.
|
|
// ToggleStarred toggles entry starred value.
|
|
|
func (c *Client) ToggleStarred(entryID int64) error {
|
|
func (c *Client) ToggleStarred(entryID int64) error {
|
|
|
- _, err := c.request.Put(fmt.Sprintf("/v1/entries/%d/star", entryID), nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.ToggleStarredContext(ctx, entryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// ToggleStarredContext toggles entry starred value.
|
|
|
|
|
+func (c *Client) ToggleStarredContext(ctx context.Context, entryID int64) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, fmt.Sprintf("/v1/entries/%d/star", entryID), nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// SaveEntry sends an entry to a third-party service.
|
|
// SaveEntry sends an entry to a third-party service.
|
|
|
func (c *Client) SaveEntry(entryID int64) error {
|
|
func (c *Client) SaveEntry(entryID int64) error {
|
|
|
- _, err := c.request.Post(fmt.Sprintf("/v1/entries/%d/save", entryID), nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.SaveEntryContext(ctx, entryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// SaveEntryContext sends an entry to a third-party service.
|
|
|
|
|
+func (c *Client) SaveEntryContext(ctx context.Context, entryID int64) error {
|
|
|
|
|
+ _, err := c.request.Post(ctx, fmt.Sprintf("/v1/entries/%d/save", entryID), nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// FetchEntryOriginalContent fetches the original content of an entry using the scraper.
|
|
// FetchEntryOriginalContent fetches the original content of an entry using the scraper.
|
|
|
func (c *Client) FetchEntryOriginalContent(entryID int64) (string, error) {
|
|
func (c *Client) FetchEntryOriginalContent(entryID int64) (string, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/entries/%d/fetch-content", entryID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FetchEntryOriginalContentContext(ctx, entryID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FetchEntryOriginalContentContext fetches the original content of an entry using the scraper.
|
|
|
|
|
+func (c *Client) FetchEntryOriginalContentContext(ctx context.Context, entryID int64) (string, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/entries/%d/fetch-content", entryID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return "", err
|
|
return "", err
|
|
|
}
|
|
}
|
|
@@ -683,7 +1030,14 @@ func (c *Client) FetchEntryOriginalContent(entryID int64) (string, error) {
|
|
|
|
|
|
|
|
// FetchCounters fetches feed counters.
|
|
// FetchCounters fetches feed counters.
|
|
|
func (c *Client) FetchCounters() (*FeedCounters, error) {
|
|
func (c *Client) FetchCounters() (*FeedCounters, error) {
|
|
|
- body, err := c.request.Get("/v1/feeds/counters")
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FetchCountersContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FetchCountersContext fetches feed counters.
|
|
|
|
|
+func (c *Client) FetchCountersContext(ctx context.Context) (*FeedCounters, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, "/v1/feeds/counters")
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -699,13 +1053,27 @@ func (c *Client) FetchCounters() (*FeedCounters, error) {
|
|
|
|
|
|
|
|
// FlushHistory changes all entries with the status "read" to "removed".
|
|
// FlushHistory changes all entries with the status "read" to "removed".
|
|
|
func (c *Client) FlushHistory() error {
|
|
func (c *Client) FlushHistory() error {
|
|
|
- _, err := c.request.Put("/v1/flush-history", nil)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.FlushHistoryContext(ctx)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// FlushHistoryContext changes all entries with the status "read" to "removed".
|
|
|
|
|
+func (c *Client) FlushHistoryContext(ctx context.Context) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, "/v1/flush-history", nil)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// Icon fetches a feed icon.
|
|
// Icon fetches a feed icon.
|
|
|
func (c *Client) Icon(iconID int64) (*FeedIcon, error) {
|
|
func (c *Client) Icon(iconID int64) (*FeedIcon, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/icons/%d", iconID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.IconContext(ctx, iconID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// IconContext fetches a feed icon.
|
|
|
|
|
+func (c *Client) IconContext(ctx context.Context, iconID int64) (*FeedIcon, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/icons/%d", iconID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -721,7 +1089,14 @@ func (c *Client) Icon(iconID int64) (*FeedIcon, error) {
|
|
|
|
|
|
|
|
// Enclosure fetches a specific enclosure.
|
|
// Enclosure fetches a specific enclosure.
|
|
|
func (c *Client) Enclosure(enclosureID int64) (*Enclosure, error) {
|
|
func (c *Client) Enclosure(enclosureID int64) (*Enclosure, error) {
|
|
|
- body, err := c.request.Get(fmt.Sprintf("/v1/enclosures/%d", enclosureID))
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.EnclosureContext(ctx, enclosureID)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// EnclosureContext fetches a specific enclosure.
|
|
|
|
|
+func (c *Client) EnclosureContext(ctx context.Context, enclosureID int64) (*Enclosure, error) {
|
|
|
|
|
+ body, err := c.request.Get(ctx, fmt.Sprintf("/v1/enclosures/%d", enclosureID))
|
|
|
if err != nil {
|
|
if err != nil {
|
|
|
return nil, err
|
|
return nil, err
|
|
|
}
|
|
}
|
|
@@ -737,7 +1112,14 @@ func (c *Client) Enclosure(enclosureID int64) (*Enclosure, error) {
|
|
|
|
|
|
|
|
// UpdateEnclosure updates an enclosure.
|
|
// UpdateEnclosure updates an enclosure.
|
|
|
func (c *Client) UpdateEnclosure(enclosureID int64, enclosureUpdate *EnclosureUpdateRequest) error {
|
|
func (c *Client) UpdateEnclosure(enclosureID int64, enclosureUpdate *EnclosureUpdateRequest) error {
|
|
|
- _, err := c.request.Put(fmt.Sprintf("/v1/enclosures/%d", enclosureID), enclosureUpdate)
|
|
|
|
|
|
|
+ ctx, cancel := withDefaultTimeout()
|
|
|
|
|
+ defer cancel()
|
|
|
|
|
+ return c.UpdateEnclosureContext(ctx, enclosureID, enclosureUpdate)
|
|
|
|
|
+}
|
|
|
|
|
+
|
|
|
|
|
+// UpdateEnclosureContext updates an enclosure.
|
|
|
|
|
+func (c *Client) UpdateEnclosureContext(ctx context.Context, enclosureID int64, enclosureUpdate *EnclosureUpdateRequest) error {
|
|
|
|
|
+ _, err := c.request.Put(ctx, fmt.Sprintf("/v1/enclosures/%d", enclosureID), enclosureUpdate)
|
|
|
return err
|
|
return err
|
|
|
}
|
|
}
|
|
|
|
|
|