Finalising history and notes

Author: MJMortimer

CoreTests/Integration/HistoryAndNotes/CreateNotes.cs

@@ -1,5 +1,4 @@
-using System;
-using NUnit.Framework;
+using NUnit.Framework;
 
 namespace CoreTests.Integration.HistoryAndNotes
 {
@@ -8,28 +7,15 @@ public class CreateNotes : HistoryAndNotesTest
         [Test]
         public void Can_create_notes()
         {
-            var date = DateTime.UtcNow;
             const string details = "Details";
 
             Given_a_contact();
 
-            Given_a_note_with_this_date_and_details(date, details);
+            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(date, details);
-        }
-
-        [Test]
-        public void Validation_errors_are_as_expected()
-        {
-            Given_a_contact();
-
-            Given_a_note_with_this_date_and_details(new DateTime(1000, 1, 1), "Details");
-
-            When_I_retrieve_history_and_notes_for_the_contact();
-
-            Then_there_is_this_validation_error("sad");
+            Then_there_is_a_note_with_the_correct_details(details);
         }
     }
 }

CoreTests/Integration/HistoryAndNotes/HistoryAndNotesTest.cs

@@ -4,36 +4,26 @@
 using NUnit.Framework;
 using Xero.Api.Core.Model;
 using Xero.Api.Core.Model.Types;
-using Xero.Api.Infrastructure.Exceptions;
 
 namespace CoreTests.Integration.HistoryAndNotes
 {
     public class HistoryAndNotesTest : ApiWrapperTest
     {
         private Contact _contact;
         private IEnumerable<HistoryRecord> _historyRecords;
-        private ValidationException _exception;
-
+        
         protected void Given_a_contact()
         {
             _contact = Api.Contacts.Create(new Contact { Name = Guid.NewGuid().ToString() });
         }
 
-        protected void Given_a_note_with_this_date_and_details(DateTime date, string details)
+        protected void Given_a_note_with_these_details(string details)
         {
-            try
-            {
-                Api.HistoryAndNotes.CreateNote(HistoryAndNotesEndpointCreateType.Contacts, _contact.Id,
-                    new HistoryRecord
-                    {
-                        DateUtc = date,
-                        Details = details
-                    });
-            }
-            catch (ValidationException e)
-            {
-                _exception = e;
-            }
+            Api.HistoryAndNotes.CreateNote(HistoryAndNotesEndpointCreateType.Contacts, _contact.Id,
+                new HistoryRecord
+                {
+                    Details = details
+                });
         }
 
         protected void When_I_retrieve_history_and_notes_for_the_contact()
@@ -46,14 +36,9 @@ 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(DateTime date, string details)
-        {
-            Assert.True(_historyRecords.Any(it => it.DateUtc.Date.Equals(date.Date) && it.Details == details), "Expected a note with the expected details to be retunred but it was not");
-        }
-
-        protected void Then_there_is_this_validation_error(string expectedError)
+        protected void Then_there_is_a_note_with_the_correct_details(string details)
         {
-            Assert.Contains(expectedError, _exception.ValidationErrors.Select(it => it.Message).ToList());
+            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

@@ -1,8 +1,10 @@
 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;
 
@@ -11,7 +13,7 @@ namespace Xero.Api.Core.Endpoints
     public interface IHistoryAndNotesEndpoint
     {
         IEnumerable<HistoryRecord> Find(HistoryAndNotesEndpointRetrieveType type, Guid parent);
-        void CreateNote(HistoryAndNotesEndpointCreateType type, Guid parent, HistoryRecord note);
+        HistoryRecord CreateNote(HistoryAndNotesEndpointCreateType type, Guid parent, HistoryRecord note);
     }
 
     public class HistoryAndNotesEndpoint : IHistoryAndNotesEndpoint
@@ -28,14 +30,11 @@ public IEnumerable<HistoryRecord> Find(HistoryAndNotesEndpointRetrieveType type,
             return Client.Get<HistoryRecord, HistoryRecordsResponse>(string.Format("api.xro/2.0/{0}/{1:D}/history", type, parent));
         }
 
-        public void CreateNote(HistoryAndNotesEndpointCreateType type, Guid parent, HistoryRecord note)
+        public HistoryRecord CreateNote(HistoryAndNotesEndpointCreateType type, Guid parent, HistoryRecord note)
         {
-            var response = Client.Client.Put(string.Format("api.xro/2.0/{0}/{1:D}/history", type, parent), Client.XmlMapper.To(new List<HistoryRecord>{note}));
+            var request = new HistoryRecordsRequest {note};
 
-            if (response.StatusCode != HttpStatusCode.OK)
-            {
-                Client.HandleErrors(response);
-            }
+            return Client.Put<HistoryRecord, HistoryRecordsResponse>(string.Format("api.xro/2.0/{0}/{1:D}/history", type, parent), request).FirstOrDefault();
         }
     }
 }

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>
+    {
+    }
+}

Xero.Api/Xero.Api.csproj

@@ -80,6 +80,7 @@
     <Compile Include="Core\Model\Types\ObjectType.cs" />
     <Compile Include="Core\Model\Types\SourceType.cs" />
     <Compile Include="Core\Request\CurrenciesRequest.cs" />
+    <Compile Include="Core\Request\HistoryRecordsRequest.cs" />
     <Compile Include="Core\Request\LinkedTransactionsRequest.cs" />
     <Compile Include="Core\Request\OnlineInvoicesRequest.cs" />
     <Compile Include="Core\Request\PurchaseOrdersRequest.cs" />