Improve iot client function names

polldo · polldo · commit e39518fb5665 · 2021-08-30T18:32:42.000+02:00
diff --git a/command/device/create.go b/command/device/create.go
@@ -57,7 +57,7 @@ func Create(params *CreateParams) (string, error) {
 	}
 
 	fmt.Println("Creating a new device on the cloud")
-	devID, err := iotClient.AddDevice(dev.fqbn, params.Name, dev.serial, dev.dType)
+	devID, err := iotClient.DeviceCreate(dev.fqbn, params.Name, dev.serial, dev.dType)
 	if err != nil {
 		return "", err
 	}
@@ -71,7 +71,7 @@ func Create(params *CreateParams) (string, error) {
 	if err != nil {
 		// TODO: retry to delete the device if it returns an error.
 		// In alternative: encapsulate also this error.
-		iotClient.DeleteDevice(devID)
+		iotClient.DeviceDelete(devID)
 		err = fmt.Errorf("%s: %w", "cannot provision device", err)
 		return "", err
 	}
diff --git a/command/device/delete.go b/command/device/delete.go
@@ -23,5 +23,5 @@ func Delete(params *DeleteParams) error {
 		return err
 	}
 
-	return iotClient.DeleteDevice(params.ID)
+	return iotClient.DeviceDelete(params.ID)
 }
diff --git a/command/device/list.go b/command/device/list.go
@@ -27,7 +27,7 @@ func List() ([]DeviceInfo, error) {
 		return nil, err
 	}
 
-	foundDevices, err := iotClient.ListDevices()
+	foundDevices, err := iotClient.DeviceList()
 	if err != nil {
 		return nil, err
 	}
