Merge pull request #66 from golift/dn2_level_2

Fix a whole slew of problems

Author: davidnewhall

README.md

@@ -15,7 +15,7 @@ A command line interface app that uses this library exists. Most of the testing
 Find it here: [https://github.com/davidnewhall/SecSpyCLI](https://github.com/davidnewhall/SecSpyCLI)
 It's full of great examples on how to use this library, and can be easily installed with homebrew.
 
--   Works with SecuritySpy 4 and 5.
+-   Works with SecuritySpy 4 and 5 and probably 6.
 -   There's a lot more to learn about this package in [GODOC](https://godoc.org/golift.io/securityspy).
 
 ## FEATURES

cameras.go

@@ -6,6 +6,7 @@ import (
 	"image"
 	"image/jpeg"
 	"io"
+	"net/http"
 	"net/url"
 	"os"
 	"strconv"
@@ -116,7 +117,13 @@ func (c *Camera) SaveVideo(ops *VidOps, length time.Duration, maxsize int64, out
 // StreamMJPG makes a web request to retrieve a motion JPEG stream.
 // Returns an io.ReadCloser that will (hopefully) never end.
 func (c *Camera) StreamMJPG(ops *VidOps) (io.ReadCloser, error) {
-	resp, err := c.server.Get("++video", c.makeRequestParams(ops))
+	return c.StreamMJPGContext(context.Background(), ops)
+}
+
+// StreamMJPGContext makes a web request to retrieve a motion JPEG stream.
+// Returns an io.ReadCloser that will (hopefully) never end.
+func (c *Camera) StreamMJPGContext(ctx context.Context, ops *VidOps) (io.ReadCloser, error) {
+	resp, err := c.server.GetContextClient(ctx, "++video", c.makeRequestParams(ops), c.streamHTTPClient())
 	if err != nil {
 		return nil, fmt.Errorf("getting video: %w", err)
 	}
@@ -127,7 +134,13 @@ func (c *Camera) StreamMJPG(ops *VidOps) (io.ReadCloser, error) {
 // StreamH264 makes a web request to retrieve an H264 stream.
 // Returns an io.ReadCloser that will (hopefully) never end.
 func (c *Camera) StreamH264(ops *VidOps) (io.ReadCloser, error) {
-	resp, err := c.server.Get("++stream", c.makeRequestParams(ops))
+	return c.StreamH264Context(context.Background(), ops)
+}
+
+// StreamH264Context makes a web request to retrieve an H264 stream.
+// Returns an io.ReadCloser that will (hopefully) never end.
+func (c *Camera) StreamH264Context(ctx context.Context, ops *VidOps) (io.ReadCloser, error) {
+	resp, err := c.server.GetContextClient(ctx, "++stream", c.makeRequestParams(ops), c.streamHTTPClient())
 	if err != nil {
 		return nil, fmt.Errorf("getting stream: %w", err)
 	}
@@ -138,7 +151,13 @@ func (c *Camera) StreamH264(ops *VidOps) (io.ReadCloser, error) {
 // StreamG711 makes a web request to retrieve an G711 audio stream.
 // Returns an io.ReadCloser that will (hopefully) never end.
 func (c *Camera) StreamG711() (io.ReadCloser, error) {
-	resp, err := c.server.Get("++audio", c.makeRequestParams(nil))
+	return c.StreamG711Context(context.Background())
+}
+
+// StreamG711Context makes a web request to retrieve an G711 audio stream.
+// Returns an io.ReadCloser that will (hopefully) never end.
+func (c *Camera) StreamG711Context(ctx context.Context) (io.ReadCloser, error) {
+	resp, err := c.server.GetContextClient(ctx, "++audio", c.makeRequestParams(nil), c.streamHTTPClient())
 	if err != nil {
 		return nil, fmt.Errorf("getting audio: %w", err)
 	}
@@ -165,6 +184,10 @@ func (c *Camera) PostG711(audio io.ReadCloser) ([]byte, error) {
 // GetJPEG returns an images from a camera.
 // VidOps defines the image size. ops.FPS is ignored.
 func (c *Camera) GetJPEG(ops *VidOps) (image.Image, error) {
+	if ops == nil {
+		ops = &VidOps{}
+	}
+
 	ops.FPS = -1 // not used for single image
 
 	ctx, cancel := context.WithTimeout(context.Background(), c.server.TimeoutDur())
@@ -329,3 +352,10 @@ func (c *Camera) makeRequestParams(ops *VidOps) url.Values {
 
 	return params
 }
+
+func (c *Camera) streamHTTPClient() *http.Client {
+	client := c.server.HTTPClient()
+	client.Timeout = 0
+
+	return client
+}

cameras_commands_test.go

@@ -0,0 +1,67 @@
+package securityspy_test
+
+import (
+	"encoding/xml"
+	"net/url"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"go.uber.org/mock/gomock"
+	"golift.io/securityspy"
+	"golift.io/securityspy/mocks"
+	"golift.io/securityspy/server"
+)
+
+func testServerWithCamera(t *testing.T) (*securityspy.Server, *mocks.MockAPI, *securityspy.Camera) {
+	t.Helper()
+
+	mockCtrl := gomock.NewController(t)
+	t.Cleanup(mockCtrl.Finish)
+
+	secspyServer := securityspy.NewMust(
+		&server.Config{Username: "user", Password: "pass", URL: "http://127.0.0.1:5678", VerifySSL: false})
+	fake := mocks.NewMockAPI(mockCtrl)
+	secspyServer.API = fake
+
+	fake.EXPECT().GetXML(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil).Do(
+		func(_, _, v any) {
+			_ = xml.Unmarshal([]byte(testSystemInfo), &v)
+		},
+	)
+	require.NoError(t, secspyServer.Refresh())
+
+	camera := secspyServer.Cameras.ByNum(1)
+	require.NotNil(t, camera)
+
+	return secspyServer, fake, camera
+}
+
+func TestToggleContinuousUsesNumericArmValues(t *testing.T) {
+	t.Parallel()
+
+	_, fake, camera := testServerWithCamera(t)
+
+	fake.EXPECT().SimpleReq("++ssControlContinuous", url.Values{"arm": []string{"0"}}, camera.Number)
+	require.NoError(t, camera.ToggleContinuous(securityspy.CameraDisarm))
+
+	fake.EXPECT().SimpleReq("++ssControlContinuous", url.Values{"arm": []string{"1"}}, camera.Number)
+	require.NoError(t, camera.ToggleContinuous(securityspy.CameraArm))
+}
+
+func TestToggleMotionUsesNumericArmValues(t *testing.T) {
+	t.Parallel()
+
+	_, fake, camera := testServerWithCamera(t)
+
+	fake.EXPECT().SimpleReq("++ssControlMotionCapture", url.Values{"arm": []string{"1"}}, camera.Number)
+	require.NoError(t, camera.ToggleMotion(securityspy.CameraArm))
+}
+
+func TestToggleActionsUsesNumericArmValues(t *testing.T) {
+	t.Parallel()
+
+	_, fake, camera := testServerWithCamera(t)
+
+	fake.EXPECT().SimpleReq("++ssControlActions", url.Values{"arm": []string{"0"}}, camera.Number)
+	require.NoError(t, camera.ToggleActions(securityspy.CameraDisarm))
+}

cameras_test.go

@@ -4,9 +4,9 @@ import (
 	"encoding/xml"
 	"testing"
 
-	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"go.uber.org/mock/gomock"
 	"golift.io/securityspy"
 	"golift.io/securityspy/mocks"
 	"golift.io/securityspy/server"

cameras_types.go

@@ -14,8 +14,8 @@ type CameraArmMode rune
 // Arming is either 0 or 1.
 // Use these constants as inputs to a camera's schedule methods.
 const (
-	CameraDisarm CameraArmMode = iota
-	CameraArm
+	CameraDisarm CameraArmMode = '0'
+	CameraArm    CameraArmMode = '1'
 )
 
 // VidOps are the frame options for a video that can be requested from SecuritySpy.