Add comments for download tools

Author: matteosuppo

tools/tools.go

@@ -45,14 +45,44 @@ import (
 	"github.com/codeclysm/extract"
 )
 
+// Tool is a program needed to program a board
 type Tool struct {
 	Name     string
 	Version  string
 	Packager string
 	Path     string
 }
 
-func (t *Tool) Download(url, signature string, opts *Opts) error {
+// Opts contain options to pass to the Download function
+type Opts struct {
+	Location string
+	Client   *http.Client
+}
+
+// fill fills itself with default values
+func (o *Opts) fill() *Opts {
+	if o == nil {
+		o = &Opts{}
+	}
+
+	if o.Location == "" {
+		usr, _ := user.Current()
+		o.Location = filepath.Join(usr.HomeDir, ".arduino-create")
+	}
+
+	if o.Client == nil {
+		o.Client = &http.Client{
+			Timeout: 10 * time.Second,
+		}
+	}
+
+	fmt.Println(o)
+
+	return o
+}
+
+// Download unpacks a tool on the system, checking that the checksum matches
+func (t *Tool) Download(url, checksum string, opts *Opts) error {
 	opts = opts.fill()
 
 	// Download
@@ -75,10 +105,10 @@ func (t *Tool) Download(url, signature string, opts *Opts) error {
 	h := sha256.New()
 	h.Write(body)
 	sum := h.Sum(nil)
-	signature = strings.Split(signature, ":")[1]
+	checksum = strings.Split(checksum, ":")[1]
 
-	if string(hex.EncodeToString(sum)) != signature {
-		return errors.New("signature doesn't match")
+	if string(hex.EncodeToString(sum)) != checksum {
+		return errors.New("checksum doesn't match")
 	}
 
 	// Remove folder
@@ -107,34 +137,6 @@ func (t *Tool) Download(url, signature string, opts *Opts) error {
 	return nil
 }
 
-// Opts contain options to pass to the Download function
-type Opts struct {
-	Location string
-	Client   *http.Client
-}
-
-// fill fills itself with default values
-func (o *Opts) fill() *Opts {
-	if o == nil {
-		o = &Opts{}
-	}
-
-	if o.Location == "" {
-		usr, _ := user.Current()
-		o.Location = filepath.Join(usr.HomeDir, ".arduino-create")
-	}
-
-	if o.Client == nil {
-		o.Client = &http.Client{
-			Timeout: 10 * time.Second,
-		}
-	}
-
-	fmt.Println(o)
-
-	return o
-}
-
 // Installed returns a list of the installed tools
 func Installed(opts *Opts) ([]Tool, error) {
 	opts = opts.fill()