fix(product): Make product naming consistent, rename JIRA to Jira (#286)

Atlassian names the product "Jira".
In this library, the product name is used different (JIRA) and
inconsistent (sometimes JIRA, sometimes Jira).

closes issue #284

Author: andygrunwald

README.md

@@ -4,23 +4,23 @@
 [![Build Status](https://travis-ci.org/andygrunwald/go-jira.svg?branch=master)](https://travis-ci.org/andygrunwald/go-jira)
 [![Go Report Card](https://goreportcard.com/badge/github.com/andygrunwald/go-jira)](https://goreportcard.com/report/github.com/andygrunwald/go-jira)
 
-[Go](https://golang.org/) client library for [Atlassian JIRA](https://www.atlassian.com/software/jira).
+[Go](https://golang.org/) client library for [Atlassian Jira](https://www.atlassian.com/software/jira).
 
-![Go client library for Atlassian JIRA](./img/logo_small.png "Go client library for Atlassian JIRA.")
+![Go client library for Atlassian Jira](./img/logo_small.png "Go client library for Atlassian Jira.")
 
 ## Features
 
 * Authentication (HTTP Basic, OAuth, Session Cookie)
 * Create and retrieve issues
 * Create and retrieve issue transitions (status updates)
-* Call every API endpoint of the JIRA, even if it is not directly implemented in this library
+* Call every API endpoint of the Jira, even if it is not directly implemented in this library
 
-This package is not JIRA API complete (yet), but you can call every API endpoint you want. See [Call a not implemented API endpoint](#call-a-not-implemented-api-endpoint) how to do this. For all possible API endpoints of JIRA have a look at [latest JIRA REST API documentation](https://docs.atlassian.com/jira/REST/latest/).
+This package is not Jira API complete (yet), but you can call every API endpoint you want. See [Call a not implemented API endpoint](#call-a-not-implemented-api-endpoint) how to do this. For all possible API endpoints of Jira have a look at [latest Jira REST API documentation](https://docs.atlassian.com/jira/REST/latest/).
 
 ## Requirements
 
 * Go >= 1.8
-* JIRA v6.3.4 & v7.1.2.
+* Jira v6.3.4 & v7.1.2.
 
 ## Installation
 
@@ -52,7 +52,7 @@ go test -v ./...
 
 Please have a look at the [GoDoc documentation](https://godoc.org/github.com/andygrunwald/go-jira) for a detailed API description.
 
-The [latest JIRA REST API documentation](https://docs.atlassian.com/jira/REST/latest/) was the base document for this package.
+The [latest Jira REST API documentation](https://docs.atlassian.com/jira/REST/latest/) was the base document for this package.
 
 ## Examples
 
@@ -113,12 +113,12 @@ func main() {
 
 #### Authenticate with session cookie [DEPRECATED]
 
-JIRA [deprecated this authentication method.](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-basic-auth-and-cookie-based-auth/)  It's not longer available for use.
+Jira [deprecated this authentication method.](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-basic-auth-and-cookie-based-auth/)  It's not longer available for use.
 
 
 #### Authenticate with OAuth
 
-If you want to connect via OAuth to your JIRA Cloud instance checkout the [example of using OAuth authentication with JIRA in Go](https://gist.github.com/Lupus/edafe9a7c5c6b13407293d795442fe67) by [@Lupus](https://github.com/Lupus).
+If you want to connect via OAuth to your Jira Cloud instance checkout the [example of using OAuth authentication with Jira in Go](https://gist.github.com/Lupus/edafe9a7c5c6b13407293d795442fe67) by [@Lupus](https://github.com/Lupus).
 
 For more details have a look at the [issue #56](https://github.com/andygrunwald/go-jira/issues/56).
 
@@ -175,9 +175,9 @@ func main() {
 
 ### Call a not implemented API endpoint
 
-Not all API endpoints of the JIRA API are implemented into *go-jira*.
+Not all API endpoints of the Jira API are implemented into *go-jira*.
 But you can call them anyway:
-Lets get all public projects of [Atlassian`s JIRA instance](https://jira.atlassian.com/).
+Lets get all public projects of [Atlassian`s Jira instance](https://jira.atlassian.com/).
 
 ```go
 package main
@@ -209,7 +209,7 @@ func main() {
 
 	// ...
 	// BAM: Bamboo
-	// BAMJ: Bamboo JIRA Plugin
+	// BAMJ: Bamboo Jira Plugin
 	// CLOV: Clover
 	// CONF: Confluence
 	// ...
@@ -218,15 +218,15 @@ func main() {
 
 ## Implementations
 
-* [andygrunwald/jitic](https://github.com/andygrunwald/jitic) - The JIRA Ticket Checker
+* [andygrunwald/jitic](https://github.com/andygrunwald/jitic) - The Jira Ticket Checker
 
 ## Code structure
 
 The code structure of this package was inspired by [google/go-github](https://github.com/google/go-github).
 
 There is one main part (the client).
 Based on this main client the other endpoints, like Issues or Authentication are extracted in services. E.g. `IssueService` or `AuthenticationService`.
-These services own a responsibility of the single endpoints / usecases of JIRA.
+These services own a responsibility of the single endpoints / usecases of Jira.
 
 ## Contribution
 

authentication.go

@@ -15,9 +15,9 @@ const (
 	authTypeSession = 2
 )
 
-// AuthenticationService handles authentication for the JIRA instance / API.
+// AuthenticationService handles authentication for the Jira instance / API.
 //
-// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#authentication
+// Jira API docs: https://docs.atlassian.com/jira/REST/latest/#authentication
 type AuthenticationService struct {
 	client *Client
 
@@ -31,7 +31,7 @@ type AuthenticationService struct {
 	password string
 }
 
-// Session represents a Session JSON response by the JIRA API.
+// Session represents a Session JSON response by the Jira API.
 type Session struct {
 	Self    string `json:"self,omitempty"`
 	Name    string `json:"name,omitempty"`
@@ -48,13 +48,13 @@ type Session struct {
 	Cookies []*http.Cookie
 }
 
-// AcquireSessionCookieWithContext creates a new session for a user in JIRA.
-// Once a session has been successfully created it can be used to access any of JIRA's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.
+// AcquireSessionCookieWithContext creates a new session for a user in Jira.
+// Once a session has been successfully created it can be used to access any of Jira's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.
 // The header will by automatically applied to every API request.
 // Note that it is generally preferrable to use HTTP BASIC authentication with the REST API.
-// However, this resource may be used to mimic the behaviour of JIRA's log-in page (e.g. to display log-in errors to a user).
+// However, this resource may be used to mimic the behaviour of Jira's log-in page (e.g. to display log-in errors to a user).
 //
-// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#auth/1/session
+// Jira API docs: https://docs.atlassian.com/jira/REST/latest/#auth/1/session
 //
 // Deprecated: Use CookieAuthTransport instead
 func (s *AuthenticationService) AcquireSessionCookieWithContext(ctx context.Context, username, password string) (bool, error) {
@@ -99,7 +99,7 @@ func (s *AuthenticationService) AcquireSessionCookie(username, password string)
 	return s.AcquireSessionCookieWithContext(context.Background(), username, password)
 }
 
-// SetBasicAuth sets username and password for the basic auth against the JIRA instance.
+// SetBasicAuth sets username and password for the basic auth against the Jira instance.
 //
 // Deprecated: Use BasicAuthTransport instead
 func (s *AuthenticationService) SetBasicAuth(username, password string) {
@@ -108,7 +108,7 @@ func (s *AuthenticationService) SetBasicAuth(username, password string) {
 	s.authType = authTypeBasic
 }
 
-// Authenticated reports if the current Client has authentication details for JIRA
+// Authenticated reports if the current Client has authentication details for Jira
 func (s *AuthenticationService) Authenticated() bool {
 	if s != nil {
 		if s.authType == authTypeSession {
@@ -123,7 +123,7 @@ func (s *AuthenticationService) Authenticated() bool {
 
 // LogoutWithContext logs out the current user that has been authenticated and the session in the client is destroyed.
 //
-// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#auth/1/session
+// Jira API docs: https://docs.atlassian.com/jira/REST/latest/#auth/1/session
 //
 // Deprecated: Use CookieAuthTransport to create base client.  Logging out is as simple as not using the
 // client anymore
@@ -163,7 +163,7 @@ func (s *AuthenticationService) Logout() error {
 
 // GetCurrentUserWithContext gets the details of the current user.
 //
-// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#auth/1/session
+// Jira API docs: https://docs.atlassian.com/jira/REST/latest/#auth/1/session
 func (s *AuthenticationService) GetCurrentUserWithContext(ctx context.Context) (*Session, error) {
 	if s == nil {
 		return nil, fmt.Errorf("authentication Service is not instantiated")

board.go

@@ -7,9 +7,9 @@ import (
 	"time"
 )
 
-// BoardService handles Agile Boards for the JIRA instance / API.
+// BoardService handles Agile Boards for the Jira instance / API.
 //
-// JIRA API docs: https://docs.atlassian.com/jira-software/REST/server/
+// Jira API docs: https://docs.atlassian.com/jira-software/REST/server/
 type BoardService struct {
 	client *Client
 }
@@ -23,7 +23,7 @@ type BoardsList struct {
 	Values     []Board `json:"values" structs:"values"`
 }
 
-// Board represents a JIRA agile board
+// Board represents a Jira agile board
 type Board struct {
 	ID       int    `json:"id,omitempty" structs:"id,omitempty"`
 	Self     string `json:"self,omitempty" structs:"self,omitempty"`
@@ -63,7 +63,7 @@ type SprintsList struct {
 	Values     []Sprint `json:"values" structs:"values"`
 }
 
-// Sprint represents a sprint on JIRA agile board
+// Sprint represents a sprint on Jira agile board
 type Sprint struct {
 	ID            int        `json:"id" structs:"id"`
 	Name          string     `json:"name" structs:"name"`
@@ -127,7 +127,7 @@ type BoardConfigurationColumnStatus struct {
 
 // GetAllBoardsWithContext will returns all boards. This only includes boards that the user has permission to view.
 //
-// JIRA API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-getAllBoards
+// Jira API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-getAllBoards
 func (s *BoardService) GetAllBoardsWithContext(ctx context.Context, opt *BoardListOptions) (*BoardsList, *Response, error) {
 	apiEndpoint := "rest/agile/1.0/board"
 	url, err := addOptions(apiEndpoint, opt)
@@ -157,7 +157,7 @@ func (s *BoardService) GetAllBoards(opt *BoardListOptions) (*BoardsList, *Respon
 // GetBoardWithContext will returns the board for the given boardID.
 // This board will only be returned if the user has permission to view it.
 //
-// JIRA API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-getBoard
+// Jira API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-getBoard
 func (s *BoardService) GetBoardWithContext(ctx context.Context, boardID int) (*Board, *Response, error) {
 	apiEndpoint := fmt.Sprintf("rest/agile/1.0/board/%v", boardID)
 	req, err := s.client.NewRequestWithContext(ctx, "GET", apiEndpoint, nil)
@@ -187,7 +187,7 @@ func (s *BoardService) GetBoard(boardID int) (*Board, *Response, error) {
 // Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private
 // board will be created instead (remember that board sharing depends on the filter sharing).
 //
-// JIRA API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-createBoard
+// Jira API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-createBoard
 func (s *BoardService) CreateBoardWithContext(ctx context.Context, board *Board) (*Board, *Response, error) {
 	apiEndpoint := "rest/agile/1.0/board"
 	req, err := s.client.NewRequestWithContext(ctx, "POST", apiEndpoint, board)
@@ -212,7 +212,7 @@ func (s *BoardService) CreateBoard(board *Board) (*Board, *Response, error) {
 
 // DeleteBoardWithContext will delete an agile board.
 //
-// JIRA API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-deleteBoard
+// Jira API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-deleteBoard
 func (s *BoardService) DeleteBoardWithContext(ctx context.Context, boardID int) (*Board, *Response, error) {
 	apiEndpoint := fmt.Sprintf("rest/agile/1.0/board/%v", boardID)
 	req, err := s.client.NewRequestWithContext(ctx, "DELETE", apiEndpoint, nil)
@@ -235,7 +235,7 @@ func (s *BoardService) DeleteBoard(boardID int) (*Board, *Response, error) {
 // GetAllSprintsWithContext will return all sprints from a board, for a given board Id.
 // This only includes sprints that the user has permission to view.
 //
-// JIRA API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board/{boardId}/sprint
+// Jira API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board/{boardId}/sprint
 func (s *BoardService) GetAllSprintsWithContext(ctx context.Context, boardID string) ([]Sprint, *Response, error) {
 	id, err := strconv.Atoi(boardID)
 	if err != nil {
@@ -258,7 +258,7 @@ func (s *BoardService) GetAllSprints(boardID string) ([]Sprint, *Response, error
 // GetAllSprintsWithOptionsWithContext will return sprints from a board, for a given board Id and filtering options
 // This only includes sprints that the user has permission to view.
 //
-// JIRA API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board/{boardId}/sprint
+// Jira API docs: https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board/{boardId}/sprint
 func (s *BoardService) GetAllSprintsWithOptionsWithContext(ctx context.Context, boardID int, options *GetAllSprintsOptions) (*SprintsList, *Response, error) {
 	apiEndpoint := fmt.Sprintf("rest/agile/1.0/board/%d/sprint", boardID)
 	url, err := addOptions(apiEndpoint, options)

component.go

@@ -2,14 +2,13 @@ package jira
 
 import "context"
 
-// ComponentService handles components for the JIRA instance / API.
-//
-// JIRA API docs: https://docs.atlassian.com/software/jira/docs/api/REST/7.10.1/#api/2/component
+// ComponentService handles components for the Jira instance / API.//
+// Jira API docs: https://docs.atlassian.com/software/jira/docs/api/REST/7.10.1/#api/2/component
 type ComponentService struct {
 	client *Client
 }
 
-// CreateComponentOptions are passed to the ComponentService.Create function to create a new JIRA component
+// CreateComponentOptions are passed to the ComponentService.Create function to create a new Jira component
 type CreateComponentOptions struct {
 	Name         string `json:"name,omitempty" structs:"name,omitempty"`
 	Description  string `json:"description,omitempty" structs:"description,omitempty"`
@@ -21,7 +20,7 @@ type CreateComponentOptions struct {
 	ProjectID    int    `json:"projectId,omitempty" structs:"projectId,omitempty"`
 }
 
-// CreateWithContext creates a new JIRA component based on the given options.
+// CreateWithContext creates a new Jira component based on the given options.
 func (s *ComponentService) CreateWithContext(ctx context.Context, options *CreateComponentOptions) (*ProjectComponent, *Response, error) {
 	apiEndpoint := "rest/api/2/component"
 	req, err := s.client.NewRequestWithContext(ctx, "POST", apiEndpoint, options)

component_test.go

@@ -14,7 +14,7 @@ func TestComponentService_Create_Success(t *testing.T) {
 		testRequestURL(t, r, "/rest/api/2/component")
 
 		w.WriteHeader(http.StatusCreated)
-		fmt.Fprint(w, `{ "self": "http://www.example.com/jira/rest/api/2/component/10000", "id": "10000", "name": "Component 1", "description": "This is a JIRA component", "lead": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. User", "active": false }, "assigneeType": "PROJECT_LEAD", "assignee": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. User", "active": false }, "realAssigneeType": "PROJECT_LEAD", "realAssignee": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. User", "active": false }, "isAssigneeTypeValid": false, "project": "HSP", "projectId": 10000 }`)
+		fmt.Fprint(w, `{ "self": "http://www.example.com/jira/rest/api/2/component/10000", "id": "10000", "name": "Component 1", "description": "This is a Jira component", "lead": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. User", "active": false }, "assigneeType": "PROJECT_LEAD", "assignee": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. User", "active": false }, "realAssigneeType": "PROJECT_LEAD", "realAssignee": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. User", "active": false }, "isAssigneeTypeValid": false, "project": "HSP", "projectId": 10000 }`)
 	})
 
 	component, _, err := testClient.Component.Create(&CreateComponentOptions{

error.go

@@ -10,7 +10,7 @@ import (
 	"github.com/pkg/errors"
 )
 
-// Error message from JIRA
+// Error message from Jira
 // See https://docs.atlassian.com/jira/REST/cloud/#error-responses
 type Error struct {
 	HTTPError     error