From 5e01fb1297e25314184effe2c9f9fbbda0e512fb Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Wed, 23 Feb 2022 20:52:09 +0530 Subject: Pushing barebones manga package --- anime/anime.structs.go | 48 +++++++++---------------------- anime/general.structs.go | 9 +++--- manga/README.md | 45 +++++++++++++++++++++++++++++ manga/client.go | 23 +++++++++++++++ manga/manga.structs.go | 64 +++++++++++++++++++++++++++++++++++++++++ manga/request_handler.go | 48 +++++++++++++++++++++++++++++++ manga/search.structs.go | 32 +++++++++++++++++++++ user/anime/animelist.structs.go | 3 +- util/structs.go | 46 +++++++++++++++++++++++++++++ 9 files changed, 279 insertions(+), 39 deletions(-) create mode 100644 manga/README.md create mode 100644 manga/client.go create mode 100644 manga/manga.structs.go create mode 100644 manga/request_handler.go create mode 100644 manga/search.structs.go diff --git a/anime/anime.structs.go b/anime/anime.structs.go index c7b4f00..f5fd273 100644 --- a/anime/anime.structs.go +++ b/anime/anime.structs.go @@ -16,37 +16,15 @@ package anime -type AnimePicture struct { - Medium string `json:"large"` - Large string `json:"medium"` -} - -type StatusStatistics struct { - Watching string `json:"watching"` - Completed string `json:"completed"` - OnHold string `json:"on_hold"` - Dropped string `json:"dropped"` - PlanToWatch string `json:"plan_to_watch"` -} +import ( + u "github.com/MikunoNaka/MAL2Go/util" +) type AnimeStatistics struct { - Status StatusStatistics `json:"status"` + Status u.StatusStatistics `json:"status"` NumListUsers int `json:"num_list_users"` } -type Genre struct { - Id int `json:"id"` - Name string `json:"name"` -} - -type ListStatus struct { - Status string `json:"status"` - Score int `json:"score"` - EpWatched int `json:"num_episodes_watched"` - IsRewatching bool `json:"is_rewatching"` - UpdatedAt string `json:"updated_at"` -} - type Broadcast struct { Day string `json:"day_of_the_week"` Time string `json:"start_time"` @@ -68,17 +46,19 @@ type Recommendation struct { Num int `json:"num_recommendations"` } -type AltTitles struct { - Synonyms []string `json:"synonyms"` - En string `json:"en"` - Ja string `json:"ja"` +type ListStatus struct { + u.DefaultListStatus + EpWatched int `json:"num_watched_episodes"` + IsRewatching bool `json:"is_rewatching"` + TimesRewatched int `json:"num_times_rewatched"` + RewatchValue int `json:"rewatch_value"` } type Anime struct { Id int `json:"id"` Title string `json:"title"` - MainPicture AnimePicture `json:"main_picture"` - AltTitles AltTitles `json:"alternative_titles"` + MainPicture u.Picture `json:"main_picture"` + AltTitles u.AltTitles `json:"alternative_titles"` StartDate string `json:"start_date"` EndDate string `json:"end_date"` Synopsis string `json:"synopsis"` @@ -96,7 +76,7 @@ type Anime struct { UpdatedAt string `json:"updated_at"` MediaType string `json:"media_type"` Status string `json:"status"` - Genres []Genre `json:"genres"` + Genres []u.Genre `json:"genres"` MyListStatus ListStatus `json:"my_list_status"` NumEpisodes int `json:"num_episodes"` StartSeason Season `json:"start_season"` @@ -105,7 +85,7 @@ type Anime struct { DurationSeconds int `json:"average_episode_duration"` // Rating as in R, PG13, etc Rating string `json:"rating"` - Pictures []AnimePicture `json:"pictures"` + Pictures []u.Picture `json:"pictures"` Background string `json:"background"` RelatedAnime []Related `json:"related_anime"` Recommendations []Recommendation `json:"recommendations"` diff --git a/anime/general.structs.go b/anime/general.structs.go index 47309c3..152eb28 100644 --- a/anime/general.structs.go +++ b/anime/general.structs.go @@ -16,11 +16,12 @@ package anime +import ( + "github.com/MikunoNaka/MAL2Go/util" +) + // contains previous/next page for anime list -type ListPaging struct { - NextPage string `json:"next"` - PrevPage string `json:"previous"` // might need checking -} +type ListPaging util.ListPaging type Season struct { Year int `json:"year"` diff --git a/manga/README.md b/manga/README.md new file mode 100644 index 0000000..74a97a3 --- /dev/null +++ b/manga/README.md @@ -0,0 +1,45 @@ +# MAL2Go/manga +MAL2Go `manga` package has functionality related to getting data about anime. + +## Installation +In a terminal, run +``` fish +go get "github.com/MikunoNaka/MAL2Go/manga" +``` + +## Usage +Firstly, import this package and instanciate the client. +``` go +import ( + "github.com/MikunoNaka/MAL2Go/manga" +) +``` + +Now instanciate with +``` go +myClient := manga.Client { + AuthToken: "Bearer " + yourTokenHere, +} +``` + +- ### Searching for a manga +``` go +``` + +- ### Getting a manga's info +``` go +``` + +- ### Get manga ranking +``` go +``` + +## Structure +- [manga.go](anime.go) +Contains all the exported functions for pulling data from the API. + +- [manga.structs.go](anime.structs.go) +Contains all the structs representing a manga entry on MyAnimeList. + +- [client.go](client.go) +The Client for accessing the API with this package. diff --git a/manga/client.go b/manga/client.go new file mode 100644 index 0000000..272bfff --- /dev/null +++ b/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/manga/manga.structs.go b/manga/manga.structs.go new file mode 100644 index 0000000..b9748c4 --- /dev/null +++ b/manga/manga.structs.go @@ -0,0 +1,64 @@ +/* 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 ListPaging util.ListPaging + +type Author struct { + // TODO: add stuff +} + +type ListStatus struct { + util.DefaultListStatus + VolumesRead int `json:"num_volumes_read"` + ChaptersRead int `json:"num_chapters_read"` + IsRereading bool `json:"is_rereading"` + TimesReread int `json:"num_times_reread"` + RereadValue int `json:"reread_value"` +} + +type Manga struct { + Id int `json:"id"` + Title string `json:"title"` + MainPicture util.Picture `json:"main_picture"` + AltTitles util.AltTitles `json:"alternative_titles"` + StartDate string `json:"start_date"` + EndDate string `json:"end_date"` + Synopsis string `json:"synopsis"` + MeanScore float32 `json:"mean"` + Rank int `json:"rank"` + Popularity int `json:"popularity"` + NumListUsers int `json:"num_list_users"` + NsfwStatus string `json:"nsfw"` + Genres []util.Genre `json:"genres"` + CreatedAt string `json:"created_at"` + UpdatedAt string `json:"updated_at"` + MediaType string `json:"media_type"` + Status string `json:"status"` + MyListStattus ListStatus `json:"my_list_status"` + NumVolumes int `json:"num_volumes"` + NumChapters int `json:"num_chapters"` + Authors []Author `json:"authors"` + Pictures []util.Picture `json:"pictures"` + Background string `json:"background"` + /* TODO add these fields: + * related_anime, related_manga, recommendations, serialization */ +} diff --git a/manga/request_handler.go b/manga/request_handler.go new file mode 100644 index 0000000..892289b --- /dev/null +++ b/manga/request_handler.go @@ -0,0 +1,48 @@ +/* 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 ( + "io/ioutil" + "log" + "net/http" +) + +// Handles HTTP request with your OAuth token as a Header +func (c Client) requestHandler(endpoint string) string { + // generate request + req, err := http.NewRequest("GET", 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) + } + + return string(body) +} diff --git a/manga/search.structs.go b/manga/search.structs.go new file mode 100644 index 0000000..af154a9 --- /dev/null +++ b/manga/search.structs.go @@ -0,0 +1,32 @@ +/* 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 + +// this is how the API returns data (looks horrible) +type MangaSearchRaw struct { + Data []struct { + Manga Manga `json:"node"` + } `json:"data"` + + Paging ListPaging `json:"paging"` +} + +// this is how mal2go returns data +type AnimeSearch struct { + Mangas []Manga + Paging ListPaging +} diff --git a/user/anime/animelist.structs.go b/user/anime/animelist.structs.go index 80eb01a..31296fa 100644 --- a/user/anime/animelist.structs.go +++ b/user/anime/animelist.structs.go @@ -17,6 +17,7 @@ package anime import ( + "github.com/MikunoNaka/MAL2Go/util" "github.com/MikunoNaka/MAL2Go/anime" ) @@ -25,7 +26,7 @@ type AnimeListRaw struct { Anime anime.Anime `json:"node"` ListStatus anime.ListStatus `json:"list_status"` } `json:"data"` - Paging anime.ListPaging `json:"paging"` + Paging util.ListPaging `json:"paging"` } type UpdateAnimeData struct { diff --git a/util/structs.go b/util/structs.go index b17f1f7..4eb6325 100644 --- a/util/structs.go +++ b/util/structs.go @@ -34,3 +34,49 @@ var DefaultFields []string = []string{ "related_manga", "recommendations", "studios", "statistics", } + +// contains previous/next page for anime list +// we don't actually need this. +// TODO: for compatibility's sake, keep this but also define methods +// to get the prev. and next page's elements automatically +type ListPaging struct { + NextPage string `json:"next"` + PrevPage string `json:"previous"` +} + +/* these structs are used + * both by anime and manga package */ +type Picture struct { + Medium string `json:"medium"` + Large string `json:"large"` +} + +type StatusStatistics struct { + Watching string `json:"watching"` + Completed string `json:"completed"` + OnHold string `json:"on_hold"` + Dropped string `json:"dropped"` + PlanToWatch string `json:"plan_to_watch"` +} + +type Genre struct { + Id int `json:"id"` + 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"` + Ja string `json:"ja"` +} -- cgit v1.2.3 From a92af9a2dd6ac31db2024bdaab06df2da2d4face Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Wed, 23 Feb 2022 21:01:22 +0530 Subject: pushing first working endpoint: SearchManga --- manga/manga.go | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ manga/search.structs.go | 2 +- 2 files changed, 159 insertions(+), 1 deletion(-) create mode 100644 manga/manga.go diff --git a/manga/manga.go b/manga/manga.go new file mode 100644 index 0000000..dd79db2 --- /dev/null +++ b/manga/manga.go @@ -0,0 +1,158 @@ +/* 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" + // "errors" + // "fmt" + "strconv" + e "github.com/MikunoNaka/MAL2Go/errhandlers" + u "github.com/MikunoNaka/MAL2Go/util" +) + +const BASE_URL string = "https://api.myanimelist.net/v2/manga" + +// MAL Might change this +const maxMangaLimit int = 100 + +// in MAL documentation this is named Get Manga List +func (c Client) SearchManga(searchString string, limit, offset int, fields []string) (MangaSearch, error) { + var searchResults MangaSearch + + // error handling for limit + limitErr := e.LimitErrHandler(limit, maxMangaLimit) + if limitErr != nil { + return searchResults, limitErr + } + + // handle all the errors for the fields + fields, err := e.FieldsErrHandler(fields) + if err != nil { + return searchResults, err + } + + // generate endpoint url with custom params + endpoint, _ := u.UrlGenerator( + BASE_URL, + []string{"q", "limit", "offset", "fields"}, + [][]string{{searchString}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, + true, + ) + + // gets data from API and stores it in a struct + var mangaSearchData MangaSearchRaw + data := c.requestHandler(endpoint) + json.Unmarshal([]byte(data), &mangaSearchData) + + // Adding all the mangas to another list to get formatted results later + var mangas []Manga + for _, element := range mangaSearchData.Data { + mangas = append(mangas, element.Manga) + } + + // finally generate AnimeList + searchResults = MangaSearch { + Mangas: mangas, + Paging: mangaSearchData.Paging, + } + + return searchResults, nil +} + +// // Each anime has its own ID on MAL +// func (c Client) GetAnimeById(animeId int, fields []string) (Anime, error) { +// var anime Anime +// +// // handle all the errors for the fields +// fields, err := e.FieldsErrHandler(fields) +// if err != nil { +// return anime, err +// } +// +// endpoint, _ := u.UrlGenerator( +// BASE_URL + "/" + strconv.Itoa(animeId), +// []string{"fields"}, +// /* it seems to still return all fields from the API. +// * this might be an issue with MAL itself +// * TODO: look into this */ +// [][]string{fields}, +// true, +// ) +// +// data := c.requestHandler(endpoint) +// json.Unmarshal([]byte(data), &anime) +// +// return anime, nil +// } + +// // Ranking is a list of anime sorted by their rank +// func (c Client) GetAnimeRanking(rankingType string, limit, offset int, fields []string) (AnimeRanking, error) { +// var animeRanking AnimeRanking +// +// // error handling for limit +// limitErr := e.LimitErrHandler(limit, maxAnimeLimit) +// if limitErr != nil { +// return animeRanking, limitErr +// } +// +// // handle all the errors for the fields +// fields, err := e.FieldsErrHandler(fields) +// if err != nil { +// return animeRanking, err +// } +// +// // if ranking type is invalid +// if !e.IsValidRankingType(rankingType) { +// return animeRanking, errors.New(fmt.Sprintf("GetAnimeRanking: Invalid ranking type specified: \"%s\"", rankingType)) +// } +// +// endpoint, _ := u.UrlGenerator( +// BASE_URL + "/ranking", +// []string{"ranking_type", "limit", "offset", "fields"}, +// [][]string{{rankingType}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, +// true, +// ) +// +// // gets data from API and stores it in a struct +// var rankingData RawRanking +// data := c.requestHandler(endpoint) +// json.Unmarshal([]byte(data), &rankingData) +// +// // Adding all the animes in ranking list to a slice +// var animeRankingTitles []AnimeRankingTitle +// for _, element := range rankingData.Data { +// animeRankingTitles = append( +// animeRankingTitles, +// AnimeRankingTitle { +// Anime: element.Anime, +// RankNum: element.Ranking.Rank, +// }, +// ) +// } +// +// // Finally, create the AnimeRanking object +// animeRanking = AnimeRanking { +// Titles: animeRankingTitles, +// Paging: ListPaging { +// NextPage: rankingData.Paging.NextPage, +// PrevPage: rankingData.Paging.PrevPage, +// }, +// } +// +// return animeRanking, nil +// } diff --git a/manga/search.structs.go b/manga/search.structs.go index af154a9..d2da279 100644 --- a/manga/search.structs.go +++ b/manga/search.structs.go @@ -26,7 +26,7 @@ type MangaSearchRaw struct { } // this is how mal2go returns data -type AnimeSearch struct { +type MangaSearch struct { Mangas []Manga Paging ListPaging } -- cgit v1.2.3 From 7a68abbc9e492934cf4170d5a0ff52a456fe92bd Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Wed, 23 Feb 2022 21:04:55 +0530 Subject: added second endpoint: GetMangaById --- manga/manga.go | 47 ++++++++++++++++++++++------------------------- 1 file changed, 22 insertions(+), 25 deletions(-) diff --git a/manga/manga.go b/manga/manga.go index dd79db2..2bbc7d4 100644 --- a/manga/manga.go +++ b/manga/manga.go @@ -74,31 +74,28 @@ func (c Client) SearchManga(searchString string, limit, offset int, fields []str return searchResults, nil } -// // Each anime has its own ID on MAL -// func (c Client) GetAnimeById(animeId int, fields []string) (Anime, error) { -// var anime Anime -// -// // handle all the errors for the fields -// fields, err := e.FieldsErrHandler(fields) -// if err != nil { -// return anime, err -// } -// -// endpoint, _ := u.UrlGenerator( -// BASE_URL + "/" + strconv.Itoa(animeId), -// []string{"fields"}, -// /* it seems to still return all fields from the API. -// * this might be an issue with MAL itself -// * TODO: look into this */ -// [][]string{fields}, -// true, -// ) -// -// data := c.requestHandler(endpoint) -// json.Unmarshal([]byte(data), &anime) -// -// return anime, nil -// } +// Each manga has its own ID on MAL +func (c Client) GetMangaById(mangaId int, fields []string) (Manga, error) { + var manga Manga + + // handle all the errors for the fields + fields, err := e.FieldsErrHandler(fields) + if err != nil { + return manga, err + } + + endpoint, _ := u.UrlGenerator( + BASE_URL + "/" + strconv.Itoa(mangaId), + []string{"fields"}, + [][]string{fields}, + true, + ) + + data := c.requestHandler(endpoint) + json.Unmarshal([]byte(data), &manga) + + return manga, nil +} // // Ranking is a list of anime sorted by their rank // func (c Client) GetAnimeRanking(rankingType string, limit, offset int, fields []string) (AnimeRanking, error) { -- cgit v1.2.3 From e21dc47f2fe1dd3b1ad47224cd9cc3e75d0835fb Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Wed, 23 Feb 2022 21:32:44 +0530 Subject: finalized manga package with all the endpoints added --- errhandlers/anime_validators.go | 148 ++++++++++++++++++++++++++++++++++++++++ errhandlers/errhandlers.go | 22 +++++- errhandlers/manga_validators.go | 70 +++++++++++++++++++ errhandlers/validators.go | 148 ---------------------------------------- manga/manga.go | 120 ++++++++++++++++---------------- manga/ranking.structs.go | 41 +++++++++++ util/structs.go | 15 +++- 7 files changed, 354 insertions(+), 210 deletions(-) create mode 100644 errhandlers/anime_validators.go create mode 100644 errhandlers/manga_validators.go delete mode 100644 errhandlers/validators.go create mode 100644 manga/ranking.structs.go diff --git a/errhandlers/anime_validators.go b/errhandlers/anime_validators.go new file mode 100644 index 0000000..b51afa6 --- /dev/null +++ b/errhandlers/anime_validators.go @@ -0,0 +1,148 @@ +/* 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 errhandlers + +// Checks if given rankingType is valid +func IsValidRankingType(rankingType string) bool { + switch rankingType { + case + "all", + "airing", + "upcoming", + "tv", + "ova", + "movie", + "special", + "bypopularity", + "favorite": return true + } + return false +} + +// Checks if given field is valid +func IsValidField(field string) bool { + switch field { + case + "id", + "title", + "main_picture", + "alternative_titles", + "start_date", + "end_date", + "synopsis", + "mean", + "rank", + "popularity", + "num_list_users", + "num_scoring_users", + "nsfw", + "created_at", + "updated_at", + "media_type", + "status", + "genres", + "my_list_status", + "num_episodes", + "start_season", + "broadcast", + "source", + "average_episode_duration", + "rating", + "pictures", + "background", + "related_anime", + "related_manga", + "recommendations", + "studios", + "statistics": return true + } + return false +} + +// Checks if given season is valid +func IsValidSeason(season string) bool { + switch season { + case + "winter", + "spring", + "summer", + "fall": return true + } + return false +} + +// Checks if given sort is valid +// For seasonal anime lists +func IsValidSeasonalSort(sort string) bool { + switch sort { + case + "anime_score", + "anime_num_list_users": return true + } + return false +} + +// Checks if given sort is valid +// for user anime lists +func IsValidListSort(sort string) bool { + switch sort { + case + "list_score", + "list_updated_at", + "anime_title", + "anime_start_date", + "anime_id": return true + } + return false +} + +// Checks if given anime list status is valid +func IsValidListStatus(status string) bool { + switch status { + case + "watching", + "completed", + "on_hold", + "dropped", + "plan_to_watch": return true + } + return false +} + +// Checks if given anime score is valid +func IsValidScore(score int) bool { + if score >= 0 && score <= 10 { + return true + } + return false +} + +// Checks if given anime priority is valid +func IsValidPriority(priority int) bool { + if priority >= 0 && priority <= 2 { + return true + } + return false +} + +// Checks if given rewatch value is valid +func IsValidRewatchValue(r int) bool { + if r >= 0 && r <= 5 { + return true + } + return false +} diff --git a/errhandlers/errhandlers.go b/errhandlers/errhandlers.go index 14c1d33..5f4db25 100644 --- a/errhandlers/errhandlers.go +++ b/errhandlers/errhandlers.go @@ -22,8 +22,9 @@ import ( "github.com/MikunoNaka/MAL2Go/util" ) -// if fields aren't specified +// this is only for anime fields func FieldsErrHandler(fields []string) ([]string, error) { + // if fields aren't specified if cap(fields) == 0 { // uses all the default fields if none specified return util.DefaultFields, nil @@ -40,6 +41,25 @@ func FieldsErrHandler(fields []string) ([]string, error) { return fields, nil } +// only for manga fields +func MangaFieldsErrHandler(fields []string) ([]string, error) { + // if fields aren't specified + if cap(fields) == 0 { + // uses all the default fields if none specified + return util.DefaultMangaFields, nil + } + + // checks if each given field is valid + for _, j := range(fields) { + if !IsValidMangaField(j) { + return []string{}, errors.New(fmt.Sprintf("InvalidFieldError: Invalid field specified: \"%s\"", j)) + } + } + + // everything's fine! + return fields, nil +} + // if limit or error specified are above the limit func LimitErrHandler(limit, maxLimit int) error { if limit > maxLimit { diff --git a/errhandlers/manga_validators.go b/errhandlers/manga_validators.go new file mode 100644 index 0000000..fa12e5f --- /dev/null +++ b/errhandlers/manga_validators.go @@ -0,0 +1,70 @@ +/* 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 errhandlers + +// Checks if given field is valid +func IsValidMangaField(field string) bool { + switch field { + case + "id", + "title", + "main_picture", + "alternative_titles", + "start_date", + "end_date", + "synopsis", + "mean", + "rank", + "popularity", + "num_list_users", + "num_scoring_users", + "nsfw", + "created_at", + "updated_at", + "media_type", + "status", + "genres", + "my_list_status", + "num_volumes", + "num_chapters", + "authors", + "pictures", + "background", + "related_anime", + "related_manga", + "recommendations", + "serialization": return true + } + return false +} + +// Checks if given ranking type is valid +func IsValidMangaRankingType(rankingType string) bool { + switch rankingType { + case + "all", + "manga", + "novels", + "oneshots", + "doujin", + "manhwa", + "manhua", + "bypopularity", + "favorite": return true + } + return false +} diff --git a/errhandlers/validators.go b/errhandlers/validators.go deleted file mode 100644 index 4e4137d..0000000 --- a/errhandlers/validators.go +++ /dev/null @@ -1,148 +0,0 @@ -/* 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 errhandlers - -// Checks if given rankingType is valid -func IsValidRankingType(rankingType string) bool { - switch rankingType { - case - "all", - "airing", - "upcoming", - "tv", - "ova", - "movie", - "special", - "bypopularity", - "favorite": return true - } - return false -} - -// Checks if given rankingType is valid -func IsValidField(field string) bool { - switch field { - case - "id", - "title", - "main_picture", - "alternative_titles", - "start_date", - "end_date", - "synopsis", - "mean", - "rank", - "popularity", - "num_list_users", - "num_scoring_users", - "nsfw", - "created_at", - "updated_at", - "media_type", - "status", - "genres", - "my_list_status", - "num_episodes", - "start_season", - "broadcast", - "source", - "average_episode_duration", - "rating", - "pictures", - "background", - "related_anime", - "related_manga", - "recommendations", - "studios", - "statistics": return true - } - return false -} - -// Checks if given season is valid -func IsValidSeason(season string) bool { - switch season { - case - "winter", - "spring", - "summer", - "fall": return true - } - return false -} - -// Checks if given sort is valid -// For seasonal anime lists -func IsValidSeasonalSort(sort string) bool { - switch sort { - case - "anime_score", - "anime_num_list_users": return true - } - return false -} - -// Checks if given sort is valid -// for user anime lists -func IsValidListSort(sort string) bool { - switch sort { - case - "list_score", - "list_updated_at", - "anime_title", - "anime_start_date", - "anime_id": return true - } - return false -} - -// Checks if given anime list status is valid -func IsValidListStatus(status string) bool { - switch status { - case - "watching", - "completed", - "on_hold", - "dropped", - "plan_to_watch": return true - } - return false -} - -// Checks if given anime score is valid -func IsValidScore(score int) bool { - if score >= 0 && score <= 10 { - return true - } - return false -} - -// Checks if given anime priority is valid -func IsValidPriority(priority int) bool { - if priority >= 0 && priority <= 2 { - return true - } - return false -} - -// Checks if given rewatch value is valid -func IsValidRewatchValue(r int) bool { - if r >= 0 && r <= 5 { - return true - } - return false -} diff --git a/manga/manga.go b/manga/manga.go index 2bbc7d4..9979bff 100644 --- a/manga/manga.go +++ b/manga/manga.go @@ -18,8 +18,8 @@ package manga import ( "encoding/json" - // "errors" - // "fmt" + "errors" + "fmt" "strconv" e "github.com/MikunoNaka/MAL2Go/errhandlers" u "github.com/MikunoNaka/MAL2Go/util" @@ -41,7 +41,7 @@ func (c Client) SearchManga(searchString string, limit, offset int, fields []str } // handle all the errors for the fields - fields, err := e.FieldsErrHandler(fields) + fields, err := e.MangaFieldsErrHandler(fields) if err != nil { return searchResults, err } @@ -79,7 +79,7 @@ func (c Client) GetMangaById(mangaId int, fields []string) (Manga, error) { var manga Manga // handle all the errors for the fields - fields, err := e.FieldsErrHandler(fields) + fields, err := e.MangaFieldsErrHandler(fields) if err != nil { return manga, err } @@ -97,59 +97,59 @@ func (c Client) GetMangaById(mangaId int, fields []string) (Manga, error) { return manga, nil } -// // Ranking is a list of anime sorted by their rank -// func (c Client) GetAnimeRanking(rankingType string, limit, offset int, fields []string) (AnimeRanking, error) { -// var animeRanking AnimeRanking -// -// // error handling for limit -// limitErr := e.LimitErrHandler(limit, maxAnimeLimit) -// if limitErr != nil { -// return animeRanking, limitErr -// } -// -// // handle all the errors for the fields -// fields, err := e.FieldsErrHandler(fields) -// if err != nil { -// return animeRanking, err -// } -// -// // if ranking type is invalid -// if !e.IsValidRankingType(rankingType) { -// return animeRanking, errors.New(fmt.Sprintf("GetAnimeRanking: Invalid ranking type specified: \"%s\"", rankingType)) -// } -// -// endpoint, _ := u.UrlGenerator( -// BASE_URL + "/ranking", -// []string{"ranking_type", "limit", "offset", "fields"}, -// [][]string{{rankingType}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, -// true, -// ) -// -// // gets data from API and stores it in a struct -// var rankingData RawRanking -// data := c.requestHandler(endpoint) -// json.Unmarshal([]byte(data), &rankingData) -// -// // Adding all the animes in ranking list to a slice -// var animeRankingTitles []AnimeRankingTitle -// for _, element := range rankingData.Data { -// animeRankingTitles = append( -// animeRankingTitles, -// AnimeRankingTitle { -// Anime: element.Anime, -// RankNum: element.Ranking.Rank, -// }, -// ) -// } -// -// // Finally, create the AnimeRanking object -// animeRanking = AnimeRanking { -// Titles: animeRankingTitles, -// Paging: ListPaging { -// NextPage: rankingData.Paging.NextPage, -// PrevPage: rankingData.Paging.PrevPage, -// }, -// } -// -// return animeRanking, nil -// } +// Ranking is a list of anime sorted by their rank +func (c Client) GetMangaRanking(rankingType string, limit, offset int, fields []string) (MangaRanking, error) { + var mangaRanking MangaRanking + + // error handling for limit + limitErr := e.LimitErrHandler(limit, maxMangaLimit) + if limitErr != nil { + return mangaRanking, limitErr + } + + // handle all the errors for the fields + fields, err := e.MangaFieldsErrHandler(fields) + if err != nil { + return mangaRanking, err + } + + // if ranking type is invalid + if !e.IsValidMangaRankingType(rankingType) { + return mangaRanking, errors.New(fmt.Sprintf("GetMangaRanking: Invalid ranking type specified: \"%s\"", rankingType)) + } + + endpoint, _ := u.UrlGenerator( + BASE_URL + "/ranking", + []string{"ranking_type", "limit", "offset", "fields"}, + [][]string{{rankingType}, {strconv.Itoa(limit)}, {strconv.Itoa(offset)}, fields}, + true, + ) + + // gets data from API and stores it in a struct + var rankingData RawRanking + data := c.requestHandler(endpoint) + json.Unmarshal([]byte(data), &rankingData) + + // Adding all the animes in ranking list to a slice + var mangas []rManga + + for _, manga := range rankingData.Data { + // set RankNum for manga + newManga := manga.Manga + newManga.RankNum = manga.Ranking.Rank + + // add newManga to list + mangas = append(mangas, newManga) + } + + // Finally, create the AnimeRanking object + mangaRanking = MangaRanking { + Mangas: mangas, + Paging: ListPaging { + NextPage: rankingData.Paging.NextPage, + PrevPage: rankingData.Paging.PrevPage, + }, + } + + return mangaRanking, nil +} diff --git a/manga/ranking.structs.go b/manga/ranking.structs.go new file mode 100644 index 0000000..698b68a --- /dev/null +++ b/manga/ranking.structs.go @@ -0,0 +1,41 @@ +/* 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 + +// Manga but with an extra RankNum field +type rManga struct { + Manga + RankNum int +} + +// this is how the API returns data (looks horrible) +type RawRanking struct { + Data []struct { + Manga rManga `json:"node"` + Ranking struct { + Rank int `json:"rank"` + } `json:"ranking"` + } `json:"data"` + + Paging ListPaging `json:"paging"` +} + +// this is how mal2go returns data +type MangaRanking struct { + Mangas []rManga + Paging ListPaging +} diff --git a/util/structs.go b/util/structs.go index 4eb6325..1483d3f 100644 --- a/util/structs.go +++ b/util/structs.go @@ -19,7 +19,7 @@ package util /* NOTE: MAL still seems to send some fields * even if they aren't requested. * those include Title, Picture, Id, etc */ -// default fields to use when none are specified +// default anime fields to use when none are specified var DefaultFields []string = []string{ "id", "title", "main_picture", "alternative_titles", "start_date", @@ -35,6 +35,19 @@ var DefaultFields []string = []string{ "studios", "statistics", } +// default manga fields to use when none are specified +var DefaultMangaFields []string = []string{ + "id", "title", "main_picture", + "alternative_titles", "start_date", "end_date", + "synopsis", "mean", "rank", + "popularity", "num_list_users", "num_scoring_users", + "nsfw", "created_at", "media_type", + "status", "genres", "my_list_status", + "num_volumes", "num_chapters", "authors", + "pictures", "background", "related_anime", + "related_manga", "recommendations", "serialization", +} + // contains previous/next page for anime list // we don't actually need this. // TODO: for compatibility's sake, keep this but also define methods -- cgit v1.2.3