diff options
| -rw-r--r-- | anime/anime.structs.go | 48 | ||||
| -rw-r--r-- | anime/general.structs.go | 9 | ||||
| -rw-r--r-- | errhandlers/anime_validators.go (renamed from errhandlers/validators.go) | 2 | ||||
| -rw-r--r-- | errhandlers/errhandlers.go | 22 | ||||
| -rw-r--r-- | errhandlers/manga_validators.go | 70 | ||||
| -rw-r--r-- | manga/README.md | 45 | ||||
| -rw-r--r-- | manga/client.go | 23 | ||||
| -rw-r--r-- | manga/manga.go | 155 | ||||
| -rw-r--r-- | manga/manga.structs.go | 64 | ||||
| -rw-r--r-- | manga/ranking.structs.go | 41 | ||||
| -rw-r--r-- | manga/request_handler.go | 48 | ||||
| -rw-r--r-- | manga/search.structs.go | 32 | ||||
| -rw-r--r-- | user/anime/animelist.structs.go | 3 | ||||
| -rw-r--r-- | util/structs.go | 61 |
14 files changed, 581 insertions, 42 deletions
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/errhandlers/validators.go b/errhandlers/anime_validators.go index 4e4137d..b51afa6 100644 --- a/errhandlers/validators.go +++ b/errhandlers/anime_validators.go @@ -33,7 +33,7 @@ func IsValidRankingType(rankingType string) bool { return false } -// Checks if given rankingType is valid +// Checks if given field is valid func IsValidField(field string) bool { switch field { case 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 <vidhukant@protonmail.ch> + + * 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 <https://www.gnu.org/licenses/>. */ + +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/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 <vidhukant@protonmail.ch> + + * 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 <https://www.gnu.org/licenses/>. */ + +package manga + +import ( + "github.com/MikunoNaka/MAL2Go/util" +) + +type Client util.DefaultClient diff --git a/manga/manga.go b/manga/manga.go new file mode 100644 index 0000000..9979bff --- /dev/null +++ b/manga/manga.go @@ -0,0 +1,155 @@ +/* MAL2Go - MyAnimeList V2 API wrapper for Go + * Copyright (C) 2022 Vidhu Kant Sharma <vidhukant@protonmail.ch> + + * 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 <https://www.gnu.org/licenses/>. */ + +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.MangaFieldsErrHandler(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 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.MangaFieldsErrHandler(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) 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/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 <vidhukant@protonmail.ch> + + * 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 <https://www.gnu.org/licenses/>. */ + +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/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 <vidhukant@protonmail.ch> + + * 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 <https://www.gnu.org/licenses/>. */ + +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/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 <vidhukant@protonmail.ch> + + * 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 <https://www.gnu.org/licenses/>. */ + +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..d2da279 --- /dev/null +++ b/manga/search.structs.go @@ -0,0 +1,32 @@ +/* MAL2Go - MyAnimeList V2 API wrapper for Go + * Copyright (C) 2022 Vidhu Kant Sharma <vidhukant@protonmail.ch> + + * 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 <https://www.gnu.org/licenses/>. */ + +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 MangaSearch 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..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", @@ -34,3 +34,62 @@ var DefaultFields []string = []string{ "related_manga", "recommendations", "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 +// 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"` +} |