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 --- manga/README.md | 45 ++++++++++++++++++++++++++++++++++ manga/client.go | 23 +++++++++++++++++ manga/manga.structs.go | 64 ++++++++++++++++++++++++++++++++++++++++++++++++ manga/request_handler.go | 48 ++++++++++++++++++++++++++++++++++++ manga/search.structs.go | 32 ++++++++++++++++++++++++ 5 files changed, 212 insertions(+) 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 (limited to 'manga') 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 +} -- 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 (limited to 'manga') 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(-) (limited to 'manga') 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 --- manga/manga.go | 120 +++++++++++++++++++++++------------------------ manga/ranking.structs.go | 41 ++++++++++++++++ 2 files changed, 101 insertions(+), 60 deletions(-) create mode 100644 manga/ranking.structs.go (limited to 'manga') 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 +} -- cgit v1.2.3