Add movie editor endpoints #69

davidnewhall · 2022-10-05T20:13:17Z

Adds movie editor endpoint.
Adds movie delete and bulk delete endpoints.
Closes #68. @NCRoxas, can you test this?

edit := &radarr.BulkEdit{
    MovieIDs:    []int64{7, 3},
    Monitored:   starr.True(),
    DeleteFiles: starr.False(),
}
movies, err := r.EditMovies(edit)

davidnewhall · 2022-10-05T20:13:53Z

test_methods.go

@@ -40,7 +40,7 @@ func (test *TestMockData) GetMockServer(t *testing.T) *httptest.Server {
 		assert.EqualValues(t, test.ExpectedPath, req.URL.String())
 		writer.WriteHeader(test.ResponseStatus)

-		assert.EqualValues(t, req.Method, test.ExpectedMethod)
+		assert.EqualValues(t, test.ExpectedMethod, req.Method)


This was backward.

davidnewhall · 2022-10-05T20:14:13Z

pointers.go

@@ -0,0 +1,23 @@
+package starr


These may be useful down the road too.

d34dscene · 2022-10-05T21:07:42Z

Looks great! Unmonitoring works, but DeleteFiles and AddImportExclusion doesn't work on my end.

davidnewhall · 2022-10-05T21:23:45Z

Did you mean DeleteMovie or DeleteMovies?

We'll have to address AddImportExclusion in another conversation. edit: oh, derp, you mean AddImportExclusion as part of the input. I see it now. Can you share your code?

davidnewhall · 2022-10-05T21:27:07Z

AddImportExclusion is documented here: https://radarr.video/docs/api/#/MovieEditor/delete_api_v3_movie_editor
...but I don't see any way to trigger it in the UI, so it may not actual work? Can you get an example payload where this works?

d34dscene · 2022-10-05T21:34:26Z

I meant DeleteFiles in this code block

edit := &radarr.EditMovies{
  MovieIDs:    []int64{1, 2, 3},
  Monitored:   starr.True(),
  DeleteFiles: starr.True(),
}

So it bulk deletes all movies and their files.

For the AddImportExclusion I created a simple request:

request, _ := json.Marshal(map[string]any{
  "movieIds": []int64{1, 2, 3},
  "monitored": false,
  "deleteFiles": true,
  "addImportExclusion": true,
})

and sent it via:

req, err := http.NewRequest("DELETE", url, bytes.NewBuffer(request))
// error handling
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
_, err := client.Do(req);
// error handling

url is xxx/api/v3/movie/editor?apikey=xxx

davidnewhall · 2022-10-05T22:46:08Z

I suspect those things do not actually work in radarr. Do you know how to do these actions in the UI? So I can reproduce and see what the difference is.

d34dscene · 2022-10-05T23:02:24Z

You can bulk delete movies in the UI by going to "Movies" > clicking on the "Movie Editor" button > selecting multiple movies and clicking on Delete on the bottom right.

But I don't think you can add movies to the exclusion list via the UI. That's only possible with an api call. The request I sent in the previous message actually works and it deletes all the movie files in the movieID list and puts the movies under "Settings" > "Lists" > "List Exclusions" in the UI.

davidnewhall · 2022-10-06T00:48:27Z

oh, I see what the problem is.

davidnewhall · 2022-10-06T00:54:03Z

Okay, I gave delete the same inputs as edit, so you can pass in those fields. Good to know how it works, thanks! I also renamed the struct to BulkEdit. Try this:

r.DeleteMovies(&radarr.BulkEdit{
  MovieIDs:           []int64{1, 2, 3},
  DeleteFiles:        starr.True(),
  Monitored:          starr.False(),
  AddImportExclusion: starr.True(),
})

d34dscene · 2022-10-06T01:15:33Z

Awesome it works now :D

Fuochi

just a thought about the usage of pointers

Fuochi · 2022-10-06T04:31:00Z

radarr/movieeditor_test.go

@@ -0,0 +1,45 @@
+package radarr_test


@davidnewhall this really rock! thanks 🚀

Fuochi · 2022-10-06T04:39:58Z

radarr/movieeditor.go

+type BulkEdit struct {
+	MovieIDs            []int64 `json:"movieIds"`
+	Monitored           *bool   `json:"monitored,omitempty"`
+	QualityProfileID    *int64  `json:"qualityProfileId,omitempty"`
+	MinimumAvailability *string `json:"minimumAvailability,omitempty"` // tba
+	RootFolderPath      *string `json:"rootFolderPath,omitempty"`      // path
+	Tags                []int   `json:"tags,omitempty"`                // [0]
+	ApplyTags           *string `json:"applyTags,omitempty"`           // add
+	MoveFiles           *bool   `json:"moveFiles,omitempty"`
+	DeleteFiles         *bool   `json:"deleteFiles,omitempty"`        // delete only
+	AddImportExclusion  *bool   `json:"addImportExclusion,omitempty"` // delete only


are they pointer to let them leverage the omitempty tag and use the default 0 value as well?
when they are not present which is the default behaviour? if it is the same as the 0 value you can use values instead of pointers and remove the omitempty tag.
I haven't tried this, so they're just some thoughts

These members are purposely pointers, because the default value is different than the "missing" value.

This is a bulk-change endpoint. When you pick monitored, for instance, there are three choices. monitored, not monitored and no change. We achieve "no change" by omitting the key entirely. If we set it to true, then all movie IDs provided are monitored. If we set it to false then they are all unmonitored. If we do not want to change the monitored status, but rather, change something else, then we have to omit monitored.

got it, thanks for the example

davidnewhall · 2022-10-07T00:03:40Z

radarr/movieeditor.go

+	MinimumAvailability *string `json:"minimumAvailability,omitempty"` // tba
+	RootFolderPath      *string `json:"rootFolderPath,omitempty"`      // path
+	Tags                []int   `json:"tags,omitempty"`                // [0]
+	ApplyTags           *string `json:"applyTags,omitempty"`           // add


ApplyTags could probably be enum constants, but I do not know all the values.

add, remove, replace

ref https://radarr.video/docs/api/#/MovieEditor/put_api_v3_movie_editor

davidnewhall · 2022-10-07T00:04:01Z

radarr/movieeditor.go

+	MovieIDs            []int64 `json:"movieIds"`
+	Monitored           *bool   `json:"monitored,omitempty"`
+	QualityProfileID    *int64  `json:"qualityProfileId,omitempty"`
+	MinimumAvailability *string `json:"minimumAvailability,omitempty"` // tba


MinimumAvailability could probably be enum constants, but I do not know all the values.

tba, announced, inCinemas, released, deleted

ref https://radarr.video/docs/api/#/MovieEditor/put_api_v3_movie_editor

bakerboy448 · 2022-10-07T02:18:23Z

AddImportExclusion is documented here: https://radarr.video/docs/api/#/MovieEditor/delete_api_v3_movie_editor
...but I don't see any way to trigger it in the UI, so it may not actual work? Can you get an example payload where this works?

This is a modal prompt when you delete movies. Same prompt when deleting movie (not via editor)

delete files
add To exclusion list

bakerboy448 · 2022-10-07T02:20:13Z

But I don't think you can add movies to the exclusion list via the UI. That's only possible with an api call.

discover tab has this option to select and exclude

Otherwise when deleting a movie or movies the exclusion list is a modal confirmation checkbox

davidnewhall · 2022-10-07T05:35:54Z

I think I'm gonna turn those inputs into enums. We can probably re-use them in a few places.

davidnewhall · 2022-10-07T06:42:15Z

How's that look @Fuochi ?

Fuochi

I don't fully get the Ptr() functions added... but I'm sure I'm missing a use case

Fuochi · 2022-10-07T07:13:22Z

radarr/movieeditor.go

+// Ptr returns a pointer to a minimum availability. Useful for a BulkEdit struct.
+func (a Availability) Ptr() *Availability {
+	return &a
 }


I don't get the use case of this, can't you just use the & operator? why is a method needed?

You cannot make pointers to constants, so the user would have to do:

avail := radarr.AvailabilityInCinemas

Then pass in &avail. Having the Ptr method allows passing a value in 1 line, as shown in the test.

Fuochi · 2022-10-07T07:28:07Z

radarr/movieeditor.go

+// Availability is an enum used as MinimumAvailability in a few places throughout Radarr.
+type Availability string
+
+// Availability / MinimumAvailability constants.
+// https://radarr.video/docs/api/#/MovieEditor/put_api_v3_movie_editor
+const (
+	AvailabilityToBeAnnounced Availability = "tba"
+	AvailabilityAnnounced     Availability = "announced"
+	AvailabilityInCinemas     Availability = "inCinemas"
+	AvailabilityReleased      Availability = "released"
+	AvailabilityDeleted       Availability = "deleted"
+)


this is nice for a user perspective since it provides users with valid values. However, users can still use any string they want... so I'd say it doesn't make much difference for me, if you like this approach you can continue to use it!

It's all about users. This, if nothing else, gives them an easy way to see what values are appropriate.

There is a difference in status and availability. tba and deleted will not work as a minimum availability in radarr. "announced", "released" & "inCinemas"

Practical use would be the 3 nit mentioned

deleted is a status from tmdb

tba is legacy carryover

neither really has any practical use

All good. I just made them constants. Users don't have to use them. :)

austinwbest · 2022-10-07T13:33:18Z

But I don't think you can add movies to the exclusion list via the UI. That's only possible with an api call. The request I sent in the previous message actually works and it deletes all the movie files in the movieID list and puts the movies under "Settings" > "Lists" > "List Exclusions" in the UI.

You can add movies to the exclusion list on the List Exclusions page @NCRoxas ... There is a + at the bottom of the list.

add movie editor endpoints

0ab5fd5

davidnewhall requested a review from Fuochi October 5, 2022 20:13

davidnewhall commented Oct 5, 2022

View reviewed changes

make delete take the bulk edit input

9735b7c

davidnewhall added 2 commits October 5, 2022 18:08

allow deleteFiles and exclude on single movie delete

dedd989

add dcomments

574338e

Fuochi reviewed Oct 6, 2022

View reviewed changes

davidnewhall commented Oct 7, 2022

View reviewed changes

Fuochi approved these changes Oct 7, 2022

View reviewed changes

Switch availability and applytags to enums

e14d1f8

add one more test

cc0cd9a

Fuochi reviewed Oct 7, 2022

View reviewed changes

davidnewhall merged commit 843eaad into master Oct 7, 2022

davidnewhall deleted the dn2_movie_editor branch October 7, 2022 08:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add movie editor endpoints #69

Add movie editor endpoints #69

davidnewhall commented Oct 5, 2022 •

edited

Loading

davidnewhall Oct 5, 2022

davidnewhall Oct 5, 2022

d34dscene commented Oct 5, 2022

davidnewhall commented Oct 5, 2022 •

edited

Loading

davidnewhall commented Oct 5, 2022

d34dscene commented Oct 5, 2022 •

edited

Loading

davidnewhall commented Oct 5, 2022

d34dscene commented Oct 5, 2022

davidnewhall commented Oct 6, 2022

davidnewhall commented Oct 6, 2022

d34dscene commented Oct 6, 2022

Fuochi left a comment

Fuochi Oct 6, 2022

Fuochi Oct 6, 2022

davidnewhall Oct 7, 2022

Fuochi Oct 7, 2022

davidnewhall Oct 7, 2022

bakerboy448 Oct 7, 2022

davidnewhall Oct 7, 2022

bakerboy448 Oct 7, 2022

bakerboy448 commented Oct 7, 2022

bakerboy448 commented Oct 7, 2022

davidnewhall commented Oct 7, 2022

davidnewhall commented Oct 7, 2022

Fuochi left a comment

Fuochi Oct 7, 2022

davidnewhall Oct 7, 2022 •

edited

Loading

Fuochi Oct 7, 2022

davidnewhall Oct 7, 2022

austinwbest Oct 7, 2022

davidnewhall Oct 7, 2022

bakerboy448 Oct 7, 2022

davidnewhall Oct 7, 2022

austinwbest commented Oct 7, 2022

Add movie editor endpoints #69

Add movie editor endpoints #69

Conversation

davidnewhall commented Oct 5, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

d34dscene commented Oct 5, 2022

davidnewhall commented Oct 5, 2022 • edited Loading

davidnewhall commented Oct 5, 2022

d34dscene commented Oct 5, 2022 • edited Loading

davidnewhall commented Oct 5, 2022

d34dscene commented Oct 5, 2022

davidnewhall commented Oct 6, 2022

davidnewhall commented Oct 6, 2022

d34dscene commented Oct 6, 2022

Fuochi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bakerboy448 commented Oct 7, 2022

bakerboy448 commented Oct 7, 2022

davidnewhall commented Oct 7, 2022

davidnewhall commented Oct 7, 2022

Fuochi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidnewhall Oct 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

austinwbest commented Oct 7, 2022

davidnewhall commented Oct 5, 2022 •

edited

Loading

davidnewhall commented Oct 5, 2022 •

edited

Loading

d34dscene commented Oct 5, 2022 •

edited

Loading

davidnewhall Oct 7, 2022 •

edited

Loading