Update docs, examples, tests and democlient (#17)

nstratos · Mar 29, 2023 · 23294af · 23294af
1 parent 92740b3
commit 23294af
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@ count.out
 cover.out
 *token-cache.txt
 *.exe
+malauth
+!malauth/
diff --git a/README.md b/README.md
@@ -307,6 +307,8 @@ _, _, err := c.Anime.UpdateMyListStatus(ctx, 967,
 	mal.NumEpisodesWatched(73),
 	mal.Score(8),
 	mal.Comments("You wa shock!"),
+	mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+	mal.FinishDate(time.Time{}), // Remove an existing date.
 )
 // ...
 
@@ -315,6 +317,8 @@ _, _, err := c.Manga.UpdateMyListStatus(ctx, 401,
 	mal.NumVolumesRead(1),
 	mal.NumChaptersRead(5),
 	mal.Comments("Migi"),
+	mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+	mal.FinishDate(time.Time{}), // Remove an existing date.
 )
 // ...
 ```

diff --git a/example/malauth/democlient.go b/example/malauth/democlient.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"strings"
+	"time"
 
 	"github.com/nstratos/go-myanimelist/mal"
 )
@@ -261,12 +262,14 @@ func (c *demoClient) updateMyAnimeListStatus(ctx context.Context) {
 		mal.NumEpisodesWatched(73),
 		mal.Score(8),
 		mal.Comments("You wa shock!"),
+		mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+		mal.FinishDate(time.Time{}), // Remove an existing date.
 	)
 	if err != nil {
 		c.err = err
 		return
 	}
-	fmt.Printf("Status: %q, Score: %d, Episodes Watched: %d, Comments: %s\n", s.Status, s.Score, s.NumEpisodesWatched, s.Comments)
+	fmt.Printf("Status: %q, Score: %d, Episodes Watched: %d, Comments: %q, Start Date: %s\n", s.Status, s.Score, s.NumEpisodesWatched, s.Comments, s.StartDate)
 }
 
 func (c *demoClient) updateMyMangaListStatus(ctx context.Context) {
@@ -278,12 +281,14 @@ func (c *demoClient) updateMyMangaListStatus(ctx context.Context) {
 		mal.NumVolumesRead(1),
 		mal.NumChaptersRead(5),
 		mal.Comments("Migi"),
+		mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+		mal.FinishDate(time.Time{}), // Remove an existing date.
 	)
 	if err != nil {
 		c.err = err
 		return
 	}
-	fmt.Printf("Status: %q, Volumes Read: %d, Chapters Read: %d, Comments: %s\n", s.Status, s.NumVolumesRead, s.NumChaptersRead, s.Comments)
+	fmt.Printf("Status: %q, Volumes Read: %d, Chapters Read: %d, Comments: %q, Start Date: %s\n", s.Status, s.NumVolumesRead, s.NumChaptersRead, s.Comments, s.StartDate)
 }
 
 func (c *demoClient) deleteMyAnimeListItem(ctx context.Context) {

diff --git a/mal/doc.go b/mal/doc.go
@@ -273,6 +273,8 @@ manga ID and then options to specify the status, score, comments, tags etc.
 		mal.NumEpisodesWatched(73),
 		mal.Score(8),
 		mal.Comments("You wa shock!"),
+		mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+		mal.FinishDate(time.Time{}), // Remove an existing date.
 	)
 	// ...
 
@@ -281,6 +283,8 @@ manga ID and then options to specify the status, score, comments, tags etc.
 		mal.NumVolumesRead(1),
 		mal.NumChaptersRead(5),
 		mal.Comments("Migi"),
+		mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+		mal.FinishDate(time.Time{}), // Remove an existing date.
 	)
 	// ...
 

diff --git a/mal/example_useranimelist_test.go b/mal/example_useranimelist_test.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"net/url"
+	"time"
 
 	"github.com/nstratos/go-myanimelist/mal"
 )
@@ -55,12 +56,14 @@ func ExampleAnimeService_UpdateMyListStatus() {
 		mal.NumEpisodesWatched(73),
 		mal.Score(8),
 		mal.Comments("You wa shock!"),
+		mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+		mal.FinishDate(time.Time{}), // Remove an existing date.
 	)
 	if err != nil {
 		fmt.Printf("Anime.UpdateMyListStatus error: %v", err)
 		return
 	}
-	fmt.Printf("Status: %q, Score: %d, Episodes Watched: %d, Comments: %s\n", s.Status, s.Score, s.NumEpisodesWatched, s.Comments)
+	fmt.Printf("Status: %q, Score: %d, Episodes Watched: %d, Comments: %q, Start Date: %s\n", s.Status, s.Score, s.NumEpisodesWatched, s.Comments, s.StartDate)
 	// Output:
-	// Status: "watching", Score: 8, Episodes Watched: 73, Comments: You wa shock!
+	// Status: "watching", Score: 8, Episodes Watched: 73, Comments: "You wa shock!", Start Date: 2022-02-20
 }
diff --git a/mal/example_usermangalist_test.go b/mal/example_usermangalist_test.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"net/url"
+	"time"
 
 	"github.com/nstratos/go-myanimelist/mal"
 )
@@ -52,12 +53,14 @@ func ExampleMangaService_UpdateMyListStatus() {
 		mal.NumVolumesRead(1),
 		mal.NumChaptersRead(5),
 		mal.Comments("Migi"),
+		mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+		mal.FinishDate(time.Time{}), // Remove an existing date.
 	)
 	if err != nil {
 		fmt.Printf("Manga.UpdateMyListStatus error: %v", err)
 		return
 	}
-	fmt.Printf("Status: %q, Volumes Read: %d, Chapters Read: %d, Comments: %s\n", s.Status, s.NumVolumesRead, s.NumChaptersRead, s.Comments)
+	fmt.Printf("Status: %q, Volumes Read: %d, Chapters Read: %d, Comments: %q, Start Date: %s\n", s.Status, s.NumVolumesRead, s.NumChaptersRead, s.Comments, s.StartDate)
 	// Output:
-	// Status: "reading", Volumes Read: 1, Chapters Read: 5, Comments: Migi
+	// Status: "reading", Volumes Read: 1, Chapters Read: 5, Comments: "Migi", Start Date: 2022-02-20
 }
diff --git a/mal/integration_test.go b/mal/integration_test.go
@@ -127,6 +127,8 @@ func testUpdateUserAnimeList(ctx context.Context, t *testing.T, client *mal.Clie
 			mal.RewatchValue(1),
 			mal.Score(1),
 			mal.Tags{"foo", "bar"},
+			mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+			mal.FinishDate(time.Time{}),
 		); err != nil {
 			t.Fatalf("Anime.UpdateMyListStatus(%d) returned err: %v", id, err)
 		}
@@ -157,6 +159,8 @@ func testUpdateUserAnimeList(ctx context.Context, t *testing.T, client *mal.Clie
 			RewatchValue:       1,
 			Tags:               []string{"foo", "bar"},
 			Comments:           "test comment",
+			StartDate:          "2022-02-20",
+			FinishDate:         "",
 		}
 		a.Status.UpdatedAt = time.Time{}
 		if got := a.Status; !reflect.DeepEqual(got, want) {
@@ -201,6 +205,8 @@ func testUpdateUserMangaList(ctx context.Context, t *testing.T, client *mal.Clie
 			mal.RereadValue(1),
 			mal.Score(1),
 			mal.Tags{"foo", "bar"},
+			mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+			mal.FinishDate(time.Time{}),
 		); err != nil {
 			t.Fatalf("Manga.UpdateMyListStatus(%d) returned err: %v", id, err)
 		}
@@ -232,6 +238,8 @@ func testUpdateUserMangaList(ctx context.Context, t *testing.T, client *mal.Clie
 			RereadValue:     1,
 			Tags:            []string{"foo", "bar"},
 			Comments:        "test comment",
+			StartDate:       "2022-02-20",
+			FinishDate:      "",
 		}
 		a.Status.UpdatedAt = time.Time{}
 		if got := a.Status; !reflect.DeepEqual(got, want) {

diff --git a/mal/testdata/updateMyAnimeList.json b/mal/testdata/updateMyAnimeList.json
@@ -4,6 +4,7 @@
     "num_episodes_watched":73,
     "is_rewatching":false,
     "updated_at":"2021-03-16T07:36:44+00:00",
+    "start_date":"2022-02-20",
     "priority":0,
     "num_times_rewatched":0,
     "rewatch_value":0,

diff --git a/mal/testdata/updateMyMangaList.json b/mal/testdata/updateMyMangaList.json
@@ -5,6 +5,7 @@
     "num_chapters_read":5,
     "score":0,
     "updated_at":"2021-03-22T18:15:09+00:00",
+    "start_date":"2022-02-20",
     "priority":0,
     "num_times_reread":0,
     "reread_value":0,

diff --git a/mal/usermangalist.go b/mal/usermangalist.go
@@ -45,6 +45,8 @@ type MangaListStatus struct {
 	RereadValue     int         `json:"reread_value"`
 	Tags            []string    `json:"tags"`
 	Comments        string      `json:"comments"`
+	StartDate       string      `json:"start_date"`
+	FinishDate      string      `json:"finish_date"`
 }
 
 // mangaList represents the anime list of a user.

diff --git a/mal/usermangalist_test.go b/mal/usermangalist_test.go
@@ -99,7 +99,7 @@ func TestMangaServiceUpdateMyListStatus(t *testing.T) {
 	mux.HandleFunc("/manga/1/my_list_status", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, http.MethodPatch)
 		testContentType(t, r, "application/x-www-form-urlencoded")
-		testBody(t, r, "comments=comments&is_rereading=true&num_chapters_read=3&num_times_reread=2&num_volumes_read=3&priority=2&reread_value=1&score=8&status=completed&tags=foo%2Cbar")
+		testBody(t, r, "comments=comments&finish_date=&is_rereading=true&num_chapters_read=3&num_times_reread=2&num_volumes_read=3&priority=2&reread_value=1&score=8&start_date=2022-02-20&status=completed&tags=foo%2Cbar")
 		const out = `
 		{
 		  "status": "completed",
@@ -108,6 +108,7 @@ func TestMangaServiceUpdateMyListStatus(t *testing.T) {
 		  "num_chapters_read": 3,
 		  "is_rereading": true,
 		  "updated_at": "2018-04-25T15:59:52Z",
+		  "start_date": "2022-02-20",
 		  "priority": 2,
 		  "num_times_reread": 2,
 		  "reread_value": 1,
@@ -129,6 +130,8 @@ func TestMangaServiceUpdateMyListStatus(t *testing.T) {
 		RereadValue(1),
 		Tags{"foo", "bar"},
 		Comments("comments"),
+		StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
+		FinishDate(time.Time{}),
 	)
 	if err != nil {
 		t.Errorf("Manga.UpdateMyListStatus returned error: %v", err)
@@ -146,6 +149,8 @@ func TestMangaServiceUpdateMyListStatus(t *testing.T) {
 		Tags:            []string{"foo", "bar"},
 		Comments:        "comments",
 		UpdatedAt:       time.Date(2018, 04, 25, 15, 59, 52, 0, time.UTC),
+		StartDate:       "2022-02-20",
+		FinishDate:      "",
 	}
 	if !reflect.DeepEqual(got, want) {
 		t.Errorf("Manga.UpdateMyListStatus returned\nhave: %+v\n\nwant: %+v", got, want)