Add ping endpoints

Author: davidnewhall

lidarr/lidarr.go

@@ -1,6 +1,8 @@
 package lidarr
 
 import (
+	"context"
+	"fmt"
 	"strings"
 
 	"golift.io/starr"
@@ -42,3 +44,24 @@ func New(config *starr.Config) *Lidarr {
 
 	return &Lidarr{APIer: config}
 }
+
+// bp means base path. You'll see it a lot in these files.
+const bpPing = "/ping" // ping has no api or version prefix.
+
+// Ping returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (l *Lidarr) Ping() error {
+	return l.PingContext(context.Background())
+}
+
+// PingContext returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (l *Lidarr) PingContext(ctx context.Context) error {
+	req := starr.Request{URI: bpPing}
+
+	resp, err := l.Get(ctx, req)
+	if err != nil {
+		return fmt.Errorf("api.Get(%s): %w", &req, err)
+	}
+	defer resp.Body.Close()
+
+	return nil
+}

prowlarr/prowlarr.go

@@ -1,6 +1,8 @@
 package prowlarr
 
 import (
+	"context"
+	"fmt"
 	"strings"
 
 	"golift.io/starr"
@@ -24,3 +26,24 @@ func New(config *starr.Config) *Prowlarr {
 
 	return &Prowlarr{APIer: config}
 }
+
+// bp means base path. You'll see it a lot in these files.
+const bpPing = "/ping" // ping has no api or version prefix.
+
+// Ping returns an error if the Prowlarr instance does not respond with a 200 to an HTTP /ping request.
+func (p *Prowlarr) Ping() error {
+	return p.PingContext(context.Background())
+}
+
+// PingContext returns an error if the Prowlarr instance does not respond with a 200 to an HTTP /ping request.
+func (p *Prowlarr) PingContext(ctx context.Context) error {
+	req := starr.Request{URI: bpPing}
+
+	resp, err := p.Get(ctx, req)
+	if err != nil {
+		return fmt.Errorf("api.Get(%s): %w", &req, err)
+	}
+	defer resp.Body.Close()
+
+	return nil
+}

radarr/radarr.go

@@ -1,6 +1,8 @@
 package radarr
 
 import (
+	"context"
+	"fmt"
 	"strings"
 
 	"golift.io/starr"
@@ -41,3 +43,24 @@ func New(config *starr.Config) *Radarr {
 
 	return &Radarr{APIer: config}
 }
+
+// bp means base path. You'll see it a lot in these files.
+const bpPing = "ping" // ping has no api or version prefix.
+
+// Ping returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (r *Radarr) Ping() error {
+	return r.PingContext(context.Background())
+}
+
+// PingContext returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (r *Radarr) PingContext(ctx context.Context) error {
+	req := starr.Request{URI: bpPing}
+
+	resp, err := r.Get(ctx, req)
+	if err != nil {
+		return fmt.Errorf("api.Get(%s): %w", &req, err)
+	}
+	defer resp.Body.Close()
+
+	return nil
+}

readarr/readarr.go

@@ -1,6 +1,8 @@
 package readarr
 
 import (
+	"context"
+	"fmt"
 	"strings"
 
 	"golift.io/starr"
@@ -42,3 +44,24 @@ func New(config *starr.Config) *Readarr {
 
 	return &Readarr{APIer: config}
 }
+
+// bp means base path. You'll see it a lot in these files.
+const bpPing = "/ping" // ping has no api or version prefix.
+
+// Ping returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (r *Readarr) Ping() error {
+	return r.PingContext(context.Background())
+}
+
+// PingContext returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (r *Readarr) PingContext(ctx context.Context) error {
+	req := starr.Request{URI: bpPing}
+
+	resp, err := r.Get(ctx, req)
+	if err != nil {
+		return fmt.Errorf("api.Get(%s): %w", &req, err)
+	}
+	defer resp.Body.Close()
+
+	return nil
+}

sonarr/sonarr.go

@@ -1,6 +1,8 @@
 package sonarr
 
 import (
+	"context"
+	"fmt"
 	"strings"
 
 	"golift.io/starr"
@@ -39,3 +41,24 @@ func New(config *starr.Config) *Sonarr {
 
 	return &Sonarr{APIer: config}
 }
+
+// bp means base path. You'll see it a lot in these files.
+const bpPing = "/ping" // ping has no api or version prefix.
+
+// Ping returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (s *Sonarr) Ping() error {
+	return s.PingContext(context.Background())
+}
+
+// PingContext returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.
+func (s *Sonarr) PingContext(ctx context.Context) error {
+	req := starr.Request{URI: bpPing}
+
+	resp, err := s.Get(ctx, req)
+	if err != nil {
+		return fmt.Errorf("api.Get(%s): %w", &req, err)
+	}
+	defer resp.Body.Close()
+
+	return nil
+}