Subversion Repository Public Repository

insightly-api

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
´╗┐using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using RestSharp;
using TS.Insightly.API;
using TS.Insightly.API.Contract;
using TS.Insightly.API.Exception;
using TS.Insightly.API.Utility;

namespace UnitTestInsightly
{
    [TestClass]
    public class ContactTests
    {
        /// <summary>
        /// Contact ID for the default contact, which should not be changed for
        /// removed from the CRM.
        /// </summary>
        private const int JohnSmithContactId = 39547555;

        #region Get

        /// <summary>
        /// Basic test to confirm the connection and correct response from the api.
        /// </summary>
        /// <remarks>
        /// Contact ID 39547555 relates to the 2nd contact (Mr John Smith ID: 2") 
        /// in http://VIVHX6A8.insight.ly
        /// </remarks>
        [TestMethod]
        public void BasicConnectionAndContactGetTest()
        {
            var client = new RestClient();
            client.BaseUrl = @"https://api.insight.ly/v2/";
            client.Authenticator = new HttpBasicAuthenticator(APIUser.PLAIN_API_KEY, "");

            var request = new RestRequest(Method.GET);
            request.Resource = String.Format("contacts/{0}", JohnSmithContactId);

            IRestResponse response = client.Execute(request);

            Assert.IsNull(response.ErrorException);
            Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
        }

        /// <summary>
        /// Test returns contact record john smith for CRM contact unique identifier.
        /// </summary>
        [TestMethod]
        public void GetJohnSmithForCRMContactId()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var contact = api.GetContact(JohnSmithContactId);

            Assert.IsNotNull(contact);
            Assert.IsInstanceOfType(contact, typeof(Contact));
            Assert.AreEqual(JohnSmithContactId, contact.CONTACT_ID);
        }

        /// <summary>
        /// Test returns contact record john smith for email address.
        /// </summary>
        [TestMethod]
        public void GetJohnSmithForEmailAddress()
        {
            const string contactEmail = "johnsmith@smith.net";
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var contacts = api.GetContactsForEmail(contactEmail);

            Assert.IsNotNull(contacts);
            Assert.IsInstanceOfType(contacts, typeof(List<Contact>));
            Assert.IsTrue(contacts.Count > 0);

            Contact firstContact = contacts[0];

            Assert.AreEqual(JohnSmithContactId, firstContact.CONTACT_ID);

            Assert.IsNotNull(firstContact.CONTACTINFOS);
            Assert.IsTrue(firstContact.CONTACTINFOS.Count > 0);

            ContactInfo firstInfo = contacts[0].CONTACTINFOS[0];

            Assert.AreEqual(contactEmail, firstInfo.DETAIL);
        }

        /// <summary>
        /// Test returns empty list if no matching contacts.
        /// </summary>
        [TestMethod]
        public void GetForNonExistentEmailAddress()
        {
            const string contactEmail = "abcde@123.net";
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var contacts = api.GetContactsForEmail(contactEmail);

            Assert.IsNotNull(contacts);
            Assert.IsTrue(contacts.Count == 0);
        }

        /// <summary>
        /// Test returns the postal address for john smith.
        /// </summary>
        [TestMethod]
        public void GetPostalAddressForJohnSmith()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var contact = api.GetContact(JohnSmithContactId);

            Assert.IsNotNull(contact);
            Assert.IsInstanceOfType(contact, typeof(Contact));
            Assert.AreEqual(JohnSmithContactId, contact.CONTACT_ID);
            Assert.IsNotNull(contact.ADDRESSES);
            Assert.IsTrue(contact.ADDRESSES.Any());

            Address address = contact.ADDRESSES[0];

