Better split between high- and low-level clients

Author: sgrimee

Makefile

@@ -1,8 +1,15 @@
-.PHONY: doc
+.PHONY: doc test
 
 doc:
 	go get github.com/robertkrimen/godocdown/godocdown
 	godocdown > doc/package.md 
 
-integration:
-	go test -tags=integration
+test:
+	go test -v ./...
+
+integration-test:
+	go test -tags=integration
+
+coverage:
+	go test -coverprofile=coverage.out 
+	go tool cover -html=coverage.out

README.md

@@ -5,14 +5,14 @@
   <p align="center"><a href="https://circleci.com/gh/sgrimee/kizcool"><img src="https://circleci.com/gh/sgrimee/kizcool.svg?style=shield" alt="Build Status"></a></p>
 </p>
 
-# Get kizcool
+## Get kizcool command line tool
 
 ```
 go get github.com/sgrimee/kizcool
-cd $GOPATH/src/github.com/sgrimee/kizcool/kizcli
+cd $GOPATH/src/github.com/sgrimee/kizcool/exe/kizcmd
 go get
 go install
-kizcli configure
+kizcmd configure
 ```
 
 ## Go package documentation

client/client.go

@@ -1,4 +1,5 @@
 // Package client provides a low-level client to the overkiz api
+// JSON responses are not unmarshalled and are returned as-is.
 package client
 
 import (
@@ -109,7 +110,6 @@ func (c *Client) Login() error {
 	if err := checkStatusOk(resp); err != nil {
 		return err
 	}
-	u, _ := url.Parse(c.baseURL)
 	for _, cookie := range resp.Cookies() {
 		if (cookie.Name == "JSESSIONID") && (cookie.Value != "") {
 			return nil
@@ -153,6 +153,24 @@ func (c *Client) DoWithAuth(req *http.Request) (*http.Response, error) {
 	return resp, nil
 }
 
+// GetDevices returns the raw response to retrieving all devices
+func (c *Client) GetDevices() (*http.Response, error) {
+	return c.GetWithAuth("/enduserAPI/setup/devices")
+}
+
+// GetDevice returns the raw response to retrieving one device by URL
+func (c *Client) GetDevice(deviceURL string) (*http.Response, error) {
+	query := "/enduserAPI/setup/devices/" + url.QueryEscape(deviceURL)
+	return c.GetWithAuth(query)
+}
+
+// GetDeviceState returns the current state with name for the device with URL deviceURL
+func (c *Client) GetDeviceState(deviceURL, stateName string) (*http.Response, error) {
+	query := "/enduserAPI/setup/devices/" + url.QueryEscape(deviceURL) +
+		"/states/" + url.QueryEscape(stateName)
+	return c.GetWithAuth(query)
+}
+
 // RefreshStates tells the server to refresh states.
 // But not sure yet what it really means`?
 func (c *Client) RefreshStates() error {
@@ -183,7 +201,7 @@ func (c *Client) Execute(json []byte) (*http.Response, error) {
 }
 
 // RegisterListener registers for events and returns a listener id
-func (c *Client) RegisterListener() (ListenerID, error) {
+func (c *Client) RegisterListener() (string, error) {
 	req, err := http.NewRequest(http.MethodPost, c.baseURL+"/events/register", nil)
 	if err != nil {
 		return "", err
@@ -194,17 +212,17 @@ func (c *Client) RegisterListener() (ListenerID, error) {
 	}
 	defer resp.Body.Close()
 	type Result struct {
-		lid ListenerID
+		ID string
 	}
 	var result Result
 	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
 		return "", err
 	}
-	return result.lid, nil
+	return result.ID, nil
 }
 
 // UnregisterListener unregisters the listener
-func (c *Client) UnregisterListener(l ListenerID) error {
+func (c *Client) UnregisterListener(l string) error {
 	query := fmt.Sprintf("%s/events/%s/unregister", c.baseURL, l)
 	req, err := http.NewRequest(http.MethodPost, query, nil)
 	if err != nil {

client/client_test.go

@@ -67,13 +67,31 @@ func TestNewWithHTTPClientGetsSessionCookie(t *testing.T) {
 }
 
 func TestRegisterListener(t *testing.T) {
-	t.Skip("Need to write test")
+	const lid = "77777777-3333-5555-2222-cccccccccccc"
+	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
+		assert.Equal(t, "/events/register", req.URL.String())
+		rw.Write([]byte(`{"id":"` + lid + `"}`))
+	}))
+	defer server.Close()
+	c, err := NewWithHTTPClient("user", "pass", server.URL, "", server.Client())
+	assert.NoError(t, err)
+	l, err := c.RegisterListener()
+	assert.NoError(t, err)
+	assert.Equal(t, lid, l)
 }
 
 func TestUnregisterListener(t *testing.T) {
-	t.Skip("Need to write test")
+	const lid = "77777777-3333-5555-2222-cccccccccccc"
+	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
+		assert.Equal(t, "/events/"+lid+"/unregister", req.URL.String())
+	}))
+	defer server.Close()
+	c, err := NewWithHTTPClient("user", "pass", server.URL, "", server.Client())
+	assert.NoError(t, err)
+	err = c.UnregisterListener(lid)
+	assert.NoError(t, err)
 }
 
 func TestFetchEvents(t *testing.T) {
-	t.Skip("Need to write test")
+	t.Skip("Implement me")
 }

client/interface.go

@@ -2,12 +2,17 @@ package client
 
 import "net/http"
 
-// APIClient interface defines a low-level api client
+// APIClient interface defines a low-level api client to the kiz server
 type APIClient interface {
 	SessionID() string
 	Login() error
 	GetWithAuth(query string) (*http.Response, error)
 	DoWithAuth(req *http.Request) (*http.Response, error)
+	GetDevices() (*http.Response, error)
+	GetDevice(deviceURL string) (*http.Response, error)
+	GetDeviceState(deviceURL, stateName string) (*http.Response, error)
 	RefreshStates() error
 	Execute(json []byte) (*http.Response, error)
+	RegisterListener() (string, error)
+	UnregisterListener(string) error
 }

config/config.go

@@ -2,8 +2,6 @@
 package config
 
 import (
-	"fmt"
-
 	homedir "github.com/mitchellh/go-homedir"
 	"github.com/spf13/viper"
 )
@@ -79,7 +77,6 @@ func Read(create bool) error {
 
 // Write saves the current config to file
 func Write() error {
-	fmt.Printf("Writing to config file: %s\n", viper.ConfigFileUsed())
 	return viper.WriteConfig()
 }
 

doc.go

@@ -1,2 +1,4 @@
-// Package kizcool provides a client to the Overkiz IoT API, used by velux, somfy and other vendors to control velux devices with a Tahoma box.
+// Package kizcool provides a high-level client to the Overkiz IoT API,
+// used by velux, somfy and other vendors to control velux devices with
+// a Tahoma box.
 package kizcool

doc/package.md

@@ -2,8 +2,8 @@
 --
     import "github.com/sgrimee/kizcool"
 
-Package kizcool provides a client to the Overkiz IoT API, used by velux, somfy
-and other vendors to control velux devices with a Tahoma box.
+Package kizcool provides a high-level client to the Overkiz IoT API, used by
+velux, somfy and other vendors to control velux devices with a Tahoma box.
 
 ## Usage
 
@@ -171,7 +171,7 @@ type Kiz struct {
 }
 ```
 
-Kiz provides high-level methods and structs to interact with the server.
+Kiz high-level client
 
 #### func  New
 
@@ -273,7 +273,7 @@ Open opens a device
 func (k *Kiz) RefreshStates() error
 ```
 RefreshStates tells the server to refresh states. But not sure yet what it
-really means`?
+really does...
 
 #### func (*Kiz) SessionID
 

kizcli/cmd/cmd_close.go renamed to exe/kizcmd/cmd/cmd_close.go

@@ -10,7 +10,7 @@ var deviceCmd = &cobra.Command{
 	Use:   "device",
 	Short: "Get a single device",
 	Long: `Get infos on a single device identified by its device url or label (case insensitive)
-	kizclient get device "io://1111-0000-4444/15332221"`,
+	kizcmd get device "io://1111-0000-4444/15332221"`,
 	Run: func(cmd *cobra.Command, args []string) {
 		if len(args) == 0 {
 			log.Fatal("You must specify a device.")

kizcli/cmd/cmd_closure.go renamed to exe/kizcmd/cmd/cmd_closure.go

@@ -13,9 +13,9 @@ var kiz *kizcool.Kiz
 
 // RootCmd represents the base command when called without any subcommands
 var RootCmd = &cobra.Command{
-	Use:   "kizcli",
+	Use:   "kizcmd",
 	Short: "Overkiz command-line client",
-	Long:  `kizclient implements a partial client for the Overkiz home automation api.`,
+	Long:  `kizcmd implements a partial client for the Overkiz home automation api.`,
 }
 
 // Execute adds all child commands to the root command sets flags appropriately.

kizcli/cmd/cmd_configure.go renamed to exe/kizcmd/cmd/cmd_configure.go

@@ -0,0 +1,7 @@
+package main
+
+import "github.com/sgrimee/kizcool/exe/kizcmd/cmd"
+
+func main() {
+	cmd.Execute()
+}

kizcli/cmd/cmd_get.go renamed to exe/kizcmd/cmd/cmd_get.go

@@ -3,14 +3,13 @@ package kizcool
 import (
 	"encoding/json"
 	"errors"
-	"net/url"
 	"regexp"
 	"strings"
 
 	"github.com/sgrimee/kizcool/client"
 )
 
-// Kiz provides high-level methods and structs to interact with the server.
+// Kiz high-level client
 type Kiz struct {
 	clt client.APIClient
 }
@@ -46,7 +45,7 @@ func (k *Kiz) Login() error {
 
 // GetDevices returns the list of devices
 func (k *Kiz) GetDevices() ([]Device, error) {
-	resp, err := k.clt.GetWithAuth("/enduserAPI/setup/devices")
+	resp, err := k.clt.GetDevices()
 	if err != nil {
 		return nil, err
 	}
@@ -58,8 +57,7 @@ func (k *Kiz) GetDevices() ([]Device, error) {
 
 // GetDevice returns a single device
 func (k *Kiz) GetDevice(deviceURL DeviceURL) (Device, error) {
-	query := "/enduserAPI/setup/devices/" + url.QueryEscape(string(deviceURL))
-	resp, err := k.clt.GetWithAuth(query)
+	resp, err := k.clt.GetDevice(string(deviceURL))
 	if err != nil {
 		return Device{}, err
 	}
@@ -113,9 +111,7 @@ func (k *Kiz) GetDeviceByText(text string) (Device, error) {
 
 // GetDeviceState returns the current state with name stateName for the device with URL deviceURL
 func (k *Kiz) GetDeviceState(deviceURL DeviceURL, stateName StateName) (State, error) {
-	query := "/enduserAPI/setup/devices/" + url.QueryEscape(string(deviceURL)) +
-		"/states/" + url.QueryEscape(string(stateName))
-	resp, err := k.clt.GetWithAuth(query)
+	resp, err := k.clt.GetDeviceState(string(deviceURL), string(stateName))
 	if err != nil {
 		return State{}, err
 	}
@@ -126,7 +122,7 @@ func (k *Kiz) GetDeviceState(deviceURL DeviceURL, stateName StateName) (State, e
 }
 
 // RefreshStates tells the server to refresh states.
-// But not sure yet what it really means`?
+// But not sure yet what it really does...
 func (k *Kiz) RefreshStates() error {
 	return k.clt.RefreshStates()
 }