Merge pull request #13 from machinebox/feature-helpers

added feature helpers

Author: dahernan

suggestionbox/suggestionbox_model.go

@@ -4,8 +4,10 @@ import (
 	"bytes"
 	"context"
 	"encoding/json"
+	"fmt"
 	"net/http"
 	"net/url"
+	"strings"
 	"time"
 
 	"github.com/pkg/errors"
@@ -16,35 +18,52 @@ type Model struct {
 	// ID is the ID of the model.
 	ID string `json:"id,omitempty"`
 	// Name is the human readable name of the Model.
-	Name string `json:"name,omitempty"`
+	Name string `json:"name"`
 	// Options are optional Model settings to adjust the behaviour
 	// of this Model within Suggestionbox.
 	Options *ModelOptions `json:"options,omitempty"`
 	// Choices are the options this Model will select from.
 	Choices []Choice `json:"choices,omitempty"`
 }
 
+// NewModel makes a new Model.
+func NewModel(id, name string, choices ...Choice) Model {
+	return Model{
+		ID:      id,
+		Name:    name,
+		Choices: choices,
+	}
+}
+
 // Feature represents a single feature, to describe an input or a choice
 // for example age:28 or location:"London".
 type Feature struct {
 	// Key is the name of the Feature.
-	Key string `json:"key,omitempty"`
+	Key string `json:"key"`
 	// Value is the string value of this Feature.
-	Value string `json:"value,omitempty"`
+	Value string `json:"value"`
 	// Type is the type of the Feature.
 	// Can be "number", "text", "keyword", "list", "image_url" or "image_base64"..
-	Type string `json:"type,omitempty"`
+	Type string `json:"type"`
 }
 
 // Choice is an option with features.
 type Choice struct {
 	// ID is a unique ID for this choice.
-	ID string `json:"id,omitempty"`
+	ID string `json:"id"`
 	// Features holds all the Feature objects that describe
 	// this choice.
 	Features []Feature `json:"features,omitempty"`
 }
 
+// NewChoice creates a new Choice.
+func NewChoice(id string, features ...Feature) Choice {
+	return Choice{
+		ID:       id,
+		Features: features,
+	}
+}
+
 // ModelOptions describes the behaviours of a Model.
 type ModelOptions struct {
 	// Expiration is the time to wait for the reward before it expires.
@@ -104,3 +123,60 @@ func (c *Client) CreateModel(ctx context.Context, model Model) (Model, error) {
 	}
 	return response.Model, nil
 }
+
+// FeatureNumber makes a numerical Feature.
+func FeatureNumber(key string, value float64) Feature {
+	return Feature{
+		Type:  "number",
+		Key:   key,
+		Value: fmt.Sprintf("%v", value),
+	}
+}
+
+// FeatureText makes a textual Feature that will be tokenized.
+// Use FeatureKeyword for values that should not be tokenized.
+func FeatureText(key string, text string) Feature {
+	return Feature{
+		Type:  "text",
+		Key:   key,
+		Value: text,
+	}
+}
+
+// FeatureKeyword makes a textual Feature that will not be tokenized.
+// Use FeatureList to provide multiple keywords in a single Feature.
+// Use Text for bodies of text that should be tokenized.
+func FeatureKeyword(key string, keyword string) Feature {
+	return Feature{
+		Type:  "keyword",
+		Key:   key,
+		Value: keyword,
+	}
+}
+
+// FeatureList makes a Feature made up of multiple keywords.
+func FeatureList(key string, keywords ...string) Feature {
+	return Feature{
+		Type:  "list",
+		Key:   key,
+		Value: strings.Join(keywords, ","),
+	}
+}
+
+// FeatureImageURL makes a Feature that points to a hosted image.
+func FeatureImageURL(key string, url string) Feature {
+	return Feature{
+		Type:  "image_url",
+		Key:   key,
+		Value: url,
+	}
+}
+
+// FeatureImageBase64 makes a Feature that is base 64 encoded.
+func FeatureImageBase64(key string, data string) Feature {
+	return Feature{
+		Type:  "image_base64",
+		Key:   key,
+		Value: data,
+	}
+}

suggestionbox/suggestionbox_model_test.go

@@ -34,23 +34,75 @@ func TestCreateModel(t *testing.T) {
 	}))
 	defer srv.Close()
 	sb := suggestionbox.New(srv.URL)
-	inModel := suggestionbox.Model{
-		Name: "My Model",
-		Choices: []suggestionbox.Choice{
-			{
-				ID: "choice1",
-				Features: []suggestionbox.Feature{
-					{
-						Key:   "title",
-						Type:  "text",
-						Value: "Machine Box releases new product",
-					},
-				},
-			},
-		},
-	}
+	inModel := suggestionbox.NewModel("", "My Model",
+		suggestionbox.NewChoice("choice1",
+			suggestionbox.FeatureText("title", "Machine Box releases new product"),
+		),
+	)
 	outModel, err := sb.CreateModel(context.Background(), inModel)
 	is.NoErr(err)
 	is.Equal(apiCalls, 1)      // apiCalls
 	is.Equal(outModel.ID, "1") // outModel.ID
 }
+
+func TestNewModel(t *testing.T) {
+	is := is.New(t)
+
+	m := suggestionbox.NewModel("model1", "My Model",
+		suggestionbox.NewChoice("choice1",
+			suggestionbox.FeatureKeyword("city", "New York City"),
+		),
+	)
+	is.Equal(m.ID, "model1")
+	is.Equal(m.Name, "My Model")
+	is.Equal(len(m.Choices), 1)
+	is.Equal(m.Choices[0].ID, "choice1")
+}
+
+func TestNewChoice(t *testing.T) {
+	is := is.New(t)
+
+	c := suggestionbox.NewChoice("choice1",
+		suggestionbox.FeatureKeyword("city", "New York City"),
+	)
+	is.Equal(c.ID, "choice1")
+	is.Equal(len(c.Features), 1)
+	is.Equal(c.Features[0].Key, "city")
+}
+
+func TestFeatureHelpers(t *testing.T) {
+	is := is.New(t)
+
+	var f suggestionbox.Feature
+
+	f = suggestionbox.FeatureNumber("age", 20)
+	is.Equal(f.Type, "number")
+	is.Equal(f.Key, "age")
+	is.Equal(f.Value, "20")
+
+	f = suggestionbox.FeatureText("title", "Machine box releases new box")
+	is.Equal(f.Type, "text")
+	is.Equal(f.Key, "title")
+	is.Equal(f.Value, "Machine box releases new box")
+
+	f = suggestionbox.FeatureKeyword("city", "New York City")
+	is.Equal(f.Type, "keyword")
+	is.Equal(f.Key, "city")
+	is.Equal(f.Value, "New York City")
+
+	f = suggestionbox.FeatureList("categories", "one", "two", "three")
+	is.Equal(f.Type, "list")
+	is.Equal(f.Key, "categories")
+	is.Equal(f.Value, "one,two,three")
+
+	f = suggestionbox.FeatureImageURL("pic", "http://url.com/path/to/pic.jpg")
+	is.Equal(f.Type, "image_url")
+	is.Equal(f.Key, "pic")
+	is.Equal(f.Value, "http://url.com/path/to/pic.jpg")
+
+	f = suggestionbox.FeatureImageBase64("pic", "pretendthisisimagedata")
+	is.Equal(f.Type, "image_base64")
+	is.Equal(f.Key, "pic")
+	is.Equal(f.Value, "pretendthisisimagedata")
+
+}