Merge pull request #326 from MJMortimer/history-and-notes

History and notes

Author: MJMortimer

CoreTests/CoreTests.csproj

@@ -110,6 +110,9 @@
     <Compile Include="Integration\Files\Support\File.cs" />
     <Compile Include="Integration\Files\Support\FilesTest.cs" />
     <Compile Include="Integration\Files\Files\AddFileTest.cs" />
+    <Compile Include="Integration\HistoryAndNotes\CreateNotes.cs" />
+    <Compile Include="Integration\HistoryAndNotes\Find.cs" />
+    <Compile Include="Integration\HistoryAndNotes\HistoryAndNotesTest.cs" />
     <Compile Include="Integration\Invoices\Find.cs" />
     <Compile Include="Integration\Invoices\InvoicesTest.cs" />
     <Compile Include="Integration\Invoices\OnlineInvoiceUrl.cs" />

CoreTests/Integration/HistoryAndNotes/CreateNotes.cs

@@ -0,0 +1,21 @@
+using NUnit.Framework;
+
+namespace CoreTests.Integration.HistoryAndNotes
+{
+    public class CreateNotes : HistoryAndNotesTest
+    {
+        [Test]
+        public void Can_create_notes()
+        {
+            const string details = "Details";
+
+            Given_a_contact();
+
+            Given_a_note_with_these_details(details);
+
+            When_I_retrieve_history_and_notes_for_the_contact();
+
+            Then_there_is_a_note_with_the_correct_details(details);
+        }
+    }
+}

CoreTests/Integration/HistoryAndNotes/Find.cs

@@ -0,0 +1,17 @@
+using NUnit.Framework;
+
+namespace CoreTests.Integration.HistoryAndNotes
+{
+    public class Find : HistoryAndNotesTest
+    {
+        [Test]
+        public void Can_fetch_history_and_notes()
+        {
+            Given_a_contact();
+
+            When_I_retrieve_history_and_notes_for_the_contact();
+
+            Then_there_are_some_history_records();
+        }
+    }
+}

CoreTests/Integration/HistoryAndNotes/HistoryAndNotesTest.cs

@@ -0,0 +1,44 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using NUnit.Framework;
+using Xero.Api.Core.Model;
+using Xero.Api.Core.Model.Types;
+
+namespace CoreTests.Integration.HistoryAndNotes
+{
+    public class HistoryAndNotesTest : ApiWrapperTest
+    {
+        private Contact _contact;
+        private IEnumerable<HistoryRecord> _historyRecords;
+        
+        protected void Given_a_contact()
+        {
+            _contact = Api.Contacts.Create(new Contact { Name = Guid.NewGuid().ToString() });
+        }
+
+        protected void Given_a_note_with_these_details(string details)
+        {
+            Api.HistoryAndNotes.CreateNote(HistoryAndNotesEndpointCreateType.Contacts, _contact.Id,
+                new HistoryRecord
+                {
+                    Details = details
+                });
+        }
+
+        protected void When_I_retrieve_history_and_notes_for_the_contact()
+        {
+            _historyRecords = Api.HistoryAndNotes.Find(HistoryAndNotesEndpointRetrieveType.Contacts, _contact.Id);
+        }
+
+        protected void Then_there_are_some_history_records()
+        {
+            Assert.True(_historyRecords.Any(), "Expected some history records to be returned, but there were none");
+        }
+
+        protected void Then_there_is_a_note_with_the_correct_details(string details)
+        {
+            Assert.True(_historyRecords.Any(it => it.Details == details), "Expected a note with the expected details to be returned but it was not");
+        }
+    }
+}

