Added album searching and paging objects as they are different than t… #9
Conversation
…racks but same endpoint
|
brianstrauch/spotify-cli#40 <= for this issue :) |
paging.go
Outdated
| // PagingAlbums represents an PagingObject in the spotify API for albums | ||
| type PagingAlbums struct { | ||
| Albums AlbumPage `json:"albums"` | ||
| } | ||
|
|
There was a problem hiding this comment.
A Paging object already exists (line 5). You can add the Albums field to that struct and simply use the existing Search() function instead of creating a new SearchAlbums() function.
| // PagingAlbums represents an PagingObject in the spotify API for albums | |
| type PagingAlbums struct { | |
| Albums AlbumPage `json:"albums"` | |
| } |
There was a problem hiding this comment.
So I should just add a field to the Paging object with something like:
type Paging struct {
Tracks TrackPage `json:"track"``
Albums AlbumPage `json:"album"`
}
There was a problem hiding this comment.
Yep, exactly. There's unfortunately no way to have multiple json:"item" tags in Golang, so we can't conform to the Spotify documentation exactly.
album.go
Outdated
| func (a *API) GetAlbum(name string) (*Album, error) { | ||
|
|
||
| pagingAlbums, err := a.SearchAlbum(name, "album", 1) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| album := pagingAlbums.Albums.Items | ||
|
|
||
| return album[0], nil | ||
| } |
There was a problem hiding this comment.
I'd really only like to add functions to this API that represent endpoints, so let's delete this. This is a convenience function, so it should be added similarly to how this function was added in the CLI: https://github.com/brianstrauch/spotify-cli/blob/def54fb1e6b3ae84292c4ea73d8d32ea00d336f4/internal/common.go#L70-L76.
| func (a *API) GetAlbum(name string) (*Album, error) { | |
| pagingAlbums, err := a.SearchAlbum(name, "album", 1) | |
| if err != nil { | |
| return nil, err | |
| } | |
| album := pagingAlbums.Albums.Items | |
| return album[0], nil | |
| } |
There was a problem hiding this comment.
Let's make SearchTrack() and SearchAlbum() convenience methods in the CLI (the first already exists; it just needs to be renamed). Then, it would be really slick if we extracted the SearchPlaylist() functionality into the common.go file as well, right beneath the other two functions.
Threpio
changed the title
As they are different than Tracks but same endpoint.
Had to change the field:
it was of a weird time syntax that I had not seen before and was not automatically transformed
searchAlbums is not hardcoded for type. It probably could be.