move to v6 respecting go modules release guidelines (#91)

* move to v6 respecting go modules release guidelines * Update UPGRADING.md * set ClientVersion to 6.0.0 * update badge Co-authored-by: Sarath Pillai <[email protected]>
messagebird · Aug 18, 2020 · 1f4ec5f · 1f4ec5f
1 parent 23b045e
commit 1f4ec5f
Show file tree

Hide file tree

Showing 45 changed files with 68 additions and 59 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,8 +1,8 @@
 language: go
-go_import_path: github.com/messagebird/go-rest-api
+go_import_path: github.com/messagebird/go-rest-api/v6
 go:
-  - "1.13"
   - "1.14"
+  - "1.15"
   - stable
   - master
 matrix:

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@ 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://developers.messagebird.com.
 
-[![Build Status](https://travis-ci.org/messagebird/go-rest-api.svg?branch=master)](https://travis-ci.org/messagebird/go-rest-api) [![GoDoc](https://godoc.org/github.com/messagebird/go-rest-api?status.svg)](https://godoc.org/github.com/messagebird/go-rest-api)
+[![Build Status](https://travis-ci.org/messagebird/go-rest-api.svg?branch=master)](https://travis-ci.org/messagebird/go-rest-api) [![PkgGoDev](https://pkg.go.dev/badge/github.com/messagebird/go-rest-api)](https://pkg.go.dev/github.com/messagebird/go-rest-api)
 
 Requirements
 ------------
@@ -15,15 +15,15 @@ Installation
 The easiest way to use the MessageBird API in your Go project is to install it using *go get*:
 
 ```
-$ go get github.com/messagebird/go-rest-api
+$ go get github.com/messagebird/go-rest-api/v6
 ```
 
 Examples
 --------
 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"
+import "github.com/messagebird/go-rest-api/v6"
 ```
 
 Then, create an instance of **messagebird.Client**. It can be used to access the MessageBird APIs.
@@ -69,8 +69,8 @@ For this reason, errors returned by the `voice` package are of type `voice.Error
 An example of "simple" error handling is shown in the example above. Let's look how we can gain more in-depth insight in what exactly went wrong:
 
 ```go
-import "github.com/messagebird/go-rest-api"
-import "github.com/messagebird/go-rest-api/sms"
+import "github.com/messagebird/go-rest-api/v6"
+import "github.com/messagebird/go-rest-api/v6/sms"
 
 // ...
 
@@ -91,7 +91,7 @@ if err != nil {
 `voice.ErrorResponse` is very similar, except that it holds `voice.Error` structs - those contain only `Code` and `Message` (not description!) fields:
 
 ```go
-import "github.com/messagebird/go-rest-api/voice"
+import "github.com/messagebird/go-rest-api/v6/voice"
 
 // ...
 

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -92,3 +92,12 @@ if err != nil {
 
 ### Other improvements
 Although those are all breaking changes, it's worth mentioning this new version brings a number of other improvements. An example is that the client now supports contacts and groups - enjoy!
+
+
+## `v5.5.0` -> `v6.0.0`
+### Version suffix
+To preserve import compatibility, the go command requires that modules with major version v2 or later use a module path with that major version as the final element. 
+
+So all imports of `go-rest-api` are replaced as `go-rest-api/v6`. 
+
+
diff --git a/balance/balance.go b/balance/balance.go
@@ -3,7 +3,7 @@ package balance
 import (
 	"net/http"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // Balance describes your balance information.

diff --git a/balance/balance_test.go b/balance/balance_test.go
@@ -4,8 +4,8 @@ import (
 	"net/http"
 	"testing"
 
-	messagebird "github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	messagebird "github.com/messagebird/go-rest-api/v6"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 const Epsilon float32 = 0.001

diff --git a/client.go b/client.go
@@ -26,7 +26,7 @@ import (
 
 const (
 	// ClientVersion is used in User-Agent request header to provide server with API level.
-	ClientVersion = "5.5.0"
+	ClientVersion = "6.0.0"
 
 	// Endpoint points you to MessageBird REST API.
 	Endpoint = "https://rest.messagebird.com"

diff --git a/contact/contact.go b/contact/contact.go
@@ -8,7 +8,7 @@ import (
 	"strconv"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // Contact gets returned by the API.

diff --git a/contact/contact_test.go b/contact/contact_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/conversation/api.go b/conversation/api.go
@@ -7,7 +7,7 @@ import (
 	"strconv"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 const (

diff --git a/conversation/conversation.go b/conversation/conversation.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"net/http"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // ListOptions can be used to set pagination options in List().

diff --git a/conversation/conversation_test.go b/conversation/conversation_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/conversation/message.go b/conversation/message.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"net/http"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 type MessageCreateRequest struct {

diff --git a/conversation/message_test.go b/conversation/message_test.go
@@ -4,7 +4,7 @@ import (
 	"net/http"
 	"testing"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestCreateMessage(t *testing.T) {

diff --git a/conversation/webhook.go b/conversation/webhook.go
@@ -3,7 +3,7 @@ package conversation
 import (
 	"net/http"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 type WebhookCreateRequest struct {

diff --git a/conversation/webhook_test.go b/conversation/webhook_test.go
@@ -4,7 +4,7 @@ import (
 	"net/http"
 	"testing"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestCreateWebhook(t *testing.T) {

diff --git a/go.mod b/go.mod
@@ -1,3 +1,3 @@
-module github.com/messagebird/go-rest-api
+module github.com/messagebird/go-rest-api/v6
 
-go 1.13
+go 1.14
diff --git a/group/group.go b/group/group.go
@@ -9,8 +9,8 @@ import (
 	"strings"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/contact"
+	messagebird "github.com/messagebird/go-rest-api/v6"
+	"github.com/messagebird/go-rest-api/v6/contact"
 )
 
 // Group gets returned by the API.

diff --git a/group/group_test.go b/group/group_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/hlr/hlr.go b/hlr/hlr.go
@@ -5,7 +5,7 @@ import (
 	"net/http"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // HLR stands for Home Location Register. Contains information about the

diff --git a/hlr/hlr_test.go b/hlr/hlr_test.go
@@ -5,8 +5,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/internal/mbtest/test_client.go b/internal/mbtest/test_client.go
@@ -7,7 +7,7 @@ import (
 	"net/http"
 	"testing"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // testWriter can be used to have the client write to the tests's error log.

diff --git a/lookup/lookup.go b/lookup/lookup.go
@@ -4,8 +4,8 @@ import (
 	"net/http"
 	"net/url"
 
-	messagebird "github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/hlr"
+	messagebird "github.com/messagebird/go-rest-api/v6"
+	"github.com/messagebird/go-rest-api/v6/hlr"
 )
 
 // Formats represents phone number in multiple formats.

diff --git a/lookup/lookup_test.go b/lookup/lookup_test.go
@@ -5,8 +5,8 @@ import (
 	"strconv"
 	"testing"
 
-	"github.com/messagebird/go-rest-api/hlr"
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/hlr"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/mms/message.go b/mms/message.go
@@ -7,7 +7,7 @@ import (
 	"strings"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // Message represents a MMS Message.

diff --git a/mms/message_test.go b/mms/message_test.go
@@ -5,8 +5,8 @@ import (
 	"testing"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	messagebird "github.com/messagebird/go-rest-api/v6"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/number/number.go b/number/number.go
@@ -6,7 +6,7 @@ import (
 	"net/url"
 	"strconv"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 const (

diff --git a/number/number_test.go b/number/number_test.go
@@ -5,7 +5,7 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/sms/message.go b/sms/message.go
@@ -7,7 +7,7 @@ import (
 	"strconv"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // TypeDetails is a hash with extra information.

diff --git a/sms/message_test.go b/sms/message_test.go
@@ -6,8 +6,8 @@ import (
 	"testing"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	messagebird "github.com/messagebird/go-rest-api/v6"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/verify/verify.go b/verify/verify.go
@@ -6,7 +6,7 @@ import (
 	"net/url"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // Verify object represents MessageBird server response.

diff --git a/verify/verify_test.go b/verify/verify_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

diff --git a/voice/call.go b/voice/call.go
@@ -7,7 +7,7 @@ import (
 	"reflect"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // CallStatus enumerates all valid values for a call status.

diff --git a/voice/callflow.go b/voice/callflow.go
@@ -7,7 +7,7 @@ import (
 	"reflect"
 	"time"
 
-	"github.com/messagebird/go-rest-api"
+	"github.com/messagebird/go-rest-api/v6"
 )
 
 // A CallFlow describes the flow of operations (steps) to be executed when

diff --git a/voice/leg.go b/voice/leg.go
@@ -6,7 +6,7 @@ import (
 	"reflect"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // LegStatus enumerates all valid values for a leg status.

diff --git a/voice/main_test.go b/voice/main_test.go
@@ -9,7 +9,7 @@ import (
 	"os"
 	"testing"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 func testRequest(status int, body []byte) (*messagebird.Client, func()) {

diff --git a/voice/paginator.go b/voice/paginator.go
@@ -6,7 +6,7 @@ import (
 	"net/http"
 	"reflect"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // A Paginator is used to stream the contents of a collection of some type from

diff --git a/voice/recording.go b/voice/recording.go
@@ -9,7 +9,7 @@ import (
 	"runtime"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // RecordingStatus enumerates all valid values for the status of a recording.

diff --git a/voice/recording_test.go b/voice/recording_test.go
@@ -5,7 +5,7 @@ import (
 	"net/http"
 	"testing"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestRecordingGetFile(t *testing.T) {