Add gsm7 library to test gsm7 of string and replace variances, implem…

…ent twilio, kannel, AT and BM channels for sending
nyaruka · Jun 20, 2017 · d3c3677 · d3c3677
1 parent 45eb520
commit d3c3677
Show file tree

Hide file tree

Showing 12 changed files with 580 additions and 31 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -13,7 +13,6 @@ services:
 - redis-server
 
 before_script:
-- redis-cli info
 - psql -U postgres -c "CREATE USER courier WITH PASSWORD 'courier';"
 - psql -U postgres -c "ALTER ROLE courier WITH SUPERUSER;"
 - psql -U postgres -c "CREATE DATABASE courier_test;"

diff --git a/backends/rapidpro/channel.go b/backends/rapidpro/channel.go
@@ -174,3 +174,13 @@ func (c *DBChannel) ConfigForKey(key string, defaultValue interface{}) interface
 	}
 	return value
 }
+
+// StringConfigForKey returns the config value for the passed in key, or defaultValue if it isn't found
+func (c *DBChannel) StringConfigForKey(key string, defaultValue string) string {
+	val := c.ConfigForKey(key, defaultValue)
+	str, isStr := val.(string)
+	if !isStr {
+		return defaultValue
+	}
+	return str
+}
diff --git a/channel.go b/channel.go
@@ -8,8 +8,20 @@ import (
 )
 
 const (
-	// ConfigAuthToken is our constant key used in channel configs for auth tokens
+	// ConfigAuthToken is a constant key for channel configs
 	ConfigAuthToken = "auth_token"
+
+	// ConfigUsername is a constant key for channel configs
+	ConfigUsername = "username"
+
+	// ConfigPassword is a constant key for channel configs
+	ConfigPassword = "password"
+
+	// ConfigAPIKey is a constant key for channel configs
+	ConfigAPIKey = "api_key"
+
+	// ConfigSendURL is a constant key for channel configs
+	ConfigSendURL = "send_url"
 )
 
 // ChannelType is our typing of the two char channel types
@@ -55,4 +67,5 @@ type Channel interface {
 	Country() string
 	Address() string
 	ConfigForKey(key string, defaultValue interface{}) interface{}
+	StringConfigForKey(key string, defaultValue string) string
 }
