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
´╗┐using System;
using System.Collections.Generic;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using TS.Insightly.API;
using TS.Insightly.API.Contract;
using TS.Insightly.API.Exception;
using TS.Insightly.API.Utility;

namespace UnitTestInsightly
{
    /// <summary>
    /// Test class for various methods to add details to insightly.
    /// </summary>
    [TestClass]
    public class AddTests
    {
        #region Contacts

        /// <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);

        }

        [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);
        }

        /// <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.
            }
        }

        #endregion Contacts

        #region Organisations

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

            try
            {
                Organisation newOrg = new Organisation();
                newOrg.ORGANISATION_NAME = "Kodak Picture Inc.";

                addedOrg = api.AddNewOrganisation(newOrg);

                Assert.IsNotNull(addedOrg);
                Assert.AreEqual(newOrg.ORGANISATION_NAME, addedOrg.ORGANISATION_NAME);
            }
            finally
            {
                DeleteOrganisation(api, addedOrg);
            }
        }

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

        #endregion Organisations

        #region Linked Contacts and Organisations

        /// <summary>
        /// Test adding a new contact with an existing organisation set as the default organisation.
        /// </summary>
        [TestMethod]
        public void AddNewContactWithExistingOrganisation()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);
            const string orgName = "Smith Enterprises";

            var orgs = api.GetOrganisationsForName(orgName);

            Assert.IsTrue(orgs.Count > 0, "Failed to get organisation to link to new contact");

            Contact addedContact = null;

            try
            {
                Contact newContact = new Contact();
                newContact.FIRST_NAME = "Mary";
                newContact.LAST_NAME = "Jones";
                newContact.DEFAULT_LINKED_ORGANISATION = orgs[0].ORGANISATION_ID;

                addedContact = api.AddNewContact(newContact);

                Assert.IsNotNull(addedContact);
                Assert.AreEqual(newContact.FIRST_NAME, addedContact.FIRST_NAME);
                Assert.AreEqual(newContact.LAST_NAME, addedContact.LAST_NAME);
                Assert.AreEqual(orgs[0].ORGANISATION_ID, addedContact.DEFAULT_LINKED_ORGANISATION);
            }
            finally
            {
                DeleteContact(api, addedContact);
            }
        }

        #endregion Linked Contacts and Organisations

    }
}

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

Diff revisions: vs.
Revision Author Commited Message
11 Diff Diff HadleyHope picture HadleyHope Tue 24 Sep, 2013 12:34:09 +0000

Added basic organisation functionality, at the moment cannot link organisation to contact.

10 Diff Diff HadleyHope picture HadleyHope Tue 24 Sep, 2013 12:06:30 +0000

Added basic organisation functionality, at the moment cannot link organisation to contact.

9 Diff Diff HadleyHope picture HadleyHope Tue 24 Sep, 2013 10:12:34 +0000

Added AddNewContactIfNotExists that checks for existing email, first and last names before adding a contact.

6 Diff Diff HadleyHope picture HadleyHope Mon 23 Sep, 2013 09:46:21 +0000

Tested adding and retrieving contact custom field 1.

5 Diff Diff HadleyHope picture HadleyHope Mon 23 Sep, 2013 09:01:00 +0000

Added contact address.

4 HadleyHope picture HadleyHope Fri 20 Sep, 2013 15:08:23 +0000

Added code and tests to add a basic contact with email address.