Move HSM definitions to hsm.go

Author: epels

conversation/api.go

@@ -160,12 +160,15 @@ const (
 // per request.
 type MessageContent struct {
 	Audio    *Audio    `json:"audio,omitempty"`
-	HSM      *HSM      `json:"hsm,omitempty"`
 	File     *File     `json:"file,omitempty"`
 	Image    *Image    `json:"image,omitempty"`
 	Location *Location `json:"location,omitempty"`
 	Video    *Video    `json:"video,omitempty"`
 	Text     string    `json:"text,omitempty"`
+
+	// HSM is a highly structured message for WhatsApp. Its definition lives in
+	// hsm.go.
+	HSM *HSM `json:"hsm,omitempty"`
 }
 
 type Media struct {
@@ -177,60 +180,6 @@ type File Media
 type Image Media
 type Video Media
 
-// HSM is a pre-approved, reusable message template required when messaging
-// over WhatsApp. It allows you to just send the required parameter values
-// instead of the full message. It also allows for localization of the message
-// and decreases the possibility of being blocked on the first contact as the
-// message is pre-approved by WhatsApp.
-type HSM struct {
-	Namespace             string                     `json:"namespace"`
-	TemplateName          string                     `json:"templateName"`
-	Language              *HSMLanguage               `json:"language"`
-	LocalizableParameters []*HSMLocalizableParameter `json:"params"`
-}
-
-// HSMLanguage is used to set the message's locale.
-type HSMLanguage struct {
-	Policy HSMLanguagePolicy `json:"policy"`
-
-	// Code can be both language and language_locale formats (e.g. en and
-	// en_US).
-	Code string `json:"code"`
-}
-
-// HSMLanguagePolicy sets how the provided language is enforced.
-type HSMLanguagePolicy string
-
-const (
-	// HSMLanguagePolicyFallback will deliver the message template in the
-	// user's device language. If the settings can't be found on the user's
-	// device the fallback language is used.
-	HSMLanguagePolicyFallback HSMLanguagePolicy = "fallback"
-
-	// HSMLanguagePolicyDeterministic will deliver the message template
-	// exactly in the language and locale asked for.
-	HSMLanguagePolicyDeterministic HSMLanguagePolicy = "deterministic"
-)
-
-// HSMLocalizableParameter are used to replace the placeholders in the message
-// template. They will be localized by WhatsApp. Default values are used when
-// localization fails. Default is required. Additionally, currency OR DateTime
-// may be present in a request.
-type HSMLocalizableParameter struct {
-	Default  string                           `json:"default"`
-	Currency *HSMLocalizableParameterCurrency `json:"currency,omitempty"`
-	DateTime *time.Time                       `json:"dateTime,omitempty"`
-}
-
-type HSMLocalizableParameterCurrency struct {
-	// Code is the currency code in ISO 4217 format.
-	Code string `json:"currencyCode"`
-
-	// Amount is the total amount, including cents, multiplied by 1000. E.g.
-	// 12.34 become 12340.
-	Amount int64 `json:"amount"`
-}
-
 type Location struct {
 	Latitude  float32 `json:"latitude"`
 	Longitude float32 `json:"longitude"`

conversation/doc.go

@@ -4,8 +4,4 @@
 // contains the structs returned by the API, and the other files provide the
 // functionality needed to send requests, as well as any structs required for
 // that - e.g. request data or pagination options.
-//
-// @todo Write docs, mostly on HSM.
-// @todo Consider moving struct defs from api.go to separate files - or
-//       reorder them in a more logical way.
 package conversation

conversation/hsm.go

@@ -0,0 +1,86 @@
+package conversation
+
+import "time"
+
+// HSM is a pre-approved, reusable message template required when messaging
+// over WhatsApp. It allows you to just send the required parameter values
+// instead of the full message. It also allows for localization of the message
+// and decreases the possibility of being blocked on the first contact as the
+// message is pre-approved by WhatsApp.
+type HSM struct {
+	Namespace             string                     `json:"namespace"`
+	TemplateName          string                     `json:"templateName"`
+	Language              *HSMLanguage               `json:"language"`
+	LocalizableParameters []*HSMLocalizableParameter `json:"params"`
+}
+
+// HSMLanguage is used to set the message's locale.
+type HSMLanguage struct {
+	Policy HSMLanguagePolicy `json:"policy"`
+
+	// Code can be both language and language_locale formats (e.g. en and
+	// en_US).
+	Code string `json:"code"`
+}
+
+// HSMLanguagePolicy sets how the provided language is enforced.
+type HSMLanguagePolicy string
+
+const (
+	// HSMLanguagePolicyFallback will deliver the message template in the
+	// user's device language. If the settings can't be found on the user's
+	// device the fallback language is used.
+	HSMLanguagePolicyFallback HSMLanguagePolicy = "fallback"
+
+	// HSMLanguagePolicyDeterministic will deliver the message template
+	// exactly in the language and locale asked for.
+	HSMLanguagePolicyDeterministic HSMLanguagePolicy = "deterministic"
+)
+
+// HSMLocalizableParameter are used to replace the placeholders in the message
+// template. They will be localized by WhatsApp. Default values are used when
+// localization fails. Default is required. Additionally, currency OR DateTime
+// may be present in a request.
+type HSMLocalizableParameter struct {
+	Default  string                           `json:"default"`
+	Currency *HSMLocalizableParameterCurrency `json:"currency,omitempty"`
+	DateTime *time.Time                       `json:"dateTime,omitempty"`
+}
+
+type HSMLocalizableParameterCurrency struct {
+	// Code is the currency code in ISO 4217 format.
+	Code string `json:"currencyCode"`
+
+	// Amount is the total amount, including cents, multiplied by 1000. E.g.
+	// 12.34 become 12340.
+	Amount int64 `json:"amount"`
+}
+
+// DefaultLocalizableHSMParameter gets a simple parameter with a default value
+// that will do a simple string replacement.
+func DefaultLocalizableHSMParameter(d string) *HSMLocalizableParameter {
+	return &HSMLocalizableParameter{
+		Default: d,
+	}
+}
+
+// CurrencyLocalizableHSMParameter gets a parameter that localizes a currency.
+// Code is the currency code in ISO 4217 format and amount is the total amount,
+// including cents, multiplied by 1000. E.g. 12.34 becomes 12340.
+func CurrencyLocalizableHSMParameter(d string, code string, amount int64) *HSMLocalizableParameter {
+	return &HSMLocalizableParameter{
+		Default: d,
+		Currency: &HSMLocalizableParameterCurrency{
+			Code:   code,
+			Amount: amount,
+		},
+	}
+}
+
+// DateTimeLocalizableHSMParameter gets a parameter that localizes a DateTime.
+func DateTimeLocalizableHSMParameter(d string, dateTime time.Time) *HSMLocalizableParameter {
+	return &HSMLocalizableParameter{
+		Default:  d,
+		DateTime: &dateTime,
+	}
+}

conversation/hsm_test.go

@@ -0,0 +1,52 @@
+package conversation
+
+import (
+	"reflect"
+	"testing"
+	"time"
+)
+
+func TestLocalizableParameter(t *testing.T) {
+	now := time.Now()
+
+	tt := []struct {
+		name   string
+		got    *HSMLocalizableParameter
+		expect *HSMLocalizableParameter
+	}{
+		{
+			name: "default",
+			got:  DefaultLocalizableHSMParameter("foo"),
+			expect: &HSMLocalizableParameter{
+				Default: "foo",
+			},
+		},
+		{
+			name: "currency",
+			got:  CurrencyLocalizableHSMParameter("EUR 12.34", "EUR", int64(12340)),
+			expect: &HSMLocalizableParameter{
+				Default: "EUR 12.34",
+				Currency: &HSMLocalizableParameterCurrency{
+					Code:   "EUR",
+					Amount: int64(12340),
+				},
+			},
+		},
+		{
+			name: "date time",
+			got:  DateTimeLocalizableHSMParameter("baz", now),
+			expect: &HSMLocalizableParameter{
+				Default:  "baz",
+				DateTime: &now,
+			},
+		},
+	}
+
+	for _, tc := range tt {
+		t.Run(tc.name, func(t *testing.T) {
+			if !reflect.DeepEqual(tc.got, tc.expect) {
+				t.Fatalf("got %v, expected %v", tc.got, tc.expect)
+			}
+		})
+	}
+}