Ic added rest client factory (#145)

* Added Rest Client Factory * Added tests and version bump * Made backwards compatible * Version change * Made factory thread safe * Version bump and doc update
intercom · Nov 8, 2018 · d0e6eba · d0e6eba
1 parent f84a9a5
commit d0e6eba
Show file tree

Hide file tree

Showing 30 changed files with 300 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,16 @@ If you are building a third party application you will need to implement OAuth b
 
 ## Usage
 
+### For all client types
+
+It is now possible to create all types of client by either supplying the authentication object instance or by providing an instance of the new RestClientFactory. The latter is the new preferred method to construct instances of the various clients. The older constructor methods have been marked as obsolete and will be removed in later versions.
+
+```cs
+Authentication auth = new Authentication("MyPersonalAccessToken");
+RestClientFactory factory = new RestClientFactory(auth);
+UsersClient usersClient = new UsersClient(factory);
+```
+
 ### Users
 
 **Create UsersClient instance**

diff --git a/src/Intercom.Tests.Integration/Intercom.Tests.Integration.csproj b/src/Intercom.Tests.Integration/Intercom.Tests.Integration.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp2.0</TargetFramework>
-    <ReleaseVersion>2.0.0</ReleaseVersion>
+    <ReleaseVersion>3.0.0</ReleaseVersion>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/Intercom.Tests/Clients/AdminClientTest.cs b/src/Intercom.Tests/Clients/AdminClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -20,7 +21,9 @@ public class AdminClientTest : TestBase
         public AdminClientTest()
             : base()
         {
-            this.adminsClient = new AdminsClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            adminsClient = new AdminsClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/AdminConversationsClientTest.cs b/src/Intercom.Tests/Clients/AdminConversationsClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -20,7 +21,9 @@ public class AdminConversationsClientTest  : TestBase
 
         public AdminConversationsClientTest()
         {
-            this.adminConversationsClient = new AdminConversationsClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            adminConversationsClient = new AdminConversationsClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/CompanyClientTest.cs b/src/Intercom.Tests/Clients/CompanyClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -19,7 +20,9 @@ public class CompanyClientTest : TestBase
 
         public CompanyClientTest()
         {
-            this.companyClient = new CompanyClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            companyClient = new CompanyClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/ContactClientTest.cs b/src/Intercom.Tests/Clients/ContactClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -20,7 +21,9 @@ public class ContactClientTest : TestBase
         public ContactClientTest()
             : base()
         {
-            this.contactsClient = new ContactsClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            contactsClient = new ContactsClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/ConversationsClientTest.cs b/src/Intercom.Tests/Clients/ConversationsClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -19,7 +20,9 @@ public class ConversationsClientTest  : TestBase
 
         public ConversationsClientTest()
         {
-            this.conversationsClient = new ConversationsClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            conversationsClient = new ConversationsClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/EventsClientTest.cs b/src/Intercom.Tests/Clients/EventsClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -19,7 +20,9 @@ public class EventsClientTest : TestBase
 
         public EventsClientTest()
         {
-            this.eventsClient = new EventsClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            eventsClient = new EventsClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/NotesClientTest.cs b/src/Intercom.Tests/Clients/NotesClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -19,7 +20,9 @@ public class NotesClientTest : TestBase
 
         public NotesClientTest()
         {
-            this.notesClient = new NotesClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            notesClient = new NotesClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/TagsClientTest.cs b/src/Intercom.Tests/Clients/TagsClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Core;
 using Intercom.Data;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using Moq;
 using Newtonsoft.Json;
 using NUnit.Framework;
@@ -19,7 +20,9 @@ public class TagsClientTest : TestBase
 
         public TagsClientTest()
         {
-            this.tagsClient = new TagsClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            tagsClient = new TagsClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Clients/UserClientTest.cs b/src/Intercom.Tests/Clients/UserClientTest.cs
@@ -1,9 +1,11 @@
 using NUnit.Framework;
 using System;
+using System.Net;
 using Intercom.Core;
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -17,39 +19,71 @@ public class UserClientTest  : TestBase
     {
         private UsersClient usersClient;
 
-        public UserClientTest()
+        public UserClientTest() { }
+
+        private void SetupMock(RestClient restClient = null)
         {
-            this.usersClient = new UsersClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            if (restClient == null)
+            {
+                var restClientMock = new Mock<RestClient>();
+                restClient = restClientMock.Object;
+            }
+            var restClientFactoryMock = new Mock<RestClientFactory>(new object[] { auth });
+            restClientFactoryMock.Setup(x => x.RestClient).Returns(restClient);
+            var restClientFactory = restClientFactoryMock.Object;
+            usersClient = new UsersClient(restClientFactory);
         }
 
         [Test()]
         public void Create_WithNull_ThrowException()
         {
+            SetupMock();
             Assert.Throws<ArgumentNullException>(() => usersClient.Create(null));
         }
 
         [Test()]
         public void Create_NoUserIdOrEmail_ThrowException()
         {
+            SetupMock();
             Assert.Throws<ArgumentException>(() => usersClient.Create(new User()));
         }
 
         [Test()]
         public void Archive_NoIdOrUserIdOrEmail_ThrowException()
         {
+            SetupMock();
             Assert.Throws<ArgumentException>(() => usersClient.Archive(new User()));
         }
 
         [Test()]
         public void PermanentlyDeleteUser_NoId_ThrowException()
         {
+            SetupMock();
             Assert.Throws<ArgumentNullException>(() => usersClient.PermanentlyDeleteUser(null));
         }
 
         [Test()]
         public void Update_NoIdOrUserIdOrEmail_ThrowException()
         {
+            SetupMock();
             Assert.Throws<ArgumentException>(() => usersClient.Update(new User()));
         }
+
+        [Test()]
+        public void View_ByStringId_ReturnsObjectAsExpected()
+        {
+            var userId = "id";
+            var restClientMock = new Mock<RestClient>();
+            var restResponse = new RestResponse()
+            {
+                StatusCode = HttpStatusCode.OK,
+                Content = $"{{ \"type\": \"user\", \"id\": \"530370b477ad7120001d\", \"user_id\": \"{userId}\", \"email\": \"[email protected]\" }}",
+            };
+            restClientMock.Setup(x => x.Execute(It.IsAny<IRestRequest>())).Returns(restResponse);
+            var restClient = restClientMock.Object;
+            SetupMock(restClient);
+            Assert.AreEqual(userId, usersClient.View(userId).user_id);
+        }
     }
 }
diff --git a/src/Intercom.Tests/Clients/UserConversationsClientTest.cs b/src/Intercom.Tests/Clients/UserConversationsClientTest.cs
@@ -4,6 +4,7 @@
 using Intercom.Data;
 using Intercom.Clients;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 using System.Collections.Generic;
@@ -19,7 +20,9 @@ public class UserConversationsClientTest  : TestBase
 
         public UserConversationsClientTest()
         {
-            this.userConversationsClient = new UserConversationsClient(new Authentication(AppId, AppKey));
+            var auth = new Authentication(AppId, AppKey);
+            var restClientFactory = new RestClientFactory(auth);
+            userConversationsClient = new UserConversationsClient(restClientFactory);
         }
 
         [Test()]

diff --git a/src/Intercom.Tests/Intercom.Tests.csproj b/src/Intercom.Tests/Intercom.Tests.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp2.0</TargetFramework>
-    <ReleaseVersion>2.0.0</ReleaseVersion>
+    <ReleaseVersion>3.0.0</ReleaseVersion>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/Intercom/Clients/AdminConversationsClient.cs b/src/Intercom/Clients/AdminConversationsClient.cs
@@ -6,6 +6,7 @@
 using Intercom.Core;
 using Intercom.Data;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 
@@ -17,11 +18,18 @@ public class AdminConversationsClient: Client
         private const String MESSAGES_RESOURCE = "messages";
         private const String REPLY_RESOURCE = "reply";
 
+        public AdminConversationsClient(RestClientFactory restClientFactory)
+            : base(CONVERSATIONS_RESOURCE, restClientFactory)
+        {
+        }
+
+        [Obsolete("This constructor is deprecated as of 3.0.0 and will soon be removed, please use AdminConversationsClient(RestClientFactory restClientFactory)")]
         public AdminConversationsClient(Authentication authentication)
             : base(INTERCOM_API_BASE_URL, CONVERSATIONS_RESOURCE, authentication)
         {
         }
 
+        [Obsolete("This constructor is deprecated as of 3.0.0 and will soon be removed, please use AdminConversationsClient(RestClientFactory restClientFactory)")]
         public AdminConversationsClient(String intercomApiUrl, Authentication authentication)
             : base(String.IsNullOrEmpty(intercomApiUrl) ? INTERCOM_API_BASE_URL : intercomApiUrl, CONVERSATIONS_RESOURCE, authentication)
         {

diff --git a/src/Intercom/Clients/AdminsClient.cs b/src/Intercom/Clients/AdminsClient.cs
@@ -6,6 +6,7 @@
 using Intercom.Core;
 using Intercom.Data;
 using Intercom.Exceptions;
+using Intercom.Factories;
 using RestSharp;
 using RestSharp.Authenticators;
 
@@ -15,11 +16,18 @@ public class AdminsClient : Client
     {
         private const String ADMINS_RESOURCE = "admins";
 
-        public AdminsClient (Authentication authentication)
-            : base (INTERCOM_API_BASE_URL, ADMINS_RESOURCE, authentication)
+        public AdminsClient (RestClientFactory restClientFactory)
+            : base (ADMINS_RESOURCE, restClientFactory)
         {
         }
 
+        [Obsolete("This constructor is deprecated as of 3.0.0 and will soon be removed, please use AdminsClient(RestClientFactory restClientFactory)")]
+        public AdminsClient(Authentication authentication)
+            : base(INTERCOM_API_BASE_URL, ADMINS_RESOURCE, authentication)
+        {
+        }
+
+        [Obsolete("This constructor is deprecated as of 3.0.0 and will soon be removed, please use AdminsClient(RestClientFactory restClientFactory)")]
         public AdminsClient(String intercomApiUrl, Authentication authentication)
             : base(String.IsNullOrEmpty(intercomApiUrl) ? INTERCOM_API_BASE_URL : intercomApiUrl, ADMINS_RESOURCE, authentication)
         {

diff --git a/src/Intercom/Clients/CompanyClient.cs b/src/Intercom/Clients/CompanyClient.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using Intercom.Core;
 using Intercom.Data;
+using Intercom.Factories;
 using Newtonsoft.Json;
 
 namespace Intercom.Clients
@@ -13,11 +14,18 @@ public class CompanyClient : Client
     {
         private const String COMPANIES_RESOURCE = "companies";
 
+        public CompanyClient(RestClientFactory restClientFactory)
+            : base(COMPANIES_RESOURCE, restClientFactory)
+        {
+        }
+
+        [Obsolete("This constructor is deprecated as of 3.0.0 and will soon be removed, please use CompanyClient(RestClientFactory restClientFactory)")]
         public CompanyClient(Authentication authentication)
             : base(INTERCOM_API_BASE_URL, COMPANIES_RESOURCE, authentication)
         {
         }
 
+        [Obsolete("This constructor is deprecated as of 3.0.0 and will soon be removed, please use CompanyClient(RestClientFactory restClientFactory)")]
         public CompanyClient(String intercomApiUrl, Authentication authentication)
             : base(String.IsNullOrEmpty(intercomApiUrl) ? INTERCOM_API_BASE_URL : intercomApiUrl, COMPANIES_RESOURCE, authentication)
         {