Create a messagebird.New() function and update the documentation to reflect that addition; Also shorthand some 'if err' stuff

Author: prep

README.md

@@ -29,7 +29,7 @@ import "github.com/messagebird/go-rest-api/messagebird"
 Then, create an instance of **messagebird.Client**:
 
 ```go
-mb := &messagebird.Client{AccessKey: "test_gshuPaZoeEG6ovbc8M79w0QyM"}
+mb := messagebird.New("test_gshuPaZoeEG6ovbc8M79w0QyM")
 ```
 
 Now you can query the API for information or send data. For example, if we want to request our balance information you'd do something like this:

examples/balance.go

@@ -10,7 +10,7 @@ var AccessKey = "test_gshuPaZoeEG6ovbc8M79w0QyM"
 
 func main() {
 	// Create a MessageBird client with the specified AccessKey.
-	mb := &messagebird.Client{AccessKey: AccessKey}
+	mb := messagebird.New(AccessKey)
 
 	// Fetch the Balance object.
 	balance, err := mb.Balance()

examples/hlr.go

@@ -16,7 +16,7 @@ func main() {
 	}
 
 	// Create a MessageBird client with the specified AccessKey.
-	mb := &messagebird.Client{AccessKey: AccessKey}
+	mb := messagebird.New(AccessKey)
 
 	// Fetch the HLR object.
 	hlr, err := mb.HLR("d26c94c0353bd8e171a3979h97860638")

examples/hlr_create.go

@@ -10,7 +10,7 @@ var AccessKey = "test_gshuPaZoeEG6ovbc8M79w0QyM"
 
 func main() {
 	// Create a MessageBird client with the specified AccessKey.
-	mb := &messagebird.Client{AccessKey: AccessKey}
+	mb := messagebird.New(AccessKey)
 
 	// Fetch the HLR object.
 	hlr, err := mb.CreateHLR("31612345678", "MyReference")

examples/message.go

@@ -16,7 +16,7 @@ func main() {
 	}
 
 	// Create a MessageBird client with the specified AccessKey.
-	mb := &messagebird.Client{AccessKey: AccessKey}
+	mb := messagebird.New(AccessKey)
 
 	// Fetch the Message object.
 	message, err := mb.Message(MessageId)

examples/message_create.go

@@ -11,7 +11,7 @@ var AccessKey = "test_gshuPaZoeEG6ovbc8M79w0QyM"
 
 func main() {
 	// Create a MessageBird client with the specified AccessKey.
-	mb := &messagebird.Client{AccessKey: AccessKey}
+	mb := messagebird.New(AccessKey)
 
 	// The optional parameters.
 	params := &url.Values{"reference": {"MyReference"}}

examples/voice_message.go

@@ -16,7 +16,7 @@ func main() {
 	}
 
 	// Create a MessageBird client with the specified AccessKey.
-	mb := &messagebird.Client{AccessKey: AccessKey}
+	mb := messagebird.New(AccessKey)
 
 	// Fetch the VoiceMessage object.
 	vmsg, err := mb.VoiceMessage(MessageId)

examples/voice_message_create.go

@@ -11,7 +11,7 @@ var AccessKey = "test_gshuPaZoeEG6ovbc8M79w0QyM"
 
 func main() {
 	// Create a MessageBird client with the specified AccessKey.
-	mb := &messagebird.Client{AccessKey: AccessKey}
+	mb := messagebird.New(AccessKey)
 
 	// The optional parameters.
 	params := &url.Values{"reference": {"MyReference"}}

messagebird/messagebird.go

@@ -17,8 +17,8 @@ import (
 )
 
 const (
-	CLIENT_VERSION = "1.0.0"
-	ENDPOINT       = "https://rest.messagebird.com"
+	ClientVersion = "1.0.1"
+	Endpoint      = "https://rest.messagebird.com"
 )
 
 type Recipient struct {
@@ -97,20 +97,24 @@ type Client struct {
 	AccessKey string
 }
 
+// Create a new Client.
+func New(AccessKey string) *Client {
+	return &Client{AccessKey}
+}
+
 // This function performs a call to MessageBird's HTTP API and expects JSON in
 // return. It then tries to unmarshal the JSON body of the response to the
 // specified struct.
 func (c Client) request(v interface{}, path string, params *url.Values) error {
 	var request *http.Request
 
 	// Construct the URI of the request.
-	uri, err := url.Parse(ENDPOINT + "/" + path)
+	uri, err := url.Parse(Endpoint + "/" + path)
 	if err != nil {
 		return err
 	}
 
-	// Create an http.Client and construct a new request.
-	client := &http.Client{}
+	// Construct a new request.
 	if params == nil {
 		request, err = http.NewRequest("GET", uri.String(), nil)
 	} else {
@@ -123,14 +127,15 @@ func (c Client) request(v interface{}, path string, params *url.Values) error {
 	// Add a basic set of headers to the request.
 	request.Header.Add("Accept", "application/json")
 	request.Header.Add("Authorization", "AccessKey "+c.AccessKey)
-	request.Header.Add("User-Agent", "MessageBird/ApiClient/"+CLIENT_VERSION+" Go/"+runtime.Version())
+	request.Header.Add("User-Agent", "MessageBird/ApiClient/"+ClientVersion+" Go/"+runtime.Version())
 
 	// Add the Content-Type header if this is a POST request.
 	if params != nil {
 		request.Header.Set("Content-Type", "application/x-www-form-urlencoded")
 	}
 
-	// Execute the HTTP request and wait for a response.
+	// Create an http.Client, execute the HTTP request and wait for a response.
+	client := &http.Client{}
 	response, err := client.Do(request)
 	if err != nil {
 		return err
@@ -146,8 +151,7 @@ func (c Client) request(v interface{}, path string, params *url.Values) error {
 	}
 
 	// Convert the JSON body to the specified struct.
-	err = json.Unmarshal(body, v)
-	if err != nil {
+	if err = json.Unmarshal(body, v); err != nil {
 		return err
 	}
 
@@ -158,8 +162,7 @@ func (c Client) request(v interface{}, path string, params *url.Values) error {
 func (c Client) Balance() (*Balance, error) {
 	balance := &Balance{}
 
-	err := c.request(balance, "balance", nil)
-	if err != nil {
+	if err := c.request(balance, "balance", nil); err != nil {
 		return nil, err
 	}
 
@@ -170,8 +173,7 @@ func (c Client) Balance() (*Balance, error) {
 func (c Client) HLR(id string) (*HLR, error) {
 	hlr := &HLR{}
 
-	err := c.request(hlr, "hlr/"+id, nil)
-	if err != nil {
+	if err := c.request(hlr, "hlr/"+id, nil); err != nil {
 		return nil, err
 	}
 
@@ -186,8 +188,7 @@ func (c Client) CreateHLR(msisdn string, reference string) (*HLR, error) {
 
 	hlr := &HLR{}
 
-	err := c.request(hlr, "hlr", params)
-	if err != nil {
+	if err := c.request(hlr, "hlr", params); err != nil {
 		return nil, err
 	}
 
@@ -198,16 +199,14 @@ func (c Client) CreateHLR(msisdn string, reference string) (*HLR, error) {
 func (c Client) Message(id string) (*Message, error) {
 	msg := &Message{}
 
-	err := c.request(msg, "messages/"+id, nil)
-	if err != nil {
+	if err := c.request(msg, "messages/"+id, nil); err != nil {
 		return nil, err
 	}
 
 	return msg, nil
 }
 
-// This function creates a new message, which is sent to one or more
-// recipients.
+// This function creates a new message, which is sent to one or more recipients.
 func (c Client) CreateMessage(originator string, recipients []string, body string, params *url.Values) (*Message, error) {
 	recips := strings.Join(recipients, ",")
 
@@ -224,25 +223,25 @@ func (c Client) CreateMessage(originator string, recipients []string, body strin
 
 	msg := &Message{}
 
-	err := c.request(msg, "messages", params)
-	if err != nil {
+	if err := c.request(msg, "messages", params); err != nil {
 		return nil, err
 	}
 
 	return msg, nil
 }
 
+// This function retrieves the information of a specific voice message.
 func (c Client) VoiceMessage(id string) (*VoiceMessage, error) {
 	vmsg := &VoiceMessage{}
 
-	err := c.request(vmsg, "voicemessages/"+id, nil)
-	if err != nil {
+	if err := c.request(vmsg, "voicemessages/"+id, nil); err != nil {
 		return nil, err
 	}
 
 	return vmsg, nil
 }
 
+// This function creates a new voice message
 func (c Client) CreateVoiceMessage(recipients []string, body string, params *url.Values) (*VoiceMessage, error) {
 	recips := strings.Join(recipients, ",")
 
@@ -257,8 +256,7 @@ func (c Client) CreateVoiceMessage(recipients []string, body string, params *url
 
 	vmsg := &VoiceMessage{}
 
-	err := c.request(vmsg, "voicemessages", params)
-	if err != nil {
+	if err := c.request(vmsg, "voicemessages", params); err != nil {
 		return nil, err
 	}