diff --git a/gsm7/gsm7.go b/gsm7/gsm7.go
@@ -0,0 +1,215 @@
+package gsm7
+
+import "bytes"
+
+var validGSM7 = map[rune]byte{
+	'@':  0x00,
+	'£':  0x01,
+	'$':  0x02,
+	'¥':  0x03,
+	'è':  0x04,
+	'é':  0x05,
+	'ù':  0x06,
+	'ì':  0x07,
+	'ò':  0x08,
+	'Ç':  0x09,
+	'\n': 0x0A,
+	'Ø':  0x0B,
+	'ø':  0x0C,
+	'\r': 0x0D,
+	'Å':  0x0E,
+	'å':  0x0F,
+	'Δ':  0x10,
+	'_':  0x11,
+	'Φ':  0x12,
+	'Γ':  0x13,
+	'Λ':  0x14,
+	'Ω':  0x15,
+	'Π':  0x16,
+	'Ψ':  0x17,
+	'Σ':  0x18,
+	'Θ':  0x19,
+	'Ξ':  0x1A,
+	// 'ESC':      0x1B, // Escape control
+	'Æ':  0x1C,
+	'æ':  0x1D,
+	'ß':  0x1E,
+	'É':  0x1F,
+	' ':  0x20,
+	'!':  0x21,
+	'"':  0x22,
+	'#':  0x23,
+	'¤':  0x24,
+	'%':  0x25,
+	'&':  0x26,
+	'\'': 0x27,
+	'(':  0x28,
+	')':  0x29,
+	'*':  0x2A,
+	'+':  0x2B,
+	',':  0x2C,
+	'-':  0x2D,
+	'.':  0x2E,
+	'/':  0x2F,
+	'0':  0x30,
+	'1':  0x31,
+	'2':  0x32,
+	'3':  0x33,
+	'4':  0x34,
+	'5':  0x35,
+	'6':  0x36,
+	'7':  0x37,
+	'8':  0x38,
+	'9':  0x39,
+	':':  0x3A,
+	';':  0x3B,
+	'<':  0x3C,
+	'=':  0x3D,
+	'>':  0x3E,
+	'?':  0x3F,
+	'¡':  0x40,
+	'A':  0x41,
+	'B':  0x42,
+	'C':  0x43,
+	'D':  0x44,
+	'E':  0x45,
+	'F':  0x46,
+	'G':  0x47,
+	'H':  0x48,
+	'I':  0x49,
+	'J':  0x4A,
+	'K':  0x4B,
+	'L':  0x4C,
+	'M':  0x4D,
+	'N':  0x4E,
+	'O':  0x4F,
+	'P':  0x50,
+	'Q':  0x51,
+	'R':  0x52,
+	'S':  0x53,
+	'T':  0x54,
+	'U':  0x55,
+	'V':  0x56,
+	'W':  0x57,
+	'X':  0x58,
+	'Y':  0x59,
+	'Z':  0x5A,
+	'Ä':  0x5B,
+	'Ö':  0x5C,
+	'Ñ':  0x5D,
+	'Ü':  0x5E,
+	'§':  0x5F,
+	'¿':  0x60,
+	'a':  0x61,
+	'b':  0x62,
+	'c':  0x63,
+	'd':  0x64,
+	'e':  0x65,
+	'f':  0x66,
+	'g':  0x67,
+	'h':  0x68,
+	'i':  0x69,
+	'j':  0x7A,
+	'k':  0x7B,
+	'l':  0x7C,
+	'm':  0x7D,
+	'n':  0x7E,
+	'o':  0x7F,
+	'p':  0x80,
+	'q':  0x81,
+	'r':  0x82,
+	's':  0x83,
+	't':  0x84,
+	'u':  0x85,
+	'v':  0x86,
+	'w':  0x87,
+	'x':  0x88,
+	'y':  0x89,
+	'z':  0x8A,
+	'ä':  0x8B,
+	'ö':  0x8C,
+	'ñ':  0x8D,
+	'ü':  0x8E,
+	'à':  0x8F,
+
+	// extended char set
+	// 'FF':  0x0A   // Page break
+	// 'CR2': 0x0D   // Control char
+	// 'SS2': 0x1B   // Single shift escape
+	'^':  0x14,
+	'{':  0x28,
+	'}':  0x29,
+	'\\': 0x2F,
+	'[':  0x3C,
+	'~':  0x3D,
+	']':  0x3E,
+	'|':  0x40,
+	'€':  0x65,
+}
+
+// Characters we replace in GSM7 with versions that can actually be encoded
+var gsm7Replacements = map[rune]rune{
+	'á': 'a',
+	'ê': 'e',
+	'ã': 'a',
+	'â': 'a',
+	'ç': 'c',
+	'í': 'i',
+	'î': 'i',
+	'ú': 'u',
+	'û': 'u',
+	'õ': 'o',
+	'ô': 'o',
+	'ó': 'o',
+
+	'Á': 'A',
+	'Â': 'A',
+	'Ã': 'A',
+	'À': 'A',
+	'Ç': 'C',
+	'È': 'E',
+	'Ê': 'E',
+	'Í': 'I',
+	'Î': 'I',
+	'Ì': 'I',
+	'Ó': 'O',
+	'Ô': 'O',
+	'Ò': 'O',
+	'Õ': 'O',
+	'Ú': 'U',
+	'Ù': 'U',
+	'Û': 'U',
+
+	// shit Word likes replacing automatically
+	'’':    '\'',
+	'‘':    '\'',
+	'“':    '"',
+	'”':    '"',
+	'–':    '-',
+	'\xa0': ' ',
+}
+
+// IsGSM7 returns whether the passed in string is made up of entirely GSM7 characters
+func IsGSM7(text string) bool {
+	for _, r := range text {
+		_, present := validGSM7[r]
+		if !present {
+			return false
+		}
+	}
+	return true
+}
+
+// ReplaceNonGSM7Chars replaces all the non-gsm7 characters it can in the passed in string
+func ReplaceNonGSM7Chars(text string) string {
+	output := bytes.Buffer{}
+	for _, r := range text {
+		replacement, present := gsm7Replacements[r]
+		if present {
+			output.WriteRune(replacement)
+		} else {
+			output.WriteRune(r)
+		}
+	}
+	return output.String()
+}
diff --git a/handlers/africastalking/handler.go b/handlers/africastalking/handler.go
@@ -3,12 +3,19 @@ package africastalking
 import (
 	"fmt"
 	"net/http"
+	"net/url"
+	"strings"
 	"time"
 
+	"github.com/buger/jsonparser"
 	"github.com/nyaruka/courier"
 	"github.com/nyaruka/courier/handlers"
+	"github.com/nyaruka/courier/utils"
+	"github.com/pkg/errors"
 )
 
+const configIsShared = "is_shared"
+
 func init() {
 	courier.RegisterHandler(NewHandler())
 }
