diff --git a/pkg/database/database.go b/pkg/database/database.go index dc95d91..7977186 100644 --- a/pkg/database/database.go +++ b/pkg/database/database.go @@ -5,86 +5,46 @@ import ( "git.dragse.it/anthrove/otter-space-sdk/pkg/models" ) -// OtterSpace provides an interface for interacting with the OtterSpace API. -// It includes methods for connecting to the API, adding and linking users, posts, and sources, -// and retrieving information about users and posts. type OtterSpace interface { - // Connect sets up a connection to the OtterSpace API endpoint using the provided username and password. - // It returns an error if the connection cannot be established. Connect(ctx context.Context, endpoint string, username string, password string, database string, port int, ssl string, timezone string) error - // AddUserWithRelationToSource adds a new user to the OtterSpace database and associates them with a source. - // It returns the newly created user and an error if the operation fails. AddUserWithRelationToSource(ctx context.Context, anthroveUserID models.AnthroveUserID, sourceDomain string, userID string, username string) error - // AddSource adds a new source to the OtterSpace database. - // It returns an error if the operation fails. AddSource(ctx context.Context, anthroveSource *models.Source) error - // AddPost adds a new post to the OtterSpace database. - // It returns an error if the operation fails. AddPost(ctx context.Context, anthrovePost *models.Post) error - // AddTagWithRelationToPost adds a new tag to the OtterSpace database and associates it with a post. - // It returns an error if the operation fails. AddTagWithRelationToPost(ctx context.Context, anthrovePostID models.AnthrovePostID, anthroveTag *models.Tag) error - // LinkPostWithSource establishes a link between a post and a source in the OtterSpace database. - // It returns an error if the operation fails. LinkPostWithSource(ctx context.Context, anthrovePostID models.AnthrovePostID, anthroveSourceDomain string, anthrovePostRelationship *models.PostReference) error - // LinkUserWithPost establishes a link between a user and a post in the OtterSpace database. - // It returns an error if the operation fails. LinkUserWithPost(ctx context.Context, anthroveUser *models.User, anthrovePost *models.Post) error - // CheckUserPostLink checks if a link between a user and a post exists in the OtterSpace database. - // It returns true if the link exists, false otherwise, and an error if the operation fails. CheckUserPostLink(ctx context.Context, anthroveUserID models.AnthroveUserID, sourcePostID string, sourceUrl string) (bool, error) - // CheckPostNodeExistsByAnthroveID checks if a post node exists in the OtterSpace database by its Anthrove ID. - // It returns the post if it exists, a boolean indicating whether the post was found, and an error if the operation fails. CheckPostNodeExistsByAnthroveID(ctx context.Context, anthrovePost *models.Post) (*models.Post, error) - // CheckPostNodeExistsBySourceURL checks if a post node exists in the OtterSpace database by its source URL. - // It returns the post if it exists, a boolean indicating whether the post was found, and an error if the operation fails. CheckPostNodeExistsBySourceURL(ctx context.Context, sourceUrl string) (*models.Post, error) - // CheckPostNodeExistsBySourceID checks if a post node exists in the OtterSpace database by its source ID. - // It returns the post if it exists, a boolean indicating whether the post was found, and an error if the operation fails. CheckPostNodeExistsBySourceID(ctx context.Context, sourcePostID string) (*models.Post, error) - // GetUserFavoriteCount retrieves the count of a user's favorite posts from the OtterSpace database. - // It returns the count and an error if the operation fails. GetUserFavoriteCount(ctx context.Context, anthroveUserID models.AnthroveUserID) (int64, error) - // GetUserSourceLinks retrieves the links between a user and sources in the OtterSpace database. - // It returns a map of source domains to user-source relationships, and an error if the operation fails. GetUserSourceLinks(ctx context.Context, anthroveUserID models.AnthroveUserID) (map[string]models.UserSource, error) - // GetSpecifiedUserSourceLink GetUserSourceLinks retrieves the links between a user and a specific source in the OtterSpace database. - // It returns a map of source domains to user-source relationships, and an error if the operation fails. GetSpecifiedUserSourceLink(ctx context.Context, anthroveUserID models.AnthroveUserID, sourceDisplayName string) (map[string]models.UserSource, error) - // GetAnthroveUser retrieves a user from the OtterSpace database by their ID. - // It returns the user and an error if the operation fails. GetAnthroveUser(ctx context.Context, anthroveUserID models.AnthroveUserID) (*models.User, error) - // GetAllAnthroveUserIDs retrieves all user IDs from the OtterSpace database. - // It returns a slice of user IDs and an error if the operation fails. GetAllAnthroveUserIDs(ctx context.Context) ([]models.AnthroveUserID, error) - // GetUserFavoritePostsWithPagination gets all user favorites with relation and sources for the given user GetUserFavoritePostsWithPagination(ctx context.Context, anthroveUserID models.AnthroveUserID, skip int, limit int) (*models.FavoriteList, error) - // GetUserTagsTroughFavedPosts returns a list of Tags that the user hs favorites through a post GetUserTagsTroughFavedPosts(ctx context.Context, anthroveUserID models.AnthroveUserID) ([]models.TagsWithFrequency, error) - // GetAllTags returns a list of Tags that the user hs favorites through a post GetAllTags(ctx context.Context) ([]models.TagsWithFrequency, error) - // GetAllSources returns a list of Sources in the database GetAllSources(ctx context.Context) ([]models.Source, error) - // GetSourceByURL returns the Source Node based on the URL GetSourceByURL(ctx context.Context, sourceUrl string) (*models.Source, error) }