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
´╗┐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;

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

        /// <summary>
        /// Contact ID for the default contact, which should not be changed for
        /// removed from the CRM.
        /// </summary>
        private const int JohnSmithContactId = 39547555;

        /// <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 Contacts

        #region Organisations

        /// <summary>
        /// Contact ID for the default organisation, which should not be changed for
        /// removed from the CRM.
        /// </summary>
        private const int SmithEnterprisesId = 19483007;

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

            var organisation = api.GetOrganisation(SmithEnterprisesId);

            Assert.IsNotNull(organisation);
            Assert.IsInstanceOfType(organisation, typeof(Organisation));
            Assert.AreEqual(SmithEnterprisesId, organisation.ORGANISATION_ID);
        }

        /// <summary>
        /// Test getting the basic organisation details.
        /// </summary>
        [TestMethod]
        public void GetBasicOrganisationDetails()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var orgs = api.GetOrganisations(false);

            Assert.IsTrue(orgs.Count > 0);
            Assert.IsNull(orgs[0].ADDRESSES);
        }

        /// <summary>
        /// Test getting the full organisation details.
        /// </summary>
        [TestMethod]
        public void GetFullOrganisationDetails()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var orgs = api.GetOrganisations(true);

            Assert.IsTrue(orgs.Count > 0);
            Assert.IsNotNull(orgs[0].ADDRESSES);
        }

        /// <summary>
        /// Test getting an organisation by name.
        /// </summary>
        [TestMethod]
        public void GetOrganisationByName()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);
            const string testName = "Smith Enterprises";

            var orgs = api.GetOrganisationsForName(testName);
            Assert.IsTrue(orgs.Count > 0);

            Organisation namedOrg = orgs[0];

            Assert.AreEqual(testName, namedOrg.ORGANISATION_NAME);
        }

        #endregion Organisations

        #region Linked Contacts and Organisations


        #endregion Linked Contacts and Organisations

        #region Projects

        private const int CRMTrainingId = 884059;

        /// <summary>
        /// Test returns project record smith enterprises crm training for CRM project unique identifier.
        /// </summary>
        [TestMethod]
        public void GetSmithEnterprisesCRMTrainingForCRMProjectId()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var project = api.GetProject(CRMTrainingId);

            Assert.IsNotNull(project);
            Assert.IsInstanceOfType(project, typeof(Project));
            Assert.AreEqual(CRMTrainingId, project.PROJECT_ID);
        }

        /// <summary>
        /// Test getting the basic project details.
        /// </summary>
        [TestMethod]
        public void GetBasicProjectDetails()
        {
            InsightlyAPI api = new InsightlyAPI(APIUser.PLAIN_API_KEY);

            var projects = api.GetProjects(false);

            Assert.IsTrue(projects.Count > 0);
            Assert.IsNull(projects[0].LINKS);
        }

        #endregion Projects
    }
}

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

Diff revisions: vs.
Revision Author Commited Message
13 Diff Diff HadleyHope picture HadleyHope Mon 30 Sep, 2013 15:02:03 +0000

Added basics for Project.

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 Diff Diff HadleyHope picture HadleyHope Fri 20 Sep, 2013 15:08:23 +0000

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

3 Diff Diff HadleyHope picture HadleyHope Thu 19 Sep, 2013 14:44:24 +0000

Initial working API retrieving a contact by it’s id and email address.

2 HadleyHope picture HadleyHope Thu 19 Sep, 2013 09:09:16 +0000

Initial check in.