Xero.Api/Core/Endpoints/HistoryAndNotesEndpoint.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using Xero.Api.Core.Model;
+using Xero.Api.Core.Model.Types;
+using Xero.Api.Core.Request;
+using Xero.Api.Core.Response;
+using Xero.Api.Infrastructure.Http;
+
+namespace Xero.Api.Core.Endpoints
+{
+    public interface IHistoryAndNotesEndpoint
+    {
+        IEnumerable<HistoryRecord> Find(HistoryAndNotesEndpointRetrieveType type, Guid parent);
+        HistoryRecord CreateNote(HistoryAndNotesEndpointCreateType type, Guid parent, HistoryRecord note);
+    }
+
+    public class HistoryAndNotesEndpoint : IHistoryAndNotesEndpoint
+    {
+        private XeroHttpClient Client { get; set; }
+
+        public HistoryAndNotesEndpoint(XeroHttpClient client)
+        {
+            Client = client;
+        }
+
+        public IEnumerable<HistoryRecord> Find(HistoryAndNotesEndpointRetrieveType type, Guid parent)
+        {
+            return Client.Get<HistoryRecord, HistoryRecordsResponse>(string.Format("api.xro/2.0/{0}/{1:D}/history", type, parent));
+        }
+
+        public HistoryRecord CreateNote(HistoryAndNotesEndpointCreateType type, Guid parent, HistoryRecord note)
+        {
+            var request = new HistoryRecordsRequest {note};
+
+            return Client.Put<HistoryRecord, HistoryRecordsResponse>(string.Format("api.xro/2.0/{0}/{1:D}/history", type, parent), request).FirstOrDefault();
+        }
+    }
+}

Xero.Api/Core/IXeroCoreApi.cs

@@ -22,6 +22,7 @@ public interface IXeroCoreApi
         IExpenseClaimsEndpoint ExpenseClaims { get; }
         IFilesEndpoint Files { get; }
         IFoldersEndpoint Folders { get; }
+        IHistoryAndNotesEndpoint HistoryAndNotes { get; }
         IInboxEndpoint Inbox { get; }
         IAssociationsEndpoint Associations { get; }
         IInvoicesEndpoint Invoices { get; }

Xero.Api/Core/Model/HistoryRecord.cs

@@ -0,0 +1,21 @@
+using System;
+using System.Runtime.Serialization;
+
+namespace Xero.Api.Core.Model
+{
+    [DataContract(Namespace = "")]
+    public sealed class HistoryRecord
+    {
+        [DataMember]
+        public string Changes { get; set; }
+
+        [DataMember(Name = "DateUTC")]
+        public DateTime DateUtc { get; set; }
+
+        [DataMember]
+        public string User { get; set; }
+
+        [DataMember]
+        public string Details { get; set; }
+    }
+}

Xero.Api/Core/Model/Types/HistoryAndNotesEndpointCreateType.cs

@@ -0,0 +1,11 @@
+namespace Xero.Api.Core.Model.Types
+{
+    public enum HistoryAndNotesEndpointCreateType
+    {
+        BankTransactions,
+        Contacts,
+        CreditNotes,
+        Invoices,
+        PurchaseOrders
+    }
+}

Xero.Api/Core/Model/Types/HistoryAndNotesEndpointRetrieveType.cs

@@ -0,0 +1,18 @@
+namespace Xero.Api.Core.Model.Types
+{
+    public enum HistoryAndNotesEndpointRetrieveType
+    {
+        BankTransactions,
+        BankTransfers,
+        Contacts,
+        CreditNotes,
+        ExpenseClaims,
+        Invoices,
+        Items,
+        ManualJournals,
+        Payments,
+        PurchaseOrders,
+        Receipts,
+        RepeatingInvoices
+    }
+}

Xero.Api/Core/Request/HistoryRecordsRequest.cs

@@ -0,0 +1,11 @@
+using System.Runtime.Serialization;
+using Xero.Api.Common;
+using Xero.Api.Core.Model;
+
+namespace Xero.Api.Core.Request
+{
+    [CollectionDataContract(Namespace = "", Name = "HistoryRecords")]
+    public class HistoryRecordsRequest : XeroRequest<HistoryRecord>
+    {
+    }
+}