@@ -111,5 +118,48 @@ func (h *handler) StatusMessage(channel courier.Channel, w http.ResponseWriter,
 
 // SendMsg sends the passed in message, returning any error
 func (h *handler) SendMsg(msg *courier.Msg) (*courier.MsgStatusUpdate, error) {
-	return nil, fmt.Errorf("sending not implemented channel type: %s", msg.Channel.ChannelType())
+	isSharedStr := msg.Channel.ConfigForKey(configIsShared, false)
+	isShared, _ := isSharedStr.(bool)
+
+	username := msg.Channel.StringConfigForKey(courier.ConfigUsername, "")
+	if username == "" {
+		return nil, fmt.Errorf("no username set for AT channel")
+	}
+
+	apiKey := msg.Channel.StringConfigForKey(courier.ConfigAPIKey, "")
+	if apiKey == "" {
+		return nil, fmt.Errorf("no API key set for AT channel")
+	}
+
+	// build our request
+	form := url.Values{
+		"username": []string{username},
+		"to":       []string{msg.URN.Path()},
+		"message":  []string{msg.Text},
+	}
+
+	// if this isn't shared, include our from
+	if !isShared {
+		form["from"] = []string{msg.Channel.Address()}
+	}
+
+	req, err := http.NewRequest("POST", "https://api.africastalking.com/version1/messaging", strings.NewReader(form.Encode()))
+	rr, err := utils.MakeHTTPRequest(req)
+
+	// record our status and log
+	status := courier.NewStatusUpdateForID(msg.Channel, msg.ID, courier.MsgErrored)
+	status.AddLog(courier.NewChannelLogFromRR(msg.Channel, msg.ID, rr))
+
+	// was this request successful?
+	msgStatus, _ := jsonparser.GetString([]byte(rr.Body), "SMSMessageData", "Recipients", "[0]", "status")
+	if err != nil || msgStatus != "Success" {
+		return status, errors.Errorf("received error sending message: %s", msgStatus)
+	}
+
+	// grab the external id if we can
+	externalID, _ := jsonparser.GetString([]byte(rr.Body), "SMSMessageData", "Recipients", "[0]", "messageId")
+	status.Status = courier.MsgWired
+	status.ExternalID = externalID
+
+	return status, nil
 }
diff --git a/handlers/blackmyna/handler.go b/handlers/blackmyna/handler.go
@@ -3,9 +3,14 @@ package blackmyna
 import (
 	"fmt"
 	"net/http"
+	"net/url"
+	"strings"
 
+	"github.com/buger/jsonparser"
 	"github.com/nyaruka/courier"
 	"github.com/nyaruka/courier/handlers"
+	"github.com/nyaruka/courier/utils"
+	"github.com/pkg/errors"
 )
 
 type bmHandler struct {
@@ -96,7 +101,46 @@ func (h *bmHandler) StatusMessage(channel courier.Channel, w http.ResponseWriter
 
 // SendMsg sends the passed in message, returning any error
 func (h *bmHandler) SendMsg(msg *courier.Msg) (*courier.MsgStatusUpdate, error) {
-	return nil, fmt.Errorf("sending not implemented channel type: %s", msg.Channel.ChannelType())
+	username := msg.Channel.StringConfigForKey(courier.ConfigUsername, "")
+	if username == "" {
+		return nil, fmt.Errorf("no username set for BM channel")
+	}
+
+	password := msg.Channel.StringConfigForKey(courier.ConfigPassword, "")
+	if password == "" {
+		return nil, fmt.Errorf("no password set for BM channel")
+	}
+
+	apiKey := msg.Channel.StringConfigForKey(courier.ConfigAPIKey, "")
+	if apiKey == "" {
+		return nil, fmt.Errorf("no API key set for AT channel")
+	}
+
+	// build our request
+	form := url.Values{
+		"address":       []string{msg.URN.Path()},
+		"senderaddress": []string{msg.Channel.Address()},
+		"message":       []string{msg.Text},
+	}
+
+	req, err := http.NewRequest("POST", "http://api.blackmyna.com/2/smsmessaging/outbound", strings.NewReader(form.Encode()))
+	req.SetBasicAuth(username, password)
+	rr, err := utils.MakeHTTPRequest(req)
+
+	// record our status and log
+	status := courier.NewStatusUpdateForID(msg.Channel, msg.ID, courier.MsgErrored)
+	status.AddLog(courier.NewChannelLogFromRR(msg.Channel, msg.ID, rr))
+
+	// get our external id
+	externalID, _ := jsonparser.GetString([]byte(rr.Body), "[0]", "id")
+	if err != nil || externalID == "" {
+		return status, errors.Errorf("received error sending message")
+	}
+
+	status.Status = courier.MsgWired
+	status.ExternalID = externalID
+
+	return status, nil
 }
 
 type bmStatus struct {