            Assert.AreEqual("City for Work Address", address.CITY);
        }

        /// <summary>
        /// Test returns the custom field 1 for john smith.
        /// </summary>
        [TestMethod]
        public void GetCustomField1ForJohnSmith()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var contact = api.GetContact(JohnSmithContactId);

            Assert.IsNotNull(contact);
            Assert.AreEqual("Custom Country Field (One)", contact.CONTACT_FIELD_1);
        }

        #endregion

        #region Post

        /// <summary>
        /// Test writing a very basic contact record, with just the name set.
        /// </summary>
        [TestMethod]
        public void AddBasicContactRecord()
        {
            Contact addedContact = null;
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            try
            {
                Contact newContact = new Contact();
                newContact.SALUTATION = "Ms";
                newContact.FIRST_NAME = "Mary";
                newContact.LAST_NAME = "Jones";

                addedContact = api.AddNewContact(newContact);

                Assert.IsNotNull(addedContact);
                Assert.AreEqual(newContact.SALUTATION, addedContact.SALUTATION);
                Assert.AreEqual(newContact.FIRST_NAME, addedContact.FIRST_NAME);
                Assert.AreEqual(newContact.LAST_NAME, addedContact.LAST_NAME);
            }
            finally
            {
                DeleteContact(api, addedContact);
            }
        }

        /// <summary>
        /// Test adding a contact record with an email address (contactinfo record attached).
        /// </summary>
        [TestMethod]
        public void AddContactWithEmailAddress()
        {
            Contact addedContact = null;
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            try
            {
                ContactInfo newInfo = new ContactInfo();
                newInfo.TYPE = ContactInfo.InfoType.Email.GetDescription();
                newInfo.LABEL = ContactInfo.InfoLabelEmail.Work.GetDescription();
                newInfo.DETAIL = "mike.harper@dentist.com";

                Contact newContact = new Contact();
                newContact.SALUTATION = "Dr";
                newContact.FIRST_NAME = "Mike";
                newContact.LAST_NAME = "Harper";
                newContact.CONTACTINFOS = new List<ContactInfo> { newInfo };

                addedContact = api.AddNewContact(newContact);

                Assert.IsNotNull(addedContact);
                Assert.AreEqual(newContact.LAST_NAME, addedContact.LAST_NAME);
                Assert.IsNotNull(addedContact.CONTACTINFOS);
                Assert.IsTrue(addedContact.CONTACTINFOS.Count > 0);

                ContactInfo addedInfo = addedContact.CONTACTINFOS[0];

                Assert.AreEqual(newInfo.DETAIL, addedInfo.DETAIL);
            }
            finally
            {
                DeleteContact(api, addedContact);
            }
        }

        /// <summary>
        /// Test adding a contact record with an email and postal address (contactinfo and address record attached).
        /// </summary>
        [TestMethod]
        public void AddContactWithEmailAndPostalAddress()
        {
            Contact addedContact = null;
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            try
            {
                ContactInfo newInfo = new ContactInfo();
                newInfo.TYPE = ContactInfo.InfoType.Email.GetDescription();
                newInfo.LABEL = ContactInfo.InfoLabelEmail.Work.GetDescription();
                newInfo.DETAIL = "peter@rabbit.net";

                Address newAddress = new Address();
                newAddress.ADDRESS_TYPE = Address.AddressType.Postal.GetDescription();
                newAddress.STREET = "The Warren";
                newAddress.CITY = "The Field";
                newAddress.STATE = "The Farm";
                newAddress.POSTCODE = "1Z1";
                newAddress.COUNTRY = "United States";

                Contact newContact = new Contact();
                newContact.FIRST_NAME = "Peter";
                newContact.LAST_NAME = "Rabbit";
                newContact.CONTACTINFOS = new List<ContactInfo> { newInfo };
                newContact.ADDRESSES = new List<Address> { newAddress };

                addedContact = api.AddNewContact(newContact);

                Assert.IsNotNull(addedContact);
                Assert.AreEqual(newContact.LAST_NAME, addedContact.LAST_NAME);
                Assert.IsNotNull(addedContact.CONTACTINFOS);
                Assert.IsTrue(addedContact.CONTACTINFOS.Count > 0);
                Assert.IsTrue(addedContact.ADDRESSES.Count > 0);

                ContactInfo addedInfo = addedContact.CONTACTINFOS[0];

                Assert.AreEqual(newInfo.DETAIL, addedInfo.DETAIL);

                Address addedAddress = addedContact.ADDRESSES[0];

                Assert.AreEqual(newAddress.STREET, addedAddress.STREET);
                Assert.AreEqual(newAddress.ADDRESS_TYPE, addedAddress.ADDRESS_TYPE);
            }
            finally
            {
                DeleteContact(api, addedContact);
            }
        }

        /// <summary>
        /// Test adding a new contact with custom field 1.
        /// </summary>
        [TestMethod]
        public void AddNewContactWithCustomField1()
        {
            Contact addedContact = null;
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            try
            {
                Contact newContact = new Contact();
                newContact.FIRST_NAME = "Test";
                newContact.LAST_NAME = "Custom Field 1";
                newContact.CONTACT_FIELD_1 = "Custom Field Text";

                addedContact = api.AddNewContact(newContact);

                Assert.AreEqual(newContact.CONTACT_FIELD_1, addedContact.CONTACT_FIELD_1);
            }
            finally
            {
                DeleteContact(api, addedContact);
            }
        }

        /// <summary>
        /// Test an existing contact will not be added again.
        /// </summary>
        [TestMethod]
        public void DoNotAddExistingContact()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            ContactInfo newInfo = new ContactInfo();
            newInfo.TYPE = ContactInfo.InfoType.Email.GetDescription();
            newInfo.LABEL = ContactInfo.InfoLabelEmail.Work.GetDescription();
            newInfo.DETAIL = "johnsmith@smith.net";

            Contact newContact = new Contact();
            newContact.FIRST_NAME = "John";
            newContact.LAST_NAME = "Smith";
            newContact.CONTACTINFOS = new List<ContactInfo> { newInfo };

            var addResult = api.AddNewContactIfNotExists(newContact);

            Assert.IsFalse(addResult.NewContactAdded);

        }

        /// <summary>
        /// Test adding a new contact using the check method.
        /// </summary>
        [TestMethod]
        public void AddBasicContactRecordUsingExistsCheck()
        {
            Contact addedContact = null;
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            try
            {
                ContactInfo newInfo = new ContactInfo();
                newInfo.TYPE = ContactInfo.InfoType.Email.GetDescription();
                newInfo.LABEL = ContactInfo.InfoLabelEmail.Work.GetDescription();
                newInfo.DETAIL = "mary@smith.net";

                Contact newContact = new Contact();
                newContact.SALUTATION = "Ms";
                newContact.FIRST_NAME = "Mary";
                newContact.LAST_NAME = "Jones";
                newContact.CONTACTINFOS = new List<ContactInfo> { newInfo };

                var addResult = api.AddNewContactIfNotExists(newContact);

                Assert.IsTrue(addResult.NewContactAdded);

                addedContact = addResult.Contact;

                Assert.AreEqual(newContact.SALUTATION, addedContact.SALUTATION);
                Assert.AreEqual(newContact.FIRST_NAME, addedContact.FIRST_NAME);
                Assert.AreEqual(newContact.LAST_NAME, addedContact.LAST_NAME);
            }
            finally
            {
                DeleteContact(api, addedContact);
            }
        }

        /// <summary>
        /// Test exception raised when trying to add and invalid contact.
        /// </summary>
        [TestMethod]
        [ExpectedException(typeof(ContactException))]
        public void ContactExceptionWhenInvalidAdd()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            api.AddNewContact(null);
        }

        #endregion Post

        #region Put


        #endregion Put

        #region Delete

        /// <summary>
        /// Test deleting a contact that is in the system.
        /// </summary>
        [TestMethod]
        public void DeleteExistingContact()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            Contact newContact = new Contact();
            newContact.SALUTATION = "Dr";
            newContact.FIRST_NAME = "Temp";
            newContact.LAST_NAME = "Delete";

            Contact addedContact = api.AddNewContact(newContact);

            Assert.IsNotNull(addedContact, "Failed to add contact to test delete!");

            bool deleteResult = api.DeleteContact(addedContact.CONTACT_ID);

            Assert.IsTrue(deleteResult);
        }

        /// <summary>
        /// Test deleting a non existent contact.
        /// </summary>
        [TestMethod]
        public void DeleteNonExistentContact()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            bool deleteResult = api.DeleteContact(1);

            Assert.IsFalse(deleteResult);
        }

        #endregion Delete

        /// <summary>
        /// Deletes the contact.
        /// </summary>
        /// <param name="api">The API.</param>
        /// <param name="contact">The contact.</param>
        private void DeleteContact(InsightlyAPI api, Contact contact)
        {
            try
            {
                if (contact != null && contact.CONTACT_ID > 0)
                {
                    api.DeleteContact(contact.CONTACT_ID);
                }
            }
            catch (Exception)
            {
                // Ignore any error.
            }
        }
    }
}

Commits for insightly-api/trunk/UnitTestInsightly/ContactTests.cs

Diff revisions: vs.
Revision Author Commited Message
14 HadleyHope picture HadleyHope Mon 30 Sep, 2013 15:36:43 +0000

Refactor unit tests.
Refactor API use get method to return REST client.