Fix #579: Cloud/Authentication: PATAuthTransport was renamed to APITokenAuthTransport

Author: andygrunwald

cloud/auth_transport_personal_access_token.go renamed to cloud/auth_transport_api_token.go

@@ -5,37 +5,39 @@ import (
 	"net/http"
 )
 
-// PATAuthTransport is an http.RoundTripper that authenticates all requests
-// using the Personal Access Token specified.
-// See here for more info: https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html
-type PATAuthTransport struct {
-	// Token is the key that was provided by Jira when creating the Personal Access Token.
+// APITokenAuthTransport is an http.RoundTripper that authenticates all requests
+// using a Personal API Token.
+//
+// Jira docs: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
+// Create a token: https://id.atlassian.com/manage-profile/security/api-tokens
+type APITokenAuthTransport struct {
+	// Token is the API key.
 	Token string
 
 	// Transport is the underlying HTTP transport to use when making requests.
 	// It will default to http.DefaultTransport if nil.
 	Transport http.RoundTripper
 }
 
-// RoundTrip implements the RoundTripper interface.  We just add the
-// basic auth and return the RoundTripper for this transport type.
-func (t *PATAuthTransport) RoundTrip(req *http.Request) (*http.Response, error) {
+// RoundTrip implements the RoundTripper interface. We just add the
+// API token header and return the RoundTripper for this transport type.
+func (t *APITokenAuthTransport) RoundTrip(req *http.Request) (*http.Response, error) {
 	req2 := cloneRequest(req) // per RoundTripper contract
 
 	req2.Header.Set("Authorization", fmt.Sprintf("Bearer %s", t.Token))
 	return t.transport().RoundTrip(req2)
 }
 
 // Client returns an *http.Client that makes requests that are authenticated
-// using HTTP Basic Authentication.  This is a nice little bit of sugar
+// using the API token. This is a nice little bit of sugar
 // so we can just get the client instead of creating the client in the calling code.
 // If it's necessary to send more information on client init, the calling code can
 // always skip this and set the transport itself.
-func (t *PATAuthTransport) Client() *http.Client {
+func (t *APITokenAuthTransport) Client() *http.Client {
 	return &http.Client{Transport: t}
 }
 
-func (t *PATAuthTransport) transport() http.RoundTripper {
+func (t *APITokenAuthTransport) transport() http.RoundTripper {
 	if t.Transport != nil {
 		return t.Transport
 	}

cloud/auth_transport_personal_access_token_test.go renamed to cloud/auth_transport_api_token_test.go

@@ -6,13 +6,13 @@ import (
 	"testing"
 )
 
-func TestPATAuthTransport_HeaderContainsAuth(t *testing.T) {
+func TestAPITokenAuthTransport_HeaderContainsAuth(t *testing.T) {
 	setup()
 	defer teardown()
 
-	token := "shhh, it's a token"
+	token := "shhh, it's an API token"
 
-	patTransport := &PATAuthTransport{
+	patTransport := &APITokenAuthTransport{
 		Token: token,
 	}
 
@@ -26,5 +26,4 @@ func TestPATAuthTransport_HeaderContainsAuth(t *testing.T) {
 
 	client, _ := NewClient(testServer.URL, patTransport.Client())
 	client.User.GetSelf(context.Background())
-
 }