DISCOGS-2 Search implementation
This commit is contained in:
parent
20710e3f3e
commit
d5292c30c9
63
README.md
63
README.md
@ -1,20 +1,24 @@
|
||||
# REST API 2.0 Discogs.com client
|
||||
|
||||
go-discogs is a Go client library for the [Discogs API](https://www.discogs.com/developers/). Check the usage section or try the examples to see how to access the Discogs API.
|
||||
go-discogs is a Go client library for the [Discogs API](https://www.discogs.com/developers/). Check the usage section to see how to access the Discogs API.
|
||||
|
||||
### Changelog
|
||||
```
|
||||
14.02.2017
|
||||
- search is implemented
|
||||
- minor improvements
|
||||
```
|
||||
|
||||
### Feauteres
|
||||
* Database
|
||||
* Releases
|
||||
* [Releases](#releases)
|
||||
* Master Releases
|
||||
* Release Versions
|
||||
* Artists
|
||||
* Artist Releases
|
||||
* Label
|
||||
* All Label Releases
|
||||
|
||||
#### ToDo
|
||||
- Search
|
||||
|
||||
* [Search](#search)
|
||||
|
||||
Install
|
||||
--------
|
||||
@ -28,7 +32,11 @@ First of all import library and init client variable. According to discogs api d
|
||||
import "github.com/irlndts/go-discogs"
|
||||
```
|
||||
```go
|
||||
client := discogs.NewClient().UserAgent("TestDiscogsClient/0.0.1 +example.com")
|
||||
client := discogs.NewClient("TestDiscogsClient/0.0.1 +example.com", "")
|
||||
```
|
||||
Some requests require authentication (as any user). According to [Discogs](https://www.discogs.com/developers/#page:authentication,header:authentication-discogs-auth-flow), to send requests with Discogs Auth, you have two options: sending your credentials in the query string with key and secret parameters or a token parameter. Key-secret doesn't implemented yet, but token is yes.
|
||||
```go
|
||||
client := discogs.NewClient("TestDiscogsClient/0.0.1 +example.com", "sometoken")
|
||||
```
|
||||
|
||||
#### Releases
|
||||
@ -55,5 +63,46 @@ client := discogs.NewClient().UserAgent("TestDiscogsClient/0.0.1 +example.com")
|
||||
*/
|
||||
```
|
||||
|
||||
#### Search
|
||||
Issue a search query to discogs database. This endpoint accepts pagination parameters
|
||||
Authentication (as any user) is required.
|
||||
|
||||
Use `SearchRequest` struc to create a request
|
||||
```go
|
||||
type SearchRequest struct {
|
||||
Q string // search query (optional)
|
||||
Type string // one of release, master, artist, label (optional)
|
||||
Title string // search by combined “Artist Name - Release Title” title field (optional)
|
||||
Release_title string // search release titles (optional)
|
||||
Credit string // search release credits (optional)
|
||||
Artist string // search artist names (optional)
|
||||
Anv string // search artist ANV (optional)
|
||||
Label string // search label names (optional)
|
||||
Genre string // search genres (optional)
|
||||
Style string // search styles (optional)
|
||||
Country string // search release country (optional)
|
||||
Year string // search release year (optional)
|
||||
Format string // search formats (optional)
|
||||
Catno string // search catalog number (optional)
|
||||
Barcode string // search barcodes (optional)
|
||||
Track string // search track titles (optional)
|
||||
Submitter string // search submitter username (optional)
|
||||
Contributer string // search contributor usernames (optional)
|
||||
|
||||
Page int // optional
|
||||
Per_page int // optional
|
||||
}
|
||||
```
|
||||
|
||||
Example
|
||||
```go
|
||||
request:= &discogs.SearchRequest{Artist: "reggaenauts", Release_title: "river rock", Page: 0, Per_page: 1}
|
||||
search, _, err := client.Search(request)
|
||||
|
||||
for _, r := range search.Results {
|
||||
fmt.Println(r.Title)
|
||||
}
|
||||
```
|
||||
|
||||
etc.
|
||||
More examples - soon
|
||||
|
@ -8,7 +8,7 @@ import (
|
||||
func TestArtistService_Artist(t *testing.T) {
|
||||
expectedId := 1000
|
||||
|
||||
d := NewClient().UserAgent("UnitTestClient/0.0.1 +https://github.com/irlndts/go-discogs")
|
||||
d := NewClient(testUserAgent, testToken)
|
||||
artist, _, err := d.Artist.Artist(&ArtistParams{Artist_id: "1000"})
|
||||
|
||||
check(t, err)
|
||||
@ -18,7 +18,7 @@ func TestArtistService_Artist(t *testing.T) {
|
||||
func TestArtistService_Releases(t *testing.T) {
|
||||
expectedArtist := "Dave Clarke"
|
||||
|
||||
d := NewClient().UserAgent("UnitTestClient/0.0.1 +https://github.com/irlndts/go-discogs")
|
||||
d := NewClient(testUserAgent, testToken)
|
||||
releases, _, err := d.Artist.Releases(&ArtistParams{Artist_id: "1000", Sort: "year", Sort_order: "desc"})
|
||||
|
||||
check(t, err)
|
||||
|
@ -7,10 +7,7 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
libVeresion = "0.1"
|
||||
discogsAPI = "https://api.discogs.com/"
|
||||
useragent = "irlndts/go-discogs/0.1"
|
||||
token = "oQTQKAprakIQfWOkAxTdYyDpgUqahHtdbHTuYkIy"
|
||||
)
|
||||
|
||||
// Client is a Discogs client for making Discogs API requests.
|
||||
@ -24,8 +21,8 @@ type Client struct {
|
||||
}
|
||||
|
||||
// NewClient returns a new Client.
|
||||
func NewClient() *Client {
|
||||
base := apirequest.New().Client(&http.Client{}).Base(discogsAPI).Add("User-Agent", useragent) //.Add("Authorization", "Discogs token="+token)
|
||||
func NewClient(useragent, token string) *Client {
|
||||
base := apirequest.New().Client(&http.Client{}).Base(discogsAPI).Add("User-Agent", useragent).Add("Authorization", "Discogs token="+token)
|
||||
|
||||
return &Client{
|
||||
api: base,
|
||||
@ -33,7 +30,7 @@ func NewClient() *Client {
|
||||
Label: newLabelService(base.New()),
|
||||
Master: newMasterService(base.New()),
|
||||
Release: newReleaseService(base.New()),
|
||||
Search: newSearchService(base),
|
||||
Search: newSearchService(base.New()),
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -4,6 +4,11 @@ import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
const (
|
||||
testUserAgent = "UnitTestClient/0.0.2 +https://github.com/irlndts/go-discogs"
|
||||
testToken = ""
|
||||
)
|
||||
|
||||
func check(t *testing.T, e error) {
|
||||
if e != nil {
|
||||
t.Error(e)
|
||||
|
@ -7,10 +7,10 @@ import (
|
||||
)
|
||||
|
||||
func main() {
|
||||
d := discogs.NewClient().UserAgent("TestDiscogsClient/0.0.1 +http://irlndts.moscow").Token("")
|
||||
d := discogs.NewClient("TestDiscogsClient/0.0.1 +http://irlndts.moscow", "")
|
||||
|
||||
params := &discogs.SearchRequest{Release_title: "nevermind", Artist: "nirvana"}
|
||||
search, _, err := d.Search.Search(params)
|
||||
request := &discogs.SearchRequest{Q: "The Reggaenauts - River Rock / Thursday Kick-off", Page: 0, Per_page: 1}
|
||||
search, _, err := d.Search.Search(request)
|
||||
|
||||
if err != nil {
|
||||
fmt.Println(err)
|
||||
@ -18,6 +18,6 @@ func main() {
|
||||
}
|
||||
|
||||
for _, r := range search.Results {
|
||||
fmt.Println(r)
|
||||
fmt.Println(r.Id, r.Title)
|
||||
}
|
||||
}
|
||||
|
16
labels.go
16
labels.go
@ -11,23 +11,23 @@ type LabelService struct {
|
||||
}
|
||||
|
||||
type LabelParams struct {
|
||||
LabelID string
|
||||
Label_id string
|
||||
Page int
|
||||
PerPage int
|
||||
Per_Page int
|
||||
}
|
||||
|
||||
type Label struct {
|
||||
Profile string `json:"profile"`
|
||||
ReleasesUrl string `json:"releases_url"`
|
||||
Releases_url string `json:"releases_url"`
|
||||
Name string `json:"name"`
|
||||
ContactInfo string `json:"contact_info"`
|
||||
Contact_info string `json:"contact_info"`
|
||||
Uri string `json:"uri"`
|
||||
Sublabels []Sublable `json:"sublabels"`
|
||||
Urls []string `json:"urls"`
|
||||
Images []Image `json:"images"`
|
||||
ResourceUrl string `json:"resource_url"`
|
||||
Resource_url string `json:"resource_url"`
|
||||
Id int `json:"id"`
|
||||
DataQuality string `json:"data_quality"`
|
||||
Data_quality string `json:"data_quality"`
|
||||
}
|
||||
|
||||
type LabelReleases struct {
|
||||
@ -45,7 +45,7 @@ func (self *LabelService) Label(params *LabelParams) (*Label, *http.Response, er
|
||||
label := new(Label)
|
||||
apiError := new(APIError)
|
||||
|
||||
resp, err := self.api.New().Get(params.LabelID).Receive(label, apiError)
|
||||
resp, err := self.api.New().Get(params.Label_id).Receive(label, apiError)
|
||||
return label, resp, relevantError(err, *apiError)
|
||||
}
|
||||
|
||||
@ -53,6 +53,6 @@ func (self *LabelService) Releases(params *LabelParams) (*LabelReleases, *http.R
|
||||
releases := new(LabelReleases)
|
||||
apiError := new(APIError)
|
||||
|
||||
resp, err := self.api.New().Get(params.LabelID+"/releases").QueryStruct(params).Receive(releases, apiError)
|
||||
resp, err := self.api.New().Get(params.Label_id+"/releases").QueryStruct(params).Receive(releases, apiError)
|
||||
return releases, resp, relevantError(err, *apiError)
|
||||
}
|
||||
|
@ -8,7 +8,7 @@ import (
|
||||
func TestLabelService_Label(t *testing.T) {
|
||||
expectedId := 1000
|
||||
|
||||
d := NewClient().UserAgent("UnitTestClient/0.0.1 +https://github.com/irlndts/go-discogs")
|
||||
d := NewClient(testUserAgent, testToken)
|
||||
label, _, err := d.Label.Label(&LabelParams{Label_id: "1000"})
|
||||
|
||||
check(t, err)
|
||||
@ -18,7 +18,7 @@ func TestLabelService_Label(t *testing.T) {
|
||||
func TestLabelService_Releases(t *testing.T) {
|
||||
expectedId := "Cha Cha Twist"
|
||||
|
||||
d := NewClient().UserAgent("UnitTestClient/0.0.1 +https://github.com/irlndts/go-discogs")
|
||||
d := NewClient(testUserAgent, testToken)
|
||||
label, _, err := d.Label.Releases(&LabelParams{Label_id: "1000"})
|
||||
|
||||
check(t, err)
|
||||
|
@ -8,7 +8,7 @@ import (
|
||||
func TestMasterService_Master(t *testing.T) {
|
||||
expectedTitle := "Elephant Riddim"
|
||||
|
||||
d := NewClient().UserAgent("UnitTestClient/0.0.1 +https://github.com/irlndts/go-discogs")
|
||||
d := NewClient(testUserAgent, testToken)
|
||||
master, _, err := d.Master.Master(&MasterParams{Master_id: "960657"})
|
||||
|
||||
check(t, err)
|
||||
@ -18,7 +18,7 @@ func TestMasterService_Master(t *testing.T) {
|
||||
func TestMasterService_Versions(t *testing.T) {
|
||||
expectedTitle := "Stardiver"
|
||||
|
||||
d := NewClient().UserAgent("UnitTestClient/0.0.1 +https://github.com/irlndts/go-discogs")
|
||||
d := NewClient(testUserAgent, testToken)
|
||||
versions, _, err := d.Master.Versions(&MasterVersionParams{Master_id: "1000", Page: 1, Per_page: 1})
|
||||
|
||||
check(t, err)
|
||||
|
@ -8,7 +8,7 @@ import (
|
||||
func TestReleaseService_Release(t *testing.T) {
|
||||
expectedTitle := "Elephant Riddim"
|
||||
|
||||
d := NewClient().UserAgent("UnitTestClient/0.0.1 +https://github.com/irlndts/go-discogs")
|
||||
d := NewClient(testUserAgent, testToken)
|
||||
release, _, err := d.Release.Release(&ReleaseParams{Release_id: "8138518"})
|
||||
|
||||
check(t, err)
|
||||
|
51
search.go
51
search.go
@ -6,21 +6,54 @@ import (
|
||||
"github.com/irlndts/go-apirequest"
|
||||
)
|
||||
|
||||
type SearchRequest struct {
|
||||
Release_title string
|
||||
Artist string
|
||||
type SearchService struct {
|
||||
api *apirequest.API
|
||||
}
|
||||
|
||||
Page int
|
||||
PerPage int
|
||||
type SearchRequest struct {
|
||||
Q string // search query (optional)
|
||||
Type string // one of release, master, artist, label (optional)
|
||||
Title string // search by combined “Artist Name - Release Title” title field (optional)
|
||||
Release_title string // search release titles (optional)
|
||||
Credit string // search release credits (optional)
|
||||
Artist string // search artist names (optional)
|
||||
Anv string // search artist ANV (optional)
|
||||
Label string // search label names (optional)
|
||||
Genre string // search genres (optional)
|
||||
Style string // search styles (optional)
|
||||
Country string // search release country (optional)
|
||||
Year string // search release year (optional)
|
||||
Format string // search formats (optional)
|
||||
Catno string // search catalog number (optional)
|
||||
Barcode string // search barcodes (optional)
|
||||
Track string // search track titles (optional)
|
||||
Submitter string // search submitter username (optional)
|
||||
Contributer string // search contributor usernames (optional)
|
||||
|
||||
Page int // optional
|
||||
Per_page int // optional
|
||||
}
|
||||
|
||||
type Search struct {
|
||||
Pagination Page `json:"pagination"`
|
||||
Results []interface{} `json:"results"`
|
||||
Results []Result `json:"results"`
|
||||
}
|
||||
|
||||
type SearchService struct {
|
||||
api *apirequest.API
|
||||
type Result struct {
|
||||
Style []string `json:"style"`
|
||||
Thumb string `json:"thumb"`
|
||||
Title string `json:"title"`
|
||||
Country string `json:"country"`
|
||||
Format []string `json:"format"`
|
||||
Uri string `json:"uri"`
|
||||
Community Community `json:"community"`
|
||||
Label []string `json:"label"`
|
||||
Catno string `json:"catno"`
|
||||
Year string `json:"year"`
|
||||
Genre []string `json:"genre"`
|
||||
Resource_url string `json:"resource_url"`
|
||||
Type string `json:"type"`
|
||||
Id int `json:"id"`
|
||||
}
|
||||
|
||||
func newSearchService(api *apirequest.API) *SearchService {
|
||||
@ -33,6 +66,6 @@ func (self *SearchService) Search(params *SearchRequest) (*Search, *http.Respons
|
||||
search := new(Search)
|
||||
apiError := new(APIError)
|
||||
|
||||
resp, err := self.api.QueryStruct(params).Receive(search, apiError)
|
||||
resp, err := self.api.New().QueryStruct(params).Receive(search, apiError)
|
||||
return search, resp, relevantError(err, *apiError)
|
||||
}
|
||||
|
Reference in New Issue
Block a user