Merge pull request #56 from tamccall/mock-client

Mock client

.travis.yml

@@ -1,10 +1,10 @@
 language: go
 
 go:
-  - 1.8
   - 1.9
   - 1.10.x
   - 1.11.x
+  - 1.12.x
   - master
 
 before_install:
@@ -16,7 +16,7 @@ install:
 
 script:
   - go test -v ./...
-  - goveralls -service=travis-ci
+  - goveralls -service=travis-ci -ignore=zendesk/mock/client.go
 
 notifications:
   email: false

zendesk/api.go

@@ -0,0 +1,13 @@
+package zendesk
+
+//go:generate  mockgen -destination=mock/client.go -package=mock -mock_names=API=Client github.com/nukosuke/go-zendesk/zendesk API
+
+// API an interface containing all of the zendesk client methods
+type API interface {
+	GroupAPI
+	LocaleAPI
+	TicketFieldAPI
+	TicketFormAPI
+	TriggerAPI
+	UserAPI
+}

zendesk/group.go

@@ -16,6 +16,12 @@ type Group struct {
 	UpdatedAt time.Time `json:"updated_at,omitempty"`
 }
 
+// GroupAPI an interface containing all methods associated with zendesk groups
+type GroupAPI interface {
+	GetGroups() ([]Group, Page, error)
+	CreateGroup(group Group) (Group, error)
+}
+
 // GetGroups fetches group list
 // https://developer.zendesk.com/rest_api/docs/support/groups#list-groups
 func (z *Client) GetGroups() ([]Group, Page, error) {

zendesk/locale.go

@@ -16,6 +16,11 @@ type Locale struct {
 	UpdatedAt time.Time `json:"updated_at"`
 }
 
+// LocaleAPI an interface containing all of the local related zendesk methods
+type LocaleAPI interface {
+	GetLocales() ([]Locale, error)
+}
+
 // GetLocales lists the translation locales available for the account.
 // https://developer.zendesk.com/rest_api/docs/support/locales#list-locales
 func (z *Client) GetLocales() ([]Locale, error) {

zendesk/ticket_field.go

@@ -45,6 +45,13 @@ type TicketField struct {
 	AgentDescription    string                         `json:"agent_description,omitempty"`
 }
 
+// TicketFieldAPI an interface containing all of the ticket field related zendesk methods
+type TicketFieldAPI interface {
+	GetTicketFields() ([]TicketField, Page, error)
+	CreateTicketField(ticketField TicketField) (TicketField, error)
+	GetTicketField(ticketID int64) (TicketField, error)
+}
+
 // GetTicketFields fetches ticket field list
 // ref: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#list-ticket-fields
 func (z Client) GetTicketFields() ([]TicketField, Page, error) {

zendesk/ticket_form.go

@@ -20,6 +20,12 @@ type TicketForm struct {
 	RestrictedBrandIDs []int64 `json:"restricted_brand_ids,omitempty"`
 }
 
+// TicketFormAPI an interface containing all ticket form related methods
+type TicketFormAPI interface {
+	GetTicketForms() ([]TicketForm, Page, error)
+	CreateTicketForm(ticketForm TicketForm) (TicketForm, error)
+}
+
 // GetTicketForms fetches ticket forms
 func (z Client) GetTicketForms() ([]TicketForm, Page, error) {
 	var data struct {

zendesk/trigger.go

@@ -37,6 +37,12 @@ type Trigger struct {
 	UpdatedAt   *time.Time      `json:"updated_at,omitempty"`
 }
 
+// TriggerAPI an interface containing all trigger related methods
+type TriggerAPI interface {
+	GetTriggers() ([]Trigger, Page, error)
+	CreateTrigger(trigger Trigger) (Trigger, error)
+}
+
 // GetTriggers fetch trigger list
 func (z *Client) GetTriggers() ([]Trigger, Page, error) {
 	var data struct {

zendesk/user.go

@@ -67,6 +67,12 @@ func UserRoleText(role int) string {
 	return userRoleText[role]
 }
 
+// UserAPI an interface containing all user related methods
+type UserAPI interface {
+	GetUsers() ([]User, Page, error)
+	CreateUser(user User) (User, error)
+}
+
 // GetUsers fetch user list
 func (z *Client) GetUsers() ([]User, Page, error) {
 	var data struct {