fix historical call

Author: glenwperry

src/examples/get_detours.test.js

@@ -66,6 +66,57 @@ describe('When deactivating a detour by customer', () => {
     const detoursPromise = api.customer('SYNC').detours()
       .deactivate(detourId);
 
+    return detoursPromise;
+  });
+});
+
+describe('When retrieving historical detours by customer', () => {
+  const api = new Track({ autoRenew: false });
+  
+  beforeEach(() => charlie.setUpSuccessfulMock(api.client));
+  beforeEach(() => mockDetours.setUpSuccessfulMock(api.client));
+  beforeEach(() => fetchMock.catch(503));
+  afterEach(fetchMock.restore);
+
+  it('should get all historical detours without date parameters', () => {
+    api.logIn({ username: 'charlie@example.com', password: 'securepassword' });
+
+    const detoursPromise = api.customer('SYNC').detours()
+      .getHistoricalDetours()
+      .then(detours => {
+        detours.should.be.an('array');
+        // Add more specific assertions if needed
+      });
+
+    return detoursPromise;
+  });
+
+  it('should get historical detours with start date parameter', () => {
+    api.logIn({ username: 'charlie@example.com', password: 'securepassword' });
+
+    const startDate = new Date('2024-01-01T00:00:00Z');
+    const detoursPromise = api.customer('SYNC').detours()
+      .getHistoricalDetours(startDate)
+      .then(detours => {
+        detours.should.be.an('array');
+        // Add more specific assertions if needed
+      });
+
+    return detoursPromise;
+  });
+
+  it('should get historical detours with start and end date parameters', () => {
+    api.logIn({ username: 'charlie@example.com', password: 'securepassword' });
+
+    const startDate = new Date('2024-01-01T00:00:00Z');
+    const endDate = new Date('2024-02-01T00:00:00Z');
+    const detoursPromise = api.customer('SYNC').detours()
+      .getHistoricalDetours(startDate, endDate)
+      .then(detours => {
+        detours.should.be.an('array');
+        // Add more specific assertions if needed
+      });
+
     return detoursPromise;
   });
 });

src/mocks/detour.js

@@ -5,9 +5,13 @@ import Client from '../Client';
 const detours = {
     setUpSuccessfulMock: (client) => {
         const singleResponse = () => new Response(Client.toBlob(detours.response));
+        const historicalResponse = () => new Response(Client.toBlob(detours.historicalResponse));
 
         fetchMock
             .get(client.resolve('/2/SYNC/serviceadjustments/detours'), singleResponse)
+            .get(client.resolve('/2/SYNC/serviceadjustments/detours/historical'), historicalResponse)
+            .get(client.resolve('/2/SYNC/serviceadjustments/detours/historical?startDate=2024-01-01T00:00:00.000Z'), historicalResponse)
+            .get(client.resolve('/2/SYNC/serviceadjustments/detours/historical?startDate=2024-01-01T00:00:00.000Z&endDate=2024-02-01T00:00:00.000Z'), historicalResponse)
             .post(client.resolve('/2/SYNC/serviceadjustments/detours'), () => singleResponse())
             .delete(client.resolve(`/2/SYNC/serviceadjustments/detours/2`), () => singleResponse())
     },
@@ -74,7 +78,39 @@ const detours = {
                 }
             ]
         }
-    }
+    },
+    historicalResponse: [
+        {
+            detour_id: 189,
+            customer_id: 1,
+            pattern_id: 96,
+            detour_pattern_id: 44420,
+            title: "Historical Detour 1",
+            should_match_scheduled_stops: true,
+            creator_user_id: 397,
+            created_date_time: "2024-01-15T16:45:57.168336+00:00",
+            deactivator_user_id: 397,
+            deactivated_date_time: "2024-01-16T18:58:29+00:00",
+            start_date_time: "2024-01-15T01:00:00-07:00",
+            end_date_time: "2024-01-16T01:30:00-07:00",
+            href: "/2/SYNC/serviceadjustments/detours/189"
+        },
+        {
+            detour_id: 194,
+            customer_id: 1,
+            pattern_id: 40062,
+            detour_pattern_id: 12206,
+            title: "Historical Detour 2",
+            should_match_scheduled_stops: true,
+            creator_user_id: 397,
+            created_date_time: "2024-01-20T12:55:25.8659593+00:00",
+            deactivator_user_id: 397,
+            deactivated_date_time: "2024-01-21T12:55:25.8659593+00:00",
+            start_date_time: "2024-01-20T01:00:00-07:00",
+            end_date_time: "2024-01-21T01:15:00-07:00",
+            href: "/2/SYNC/serviceadjustments/detours/194"
+        }
+    ]
 };
 
 export default detours;

src/resources/Detour.js

@@ -21,13 +21,28 @@ class Detour extends Resource {
 
   /**
    * Fetches historical detours for a given customer.
-   * @param {Client} client Instance of pre-configured client
-   * @param {string} customerCode - The customer code.
+   * @param {Date} [startDate] - Optional start date to filter detours from (the date any applicable detours started)
+   * @param {Date} [endDate] - Optional end date to filter detours to (the date any applicable detours started)
    * @returns {Promise<Array<Detour>>} A promise that resolves to an array of historical detours.
    */
-  static async getHistoricalDetours(client, customerCode) {
-    const endpoint = `/2/${customerCode}/serviceadjustments/detours/historical`;
-    return this.client.get(endpoint)
+  async getHistoricalDetours(startDate, endDate) {
+    const customerCode = this.href.split('/')[2]; // Extract customer code from href
+    let endpoint = `/2/${customerCode}/serviceadjustments/detours/historical`;
+    
+    const params = [];
+    if (startDate instanceof Date) {
+      params.push(`startDate=${encodeURIComponent(startDate.toISOString())}`);
+    }
+    if (endDate instanceof Date) {
+      params.push(`endDate=${encodeURIComponent(endDate.toISOString())}`);
+    }
+
+    if (params.length > 0) {
+      endpoint += `?${params.join('&')}`;
+    }
+
+    const { client } = this;
+    return client.get(endpoint)
       .then(response => response.json())
       .then(detours => detours.map(detour => new Detour(client, detour)));
   }