change client interface and implementation names

Author: vallerion

balance/balance.go

@@ -17,7 +17,7 @@ const path = "balance"
 
 // Read returns the balance information for the account that is associated with
 // the access key.
-func Read(c messagebird.MessageBirdClient) (*Balance, error) {
+func Read(c messagebird.Client) (*Balance, error) {
 	balance := &Balance{}
 	if err := c.Request(balance, http.MethodGet, path, nil); err != nil {
 		return nil, err

client.go

@@ -42,13 +42,13 @@ var (
 // A Feature can be enabled
 type Feature int
 
-type MessageBirdClient interface {
+type Client interface {
 	Request(v interface{}, method, path string, data interface{}) error
 }
 
-// Client is used to access API with a given key.
+// BasicClient is used to access API with a given key.
 // Uses standard lib HTTP client internally, so should be reused instead of created as needed and it is safe for concurrent use.
-type Client struct {
+type BasicClient struct {
 	AccessKey  string       // The API access key.
 	HTTPClient *http.Client // The HTTP client to send requests on.
 	DebugLog   *log.Logger  // Optional logger for debugging purposes.
@@ -73,8 +73,8 @@ func SetErrorReader(r errorReader) {
 }
 
 // New creates a new MessageBird client object.
-func New(accessKey string) *Client {
-	return &Client{
+func New(accessKey string) *BasicClient {
+	return &BasicClient{
 		AccessKey: accessKey,
 		HTTPClient: &http.Client{
 			Timeout: httpClientTimeout,
@@ -83,7 +83,7 @@ func New(accessKey string) *Client {
 }
 
 // Request is for internal use only and unstable.
-func (c *Client) Request(v interface{}, method, path string, data interface{}) error {
+func (c *BasicClient) Request(v interface{}, method, path string, data interface{}) error {
 	if !strings.HasPrefix(path, "https://") && !strings.HasPrefix(path, "http://") {
 		path = fmt.Sprintf("%s/%s", Endpoint, path)
 	}

contact/contact.go

@@ -58,7 +58,7 @@ type ViewRequest struct {
 	Name   string `json:"firstName,omitempty"`
 }
 
-func Create(c messagebird.MessageBirdClient, contactRequest *CreateRequest) (*Contact, error) {
+func Create(c messagebird.Client, contactRequest *CreateRequest) (*Contact, error) {
 	contact := &Contact{}
 	if err := c.Request(contact, http.MethodPost, path, contactRequest); err != nil {
 		return nil, err
@@ -69,13 +69,13 @@ func Create(c messagebird.MessageBirdClient, contactRequest *CreateRequest) (*Co
 
 // Delete attempts deleting the contact with the provided ID. If nil is returned,
 // the resource was deleted successfully.
-func Delete(c messagebird.MessageBirdClient, id string) error {
+func Delete(c messagebird.Client, id string) error {
 	return c.Request(nil, http.MethodDelete, path+"/"+id, nil)
 }
 
 // List retrieves a paginated list of contacts, based on the options provided.
 // It's worth noting DefaultListOptions.
-func List(c messagebird.MessageBirdClient, options *messagebird.PaginationRequest) (*Contacts, error) {
+func List(c messagebird.Client, options *messagebird.PaginationRequest) (*Contacts, error) {
 	contactList := &Contacts{}
 	if err := c.Request(contactList, http.MethodGet, path+"?"+options.QueryParams(), nil); err != nil {
 		return nil, err
@@ -85,7 +85,7 @@ func List(c messagebird.MessageBirdClient, options *messagebird.PaginationReques
 }
 
 // Read retrieves the information of an existing contact.
-func Read(c messagebird.MessageBirdClient, id string, req *ViewRequest) (*Contact, error) {
+func Read(c messagebird.Client, id string, req *ViewRequest) (*Contact, error) {
 	contact := &Contact{}
 	if err := c.Request(contact, http.MethodGet, path+"/"+id, req); err != nil {
 		return nil, err
@@ -96,7 +96,7 @@ func Read(c messagebird.MessageBirdClient, id string, req *ViewRequest) (*Contac
 
 // Update updates the record referenced by id with any values set in contactRequest.
 // Do not set any values that should not be updated.
-func Update(c messagebird.MessageBirdClient, id string, contactRequest *CreateRequest) (*Contact, error) {
+func Update(c messagebird.Client, id string, contactRequest *CreateRequest) (*Contact, error) {
 	contact := &Contact{}
 	if err := c.Request(contact, http.MethodPatch, path+"/"+id, contactRequest); err != nil {
 		return nil, err

conversation/api.go

@@ -31,9 +31,9 @@ const (
 	webhooksPath = "webhooks"
 )
 
-// request does the exact same thing as Client.Request. It does, however,
+// request does the exact same thing as BasicClient.Request. It does, however,
 // prefix the path with the Conversation API's root. This ensures the client
 // doesn't "handle" this for us: by default, it uses the REST API.
-func request(c messagebird.MessageBirdClient, v interface{}, method, path string, data interface{}) error {
+func request(c messagebird.Client, v interface{}, method, path string, data interface{}) error {
 	return c.Request(v, method, fmt.Sprintf("%s/%s", apiRoot, path), data)
 }

conversation/conversation.go

@@ -159,7 +159,7 @@ func (lr *ListByContactRequest) QueryParams() string {
 }
 
 // List gets a collection of Conversations. Pagination can be set in options.
-func List(c messagebird.MessageBirdClient, options *ListRequest) (*Conversations, error) {
+func List(c messagebird.Client, options *ListRequest) (*Conversations, error) {
 	convList := &Conversations{}
 	if err := request(c, convList, http.MethodGet, fmt.Sprintf("%s?%s", path, options.QueryParams()), nil); err != nil {
 		return nil, err
@@ -169,7 +169,7 @@ func List(c messagebird.MessageBirdClient, options *ListRequest) (*Conversations
 }
 
 // ListByContact fetches a collection of Conversations of a specific MessageBird contact ID.
-func ListByContact(c messagebird.MessageBirdClient, contactId string, options *messagebird.PaginationRequest) (*ConversationsByContact, error) {
+func ListByContact(c messagebird.Client, contactId string, options *messagebird.PaginationRequest) (*ConversationsByContact, error) {
 	reqPath := fmt.Sprintf("%s/%s/%s?%s", path, contactPath, contactId, options.QueryParams())
 
 	conv := &ConversationsByContact{}
@@ -181,7 +181,7 @@ func ListByContact(c messagebird.MessageBirdClient, contactId string, options *m
 }
 
 // Read fetches a single Conversation based on its ID.
-func Read(c messagebird.MessageBirdClient, id string) (*Conversation, error) {
+func Read(c messagebird.Client, id string) (*Conversation, error) {
 	conv := &Conversation{}
 	if err := request(c, conv, http.MethodGet, path+"/"+id, nil); err != nil {
 		return nil, err
@@ -192,7 +192,7 @@ func Read(c messagebird.MessageBirdClient, id string) (*Conversation, error) {
 
 // Start creates a conversation by sending an initial message. If an active
 // conversation exists for the recipient, it is resumed.
-func Start(c messagebird.MessageBirdClient, req *StartRequest) (*Conversation, error) {
+func Start(c messagebird.Client, req *StartRequest) (*Conversation, error) {
 	conv := &Conversation{}
 	if err := request(c, conv, http.MethodPost, path+"/"+startConversationPath, req); err != nil {
 		return nil, err
@@ -202,7 +202,7 @@ func Start(c messagebird.MessageBirdClient, req *StartRequest) (*Conversation, e
 }
 
 // Reply Send a new message to an existing conversation. In case the conversation is archived, a new conversation is created.
-func Reply(c messagebird.MessageBirdClient, conversationID string, req *ReplyRequest) (*Message, error) {
+func Reply(c messagebird.Client, conversationID string, req *ReplyRequest) (*Message, error) {
 	uri := fmt.Sprintf("%s/%s/%s", path, conversationID, messagesPath)
 
 	message := &Message{}
@@ -215,7 +215,7 @@ func Reply(c messagebird.MessageBirdClient, conversationID string, req *ReplyReq
 
 // Update changes the conversation's status, so this can be used to (un)archive
 // conversations.
-func Update(c messagebird.MessageBirdClient, id string, req *UpdateRequest) (*Conversation, error) {
+func Update(c messagebird.Client, id string, req *UpdateRequest) (*Conversation, error) {
 	conv := &Conversation{}
 	if err := request(c, conv, http.MethodPatch, path+"/"+id, req); err != nil {
 		return nil, err

conversation/message.go

@@ -212,7 +212,7 @@ func (lr *ListMessagesRequest) QueryParams() string {
 // SendMessage send a message to a specific recipient in a specific platform.
 // If an active conversation already exists for the recipient, the conversation will be resumed.
 // In case there's no active conversation a new one is created.
-func SendMessage(c messagebird.MessageBirdClient, options *SendMessageRequest) (*Message, error) {
+func SendMessage(c messagebird.Client, options *SendMessageRequest) (*Message, error) {
 	message := &Message{}
 	if err := request(c, message, http.MethodPost, sendMessagePath, options); err != nil {
 		return nil, err
@@ -223,7 +223,7 @@ func SendMessage(c messagebird.MessageBirdClient, options *SendMessageRequest) (
 
 // ListConversationMessages gets a collection of messages from a conversation.
 // Pagination can be set in the options.
-func ListConversationMessages(c messagebird.MessageBirdClient, conversationID string, options *ListConversationMessagesRequest) (*MessageList, error) {
+func ListConversationMessages(c messagebird.Client, conversationID string, options *ListConversationMessagesRequest) (*MessageList, error) {
 	uri := fmt.Sprintf("%s/%s/%s?%s", path, conversationID, messagesPath, options.QueryParams())
 
 	messageList := &MessageList{}
@@ -236,7 +236,7 @@ func ListConversationMessages(c messagebird.MessageBirdClient, conversationID st
 
 // ListMessages gets a collection of messages from a conversation.
 // Pagination can be set in the options.
-func ListMessages(c messagebird.MessageBirdClient, options *ListMessagesRequest) (*MessageList, error) {
+func ListMessages(c messagebird.Client, options *ListMessagesRequest) (*MessageList, error) {
 	uri := fmt.Sprintf("%s?%s", messagesPath, options.QueryParams())
 
 	messageList := &MessageList{}
@@ -248,7 +248,7 @@ func ListMessages(c messagebird.MessageBirdClient, options *ListMessagesRequest)
 }
 
 // ReadMessage gets a single message based on its ID.
-func ReadMessage(c messagebird.MessageBirdClient, messageID string) (*Message, error) {
+func ReadMessage(c messagebird.Client, messageID string) (*Message, error) {
 	message := &Message{}
 	if err := request(c, message, http.MethodGet, messagesPath+"/"+messageID, nil); err != nil {
 		return nil, err

conversation/webhook.go

@@ -69,7 +69,7 @@ const (
 
 // CreateWebhook registers a webhook that is invoked when something interesting
 // happens.
-func CreateWebhook(c messagebird.MessageBirdClient, req *WebhookCreateRequest) (*Webhook, error) {
+func CreateWebhook(c messagebird.Client, req *WebhookCreateRequest) (*Webhook, error) {
 	webhook := &Webhook{}
 	if err := request(c, webhook, http.MethodPost, webhooksPath, req); err != nil {
 		return nil, err
@@ -80,12 +80,12 @@ func CreateWebhook(c messagebird.MessageBirdClient, req *WebhookCreateRequest) (
 
 // DeleteWebhook ensures an existing webhook is deleted and no longer
 // triggered. If the error is nil, the deletion was successful.
-func DeleteWebhook(c messagebird.MessageBirdClient, id string) error {
+func DeleteWebhook(c messagebird.Client, id string) error {
 	return request(c, nil, http.MethodDelete, webhooksPath+"/"+id, nil)
 }
 
 // ListWebhooks gets a collection of webhooks. Pagination can be set in options.
-func ListWebhooks(c messagebird.MessageBirdClient, options *messagebird.PaginationRequest) (*WebhookList, error) {
+func ListWebhooks(c messagebird.Client, options *messagebird.PaginationRequest) (*WebhookList, error) {
 	webhookList := &WebhookList{}
 	if err := request(c, webhookList, http.MethodGet, webhooksPath+"?"+options.QueryParams(), nil); err != nil {
 		return nil, err
@@ -95,7 +95,7 @@ func ListWebhooks(c messagebird.MessageBirdClient, options *messagebird.Paginati
 }
 
 // ReadWebhook gets a single webhook based on its ID.
-func ReadWebhook(c messagebird.MessageBirdClient, id string) (*Webhook, error) {
+func ReadWebhook(c messagebird.Client, id string) (*Webhook, error) {
 	webhook := &Webhook{}
 	if err := request(c, webhook, http.MethodGet, webhooksPath+"/"+id, nil); err != nil {
 		return nil, err
@@ -106,7 +106,7 @@ func ReadWebhook(c messagebird.MessageBirdClient, id string) (*Webhook, error) {
 
 // UpdateWebhook updates a single webhook based on its ID with any values set in WebhookUpdateRequest.
 // Do not set any values that should not be updated.
-func UpdateWebhook(c messagebird.MessageBirdClient, id string, req *WebhookUpdateRequest) (*Webhook, error) {
+func UpdateWebhook(c messagebird.Client, id string, req *WebhookUpdateRequest) (*Webhook, error) {
 	webhook := &Webhook{}
 	if err := request(c, webhook, http.MethodPatch, webhooksPath+"/"+id, req); err != nil {
 		return nil, err

group/group.go

@@ -58,7 +58,7 @@ type Request struct {
 	Name string `json:"name"`
 }
 
-func Create(c messagebird.MessageBirdClient, request *Request) (*Group, error) {
+func Create(c messagebird.Client, request *Request) (*Group, error) {
 	if err := validateCreate(request); err != nil {
 		return nil, err
 	}
@@ -81,13 +81,13 @@ func validateCreate(request *Request) error {
 
 // Delete attempts deleting the group with the provided ID. If nil is returned,
 // the resource was deleted successfully.
-func Delete(c messagebird.MessageBirdClient, id string) error {
+func Delete(c messagebird.Client, id string) error {
 	return c.Request(nil, http.MethodDelete, path+"/"+id, nil)
 }
 
 // List retrieves a paginated list of groups, based on the options provided.
 // It's worth noting DefaultListOptions.
-func List(c messagebird.MessageBirdClient, options *messagebird.PaginationRequest) (*Groups, error) {
+func List(c messagebird.Client, options *messagebird.PaginationRequest) (*Groups, error) {
 	groupList := &Groups{}
 	if err := c.Request(groupList, http.MethodGet, path+"?"+options.QueryParams(), nil); err != nil {
 		return nil, err
@@ -113,7 +113,7 @@ func listQuery(options *messagebird.PaginationRequest) (string, error) {
 }
 
 // Read retrieves the information of an existing group.
-func Read(c messagebird.MessageBirdClient, id string) (*Group, error) {
+func Read(c messagebird.Client, id string) (*Group, error) {
 	group := &Group{}
 	if err := c.Request(group, http.MethodGet, path+"/"+id, nil); err != nil {
 		return nil, err
@@ -123,7 +123,7 @@ func Read(c messagebird.MessageBirdClient, id string) (*Group, error) {
 }
 
 // Update overrides the group with any values provided in request.
-func Update(c messagebird.MessageBirdClient, id string, request *Request) error {
+func Update(c messagebird.Client, id string, request *Request) error {
 	if err := validateUpdate(request); err != nil {
 		return err
 	}
@@ -140,7 +140,7 @@ func validateUpdate(request *Request) error {
 }
 
 // AddContacts adds a maximum of 50 contacts to the group.
-func AddContacts(c messagebird.MessageBirdClient, groupID string, contactIDs []string) error {
+func AddContacts(c messagebird.Client, groupID string, contactIDs []string) error {
 	if err := validateAddContacts(contactIDs); err != nil {
 		return err
 	}
@@ -179,7 +179,7 @@ func addContactsData(contactIDs []string) string {
 }
 
 // ListContacts lists the contacts that are a member of a group.
-func ListContacts(c messagebird.MessageBirdClient, groupID string, options *messagebird.PaginationRequest) (*contact.Contacts, error) {
+func ListContacts(c messagebird.Client, groupID string, options *messagebird.PaginationRequest) (*contact.Contacts, error) {
 	formattedPath := fmt.Sprintf("%s/%s/%s?%s", path, groupID, contactPath, options.QueryParams())
 
 	contacts := &contact.Contacts{}
@@ -192,7 +192,7 @@ func ListContacts(c messagebird.MessageBirdClient, groupID string, options *mess
 
 // RemoveContact removes the contact from a group. If nil is returned, the
 // operation was successful.
-func RemoveContact(c messagebird.MessageBirdClient, groupID, contactID string) error {
+func RemoveContact(c messagebird.Client, groupID, contactID string) error {
 	formattedPath := fmt.Sprintf("%s/%s/contacts/%s", path, groupID, contactID)
 
 	return c.Request(nil, http.MethodDelete, formattedPath, nil)

hlr/hlr.go

@@ -43,7 +43,7 @@ type hlrRequest struct {
 
 // Read looks up an existing HLR object for the specified id that was previously
 // created by the NewHLR function.
-func Read(c messagebird.MessageBirdClient, id string) (*HLR, error) {
+func Read(c messagebird.Client, id string) (*HLR, error) {
 	hlr := &HLR{}
 	if err := c.Request(hlr, http.MethodGet, path+"/"+id, nil); err != nil {
 		return nil, err
@@ -53,7 +53,7 @@ func Read(c messagebird.MessageBirdClient, id string) (*HLR, error) {
 }
 
 // List all HLR objects that were previously created by the Create function.
-func List(c messagebird.MessageBirdClient) (*HLRList, error) {
+func List(c messagebird.Client) (*HLRList, error) {
 	hlrList := &HLRList{}
 	if err := c.Request(hlrList, http.MethodGet, path, nil); err != nil {
 		return nil, err
@@ -63,7 +63,7 @@ func List(c messagebird.MessageBirdClient) (*HLRList, error) {
 }
 
 // Create creates a new HLR object.
-func Create(c messagebird.MessageBirdClient, msisdn string, reference string) (*HLR, error) {
+func Create(c messagebird.Client, msisdn string, reference string) (*HLR, error) {
 	requestData, err := requestDataForHLR(msisdn, reference)
 	if err != nil {
 		return nil, err

internal/mbtest/test_client.go

@@ -27,16 +27,16 @@ func (c *ClientMock) Request(v interface{}, method, path string, data interface{
 }
 
 // MockClient initializes a new mock of MessageBird client
-func MockClient() messagebird.MessageBirdClient {
+func MockClient() messagebird.Client {
 	return &ClientMock{}
 }
 
 // Client initializes a new MessageBird client that uses the
-func Client(t *testing.T) *messagebird.Client {
+func Client(t *testing.T) *messagebird.BasicClient {
 	return newClient(t, "")
 }
 
-func newClient(t *testing.T, accessKey string) *messagebird.Client {
+func newClient(t *testing.T, accessKey string) *messagebird.BasicClient {
 	transport := &http.Transport{
 		DialTLS: func(network, _ string) (net.Conn, error) {
 			addr := server.Listener.Addr().String()