Merge pull request #10 from mrobinsn/updates

Updates

README.md

@@ -6,7 +6,7 @@
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
 
-> newznab XML API client for Go (golang)
+> newznab/torznab XML API client for Go (golang)
 
 ## Documentation
 [GoDoc](https://godoc.org/github.com/mrobinsn/go-newznab/newznab)
@@ -32,6 +32,12 @@ client := newznab.New("http://my-usenet-indexer", "my-api-key", 1234, false)
 ```
 Note the missing `/api` part of the URL. Depending on the called method either `/api` or `/rss` will be appended to the given base URL. A valid user ID is only required for RSS methods.
 
+### Get the capabilities of your tracker
+```
+caps, _ := client.Capabilities()
+```
+You will want to check the result of this to determine if your tracker supports searching by tvrage, imdb, tvmaze, etc.
+
 ### Search using a tvrage id:
 ```
 categories := []int{
@@ -50,6 +56,15 @@ categories := []int{
 results, _ := client.SearchWithIMDB(categories, "0364569")
 ```
 
+### Search using a tvmaze id:
+```
+categories := []int{
+    newznab.CategoryTVHD,
+    newznab.CategoryTVSD,
+}
+results, _ := client.SearchWithTVMaze(categories, 80, 3, 1)
+```
+
 ### Search using a name and set of categories:
 ```
 results, _ := client.SearchWithQueries(categories, "Oldboy", "movie")

go.mod

@@ -0,0 +1,8 @@
+module github.com/mrobinsn/go-newznab
+
+require (
+	github.com/pkg/errors v0.8.1
+	github.com/sirupsen/logrus v1.4.1
+	github.com/stretchr/testify v1.3.0
+	golang.org/x/sys v0.0.0-20190405154228-4b34438f7a67 // indirect
+)

go.sum

@@ -0,0 +1,20 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
+github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
+github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.4.1 h1:GL2rEmy6nsikmW0r8opw9JIRScdMF5hA8cOYLH7In1k=
+github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33 h1:I6FyU15t786LL7oL/hn43zqTuEGr4PN7F4XJ1p4E3Y8=
+golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190405154228-4b34438f7a67 h1:1Fzlr8kkDLQwqMP8GxrhptBLqZG/EDpiATneiZHY998=
+golang.org/x/sys v0.0.0-20190405154228-4b34438f7a67/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

newznab/newznab.go

@@ -10,8 +10,8 @@ import (
 	"strings"
 	"time"
 
-	log "github.com/Sirupsen/logrus"
 	"github.com/pkg/errors"
+	log "github.com/sirupsen/logrus"
 )
 
 // Various constants for categories
@@ -25,6 +25,8 @@ const (
 	CategoryTVSD = 5030
 	// CategoryTVHD is for high-definition shows
 	CategoryTVHD = 5040
+	// CategoryTVUHD is for UHD shows
+	CategoryTVUHD = 5045
 	// CategoryTVOther is for other shows
 	CategoryTVOther = 5050
 	// CategoryTVSport is for sports shows
@@ -41,6 +43,8 @@ const (
 	CategoryMovieSD = 2030
 	// CategoryMovieHD is for high-definition movies
 	CategoryMovieHD = 2040
+	// CategoryMovieUHD is for UHD movies
+	CategoryMovieUHD = 2045
 	// CategoryMovieBluRay is for blu-ray movies
 	CategoryMovieBluRay = 2050
 	// CategoryMovie3D is for 3-D movies
@@ -95,6 +99,17 @@ func (c Client) SearchWithTVDB(categories []int, tvDBID int, season int, episode
 	})
 }
 
+// SearchWithTVMaze returns NZBs for the given parameters
+func (c Client) SearchWithTVMaze(categories []int, tvMazeID int, season int, episode int) ([]NZB, error) {
+	return c.search(url.Values{
+		"tvmazeid": []string{strconv.Itoa(tvMazeID)},
+		"cat":      c.splitCats(categories),
+		"season":   []string{strconv.Itoa(season)},
+		"episode":  []string{strconv.Itoa(episode)},
+		"t":        []string{"tvsearch"},
+	})
+}
+
 // SearchWithIMDB returns NZBs for the given parameters
 func (c Client) SearchWithIMDB(categories []int, imdbID string) ([]NZB, error) {
 	return c.search(url.Values{
@@ -122,6 +137,13 @@ func (c Client) LoadRSSFeed(categories []int, num int) ([]NZB, error) {
 	})
 }
 
+// Capabilities returns the capabilities of this tracker
+func (c Client) Capabilities() (Capabilities, error) {
+	return c.caps(url.Values{
+		"t": []string{"caps"},
+	})
+}
+
 // LoadRSSFeedUntilNZBID fetches NZBs until a given NZB id is reached.
 func (c Client) LoadRSSFeedUntilNZBID(categories []int, num int, id string, maxRequests int) ([]NZB, error) {
 	count := 0
@@ -170,6 +192,19 @@ func (c Client) search(vals url.Values) ([]NZB, error) {
 	return c.process(vals, apiPath)
 }
 
+func (c Client) caps(vals url.Values) (Capabilities, error) {
+	vals.Set("apikey", c.apikey)
+	resp, err := c.getURL(c.buildURL(vals, apiPath))
+	if err != nil {
+		return Capabilities{}, errors.Wrap(err, "failed to get capabilities")
+	}
+	var cResp Capabilities
+	if err = xml.Unmarshal(resp, &cResp); err != nil {
+		return cResp, errors.Wrap(err, "failed to unmarshal xml")
+	}
+	return cResp, nil
+}
+
 func (c Client) process(vals url.Values, path string) ([]NZB, error) {
 	var nzbs []NZB
 	resp, err := c.getURL(c.buildURL(vals, path))
@@ -231,6 +266,8 @@ func (c Client) process(vals url.Values, path string) ([]NZB, error) {
 				nzb.TVDBID = attr.Value
 			case "rageid":
 				nzb.TVRageID = attr.Value
+			case "tvmazeid":
+				nzb.TVMazeID = attr.Value
 			case "info":
 				nzb.Info = attr.Value
 			case "season":
@@ -260,6 +297,8 @@ func (c Client) process(vals url.Values, path string) ([]NZB, error) {
 				} else {
 					nzb.UsenetDate = parsedUsetnetDate
 				}
+			case "resolution":
+				nzb.Resolution = attr.Value
 			default:
 				log.WithFields(log.Fields{
 					"name":  attr.Name,

newznab/newznab_test.go

@@ -76,6 +76,12 @@ func TestUsenetCrawlerClient(t *testing.T) {
 			require.NotEmpty(t, results, "expected results")
 		})
 
+		t.Run("valid category and TVMaze id", func(t *testing.T) {
+			results, err := client.SearchWithTVMaze(categories, 65, 10, 1)
+			require.NoError(t, err)
+			require.NotEmpty(t, results, "expected results")
+		})
+
 		t.Run("valid category and tvrage id", func(t *testing.T) {
 			results, err := client.SearchWithTVRage(categories, 2870, 10, 1)
 			require.NoError(t, err)

newznab/structs.go

@@ -28,9 +28,12 @@ type NZB struct {
 	Info     string   `json:"info,omitempty"`
 	Genre    string   `json:"genre,omitempty"`
 
+	Resolution string `json:"resolution,omitempty"`
+
 	// TV Specific stuff
 	TVDBID   string `json:"tvdbid,omitempty"`
 	TVRageID string `json:"tvrageid,omitempty"`
+	TVMazeID string `json:"tvmazeid,omitempty"`
 	Season   string `json:"season,omitempty"`
 	Episode  string `json:"episode,omitempty"`
 	TVTitle  string `json:"tvtitle,omitempty"`
@@ -178,3 +181,33 @@ func (t *Time) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error {
 	return nil
 
 }
+
+type Capabilities struct {
+	Server struct {
+		Title string `xml:"title,attr" json:"title,omitempty"`
+	} `xml:"server" json:"server,omitempty"`
+	Searching struct {
+		Search struct {
+			Available       string `xml:"available,attr" json:"available,omitempty"`
+			SupportedParams string `xml:"supportedParams,attr" json:"supported_params,omitempty"`
+		} `xml:"search" json:"search,omitempty"`
+		TvSearch struct {
+			Available       string `xml:"available,attr" json:"available,omitempty"`
+			SupportedParams string `xml:"supportedParams,attr" json:"supported_params,omitempty"`
+		} `xml:"tv-search" json:"tv_search,omitempty"`
+		MovieSearch struct {
+			Available       string `xml:"available,attr" json:"available,omitempty"`
+			SupportedParams string `xml:"supportedParams,attr" json:"supported_params,omitempty"`
+		} `xml:"movie-search" json:"movie_search,omitempty"`
+	} `xml:"searching" json:"searching,omitempty"`
+	Categories struct {
+		Category []struct {
+			ID     string `xml:"id,attr" json:"id,omitempty"`
+			Name   string `xml:"name,attr" json:"name,omitempty"`
+			Subcat []struct {
+				ID   string `xml:"id,attr" json:"id,omitempty"`
+				Name string `xml:"name,attr" json:"name,omitempty"`
+			} `xml:"subcat" json:"subcat,omitempty"`
+		} `xml:"category" json:"category,omitempty"`
+	} `xml:"categories" json:"categories,omitempty"`
+}