From a815c4ea4aa829dedd2cff7f403788896ee0887d Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Wed, 23 Feb 2022 22:04:18 +0530 Subject: pushing barebones structs for user/manga --- user/manga/client.go | 23 +++++++++++++++++++++ user/manga/mangalist.structs.go | 44 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 user/manga/client.go create mode 100644 user/manga/mangalist.structs.go diff --git a/user/manga/client.go b/user/manga/client.go new file mode 100644 index 0000000..272bfff --- /dev/null +++ b/user/manga/client.go @@ -0,0 +1,23 @@ +/* MAL2Go - MyAnimeList V2 API wrapper for Go + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ + +package manga + +import ( + "github.com/MikunoNaka/MAL2Go/util" +) + +type Client util.DefaultClient diff --git a/user/manga/mangalist.structs.go b/user/manga/mangalist.structs.go new file mode 100644 index 0000000..860163b --- /dev/null +++ b/user/manga/mangalist.structs.go @@ -0,0 +1,44 @@ +/* MAL2Go - MyAnimeList V2 API wrapper for Go + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ + +package manga + +import ( + "github.com/MikunoNaka/MAL2Go/util" + "github.com/MikunoNaka/MAL2Go/manga" +) + +type MangaListRaw struct { + Data []struct { + Manga manga.Manga `json:"node"` + ListStatus manga.ListStatus `json:"list_status"` + } `json:"data"` + Paging util.ListPaging `json:"paging"` +} + +type UpdateMangaData struct { + Status string + IsRereading bool + Score int + VolumesRead int + ChaptersRead int + Priority int + TimesReread int + // NOTE: idk what RereadValue is + RereadValue int + Tags string + Comments string +} -- cgit v1.2.3 From 0edca3b2faf545abc065de55a94b87a10ac3f405 Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Thu, 24 Feb 2022 00:39:10 +0530 Subject: renamed MyListStatus to ListStatus --- anime/README.md | 2 +- anime/anime.structs.go | 2 +- manga/manga.go | 2 +- manga/manga.structs.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/anime/README.md b/anime/README.md index 1040dda..e20f080 100644 --- a/anime/README.md +++ b/anime/README.md @@ -75,7 +75,7 @@ if err != nil { fmt.Println(err) } -fmt.Println(anime.Title, anime.MeanScore, anime.MyListStatus.Status) +fmt.Println(anime.Title, anime.MeanScore, anime.ListStatus.Status) ``` - ### Get anime ranking diff --git a/anime/anime.structs.go b/anime/anime.structs.go index f5fd273..039af12 100644 --- a/anime/anime.structs.go +++ b/anime/anime.structs.go @@ -77,7 +77,7 @@ type Anime struct { MediaType string `json:"media_type"` Status string `json:"status"` Genres []u.Genre `json:"genres"` - MyListStatus ListStatus `json:"my_list_status"` + ListStatus ListStatus `json:"my_list_status"` NumEpisodes int `json:"num_episodes"` StartSeason Season `json:"start_season"` Broadcast Broadcast `json:"broadcast"` diff --git a/manga/manga.go b/manga/manga.go index 35b3a3d..0fd7853 100644 --- a/manga/manga.go +++ b/manga/manga.go @@ -28,7 +28,7 @@ import ( const BASE_URL string = "https://api.myanimelist.net/v2/manga" // MAL Might change this -const maxMangaLimit int = 100 +const maxMangaLimit int = 500 // in MAL documentation this is named Get Manga List func (c Client) SearchManga(searchString string, limit, offset int, fields []string) (MangaSearch, error) { diff --git a/manga/manga.structs.go b/manga/manga.structs.go index b9748c4..7c33c2b 100644 --- a/manga/manga.structs.go +++ b/manga/manga.structs.go @@ -53,7 +53,7 @@ type Manga struct { UpdatedAt string `json:"updated_at"` MediaType string `json:"media_type"` Status string `json:"status"` - MyListStattus ListStatus `json:"my_list_status"` + ListStatus ListStatus `json:"my_list_status"` NumVolumes int `json:"num_volumes"` NumChapters int `json:"num_chapters"` Authors []Author `json:"authors"` -- cgit v1.2.3 From b6235cb6331bac5e1a2d791c78578ebfb298d2eb Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Thu, 24 Feb 2022 00:40:03 +0530 Subject: added validators to check manga status and sort --- errhandlers/manga_validators.go | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/errhandlers/manga_validators.go b/errhandlers/manga_validators.go index fa12e5f..e54107d 100644 --- a/errhandlers/manga_validators.go +++ b/errhandlers/manga_validators.go @@ -68,3 +68,29 @@ func IsValidMangaRankingType(rankingType string) bool { } return false } + +// Checks if given sort is valid +func IsValidMangaListSort(sort string) bool { + switch sort { + case + "list_score", + "list_updated_at", + "manga_title", + "manga_start_date", + "manga_id": return true + } + return false +} + +// Checks if given list status is valid +func IsValidMangaListStatus(status string) bool { + switch status { + case + "reading", + "completed", + "on_hold", + "dropped", + "plan_to_read": return true + } + return false +} -- cgit v1.2.3 From 0f321b7c4691923ead42a9b020da98dce1196d07 Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Thu, 24 Feb 2022 00:43:23 +0530 Subject: modified the endpoints to meet requirements for updating manga --- user/manga/README.md | 19 ++++++++ user/manga/mangalist.go | 92 +++++++++++++++++++++++++++++++++++++++ user/manga/mangalist.structs.go | 9 +++- user/manga/request_handler.go | 96 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 215 insertions(+), 1 deletion(-) create mode 100644 user/manga/README.md create mode 100644 user/manga/mangalist.go create mode 100644 user/manga/request_handler.go diff --git a/user/manga/README.md b/user/manga/README.md new file mode 100644 index 0000000..1a6c636 --- /dev/null +++ b/user/manga/README.md @@ -0,0 +1,19 @@ +# MAL2Go/user +MAL2Go `user/anime` package has functionality related to updating the user's anime list. + +## Usage +Firstly, import this package and instanciate the client. +``` go +import ( + "github.com/MikunoNaka/MAL2Go/user/anime" +) +``` + +Now instanciate with +``` go +myClient := anime.Client { + AuthToken: "Bearer " + yourTokenHere, +} +``` + +**More to be added later** diff --git a/user/manga/mangalist.go b/user/manga/mangalist.go new file mode 100644 index 0000000..392e844 --- /dev/null +++ b/user/manga/mangalist.go @@ -0,0 +1,92 @@ +/* MAL2Go - MyAnimeList V2 API wrapper for Go + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ + +package manga + +import ( + "encoding/json" + "strconv" + "fmt" + "errors" + e "github.com/MikunoNaka/MAL2Go/errhandlers" +) + +const BASE_URL string = "https://api.myanimelist.net/v2" +const maxListLimit int = 1000 + +// Delete a manga from user's manga list +func (c Client)DeleteManga(id int) string { + endpoint := fmt.Sprintf("%s/manga/%d/my_list_status", BASE_URL, id) + /* Returns 200 if manga successfully deleted + * Alternatively returns 404 if manga not in user's manga list */ + return c.requestHandler(endpoint, "DELETE") +} + +// Get authenticated user's manga list +func (c Client) GetMangaList(user, status, sort string, limit, offset int) (MangaList, error){ + var userMangaList MangaList + // error handling for limit + limitErr := e.LimitErrHandler(limit, maxListLimit) + if limitErr != nil { + return userMangaList, limitErr + } + + // checks if valid sort is specified + if !e.IsValidMangaListSort(sort) { + return userMangaList, errors.New(fmt.Sprintf("GetMangaList: Invalid sort specified: \"%s\"", sort)) + } + + // checks if valid status is specified + if status != "" && !e.IsValidMangaListStatus(status) { + return userMangaList, errors.New(fmt.Sprintf("GetMangaList: Invalid status specified: \"%s\"", status)) + } + + // get own list if user not specified + if user == "" { + user = "@me" + } + + // if status is "" it returns all anime + var endpoint string + if status == "" { + endpoint = BASE_URL + "/users/" + user + "/mangalist?sort=" + sort + "&limit=" + strconv.Itoa(limit) + "&offset=" + strconv.Itoa(offset) + } else { + endpoint = BASE_URL + "/users/" + user + "/mangalist?status=" + status + "&sort=" + sort + "&limit=" + strconv.Itoa(limit) + "&offset=" + strconv.Itoa(offset) + } + + // get data from API + var mangaListData MangaListRaw + data := c.requestHandler(endpoint, "GET") + json.Unmarshal([]byte(data), &mangaListData) + + // set MyListStatus for each element and add it to array + var mangas []Manga + for _, element := range mangaListData.Data { + a := element.Manga + a.ListStatus = element.ListStatus + + mangas = append(mangas, a) + } + + // finally create AnimeList + userMangaList = MangaList { + Mangas: mangas, + Paging: mangaListData.Paging, + } + + return userMangaList, nil +} + diff --git a/user/manga/mangalist.structs.go b/user/manga/mangalist.structs.go index 860163b..0ea7d70 100644 --- a/user/manga/mangalist.structs.go +++ b/user/manga/mangalist.structs.go @@ -21,14 +21,21 @@ import ( "github.com/MikunoNaka/MAL2Go/manga" ) +type Manga manga.Manga + type MangaListRaw struct { Data []struct { - Manga manga.Manga `json:"node"` + Manga Manga `json:"node"` ListStatus manga.ListStatus `json:"list_status"` } `json:"data"` Paging util.ListPaging `json:"paging"` } +type MangaList struct { + Mangas []Manga + Paging util.ListPaging +} + type UpdateMangaData struct { Status string IsRereading bool diff --git a/user/manga/request_handler.go b/user/manga/request_handler.go new file mode 100644 index 0000000..ff2b0df --- /dev/null +++ b/user/manga/request_handler.go @@ -0,0 +1,96 @@ +/* MAL2Go - MyAnimeList V2 API wrapper for Go + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ + +package manga + +import ( + "encoding/json" + "io/ioutil" + "log" + "net/http" + "net/url" + "strconv" + "strings" +) + +type serverResponse struct { + Message string + Error string +} + +// Handles HTTP request with your OAuth token as a Header +func (c Client) requestHandler(endpoint, method string) string { + // generate request + req, err := http.NewRequest(method, endpoint, nil) + if err != nil { + log.Fatal(err) + } + req.Header.Add("Authorization", c.AuthToken) + + // do request + res, err := c.HttpClient.Do(req) + if err != nil { + log.Fatal(err) + } + defer res.Body.Close() + + // read body + body, err := ioutil.ReadAll(res.Body) + if err != nil { + log.Fatal(err) + } + + // for DeleteAnime, its endpoint returns null data + if method == "DELETE" { + return strconv.Itoa(res.StatusCode) + } + + return string(body) +} + +// for PUT requests (used for updating anime) +func (c Client) putRequestHandler(endpoint string, params url.Values) serverResponse { + paramsEncoded := params.Encode() + + // generate request + req, err := http.NewRequest(http.MethodPut, endpoint, strings.NewReader(paramsEncoded)) + if err != nil { + log.Fatal(err) + } + req.Header.Add("Authorization", c.AuthToken) + // this makes the sending-data-to-server magic work + req.Header.Add("Content-Type", "application/x-www-form-urlencoded") + req.Header.Add("Content-Length", strconv.Itoa(len(paramsEncoded))) + + // do request + res, err := c.HttpClient.Do(req) + if err != nil { + log.Fatal(err) + } + defer res.Body.Close() + + // read body + body, err := ioutil.ReadAll(res.Body) + if err != nil { + log.Fatal(err) + } + + // TODO: there are other serverResponses. Add them + // server response, ie message / error + var resp serverResponse + json.Unmarshal(body, &resp) + + return resp +} -- cgit v1.2.3 From e4f90575f920cbd429814dfc27a775c0666bf718 Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Thu, 24 Feb 2022 20:39:40 +0530 Subject: error fix: refer to commit 58 in main --- user/anime/animelist.go | 2 +- user/anime/animelist.structs.go | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/user/anime/animelist.go b/user/anime/animelist.go index 6516184..b27efc0 100644 --- a/user/anime/animelist.go +++ b/user/anime/animelist.go @@ -77,7 +77,7 @@ func (c Client) GetAnimeList(user, status, sort string, limit, offset int) (a.An var animes []a.Anime for _, element := range animeListData.Data { a := element.Anime - a.MyListStatus = element.ListStatus + a.ListStatus = element.ListStatus animes = append(animes, a) } diff --git a/user/anime/animelist.structs.go b/user/anime/animelist.structs.go index 31296fa..80eb01a 100644 --- a/user/anime/animelist.structs.go +++ b/user/anime/animelist.structs.go @@ -17,7 +17,6 @@ package anime import ( - "github.com/MikunoNaka/MAL2Go/util" "github.com/MikunoNaka/MAL2Go/anime" ) @@ -26,7 +25,7 @@ type AnimeListRaw struct { Anime anime.Anime `json:"node"` ListStatus anime.ListStatus `json:"list_status"` } `json:"data"` - Paging util.ListPaging `json:"paging"` + Paging anime.ListPaging `json:"paging"` } type UpdateAnimeData struct { -- cgit v1.2.3 From 314d9bf6cad4bebec431a217c23016680c56179b Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Thu, 24 Feb 2022 21:40:43 +0530 Subject: moved DefaultListStatus back to each package seperately --- anime/anime.structs.go | 24 ++++++++++++++++++------ manga/manga.structs.go | 11 ++++++++++- user/anime/animelist.go | 8 ++++---- util/structs.go | 11 ----------- 4 files changed, 32 insertions(+), 22 deletions(-) diff --git a/anime/anime.structs.go b/anime/anime.structs.go index 039af12..4132989 100644 --- a/anime/anime.structs.go +++ b/anime/anime.structs.go @@ -47,7 +47,16 @@ type Recommendation struct { } type ListStatus struct { - u.DefaultListStatus + Status string `json:"status"` + Score int `json:"score"` + StartDate string `json:"start_date"` + FinishDate string `json:"finish_date"` + Priority int `json:"priority"` + Tags string `json:"tags"` + Comments string `json:"comments"` + UpdatedAt string `json:"updated_at"` + + // these fields are exclusive to anime EpWatched int `json:"num_watched_episodes"` IsRewatching bool `json:"is_rewatching"` TimesRewatched int `json:"num_times_rewatched"` @@ -68,16 +77,19 @@ type Anime struct { NumListUsers int `json:"num_list_users"` NumScoringUsers int `json:"num_scoring_users"` /* NsfwStatus potential values: - * white = sfw - * gray = probably nsfw - * black = nsfw */ + * white = sfw + * gray = probably nsfw + * black = nsfw */ NsfwStatus string `json:"nsfw"` CreatedAt string `json:"created_at"` UpdatedAt string `json:"updated_at"` MediaType string `json:"media_type"` Status string `json:"status"` - Genres []u.Genre `json:"genres"` - ListStatus ListStatus `json:"my_list_status"` + Genres []u.Genre `json:"genres"` + /* MyListStatus refers to the authenticated user's info + * while ListStatus can be used for other users */ + MyListStatus ListStatus `json:"my_list_status"` + ListStatus ListStatus `json:"list_status"` NumEpisodes int `json:"num_episodes"` StartSeason Season `json:"start_season"` Broadcast Broadcast `json:"broadcast"` diff --git a/manga/manga.structs.go b/manga/manga.structs.go index 7c33c2b..2fb5b29 100644 --- a/manga/manga.structs.go +++ b/manga/manga.structs.go @@ -27,7 +27,16 @@ type Author struct { } type ListStatus struct { - util.DefaultListStatus + Status string `json:"status"` + Score int `json:"score"` + StartDate string `json:"start_date"` + FinishDate string `json:"finish_date"` + Priority int `json:"priority"` + Tags string `json:"tags"` + Comments string `json:"comments"` + UpdatedAt string `json:"updated_at"` + + // thsese fields are exclusive to manga VolumesRead int `json:"num_volumes_read"` ChaptersRead int `json:"num_chapters_read"` IsRereading bool `json:"is_rereading"` diff --git a/user/anime/animelist.go b/user/anime/animelist.go index b27efc0..f9ddff5 100644 --- a/user/anime/animelist.go +++ b/user/anime/animelist.go @@ -73,13 +73,13 @@ func (c Client) GetAnimeList(user, status, sort string, limit, offset int) (a.An data := c.requestHandler(endpoint, "GET") json.Unmarshal([]byte(data), &animeListData) - // set MyListStatus for each element and add it to array + // set ListStatus for each element and add it to array var animes []a.Anime for _, element := range animeListData.Data { - a := element.Anime - a.ListStatus = element.ListStatus + anime := element.Anime + anime.ListStatus = element.ListStatus - animes = append(animes, a) + animes = append(animes, anime) } // finally create AnimeList diff --git a/util/structs.go b/util/structs.go index 1483d3f..600ec94 100644 --- a/util/structs.go +++ b/util/structs.go @@ -77,17 +77,6 @@ type Genre struct { Name string `json:"name"` } -type DefaultListStatus struct { - Status string `json:"status"` - Score int `json:"score"` - StartDate string `json:"start_date"` - FinishDate string `json:"finish_date"` - Priority int `json:"priority"` - Tags string `json:"tags"` - Comments string `json:"comments"` - UpdatedAt string `json:"updated_at"` -} - type AltTitles struct { Synonyms []string `json:"synonyms"` En string `json:"en"` -- cgit v1.2.3 From 10499ad3cf8db85a5c5ebd8112415d17a727c2ec Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Thu, 24 Feb 2022 22:05:32 +0530 Subject: added fields support for GetAnimeList --- user/anime/animelist.go | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/user/anime/animelist.go b/user/anime/animelist.go index f9ddff5..f6d9965 100644 --- a/user/anime/animelist.go +++ b/user/anime/animelist.go @@ -23,6 +23,7 @@ import ( "errors" a "github.com/MikunoNaka/MAL2Go/anime" e "github.com/MikunoNaka/MAL2Go/errhandlers" + u "github.com/MikunoNaka/MAL2Go/util" ) const BASE_URL string = "https://api.myanimelist.net/v2" @@ -37,7 +38,7 @@ func (c Client)DeleteAnime(id int) string { } // Get authenticated user's anime list -func (c Client) GetAnimeList(user, status, sort string, limit, offset int) (a.AnimeList, error){ +func (c Client) GetAnimeList(user, status, sort string, limit, offset int, fields []string) (a.AnimeList, error){ var userAnimeList a.AnimeList // error handling for limit limitErr := e.LimitErrHandler(limit, maxListLimit) @@ -45,6 +46,15 @@ func (c Client) GetAnimeList(user, status, sort string, limit, offset int) (a.An return userAnimeList, limitErr } + // handle all the errors for the fields + fields, err := e.FieldsErrHandler(fields) + if err != nil { + return userAnimeList, err + } + + // append "list_status" field only used by this func. + fields = append(fields, "list_status") + // checks if valid sort is specified if !e.IsValidListSort(sort) { return userAnimeList, errors.New(fmt.Sprintf("GetAnimeList: Invalid sort specified: \"%s\"", sort)) @@ -60,14 +70,26 @@ func (c Client) GetAnimeList(user, status, sort string, limit, offset int) (a.An user = "@me" } - // if status is "" it returns all anime var endpoint string + // if status is "" it returns all anime if status == "" { - endpoint = BASE_URL + "/users/" + user + "/animelist?sort=" + sort + "&limit=" + strconv.Itoa(limit) + "&offset=" + strconv.Itoa(offset) + endpoint, _ = u.UrlGenerator( + BASE_URL + "/users/" + user + "/animelist", + []string{"sort", "limit", "offset", "fields"}, + [][]string{{sort}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, + true, + ) } else { - endpoint = BASE_URL + "/users/" + user + "/animelist?status=" + status + "&sort=" + sort + "&limit=" + strconv.Itoa(limit) + "&offset=" + strconv.Itoa(offset) + // status gets included if specified + endpoint, _ = u.UrlGenerator( + BASE_URL + "/users/" + user + "/animelist", + []string{"status", "sort", "limit", "offset", "fields"}, + [][]string{{status}, {sort}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, + true, + ) } + // get data from API var animeListData AnimeListRaw data := c.requestHandler(endpoint, "GET") -- cgit v1.2.3 From 017df270608e286c8ce85683629d5c2dcf400988 Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Thu, 24 Feb 2022 22:17:51 +0530 Subject: fixed mutliple bugs in GetMangaList --- manga/manga.structs.go | 5 ++++- user/manga/mangalist.go | 29 +++++++++++++++++++++++++---- 2 files changed, 29 insertions(+), 5 deletions(-) diff --git a/manga/manga.structs.go b/manga/manga.structs.go index 2fb5b29..e863d00 100644 --- a/manga/manga.structs.go +++ b/manga/manga.structs.go @@ -62,7 +62,10 @@ type Manga struct { UpdatedAt string `json:"updated_at"` MediaType string `json:"media_type"` Status string `json:"status"` - ListStatus ListStatus `json:"my_list_status"` + /* MyListStatus refers to the authenticated user's info + * while ListStatus can be used for other users */ + MyListStatus ListStatus `json:"my_list_status"` + ListStatus ListStatus `json:"list_status"` NumVolumes int `json:"num_volumes"` NumChapters int `json:"num_chapters"` Authors []Author `json:"authors"` diff --git a/user/manga/mangalist.go b/user/manga/mangalist.go index 392e844..009a65c 100644 --- a/user/manga/mangalist.go +++ b/user/manga/mangalist.go @@ -22,6 +22,7 @@ import ( "fmt" "errors" e "github.com/MikunoNaka/MAL2Go/errhandlers" + u "github.com/MikunoNaka/MAL2Go/util" ) const BASE_URL string = "https://api.myanimelist.net/v2" @@ -36,7 +37,7 @@ func (c Client)DeleteManga(id int) string { } // Get authenticated user's manga list -func (c Client) GetMangaList(user, status, sort string, limit, offset int) (MangaList, error){ +func (c Client) GetMangaList(user, status, sort string, limit, offset int, fields []string) (MangaList, error){ var userMangaList MangaList // error handling for limit limitErr := e.LimitErrHandler(limit, maxListLimit) @@ -44,6 +45,15 @@ func (c Client) GetMangaList(user, status, sort string, limit, offset int) (Mang return userMangaList, limitErr } + // handle all the errors for the fields + fields, err := e.FieldsErrHandler(fields) + if err != nil { + return userMangaList, err + } + + // append "list_status" field only used by this func. + fields = append(fields, "list_status") + // checks if valid sort is specified if !e.IsValidMangaListSort(sort) { return userMangaList, errors.New(fmt.Sprintf("GetMangaList: Invalid sort specified: \"%s\"", sort)) @@ -59,12 +69,23 @@ func (c Client) GetMangaList(user, status, sort string, limit, offset int) (Mang user = "@me" } - // if status is "" it returns all anime var endpoint string + // if status is "" it returns all anime if status == "" { - endpoint = BASE_URL + "/users/" + user + "/mangalist?sort=" + sort + "&limit=" + strconv.Itoa(limit) + "&offset=" + strconv.Itoa(offset) + endpoint, _ = u.UrlGenerator( + BASE_URL + "/users/" + user + "/mangalist", + []string{"sort", "limit", "offset", "fields"}, + [][]string{{sort}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, + true, + ) } else { - endpoint = BASE_URL + "/users/" + user + "/mangalist?status=" + status + "&sort=" + sort + "&limit=" + strconv.Itoa(limit) + "&offset=" + strconv.Itoa(offset) + // status gets included if specified + endpoint, _ = u.UrlGenerator( + BASE_URL + "/users/" + user + "/mangalist", + []string{"status", "sort", "limit", "offset", "fields"}, + [][]string{{status}, {sort}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, + true, + ) } // get data from API -- cgit v1.2.3 From 38f7861cc533081aba7458ef52a25acdeddd1f16 Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Sun, 27 Feb 2022 17:43:51 +0530 Subject: added functionality to update manga lists --- user/manga/update_mangalist.go | 203 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) create mode 100644 user/manga/update_mangalist.go diff --git a/user/manga/update_mangalist.go b/user/manga/update_mangalist.go new file mode 100644 index 0000000..cac27e8 --- /dev/null +++ b/user/manga/update_mangalist.go @@ -0,0 +1,203 @@ +/* MAL2Go - MyAnimeList V2 API wrapper for Go + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ + +package manga + +import ( + e "github.com/MikunoNaka/MAL2Go/errhandlers" + "errors" + "fmt" + "net/url" + "strconv" +) + +// generate the endpoint url with the manga id +func endpointGenerator(id int) string { + return fmt.Sprintf(BASE_URL + "/manga/%d/my_list_status", id) +} + +// update just an manga's status +func (c Client)SetStatus(id int, status string) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // checks if specified list status is valid + if !e.IsValidMangaListStatus(status) { + return serverResponse{}, errors.New(fmt.Sprintf("SetStatus: Invalid list status: \"%s\"", status)) + } + + // data to be sent to the server + params := url.Values{} + params.Set("status", status) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just a manga's num of chapters read +func (c Client)SetChaptersRead(id int, chapters int) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // data to be sent to the server + params := url.Values{} + params.Set("num_chapters_read", strconv.Itoa(chapters)) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just a manga's rereading status +func (c Client)SetIsRereading(id int, isRereading bool) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // data to be sent to the server + params := url.Values{} + params.Set("is_rereading", strconv.FormatBool(isRereading)) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just the manga's score +func (c Client)SetScore(id int, score int) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // checks if specified score is valid + if !e.IsValidScore(score) { + return serverResponse{}, errors.New(fmt.Sprintf("SetScore: Invalid score: %d doesn't lie within 0-10", score)) + } + + // data to be sent to the server + params := url.Values{} + params.Set("score", strconv.Itoa(score)) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just a manga's priority +func (c Client)SetPriority(id int, priority int) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // checks if specified priority is valid + if !e.IsValidPriority(priority) { + return serverResponse{}, errors.New(fmt.Sprintf("SetPriority: Invalid priority: %d doesn't lie within 0-2", priority)) + } + + // data to be sent to the server + params := url.Values{} + params.Set("priority", strconv.Itoa(priority)) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just a manga's reread value +func (c Client)SetRereadValue(id int, rereadValue int) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // checks if specified reread value is valid + if !e.IsValidRewatchValue(rereadValue) { + return serverResponse{}, errors.New(fmt.Sprintf("SetRereadValue: Invalid rewatch value: %d doesn't lie within 0-5", rereadValue)) + } + + // data to be sent to the server + params := url.Values{} + params.Set("reread_value", strconv.Itoa(rereadValue)) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just a manga's reread count +func (c Client)SetRereadCount(id int, rereadCount int) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // data to be sent to the server + params := url.Values{} + params.Set("num_times_reread", strconv.Itoa(rereadCount)) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just a manga's tags +func (c Client)UpdateTags(id int, tags string) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // data to be sent to the server + params := url.Values{} + params.Set("tags", tags) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +// update just a manga's comments +func (c Client)UpdateComments(id int, comments string) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // data to be sent to the server + params := url.Values{} + params.Set("comments", comments) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + +/* NOTE: This will overwrite everything + * i won't use it.. but it's pretty flexible + * so this will stay here */ +// Update/Add a manga to user's manga list +func (c Client)UpdateManga(id int, data UpdateMangaData) (serverResponse, error) { + endpoint := endpointGenerator(id) + + // checks if specified list status is valid + if !e.IsValidMangaListStatus(data.Status) { + return serverResponse{}, errors.New(fmt.Sprintf("UpdateManga: Invalid list status: \"%s\"", data.Status)) + } + + // checks if specified score is valid + if !e.IsValidScore(data.Score) { + return serverResponse{}, errors.New(fmt.Sprintf("UpdateManga: Invalid score: %d doesn't lie within 0-10", data.Score)) + } + + // checks if specified priority is valid + if !e.IsValidPriority(data.Priority) { + return serverResponse{}, errors.New(fmt.Sprintf("UpdateManga: Invalid priority: %d doesn't lie within 0-2", data.Priority)) + } + + // checks if specified rewatch value is valid + if !e.IsValidRewatchValue(data.RereadValue) { + return serverResponse{}, errors.New(fmt.Sprintf("UpdateManga: Invalid reread value: %d doesn't lie within 0-5", data.RereadValue)) + } + + params := url.Values{} + + /* NOTE: THIS WILL OVERWRITE ANY DATA THAT + * IS NOT SPECIFIED AND SET IT TO NULL */ + params.Set("status", data.Status) + params.Set("is_rereading", strconv.FormatBool(data.IsRereading)) + params.Set("score", strconv.Itoa(data.Score)) + params.Set("num_chapters_read", strconv.Itoa(data.ChaptersRead)) + params.Set("priority", strconv.Itoa(data.Priority)) + params.Set("num_times_reread", strconv.Itoa(data.TimesReread)) + params.Set("reread_value", strconv.Itoa(data.RereadValue)) + params.Set("tags", data.Tags) + params.Set("comments", data.Comments) + + // make API request + return c.putRequestHandler(endpoint, params), nil +} + -- cgit v1.2.3