new lookup endpoints: some changes after feedback

Author: Marcel Corso

client.go

@@ -9,7 +9,6 @@ package messagebird
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
 	"io/ioutil"
 	"log"
 	"net/http"
@@ -265,14 +264,10 @@ func (c *Client) OtpVerify(recipient string, token string, params *OtpParams) (*
 	return message, nil
 }
 
-// Lookup performs a new lookup for the specified number
-func (c *Client) Lookup(phoneNumber int, countryCode string) (*Lookup, error) {
-	urlParams := &url.Values{}
-	if countryCode != "" {
-		urlParams.Set("countryCode", countryCode)
-	}
-
-	path := fmt.Sprintf("lookup/%d?%s", phoneNumber, urlParams.Encode())
+// Lookup performs a new lookup for the specified number.
+func (c *Client) Lookup(phoneNumber string, params *LookupParams) (*Lookup, error) {
+	urlParams := paramsForLookup(params)
+	path := "lookup/" + phoneNumber + "?" + urlParams.Encode()
 
 	lookup := &Lookup{}
 	if err := c.request(lookup, path, nil); err != nil {
@@ -286,18 +281,12 @@ func (c *Client) Lookup(phoneNumber int, countryCode string) (*Lookup, error) {
 	return lookup, nil
 }
 
-// NewHLRLookup creates a new HRL lookup for the specified number
-func (c *Client) NewHLRLookup(phoneNumber int, countryCode string, reference string) (*HLR, error) {
-	params := &url.Values{}
-	if countryCode != "" {
-		params.Set("countryCode", countryCode)
-	}
-	if reference != "" {
-		params.Set("reference", reference)
-	}
+// NewHLRLookup creates a new HLR lookup for the specified number.
+func (c *Client) NewHLRLookup(phoneNumber string, lookupParams *LookupParams) (*HLR, error) {
+	params := paramsForLookup(lookupParams)
 
 	hlr := &HLR{}
-	path := fmt.Sprintf("lookup/%d/hlr", phoneNumber)
+	path := "lookup/" + phoneNumber + "/hlr"
 	if err := c.request(hlr, path, params); err != nil {
 		if err == ErrResponse {
 			return hlr, err
@@ -309,14 +298,11 @@ func (c *Client) NewHLRLookup(phoneNumber int, countryCode string, reference str
 	return hlr, nil
 }
 
-// HLRLookup performs a HLR lookup for the specified number
-func (c *Client) HLRLookup(phoneNumber int, countryCode string) (*HLR, error) {
-	urlParams := &url.Values{}
-	if countryCode != "" {
-		urlParams.Set("countryCode", countryCode)
-	}
+// HLRLookup performs a HLR lookup for the specified number.
+func (c *Client) HLRLookup(phoneNumber string, params *LookupParams) (*HLR, error) {
+	urlParams := paramsForLookup(params)
 
-	path := fmt.Sprintf("lookup/%d/hlr?%s", phoneNumber, urlParams.Encode())
+	path := "lookup/" + phoneNumber + "/hlr?" + urlParams.Encode()
 
 	hlr := &HLR{}
 	if err := c.request(hlr, path, nil); err != nil {

lookup.go

@@ -1,5 +1,7 @@
 package messagebird
 
+import "net/url"
+
 type Formats struct {
 	E164          string
 	International string
@@ -11,8 +13,30 @@ type Lookup struct {
 	Href          string
 	CountryCode   string
 	CountryPrefix int
-	PhoneNumber   int
+	PhoneNumber   int64
 	Type          string
-	Formats       *Formats
+	Formats       Formats
 	HLR           *HLR
 }
+
+type LookupParams struct {
+	CountryCode string
+	Reference   string
+}
+
+func paramsForLookup(params *LookupParams) *url.Values {
+	urlParams := &url.Values{}
+
+	if params == nil {
+		return urlParams
+	}
+
+	if params.CountryCode != "" {
+		urlParams.Set("countryCode", params.CountryCode)
+	}
+	if params.Reference != "" {
+		urlParams.Set("reference", params.Reference)
+	}
+
+	return urlParams
+}

lookup_test.go

@@ -1,6 +1,9 @@
 package messagebird
 
-import "testing"
+import (
+	"strconv"
+	"testing"
+)
 
 var lookupObject []byte = []byte(`{
     "href":"https://rest.messagebird.com/lookup/31624971134",
@@ -17,7 +20,7 @@ var lookupObject []byte = []byte(`{
     "hlr":{
         "id":"6118d3f06566fcd0cdc8962h65065907",
         "network":20416,
-        "reference":"yoloswag2000",
+        "reference":"referece2000",
         "status":"active",
         "createdDatetime":"2015-12-15T08:19:24+00:00",
         "statusDatetime":"2015-12-15T08:19:25+00:00"
@@ -27,7 +30,7 @@ var lookupObject []byte = []byte(`{
 var lookupHLRObject []byte = []byte(`{
     "id":"6118d3f06566fcd0cdc8962h65065907",
     "network":20416,
-    "reference":"yoloswag2000",
+    "reference":"referece2000",
     "status":"active",
     "createdDatetime":"2015-12-15T08:19:24+00:00",
     "statusDatetime":"2015-12-15T08:19:25+00:00"
@@ -36,27 +39,25 @@ var lookupHLRObject []byte = []byte(`{
 func TestLookup(t *testing.T) {
 	SetServerResponse(200, lookupObject)
 
-	phoneNumber := 31624971134
-	lookup, err := mbClient.Lookup(phoneNumber, "NL")
+	phoneNumber := "31624971134"
+	lookup, err := mbClient.Lookup(phoneNumber, &LookupParams{CountryCode: "NL"})
 	if err != nil {
 		t.Fatalf("Didn't expect error while doing the lookup: %s", err)
 	}
 
 	if lookup.Href != "https://rest.messagebird.com/lookup/31624971134" {
 		t.Errorf("Unexpected lookup href: %s", lookup.Href)
 	}
-	if lookup.PhoneNumber != phoneNumber {
+	if strconv.FormatInt(lookup.PhoneNumber, 10) != phoneNumber {
 		t.Errorf("Unexpected lookup phoneNumber: %s", lookup.PhoneNumber)
 	}
-	if lookup.Formats != nil {
-		if lookup.Formats.International != "+31 6 24971134" {
-			t.Errorf("Unexpected International format: %s", lookup.HLR.Reference)
-		}
-	} else {
-		t.Errorf("Unexpected empty Formats object")
+
+	if lookup.Formats.International != "+31 6 24971134" {
+		t.Errorf("Unexpected International format: %s", lookup.HLR.Reference)
 	}
+
 	if lookup.HLR != nil {
-		if lookup.HLR.Reference != "yoloswag2000" {
+		if lookup.HLR.Reference != "referece2000" {
 			t.Errorf("Unexpected hlr reference: %s", lookup.HLR.Reference)
 		}
 	} else {
@@ -71,7 +72,7 @@ func checkHLR(t *testing.T, hlr *HLR) {
 	if hlr.Network != 20416 {
 		t.Errorf("Unexpected hlr network: %d", hlr.Network)
 	}
-	if hlr.Reference != "yoloswag2000" {
+	if hlr.Reference != "referece2000" {
 		t.Errorf("Unexpected hlr reference: %s", hlr.Reference)
 	}
 	if hlr.Status != "active" {
@@ -82,7 +83,7 @@ func checkHLR(t *testing.T, hlr *HLR) {
 func TestHLRLookup(t *testing.T) {
 	SetServerResponse(200, lookupHLRObject)
 
-	hlr, err := mbClient.HLRLookup(31624971134, "NL")
+	hlr, err := mbClient.HLRLookup("31624971134", &LookupParams{CountryCode: "NL"})
 	if err != nil {
 		t.Fatalf("Didn't expect error while doing the lookup: %s", err)
 	}
@@ -92,7 +93,7 @@ func TestHLRLookup(t *testing.T) {
 func TestNewHLRLookup(t *testing.T) {
 	SetServerResponse(201, lookupHLRObject)
 
-	hlr, err := mbClient.NewHLRLookup(31624971134, "NL", "yoloswag2000")
+	hlr, err := mbClient.NewHLRLookup("31624971134", &LookupParams{CountryCode: "NL", Reference: "reference2000"})
 	if err != nil {
 		t.Fatalf("Didn't expect error while doing the lookup: %s", err)
 	}