Catchup & Clean up

Merged latest from another fork. There are a lot of golint warnings so
have been clearing those.

README.md

@@ -1,20 +1,15 @@
 go.wemo
 =======
 
-<<<<<<< HEAD
-I submitted a pull request for the changes I have made to this library. The request is pending, so I have edited the infor below to reflect the location of this library.
-
 [![GoDoc](http://godoc.org/github.com/danward79/go.wemo?status.png)](http://godoc.org/github.com/danward79/go.wemo)
-=======
-[![GoDoc](http://godoc.org/github.com/savaki/go.wemo?status.png)](http://godoc.org/github.com/savaki/go.wemo)
 [![Build Status](https://snap-ci.com/savaki/go.wemo/branch/master/build_image)](https://snap-ci.com/savaki/go.wemo/branch/master)
->>>>>>> 6113bc2e76d18130690a3ab9e1520139559c58de
+
 
 Simple package to interface with Belkin wemo devices.
 
 ### Example - Device discovery
 
-```
+```go
 package main
 
 import (
@@ -34,7 +29,7 @@ func main() {
 
 ### Example - Control a device
 
-```
+```go
 package main
 
 import (
@@ -63,7 +58,7 @@ func main() {
 
 As a convenience method, you can control lights through a more generic interface.
 
-```
+```go
 package main
 
 import (
@@ -83,7 +78,7 @@ func main() {
 
 This is an example of discovering devices, subscribing to there events and being notified of changed to there state. Resubscriptions are managed automatically at the timeout specified. Subscriber details and state are maintained in a map.
 
-```
+```go
 package main
 
 import (
@@ -93,14 +88,14 @@ import (
 )
 
 func main() {
-  
+
   listenerAddress := "192.168.0.6:6767"
   timeout := 300
-  
+
   api, _ := wemo.NewByInterface("en0")
-  
+
   devices, _ := api.DiscoverAll(3*time.Second)
- 
+
   subscriptions := make(map[string]*wemo.SubscriptionInfo)
 
   for _, device := range devices {
@@ -109,7 +104,7 @@ func main() {
       log.Println("Initial Error Subscribing: ", err)   
     }
   }
-  
+
   cs := make(chan wemo.SubscriptionEvent)
 
   go wemo.Listener(listenerAddress, cs)
@@ -125,6 +120,3 @@ func main() {
 
 }
 ```
-
-
-

client.go

@@ -1,3 +1,4 @@
+// Package wemo ...
 // Copyright 2014 Matt Ho
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

device.go

@@ -1,3 +1,4 @@
+// Package wemo ...
 // Copyright 2014 Matt Ho
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,21 +18,26 @@ import (
 	"encoding/xml"
 	"errors"
 	"fmt"
-	"github.com/savaki/httpctx"
-	"golang.org/x/net/context"
 	"io/ioutil"
 	"log"
 	"net/http"
 	"regexp"
 	"strconv"
 	"strings"
+
+	"golang.org/x/net/context"
+
+	"github.com/savaki/httpctx"
+	//"golang.org/x/net/context"
 )
 
+// Device ...
 type Device struct {
 	Host   string
 	Logger func(string, ...interface{}) (int, error)
 }
 
+// DeviceInfo ...
 type DeviceInfo struct {
 	Device          *Device `json:"-"`
 	DeviceType      string  `xml:"deviceType" json:"device-type"`
@@ -41,6 +47,7 @@ type DeviceInfo struct {
 	SerialNumber    string  `xml:"serialNumber" json:"serial-number"`
 }
 
+// DeviceInfos ...
 type DeviceInfos []*DeviceInfo
 
 func (d DeviceInfos) Len() int           { return len(d) }
@@ -65,6 +72,7 @@ func unmarshalDeviceInfo(data []byte) (*DeviceInfo, error) {
 	return &resp.DeviceInfo, nil
 }
 
+// FetchDeviceInfo ...
 func (d *Device) FetchDeviceInfo(ctx context.Context) (*DeviceInfo, error) {
 	var data []byte
 
@@ -79,16 +87,11 @@ func (d *Device) FetchDeviceInfo(ctx context.Context) (*DeviceInfo, error) {
 		return nil, err
 	}
 
-<<<<<<< HEAD
-	//log.Printf("%+v\n", resp.Device)
-
-	return &resp.Device, nil
-=======
 	deviceInfo.Device = d
 	return deviceInfo, nil
->>>>>>> 6113bc2e76d18130690a3ab9e1520139559c58de
 }
 
+// GetBinaryState ...
 func (d *Device) GetBinaryState() int {
 	message := newGetBinaryStateMessage()
 	response, err := post(d.Host, "basicevent", "GetBinaryState", message)
@@ -120,14 +123,17 @@ func (d *Device) GetBinaryState() int {
 	return result
 }
 
+// Off ...
 func (d *Device) Off() {
 	d.changeState(false)
 }
 
+// On ...
 func (d *Device) On() {
 	d.changeState(true)
 }
 
+// Toggle ...
 func (d *Device) Toggle() {
 	if binaryState := d.GetBinaryState(); binaryState == 0 {
 		d.On()
@@ -136,13 +142,9 @@ func (d *Device) Toggle() {
 	}
 }
 
-<<<<<<< HEAD
-func (self *Device) changeState(newState bool) error {
-	//fmt.Printf("changeState(%v)\n", newState)
-=======
 func (d *Device) changeState(newState bool) error {
 	fmt.Printf("changeState(%v)\n", newState)
->>>>>>> 6113bc2e76d18130690a3ab9e1520139559c58de
+
 	message := newSetBinaryStateMessage(newState)
 	response, err := post(d.Host, "basicevent", "SetBinaryState", message)
 	if err != nil {
@@ -167,10 +169,12 @@ func (d *Device) changeState(newState bool) error {
 	return nil
 }
 
+// InsightParams ...
 type InsightParams struct {
 	Power int // mW
 }
 
+// GetInsightParams ...
 func (d *Device) GetInsightParams() *InsightParams {
 	message := newGetInsightParamsMessage()
 	response, err := post(d.Host, "insight", "GetInsightParams", message)

device_test.go

@@ -15,8 +15,9 @@ package wemo
 
 import (
 	"encoding/json"
-	. "github.com/smartystreets/goconvey/convey"
 	"testing"
+
+	. "github.com/smartystreets/goconvey/convey"
 )
 
 func assert(t *testing.T, actual, expected string) {

discover.go

@@ -1,3 +1,4 @@
+// Package wemo ...
 // Copyright 2014 Matt Ho
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,12 +21,14 @@ import (
 
 var belkinRE *regexp.Regexp = regexp.MustCompile(`http://([^/]+)/setup.xml`)
 
+// Wemo ...
 type Wemo struct {
 	ipAddr string
 	Debug  bool
 }
 
-func (self *Wemo) DiscoverAll(timeout time.Duration) ([]*Device, error) {
+// DiscoverAll ...
+func (w *Wemo) DiscoverAll(timeout time.Duration) ([]*Device, error) {
 	urns := []string{
 		"urn:Belkin:device:controllee:1",
 		"urn:Belkin:device:light:1",
@@ -36,7 +39,7 @@ func (self *Wemo) DiscoverAll(timeout time.Duration) ([]*Device, error) {
 
 	var all []*Device
 	for _, urn := range urns {
-		devices, _ := self.Discover(urn, timeout)
+		devices, _ := w.Discover(urn, timeout)
 		for _, device := range devices {
 			all = append(all, device)
 		}
@@ -45,8 +48,9 @@ func (self *Wemo) DiscoverAll(timeout time.Duration) ([]*Device, error) {
 	return all, nil
 }
 
-func (self *Wemo) Discover(urn string, timeout time.Duration) ([]*Device, error) {
-	locations, err := self.scan(urn, timeout)
+// Discover ...
+func (w *Wemo) Discover(urn string, timeout time.Duration) ([]*Device, error) {
+	locations, err := w.scan(urn, timeout)
 	if err != nil {
 		return nil, err
 	}

messages.go

@@ -1,3 +1,4 @@
+// Package wemo ...
 // Copyright 2014 Matt Ho
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

network.go

@@ -1,3 +1,4 @@
+// Package wemo ...
 // Copyright 2014 Matt Ho
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,11 +23,12 @@ import (
 
 var ipAddrRE = regexp.MustCompile(`^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/\d{1,3}$`)
 
+// NewByIp ...
 func NewByIp(ipAddr string) *Wemo {
 	return &Wemo{ipAddr: ipAddr, Debug: false}
 }
 
-// find the ip address associated with the specified interface
+// NewByInterface find the ip address associated with the specified interface
 func NewByInterface(name string) (*Wemo, error) {
 	// find the interface with the selected name
 	iface, err := net.InterfaceByName(name)

scan.go

@@ -1,3 +1,4 @@
+// Package wemo ...
 // Copyright 2014 Matt Ho
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -29,9 +30,9 @@ const (
 )
 
 // scan the multicast
-func (self *Wemo) scan(urn string, timeout time.Duration) ([]*url.URL, error) {
+func (w *Wemo) scan(urn string, timeout time.Duration) ([]*url.URL, error) {
 	// open a udp port for us to receive multicast messages
-	udpAddr, err := net.ResolveUDPAddr("udp4", fmt.Sprintf("%s:0", self.ipAddr))
+	udpAddr, err := net.ResolveUDPAddr("udp4", fmt.Sprintf("%s:0", w.ipAddr))
 	if err != nil {
 		return nil, err
 	}
@@ -48,20 +49,20 @@ func (self *Wemo) scan(urn string, timeout time.Duration) ([]*url.URL, error) {
 		return nil, err
 	}
 
-	if self.Debug {
+	if w.Debug {
 		log.Printf("Found multi-cast address %v", mAddr)
 	}
 	packet := fmt.Sprintf(M_SEARCH, urn)
 
-	if self.Debug {
+	if w.Debug {
 		log.Printf("Writing discovery packet")
 	}
 	_, err = udpConn.WriteTo([]byte(packet), mAddr)
 	if err != nil {
 		return nil, err
 	}
 
-	if self.Debug {
+	if w.Debug {
 		log.Printf("Setting read deadline")
 	}
 	err = udpConn.SetReadDeadline(time.Now().Add(timeout))
@@ -89,7 +90,7 @@ func (self *Wemo) scan(urn string, timeout time.Duration) ([]*url.URL, error) {
 			}
 		}
 
-		if self.Debug {
+		if w.Debug {
 			log.Printf("Read : %v\n", string(buffer[:n]))
 		}
 	}

subscribe.go

@@ -21,6 +21,8 @@ import (
 	"net/http"
 	"strconv"
 	"time"
+
+	"golang.org/x/net/context"
 )
 
 //SubscriptionInfo struct
@@ -93,7 +95,7 @@ func (d *Device) ManageSubscription(listenerAddress string, timeout int, subscri
 	*/
 
 	// Initial Subscribe
-	info, _ := d.FetchDeviceInfo()
+	info, _ := d.FetchDeviceInfo(context.Background())
 
 	id, err := d.Subscribe(listenerAddress, timeout)
 	if err != 200 {
@@ -109,7 +111,7 @@ func (d *Device) ManageSubscription(listenerAddress string, timeout int, subscri
 			timer.Reset(time.Second * time.Duration(timeout))
 
 			// Resubscribe
-			_, err := d.ReSubscribe(id, timeout)
+			_, err = d.ReSubscribe(id, timeout)
 			if err != 200 {
 
 				// Failed to resubscribe so try unsubscribe, it is likely to fail but don't care.