first commit

Author: prep

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014, MessageBird
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -0,0 +1,18 @@
+.PHONY: examples format
+
+GORUN	= go run
+GOFMT	= gofmt -d=true -s=true -w=true
+
+all:
+	@echo "make examples - Run all the out-of-the-box workable examples"
+	@echo "make format   - Reformat the .go files in this project"
+
+examples:
+	$(GORUN) examples/balance.go
+	$(GORUN) examples/hlr_create.go
+	$(GORUN) examples/message_create.go
+	$(GORUN) examples/voice_message_create.go
+
+format:
+	$(GOFMT) messagebird/messagebird.go 
+	$(GOFMT) examples/*.go

README.md

@@ -0,0 +1,77 @@
+MessageBird's REST API for Go
+=============================
+This repository contains the open source Go client for MessageBird's REST API. Documentation can be found at: https://www.messagebird.com/developers/go.
+
+Requirements
+------------
+- [Sign up](https://www.messagebird.com/en/signup) for a free MessageBird account
+- Create a new access key in the developers sections
+- An application written in Go to make use of this API
+
+Installation
+------------
+The easiest way to use the MessageBird API in your Go project is to install it using *go get*:
+
+```
+$ go get https://github.com/messagebird/go-rest-api/messagebird
+```
+
+If this doesn't work, you probably haven't set your [GOPATH](https://code.google.com/p/go-wiki/wiki/GOPATH) variable.
+
+Examples
+--------
+We have put some self-explanatory examples in the [examples](https://github.com/messagebird/go-rest-api/tree/master/examples) directory, but here is a quick example on how to get started. Assuming the **go get** installation worked, you can import the messagebird package like this:
+
+```go
+import "github.com/messagebird/go-rest-api/messagebird"
+```
+
+Then, create an instance of **messagebird.Client**:
+
+```go
+mb := &messagebird.Client{AccessKey: "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:
+
+```go
+// Request the balance information, returned as a Balance object.
+balance, err := mb.Balance()
+if err != nil {
+	fmt.Println(err)
+	os.Exit(1)
+}
+
+// Check for errors returned as JSON.
+if len(balance.Errors) != 0 {
+	for _, error := range balance.Errors {
+		fmt.Println("  code        :", error.Code)
+		fmt.Println("  description :", error.Description)
+		fmt.Println("  parameter   :", error.Parameter)
+	}
+	os.Exit(1)
+}
+
+fmt.Println("  payment :", balance.Payment)
+fmt.Println("  type    :", balance.Type)
+fmt.Println("  amount  :", balance.Amount)
+```
+
+This will give you something like:
+```shell
+$ go run example.go
+  payment : prepaid
+  type    : credits
+  amount  : 9 
+```
+
+Please see the other examples for a complete overview of all the available API calls.
+
+Documentation
+-------------
+Complete documentation, instructions, and examples are available at:
+[https://www.messagebird.com/developers/go](https://www.messagebird.com/developers/go).
+
+License
+-------
+The MessageBird REST Client for Ruby is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2014, MessageBird

examples/balance.go

@@ -0,0 +1,37 @@
+package main
+
+import (
+	"../messagebird"
+	"fmt"
+	"os"
+)
+
+var AccessKey = "test_gshuPaZoeEG6ovbc8M79w0QyM"
+
+func main() {
+	// Create a MessageBird client with the specified AccessKey.
+	mb := &messagebird.Client{AccessKey: AccessKey}
+
+	// Fetch the Balance object.
+	balance, err := mb.Balance()
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+
+	// Check for errors returned as JSON.
+	if len(balance.Errors) != 0 {
+		for _, error := range balance.Errors {
+			fmt.Println("  code        :", error.Code)
+			fmt.Println("  description :", error.Description)
+			fmt.Println("  parameter   :", error.Parameter, "\n")
+		}
+		os.Exit(1)
+	}
+
+	// Print the object information.
+	fmt.Println("\nThe following information was returned as a Balance object:\n")
+	fmt.Println("  payment :", balance.Payment)
+	fmt.Println("  type    :", balance.Type)
+	fmt.Println("  amount  :", balance.Amount, "\n")
+}

examples/hlr.go

@@ -0,0 +1,47 @@
+package main
+
+import (
+	"../messagebird"
+	"fmt"
+	"os"
+)
+
+var AccessKey = ""
+var HLRId = ""
+
+func main() {
+	if len(AccessKey) == 0 || len(HLRId) == 0 {
+		fmt.Println("You need to set an AccessKey and HLRId in this file")
+		os.Exit(1)
+	}
+
+	// Create a MessageBird client with the specified AccessKey.
+	mb := &messagebird.Client{AccessKey: AccessKey}
+
+	// Fetch the HLR object.
+	hlr, err := mb.HLR("d26c94c0353bd8e171a3979h97860638")
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+
+	// Check for errors returned as JSON.
+	if len(hlr.Errors) != 0 {
+		for _, error := range hlr.Errors {
+			fmt.Println("  code        :", error.Code)
+			fmt.Println("  description :", error.Description)
+			fmt.Println("  parameter   :", error.Parameter, "\n")
+		}
+		os.Exit(1)
+	}
+
+	// Print the object information.
+	fmt.Println("\nThe following information was returned as an HLR object:\n")
+	fmt.Println("  id              :", hlr.Id)
+	fmt.Println("  href            :", hlr.HRef)
+	fmt.Println("  msisdn          :", hlr.MSISDN)
+	fmt.Println("  reference       :", hlr.Reference)
+	fmt.Println("  status          :", hlr.Status)
+	fmt.Println("  createdDatetime :", hlr.CreatedDatetime)
+	fmt.Println("  statusDatetime  :", hlr.StatusDatetime, "\n")
+}

examples/hlr_create.go

@@ -0,0 +1,41 @@
+package main
+
+import (
+	"../messagebird"
+	"fmt"
+	"os"
+)
+
+var AccessKey = "test_gshuPaZoeEG6ovbc8M79w0QyM"
+
+func main() {
+	// Create a MessageBird client with the specified AccessKey.
+	mb := &messagebird.Client{AccessKey: AccessKey}
+
+	// Fetch the HLR object.
+	hlr, err := mb.CreateHLR("31612345678", "MyReference")
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+
+	// Check for errors returned as JSON.
+	if len(hlr.Errors) != 0 {
+		for _, error := range hlr.Errors {
+			fmt.Println("  code        :", error.Code)
+			fmt.Println("  description :", error.Description)
+			fmt.Println("  parameter   :", error.Parameter, "\n")
+		}
+		os.Exit(1)
+	}
+
+	// Print the object information.
+	fmt.Println("\nThe following information was returned as an HLR object:\n")
+	fmt.Println("  id              :", hlr.Id)
+	fmt.Println("  href            :", hlr.HRef)
+	fmt.Println("  msisdn          :", hlr.MSISDN)
+	fmt.Println("  reference       :", hlr.Reference)
+	fmt.Println("  status          :", hlr.Status)
+	fmt.Println("  createdDatetime :", hlr.CreatedDatetime)
+	fmt.Println("  statusDatetime  :", hlr.StatusDatetime, "\n")
+}

examples/message.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"../messagebird"
+	"fmt"
+	"os"
+)
+
+var AccessKey = ""
+var MessageId = ""
+
+func main() {
+	if len(AccessKey) == 0 || len(MessageId) == 0 {
+		fmt.Println("You need to set an AccessKey and MessageId in this file")
+		os.Exit(1)
+	}
+
+	// Create a MessageBird client with the specified AccessKey.
+	mb := &messagebird.Client{AccessKey: AccessKey}
+
+	// Fetch the Message object.
+	message, err := mb.Message(MessageId)
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+
+	// Check for errors returned as JSON.
+	if len(message.Errors) != 0 {
+		for _, error := range message.Errors {
+			fmt.Println("  code        :", error.Code)
+			fmt.Println("  description :", error.Description)
+			fmt.Println("  parameter   :", error.Parameter, "\n")
+		}
+		os.Exit(1)
+	}
+
+	// Print the object information.
+	fmt.Println("\nThe following information was returned as a Message object:\n")
+	fmt.Println("  id                :", message.Id)
+	fmt.Println("  href              :", message.HRef)
+	fmt.Println("  direction         :", message.Direction)
+	fmt.Println("  type              :", message.Type)
+	fmt.Println("  originator        :", message.Originator)
+	fmt.Println("  body              :", message.Body)
+	fmt.Println("  reference         :", message.Reference)
+	fmt.Println("  validity          :", message.Validity)
+	fmt.Println("  gateway           :", message.Gateway)
+
+	if len(message.TypeDetails) > 0 {
+		fmt.Println("  typeDetails")
+		for k, v := range message.TypeDetails {
+			fmt.Println("    ", k, " : ", v)
+		}
+	}
+
+	fmt.Println("  datacoding        :", message.DataCoding)
+	fmt.Println("  mclass            :", message.MClass)
+	fmt.Println("  scheduledDatetime :", message.ScheduledDatetime)
+	fmt.Println("  createdDatetime   :", message.CreatedDatetime)
+	fmt.Println("  recipients")
+	fmt.Println("    totalCount               :", message.Recipients.TotalCount)
+	fmt.Println("    totalSentCount           :", message.Recipients.TotalSentCount)
+	fmt.Println("    totalDeliveredCount      :", message.Recipients.TotalDeliveredCount)
+	fmt.Println("    TotalDeliveryFailedCount :", message.Recipients.TotalDeliveryFailedCount)
+	fmt.Println("    items")
+
+	for _, recipient := range message.Recipients.Items {
+		fmt.Println("      recipient      :", recipient.Recipient)
+		fmt.Println("      status         :", recipient.Status)
+		fmt.Println("      statusDatetime :", recipient.StatusDatetime, "\n")
+	}
+}

examples/message_create.go

@@ -0,0 +1,71 @@
+package main
+
+import (
+	"../messagebird"
+	"fmt"
+	"net/url"
+	"os"
+)
+
+var AccessKey = "test_gshuPaZoeEG6ovbc8M79w0QyM"
+
+func main() {
+	// Create a MessageBird client with the specified AccessKey.
+	mb := &messagebird.Client{AccessKey: AccessKey}
+
+	// The optional parameters.
+	params := &url.Values{"reference": {"MyReference"}}
+
+	// Fetch the Message object.
+	message, err := mb.CreateMessage("MyName", []string{"31612345678"}, "Hello World", params)
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+
+	// Check for errors returned as JSON.
+	if len(message.Errors) != 0 {
+		for _, error := range message.Errors {
+			fmt.Println("  code        :", error.Code)
+			fmt.Println("  description :", error.Description)
+			fmt.Println("  parameter   :", error.Parameter, "\n")
+		}
+		os.Exit(1)
+	}
+
+	// Print the object information.
+	fmt.Println("\nThe following information was returned as a Message object:\n")
+	fmt.Println("  id                :", message.Id)
+	fmt.Println("  href              :", message.HRef)
+	fmt.Println("  direction         :", message.Direction)
+	fmt.Println("  type              :", message.Type)
+	fmt.Println("  originator        :", message.Originator)
+	fmt.Println("  body              :", message.Body)
+	fmt.Println("  reference         :", message.Reference)
+	fmt.Println("  validity          :", message.Validity)
+	fmt.Println("  gateway           :", message.Gateway)
+
+	if len(message.TypeDetails) > 0 {
+		fmt.Println("  typeDetails")
+		for k, v := range message.TypeDetails {
+			fmt.Println("    ", k, " : ", v)
+		}
+	}
+
+	fmt.Println("  datacoding        :", message.DataCoding)
+	fmt.Println("  mclass            :", message.MClass)
+	fmt.Println("  scheduledDatetime :", message.ScheduledDatetime)
+	fmt.Println("  createdDatetime   :", message.CreatedDatetime)
+	fmt.Println("  recipients")
+	fmt.Println("    totalCount               :", message.Recipients.TotalCount)
+	fmt.Println("    totalSentCount           :", message.Recipients.TotalSentCount)
+	fmt.Println("    totalDeliveredCount      :", message.Recipients.TotalDeliveredCount)
+	fmt.Println("    TotalDeliveryFailedCount :", message.Recipients.TotalDeliveryFailedCount)
+	fmt.Println("    items")
+
+	for _, recipient := range message.Recipients.Items {
+		fmt.Println("      recipient      :", recipient.Recipient)
+		fmt.Println("      status         :", recipient.Status)
+		fmt.Println("      statusDatetime :", recipient.StatusDatetime, "\n")
+	}
+}