tests: move integration tests to its own folder

Author: genert

.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration file
+# For Sublime Text install package `EditorConfig`
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+; Indentation override for all JS under lib directory
+[*.(yml|yaml)]
+indent_style = space
+indent_size = 2

.travis.yml

@@ -1,6 +1,5 @@
 sudo: false
 language: go
-
 go:
  - 1.9.x
  - 1.8.x
@@ -23,6 +22,6 @@ script:
  - diff -u <(echo -n) <(gofmt -d -s .)
  - go generate -x ./... && git diff --exit-code; code=$?; git checkout -- .; (exit $code) # Check that go generate ./... produces a zero diff; clean up any changes afterwards.
  - go tool vet .
- - ls -la
-  - go test ./pipedrive -api -covermode=count -coverprofile=coverage.out
-  - $HOME/gopath/bin/goveralls -coverprofile=coverage.out -service=travis-ci -repotoken $COVERALLS_TOKEN
+ - go test -v -race ./...
+# - go test ./pipedrive -api -covermode=count -coverprofile=coverage.out
+# - $HOME/gopath/bin/goveralls -coverprofile=coverage.out -service=travis-ci -repotoken $COVERALLS_TOKEN

pipedrive/pipedrive.go

@@ -56,10 +56,10 @@ type Client struct {
 Authorizations *AuthorizationsService
 Stages *StagesService
 Webhooks *WebhooksService
-UserSettings *UserSettingsService
 UserConnections *UserConnectionsService
 GoalsService *GoalsService
 PipelinesService *PipelinesService
+UserSettings *UserSettingsService
 }
 
 type service struct {
@@ -203,7 +203,7 @@ func (c *Client) SetOptions(options ...func(*Client) error) error {
 return nil
 }
 
-func New(options *Config) *Client {
+func NewClient(options *Config) *Client {
 baseURL, _ := url.Parse(defaultBaseUrl)
 
 c := &Client{
@@ -227,10 +227,10 @@ func New(options *Config) *Client {
 c.Authorizations = (*AuthorizationsService)(&c.common)
 c.Stages = (*StagesService)(&c.common)
 c.Webhooks = (*WebhooksService)(&c.common)
-c.UserSettings = (*UserSettingsService)(&c.common)
 c.UserConnections = (*UserConnectionsService)(&c.common)
 c.GoalsService = (*GoalsService)(&c.common)
 c.PipelinesService = (*PipelinesService)(&c.common)
+c.UserSettings = (*UserSettingsService)(&c.common)
 
 return c
 }

pipedrive/users.go

@@ -30,39 +30,72 @@ type User struct {
 IsYou bool `json:"is_you"`
 }
 
-type Users struct {
+type UsersResponse struct {
 Success bool `json:"success"`
 Error string `json:"error,omitempty"`
 ErrorInfo string `json:"error_info,omitempty"`
 Data []User `json:"data"`
 AdditionalData AdditionalData `json:"additional_data"`
 }
 
-type SingleUser struct {
+type UserSingleResponse struct {
 Success bool `json:"success"`
 Data User `json:"data"`
 AdditionalData AdditionalData `json:"additional_data"`
 }
 
+type UserFollowersResponse struct {
+Success bool `json:"success"`
+Data []int `json:"data"`
+AdditionalData AdditionalData `json:"additional_data"`
+}
+
 type UsersFindByNameOptions struct {
 Term string `url:"term,omitempty"`
 SearchByEmail int `url:"search_by_email,omitempty"`
 }
 
+type UsersUpdateUserDetailsOptions struct {
+ActiveFlag uint8 `url:"active_flag,omitempty"`
+}
+
+type DeletePermissionSetAssignmentOptions struct {
+PermissionSetId uint `url:"permission_set_id,omitempty"`
+}
+
 type DeleteRoleAssignmentOptions struct {
 RoleId uint `url:"role_id,omitempty"`
 }
 
-// Returns data about all users within the company.
 // Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users
-func (s *UsersService) List() (*Users, *Response, error) {
+func (s *UsersService) List() (*UsersResponse, *Response, error) {
 req, err := s.client.NewRequest(http.MethodGet, "/users", nil, nil)
 
 if err != nil {
 return nil, nil, err
 }
 
-var record *Users
+var record *UsersResponse
+
+resp, err := s.client.Do(req, &record)
+
+if err != nil {
+return nil, resp, err
+}
+
+return record, resp, nil
+}
+
+// https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_followers
+func (s *UsersService) ListFollowers(id int) (*UserFollowersResponse, *Response, error) {
+uri := fmt.Sprintf("/users/%v/followers", id)
+req, err := s.client.NewRequest(http.MethodGet, uri, nil, nil)
+
+if err != nil {
+return nil, nil, err
+}
+
+var record *UserFollowersResponse
 
 resp, err := s.client.Do(req, &record)
 
@@ -73,16 +106,15 @@ func (s *UsersService) List() (*Users, *Response, error) {
 return record, resp, nil
 }
 
-// Finds users by their name.
 // Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_find
-func (s *UsersService) FindByName(opt *UsersFindByNameOptions) (*Users, *Response, error) {
+func (s *UsersService) FindByName(opt *UsersFindByNameOptions) (*UsersResponse, *Response, error) {
 req, err := s.client.NewRequest(http.MethodGet, "/users/find", opt, nil)
 
 if err != nil {
 return nil, nil, err
 }
 
-var record *Users
+var record *UsersResponse
 
 resp, err := s.client.Do(req, &record)
 
@@ -93,17 +125,16 @@ func (s *UsersService) FindByName(opt *UsersFindByNameOptions) (*Users, *Respons
 return record, resp, nil
 }
 
-// Returns data about a specific user within the company
 // Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id
-func (s *UsersService) GetById(id int) (*SingleUser, *Response, error) {
+func (s *UsersService) GetById(id int) (*UserFollowersResponse, *Response, error) {
 uri := fmt.Sprintf("/users/%v", id)
 req, err := s.client.NewRequest(http.MethodGet, uri, nil, nil)
 
 if err != nil {
 return nil, nil, err
 }
 
-var record *SingleUser
+var record *UserFollowersResponse
 
 resp, err := s.client.Do(req, &record)
 
@@ -114,11 +145,46 @@ func (s *UsersService) GetById(id int) (*SingleUser, *Response, error) {
 return record, resp, nil
 }
 
-// Delete a role assignment for a user.
+// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Users/put_users_id
+func (s *UsersService) UpdateUserDetails(id int, opt *UsersUpdateUserDetailsOptions) (*Response, error) {
+uri := fmt.Sprintf("/users/%v", id)
+req, err := s.client.NewRequest(http.MethodPut, uri, opt, nil)
+
+if err != nil {
+return nil, err
+}
+
+resp, err := s.client.Do(req, nil)
+
+if err != nil {
+return resp, err
+}
+
+return resp, nil
+}
+
+// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Users/delete_users_id_permissionSetAssignments
+func (s *UsersService) DeletePermissionSetAssignment(id int, opt *DeletePermissionSetAssignmentOptions) (*Response, error) {
+uri := fmt.Sprintf("/users/%v/permissionSetAssignments", id)
+req, err := s.client.NewRequest(http.MethodDelete, uri, opt, nil)
+
+if err != nil {
+return nil, err
+}
+
+resp, err := s.client.Do(req, nil)
+
+if err != nil {
+return resp, err
+}
+
+return resp, nil
+}
+
 // Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Users/delete_users_id_roleAssignments
 func (s *UsersService) DeleteRoleAssignment(id int, opt *DeleteRoleAssignmentOptions) (*Response, error) {
 uri := fmt.Sprintf("/users/%v/roleAssignments", id)
-req, err := s.client.NewRequest(http.MethodDelete, uri, nil, nil)
+req, err := s.client.NewRequest(http.MethodDelete, uri, opt, nil)
 
 if err != nil {
 return nil, err

pipedrive/webhooks.go

@@ -34,6 +34,12 @@ type Webhooks struct {
 Data []Webhook `json:"data,omitempty"`
 }
 
+type SingleWebhook struct {
+Status string `json:"status,omitempty"`
+Success bool `json:"success,omitempty"`
+Data Webhook `json:"data,omitempty"`
+}
+
 type WebhooksCreateOptions struct {
 SubscriptionUrl string `url:"subscription_url"`
 EventAction EventAction `url:"event_action"`
@@ -43,7 +49,6 @@ type WebhooksCreateOptions struct {
 HttpAuthPassword string `url:"http_auth_password"`
 }
 
-// Returns data about all webhooks of a company.
 // Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/get_webhooks
 func (s *WebhooksService) List() (*Webhooks, *Response, error) {
 req, err := s.client.NewRequest(http.MethodGet, "/webhooks", nil, nil)
@@ -63,20 +68,15 @@ func (s *WebhooksService) List() (*Webhooks, *Response, error) {
 return record, resp, nil
 }
 
-// Creates a new webhook and returns its details.
-// Note that specifying an event which triggers the webhook combines 2 parameters -
-// 'event_action' and 'event_object'.
-// E.g., use '*.*' for getting notifications about all events,
-// 'added.deal' for any newly added deals, 'deleted.persons' for any deleted persons, etc.
 // Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/post_webhooks
-func (s *WebhooksService) Create(opt *WebhooksCreateOptions) (*SingleStage, *Response, error) {
+func (s *WebhooksService) Create(opt *WebhooksCreateOptions) (*SingleWebhook, *Response, error) {
 req, err := s.client.NewRequest(http.MethodPost, "/webhooks", nil, opt)
 
 if err != nil {
 return nil, nil, err
 }
 
-var record *SingleStage
+var record *SingleWebhook
 
 resp, err := s.client.Do(req, &record)
 
@@ -87,7 +87,6 @@ func (s *WebhooksService) Create(opt *WebhooksCreateOptions) (*SingleStage, *Res
 return record, resp, nil
 }
 
-// Deletes the specified webhook.
 // Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/delete_webhooks_id
 func (s *WebhooksService) Delete(id int) (*Response, error) {
 uri := fmt.Sprintf("/webhooks/%v", id)

test/README.md

@@ -0,0 +1,10 @@
+# pipedrive-api tests
+
+integration
+-----------
+
+This will exercise the library against the live Pipedrive API and verify actual behaviour of the API.
+
+Run tests using:
+
+ PIPEDRIVE_API_TOKEN=XXXXXX go test -v -tags=integration ./integration

test/integration/pipedrive_test.go

@@ -0,0 +1,25 @@
+package integration
+
+import (
+"github.com/genert/pipedrive-api/pipedrive"
+"os"
+)
+
+var (
+client *pipedrive.Client
+)
+
+func init() {
+token := os.Getenv("PIPEDRIVE_API_TOKEN")
+
+if token == "" {
+print("No API key found. Integration tests won't run!\n\n")
+os.Exit(1)
+} else {
+config := &pipedrive.Config{
+ApiKey: token,
+}
+
+client = pipedrive.NewClient(config)
+}
+}

test/integration/user_connections_test.go

@@ -0,0 +1,15 @@
+package integration
+
+import "testing"
+
+func TestUserConnectionsService_List(t *testing.T) {
+result, _, err := client.UserConnections.List()
+
+if err != nil {
+t.Errorf("Could not get webhooks list: %v", err)
+}
+
+if result.Success != true {
+t.Error("Got invalid result")
+}
+}

test/integration/user_settings_test.go

@@ -0,0 +1,15 @@
+package integration
+
+import "testing"
+
+func TestUserSettings_List(t *testing.T) {
+result, _, err := client.UserSettings.List()
+
+if err != nil {
+t.Errorf("Could not get webhooks list: %v", err)
+}
+
+if result.Success != true {
+t.Error("Got invalid result")
+}
+}

test/integration/webhooks_test.go

@@ -0,0 +1,17 @@
+package integration
+
+import (
+"testing"
+)
+
+func TestWebhooksService_List(t *testing.T) {
+result, _, err := client.Webhooks.List()
+
+if err != nil {
+t.Errorf("Could not get webhooks list: %v", err)
+}
+
+if result.Success != true {
+t.Error("Got invalid result")
+}
+}