aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@protonmail.ch>2022-02-23 21:32:44 +0530
committerVidhu Kant Sharma <vidhukant@protonmail.ch>2022-02-23 21:32:44 +0530
commite21dc47f2fe1dd3b1ad47224cd9cc3e75d0835fb (patch)
tree1bbc1d2b57c7eb8a7a36feb51ce0656cf49faf8a
parent7a68abbc9e492934cf4170d5a0ff52a456fe92bd (diff)
finalized manga package with all the endpoints added
-rw-r--r--errhandlers/anime_validators.go (renamed from errhandlers/validators.go)2
-rw-r--r--errhandlers/errhandlers.go22
-rw-r--r--errhandlers/manga_validators.go70
-rw-r--r--manga/manga.go120
-rw-r--r--manga/ranking.structs.go41
-rw-r--r--util/structs.go15
6 files changed, 207 insertions, 63 deletions
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/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 <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/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