diff --git a/command/device/provision.go b/command/device/provision.go
@@ -78,7 +78,7 @@ func (p provision) configDev() error {
 	if err != nil {
 		return err
 	}
-	cert, err := p.AddCertificate(p.id, string(csr))
+	cert, err := p.CertificateCreate(p.id, string(csr))
 	if err != nil {
 		return err
 	}
diff --git a/command/thing/bind.go b/command/thing/bind.go
@@ -31,7 +31,7 @@ func Bind(params *BindParams) error {
 		DeviceId: params.DeviceID,
 	}
 
-	err = iotClient.UpdateThing(params.ID, thing, true)
+	err = iotClient.ThingUpdate(params.ID, thing, true)
 	if err != nil {
 		return err
 	}
diff --git a/command/thing/clone.go b/command/thing/clone.go
@@ -34,7 +34,7 @@ func Clone(params *CloneParams) (string, error) {
 
 	thing.Name = params.Name
 	force := true
-	thingID, err := iotClient.AddThing(thing, force)
+	thingID, err := iotClient.ThingCreate(thing, force)
 	if err != nil {
 		return "", err
 	}
@@ -43,7 +43,7 @@ func Clone(params *CloneParams) (string, error) {
 }
 
 func retrieve(client iot.Client, thingID string) (*iotclient.Thing, error) {
-	clone, err := client.GetThing(thingID)
+	clone, err := client.ThingShow(thingID)
 	if err != nil {
 		return nil, fmt.Errorf("%s: %w", "retrieving the thing to be cloned", err)
 	}
diff --git a/command/thing/create.go b/command/thing/create.go
@@ -46,7 +46,7 @@ func Create(params *CreateParams) (string, error) {
 	}
 
 	force := true
-	thingID, err := iotClient.AddThing(thing, force)
+	thingID, err := iotClient.ThingCreate(thing, force)
 	if err != nil {
 		return "", err
 	}
diff --git a/command/thing/delete.go b/command/thing/delete.go
@@ -23,5 +23,5 @@ func Delete(params *DeleteParams) error {
 		return err
 	}
 
-	return iotClient.DeleteThing(params.ID)
+	return iotClient.ThingDelete(params.ID)
 }
diff --git a/command/thing/extract.go b/command/thing/extract.go
@@ -31,7 +31,7 @@ func Extract(params *ExtractParams) error {
 		return err
 	}
 
-	thing, err := iotClient.GetThing(params.ID)
+	thing, err := iotClient.ThingShow(params.ID)
 	if err != nil {
 		err = fmt.Errorf("%s: %w", "cannot extract thing: ", err)
 		return err
diff --git a/command/thing/list.go b/command/thing/list.go
@@ -37,7 +37,7 @@ func List(params *ListParams) ([]ThingInfo, error) {
 		return nil, err
 	}
 
-	foundThings, err := iotClient.ListThings(params.IDs, params.DeviceID, params.Variables)
+	foundThings, err := iotClient.ThingList(params.IDs, params.DeviceID, params.Variables)
 	if err != nil {
 		return nil, err
 	}
diff --git a/internal/iot/client.go b/internal/iot/client.go
@@ -10,15 +10,15 @@ import (
 
 // Client can be used to perform actions on Arduino IoT Cloud.
 type Client interface {
-	AddDevice(fqbn, name, serial, devType string) (string, error)
-	DeleteDevice(id string) error
-	ListDevices() ([]iotclient.ArduinoDevicev2, error)
-	AddCertificate(id, csr string) (*iotclient.ArduinoCompressedv2, error)
-	AddThing(thing *iotclient.Thing, force bool) (string, error)
-	UpdateThing(id string, thing *iotclient.Thing, force bool) error
-	DeleteThing(id string) error
-	GetThing(id string) (*iotclient.ArduinoThing, error)
-	ListThings(ids []string, device *string, props bool) ([]iotclient.ArduinoThing, error)
+	DeviceCreate(fqbn, name, serial, devType string) (string, error)
+	DeviceDelete(id string) error
+	DeviceList() ([]iotclient.ArduinoDevicev2, error)
+	CertificateCreate(id, csr string) (*iotclient.ArduinoCompressedv2, error)
+	ThingCreate(thing *iotclient.Thing, force bool) (string, error)
+	ThingUpdate(id string, thing *iotclient.Thing, force bool) error
+	ThingDelete(id string) error
+	ThingShow(id string) (*iotclient.ArduinoThing, error)
+	ThingList(ids []string, device *string, props bool) ([]iotclient.ArduinoThing, error)
 }
 
 type client struct {
@@ -38,9 +38,9 @@ func NewClient(clientID, secretID string) (Client, error) {
 	return cl, nil
 }
 
-// AddDevice allows to create a new device on Arduino IoT Cloud.
+// DeviceCreate allows to create a new device on Arduino IoT Cloud.
 // It returns the ID associated to the new device, and an error.
-func (cl *client) AddDevice(fqbn, name, serial, dType string) (string, error) {
+func (cl *client) DeviceCreate(fqbn, name, serial, dType string) (string, error) {
 	payload := iotclient.CreateDevicesV2Payload{
 		Fqbn:   fqbn,
 		Name:   name,
@@ -55,9 +55,9 @@ func (cl *client) AddDevice(fqbn, name, serial, dType string) (string, error) {
 	return dev.Id, nil
 }
 
-// DeleteDevice deletes the device corresponding to the passed ID
+// DeviceDelete deletes the device corresponding to the passed ID
 // from Arduino IoT Cloud.
-func (cl *client) DeleteDevice(id string) error {
+func (cl *client) DeviceDelete(id string) error {
 	_, err := cl.api.DevicesV2Api.DevicesV2Delete(cl.ctx, id)
 	if err != nil {
 		err = fmt.Errorf("deleting device: %w", errorDetail(err))
@@ -66,9 +66,9 @@ func (cl *client) DeleteDevice(id string) error {
 	return nil
 }
 
-// ListDevices retrieves and returns a list of all Arduino IoT Cloud devices
+// DeviceList retrieves and returns a list of all Arduino IoT Cloud devices
 // belonging to the user performing the request.
-func (cl *client) ListDevices() ([]iotclient.ArduinoDevicev2, error) {
+func (cl *client) DeviceList() ([]iotclient.ArduinoDevicev2, error) {
 	devices, _, err := cl.api.DevicesV2Api.DevicesV2List(cl.ctx, nil)
 	if err != nil {
 		err = fmt.Errorf("listing devices: %w", errorDetail(err))
@@ -77,9 +77,9 @@ func (cl *client) ListDevices() ([]iotclient.ArduinoDevicev2, error) {
 	return devices, nil
 }
 
-// AddCertifcate allows to upload a certificate on Arduino IoT Cloud.
+// CertificateCreate allows to upload a certificate on Arduino IoT Cloud.
 // It returns the certificate parameters populated by the cloud.
-func (cl *client) AddCertificate(id, csr string) (*iotclient.ArduinoCompressedv2, error) {
+func (cl *client) CertificateCreate(id, csr string) (*iotclient.ArduinoCompressedv2, error) {
 	cert := iotclient.CreateDevicesV2CertsPayload{
 		Ca:      "Arduino",
 		Csr:     csr,
@@ -95,8 +95,8 @@ func (cl *client) AddCertificate(id, csr string) (*iotclient.ArduinoCompressedv2
 	return &newCert.Compressed, nil
 }
 
-// AddThing adds a new thing on Arduino IoT Cloud.
-func (cl *client) AddThing(thing *iotclient.Thing, force bool) (string, error) {
+// ThingCreate adds a new thing on Arduino IoT Cloud.
+func (cl *client) ThingCreate(thing *iotclient.Thing, force bool) (string, error) {
 	opt := &iotclient.ThingsV2CreateOpts{Force: optional.NewBool(force)}
 	newThing, _, err := cl.api.ThingsV2Api.ThingsV2Create(cl.ctx, *thing, opt)
 	if err != nil {
@@ -105,8 +105,8 @@ func (cl *client) AddThing(thing *iotclient.Thing, force bool) (string, error) {
 	return newThing.Id, nil
 }
 
-// AddThing updates a thing on Arduino IoT Cloud.
-func (cl *client) UpdateThing(id string, thing *iotclient.Thing, force bool) error {
+// ThingUpdate updates a thing on Arduino IoT Cloud.
+func (cl *client) ThingUpdate(id string, thing *iotclient.Thing, force bool) error {
 	opt := &iotclient.ThingsV2UpdateOpts{Force: optional.NewBool(force)}
 	_, _, err := cl.api.ThingsV2Api.ThingsV2Update(cl.ctx, id, *thing, opt)
 	if err != nil {
@@ -115,8 +115,8 @@ func (cl *client) UpdateThing(id string, thing *iotclient.Thing, force bool) err
 	return nil
 }
 
-// DeleteThing deletes a thing from Arduino IoT Cloud.
-func (cl *client) DeleteThing(id string) error {
+// ThingDelete deletes a thing from Arduino IoT Cloud.
+func (cl *client) ThingDelete(id string) error {
 	_, err := cl.api.ThingsV2Api.ThingsV2Delete(cl.ctx, id, nil)
 	if err != nil {
 		err = fmt.Errorf("deleting thing: %w", errorDetail(err))
@@ -125,9 +125,9 @@ func (cl *client) DeleteThing(id string) error {
 	return nil
 }
 
-// GetThing allows to retrieve a specific thing, given its id,
+// ThingShow allows to retrieve a specific thing, given its id,
 // from Arduino IoT Cloud.
-func (cl *client) GetThing(id string) (*iotclient.ArduinoThing, error) {
+func (cl *client) ThingShow(id string) (*iotclient.ArduinoThing, error) {
 	thing, _, err := cl.api.ThingsV2Api.ThingsV2Show(cl.ctx, id, nil)
 	if err != nil {
 		err = fmt.Errorf("retrieving thing, %w", errorDetail(err))
@@ -136,8 +136,8 @@ func (cl *client) GetThing(id string) (*iotclient.ArduinoThing, error) {
 	return &thing, nil
 }
 
-// ListThings returns a list of things on Arduino IoT Cloud.
-func (cl *client) ListThings(ids []string, device *string, props bool) ([]iotclient.ArduinoThing, error) {
+// ThingList returns a list of things on Arduino IoT Cloud.
+func (cl *client) ThingList(ids []string, device *string, props bool) ([]iotclient.ArduinoThing, error) {
 	opts := &iotclient.ThingsV2ListOpts{}
 	opts.ShowProperties = optional.NewBool(props)
 

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func Create(params *CreateParams) (string, error) {`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`fmt.Println("Creating a new device on the cloud")`
`60`		`- devID, err := iotClient.AddDevice(dev.fqbn, params.Name, dev.serial, dev.dType)`
	`60`	`+ devID, err := iotClient.DeviceCreate(dev.fqbn, params.Name, dev.serial, dev.dType)`
`61`	`61`	`if err != nil {`
`62`	`62`	`return "", err`
`63`	`63`	`}`
`@@ -71,7 +71,7 @@ func Create(params *CreateParams) (string, error) {`
`71`	`71`	`if err != nil {`
`72`	`72`	`// TODO: retry to delete the device if it returns an error.`
`73`	`73`	`// In alternative: encapsulate also this error.`
`74`		`- iotClient.DeleteDevice(devID)`
	`74`	`+ iotClient.DeviceDelete(devID)`
`75`	`75`	`err = fmt.Errorf("%s: %w", "cannot provision device", err)`
`76`	`76`	`return "", err`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,5 @@ func Delete(params *DeleteParams) error {`
`23`	`23`	`return err`
`24`	`24`	`}`
`25`	`25`
`26`		`- return iotClient.DeleteDevice(params.ID)`
	`26`	`+ return iotClient.DeviceDelete(params.ID)`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func List() ([]DeviceInfo, error) {`
`27`	`27`	`return nil, err`
`28`	`28`	`}`
`29`	`29`
`30`		`- foundDevices, err := iotClient.ListDevices()`
	`30`	`+ foundDevices, err := iotClient.DeviceList()`
`31`	`31`	`if err != nil {`
`32`	`32`	`return nil, err`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ func (p provision) configDev() error {`
`78`	`78`	`if err != nil {`
`79`	`79`	`return err`
`80`	`80`	`}`
`81`		`- cert, err := p.AddCertificate(p.id, string(csr))`
	`81`	`+ cert, err := p.CertificateCreate(p.id, string(csr))`
`82`	`82`	`if err != nil {`
`83`	`83`	`return err`
`84`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ func Bind(params *BindParams) error {`
`31`	`31`	`DeviceId: params.DeviceID,`
`32`	`32`	`}`
`33`	`33`
`34`		`- err = iotClient.UpdateThing(params.ID, thing, true)`
	`34`	`+ err = iotClient.ThingUpdate(params.ID, thing, true)`
`35`	`35`	`if err != nil {`
`36`	`36`	`return err`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ func Clone(params *CloneParams) (string, error) {`
`34`	`34`
`35`	`35`	`thing.Name = params.Name`
`36`	`36`	`force := true`
`37`		`- thingID, err := iotClient.AddThing(thing, force)`
	`37`	`+ thingID, err := iotClient.ThingCreate(thing, force)`
`38`	`38`	`if err != nil {`
`39`	`39`	`return "", err`
`40`	`40`	`}`
`@@ -43,7 +43,7 @@ func Clone(params *CloneParams) (string, error) {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`func retrieve(client iot.Client, thingID string) (*iotclient.Thing, error) {`
`46`		`- clone, err := client.GetThing(thingID)`
	`46`	`+ clone, err := client.ThingShow(thingID)`
`47`	`47`	`if err != nil {`
`48`	`48`	`return nil, fmt.Errorf("%s: %w", "retrieving the thing to be cloned", err)`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func Create(params *CreateParams) (string, error) {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`force := true`
`49`		`- thingID, err := iotClient.AddThing(thing, force)`
	`49`	`+ thingID, err := iotClient.ThingCreate(thing, force)`
`50`	`50`	`if err != nil {`
`51`	`51`	`return "", err`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ func Extract(params *ExtractParams) error {`
`31`	`31`	`return err`
`32`	`32`	`}`
`33`	`33`
`34`		`- thing, err := iotClient.GetThing(params.ID)`
	`34`	`+ thing, err := iotClient.ThingShow(params.ID)`
`35`	`35`	`if err != nil {`
`36`	`36`	`err = fmt.Errorf("%s: %w", "cannot extract thing: ", err)`
`37`	`37`	`return err`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func List(params *ListParams) ([]ThingInfo, error) {`
`37`	`37`	`return nil, err`
`38`	`38`	`}`
`39`	`39`
`40`		`- foundThings, err := iotClient.ListThings(params.IDs, params.DeviceID, params.Variables)`
	`40`	`+ foundThings, err := iotClient.ThingList(params.IDs, params.DeviceID, params.Variables)`
`41`	`41`	`if err != nil {`
`42`	`42`	`return nil, err`
`43`	`43`	`}`