Merge pull request #49 from agility/joel

added url redirections

Author: alitahir360

src/api-client.js

@@ -6,8 +6,11 @@ import getContentItem from './methods/getContentItem'
 import getContentList from './methods/getContentList'
 import getPage from './methods/getPage'
 import getGallery from './methods/getGallery'
+import getUrlRedirections from './methods/getUrlRedirections'
+
 import getSyncContent from './methods/getSyncContent'
 import getSyncPages from './methods/getSyncPages'
+
 import FilterOperators from './types/FilterOperator'
 import FilterLogicOperators from './types/FilterLogicOperator'
 import SortDirections from './types/SortDirection'
@@ -80,10 +83,13 @@ export default function createClient(userConfig) {
         adapter = cache.adapter;
     }
 
+
     //create apply the adapter to our axios instance
     const api = axios.create({
-        adapter: adapter
-    })
+		adapter: adapter,
+	})
+
+
 
     //the function that actually makes ALL our requests
     function makeRequest(reqConfig) {
@@ -99,8 +105,20 @@ export default function createClient(userConfig) {
             //if our response is from cache, inject that property in the data response
             if (response.request.fromCache) {
                 data['fromCache'] = true;
-            }
-            return data;
+			}
+
+			if (! reqConfig.returnHeaders) {
+				//if they just wanted the data...
+				return data;
+			} else {
+				//if they indicated they wanted the headers as well as the data...
+				return {
+					headers: response.headers,
+					data
+				}
+			}
+
+
         })
             .catch(async (error) => {
                 logError(`AgilityCMS Fetch API ERROR: Request failed for ${reqConfig.baseURL}${reqConfig.url} ... ${error} ... Does the item exist?`)
@@ -110,15 +128,16 @@ export default function createClient(userConfig) {
     //export only these properties:
     return {
         config: config,
-        makeRequest: makeRequest,
-        getSitemapFlat: getSitemapFlat,
-        getSitemapNested: getSitemapNested,
-        getContentItem: getContentItem,
-        getContentList: getContentList,
-        getPage: getPage,
-        getGallery: getGallery,
-        getSyncContent: getSyncContent,
-        getSyncPages: getSyncPages,
+        makeRequest,
+        getSitemapFlat,
+        getSitemapNested,
+        getContentItem,
+        getContentList,
+        getPage,
+        getGallery,
+        getSyncContent,
+		getSyncPages,
+		getUrlRedirections,
         types: {
             FilterOperators: FilterOperators,
             FilterLogicOperators: FilterLogicOperators,

src/content-fetch.js

@@ -40,7 +40,7 @@
 import createClient from './api-client'
 import { isHttps } from './utils'
 
-/** 
+/**
  * How to create an instance of an an API client for the Agility Content Fetch REST API.
  * @func
  * @name getApi
@@ -54,9 +54,9 @@ import { isHttps } from './utils'
  * @param {string} [config.baseUrl] - Optionally override the default API Base Url.
  * @return {AgilityFetch.Client}
  * @example
- * 
+ *
  * import agility from '@agility/content-fetch'
- * 
+ *
  * const api = agility.getApi({
  *   guid: '191309ca-e675-4be2-bb29-351879528707',
  *   apiKey: 'aGd13M.fa30c36e553a36f871860407e902da9a7375322457acd6bcda038e60af699411',

src/methods/getContentItem.js

@@ -9,14 +9,14 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * @param {number} [requestParams.contentLinkDepth] - The depth, representing the levels in which you want linked content auto-resolved. Default is 1.
  * @returns {Promise<AgilityFetch.Types.ContentItem>} - Returns a content item object.
  * @example
- * 
+ *
  * import agility from '@agility/content-fetch'
- * 
+ *
  * const api = agility.getApi({
  *   guid: 'ade6cf3c',
  *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
  * });
- * 
+ *
  * api.getContentItem({
  *     contentID: 22,
  *     languageCode: 'en-us'
@@ -27,7 +27,7 @@ import { buildRequestUrlPath, buildAuthHeader } from '../utils'
  * .catch(function(error) {
  *     console.log(error);
  * });
- * 
+ *
 */
 function getContentItem(requestParams) {
 
@@ -41,9 +41,9 @@ function getContentItem(requestParams) {
         method: 'get',
         baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
         headers: buildAuthHeader(this.config),
-        params:{}
+		params:{}
     };
-    
+
     return this.makeRequest(req);
 }
 

src/methods/getUrlRedirections.js

@@ -0,0 +1,92 @@
+import { buildRequestUrlPath, buildAuthHeader } from '../utils'
+
+/**
+ * Gets the details of a gallery by their Gallery ID.
+ * @memberof AgilityFetch.Client.Pages
+ * @param {Object} requestParams - The parameters for the API request.
+ * @param {Date} [requestParams.lastAccessDate] - A Date object representing the last access date and time for the URL Redirections list.  This value should be pulled from a previous request.
+ * @returns {Promise<AgilityFetch.Types.Gallery>} - Returns a gallery object.
+ * @example
+ *
+ * import agility from '@agility/content-fetch'
+ *
+ * const api = agility.getApi({
+ *   guid: 'ade6cf3c',
+ *   apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb',
+ * });
+ *
+ * let dateObj = null;
+ *
+ * api.getUrlRedirections({
+ *     lastAccessDate: dateObj
+ * })
+ * .then(function({urlRedirections, lastAccessDate}) {
+ *     console.log(urlRedirections.length, lastAccessDate);
+ * })
+ * .catch(function(error) {
+ *     console.log(error);
+ * });
+ *
+*/
+function getUrlRedirections(requestParams) {
+
+	validateRequestParams(requestParams);
+
+	let url = "";
+	if (requestParams.lastAccessDate) {
+		url = `/?lastAccessDate=${requestParams.lastAccessDate.toISOString()}`
+	}
+
+
+	const req = {
+		url: url,
+		method: 'get',
+		baseURL: buildRequestUrlPath(this.config, 'urlredirection'),
+		headers: buildAuthHeader(this.config),
+		params: {},
+		returnHeaders: true
+	};
+
+	const self = this;
+	let promise = new Promise(function (resolve, reject) {
+
+		self.makeRequest(req)
+			.then(response => {
+
+				if (response == undefined || ! response)  {
+					reject(new Error("The URL redirections could not be retrieved."));
+				} else {
+
+					const {headers, data} = response;
+
+					//pull the lastAccessDate from the header
+					let lastAccessDate = null;
+					if (headers) {
+						let dateStr = headers["x-lastaccessdate"];
+						if (dateStr) lastAccessDate = new Date(dateStr);
+					}
+
+					//return an object with items and lastAccessDate
+					resolve({ lastAccessDate, items: data  });
+				}
+			})
+			.catch(error => {
+				console.log("error in url redir")
+				reject(error);
+			}
+		);
+	});
+	return promise;
+}
+
+function validateRequestParams(requestParams) {
+
+	if (requestParams.lastAccessDate  && ! requestParams.lastAccessDate.toISOString) {
+		throw new TypeError('You must include a valid Datetime for the lastAccessDate.');
+	} else {
+		return;
+	}
+}
+
+
+export default getUrlRedirections;

test/apiClients.config.js

@@ -8,7 +8,7 @@ const apiKeyPreview = 'UnitTestsPreview.69e6bca345ced0b7ca5ab358b351ea5c870790a5
 function createApiClient() {
     var api = agility.getApi({
         guid: guid,
-        apiKey: apiKeyFetch
+		apiKey: apiKeyFetch
     });
     return api;
 }

test/getUrlRedirections.tests.js

@@ -0,0 +1,55 @@
+import chai from 'chai'
+const assert = chai.assert;
+const expect = chai.expect;
+
+import { createApiClient } from './apiClients.config'
+
+/*
+    This file contains static references to content from the instance configured in the apiClient.config file.
+*/
+
+/* GET URL REDIRECTIONS *********************************************************/
+
+
+describe('getUrlRedirections:', function() {
+
+	this.timeout('120s');
+
+	let persistedLastAccessDate = null;
+
+    it('should retrieve the list of URL redirections', function(done) {
+        var api = createApiClient();
+        api.getUrlRedirections({
+            lastAccessDate: null
+        })
+            .then(function({lastAccessDate, items}) {
+
+				assert.isArray(items, "the items should be an array.");
+				assert.isDefined(lastAccessDate.getUTCFullYear, "the lastAccessDate should be a date object.");
+				assert.isTrue(lastAccessDate.getUTCFullYear() > 2000, "the lastAccessDate should be a recent date.")
+
+				persistedLastAccessDate = lastAccessDate;
+
+                done();
+            })
+            .catch(done);
+	});
+
+	it('should retrieve an empty list of URL redirections with saved last access date', function(done) {
+        var api = createApiClient();
+        api.getUrlRedirections({
+            lastAccessDate: persistedLastAccessDate
+        })
+            .then(function({lastAccessDate, items}) {
+
+				assert.isArray(items, "the items should be an array.");
+
+				assert.equal(items.length, 0, "the list of items should be empty.")
+
+                done();
+            })
+            .catch(done);
+    });
+
+
+});