Source: response/responseManagerFactory.js

  1. /**
  2.  * @author Sloan Seaman 
  3.  * @copyright 2016 and on
  4.  * @version .1
  5.  * @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
  6.  */
  8. /** @private */
  9. var ResponseProviderByDirectory = require ('../provider/convention/responseProviderByDirectory.js');
  10. var ResponseProviderByFile = require ('../provider/convention/responseProviderByFile.js');
  11. var ResponseProviderByMap = require ('../provider/convention/responseProviderByMap.js');
  12. var DefaultJSONFilenameFormatter = require ('../provider/defaultJSONFilenameFormatter.js');
  13. var HandlebarsFormatterManager = require('./formatter/handlebarsFormatterManager.js');
  14. var DefaultResponseBuilder = require('./defaultResponseBuilder.js');
  15. var DefaultResponseManager = require('./defaultResponseManager.js');
  17. /**
  18.  * Static factory that can create ResponseManagers depending on the specific needs of the skill.  
  19.  * This should never need to be called and is here as a placeholder.
  20.  *
  21.  * @constructor
  22.  * @see  {@link ResponseManager}
  23.  */
  24. function ResponseManagerFactory() {
  25. 	
  26. }
  28. /**
  29.  * Creates a ResponseManager that loads responses from a directory and 
  30.  * uses the DefaultResponseManager and the HandlebarsFormatterManager
  31.  *
  32.  * @function
  33.  * @static
  34.  * @see  {@link DefaultResponseManager}
  35.  * @see  {@link ResponseProviderByDirectory}
  36.  * @see  {@link HandlebarsFormatterManager}
  37.  * @param  {String} directory The directory to read the responses from
  38.  * @return {ResponseManager} The ResponseManager that will manage the responses
  39.  */
  40. ResponseManagerFactory.createHandlebarEnabledByDirectory = function(directory) {
  41. 	var responseProvider = new ResponseProviderByDirectory(directory,
  42. 		{ 
  43. 			responseBuilder : new DefaultResponseBuilder()
  44. 				.withFormatterManager(new HandlebarsFormatterManager()),
  45. 			filenameFormatter : new DefaultJSONFilenameFormatter()
  46. 		}
  47. 	);
  48. 	return new DefaultResponseManager([responseProvider]);
  49. };
  51. /**
  52.  * Creates a ResponseManager that loads responses from a file and 
  53.  * uses the DefaultResponseManager and the HandlebarsFormatterManager
  54.  *
  55.  * @function
  56.  * @static
  57.  * @see  {@link DefaultResponseManager}
  58.  * @see  {@link ResponseProviderByFile}
  59.  * @see  {@link HandlebarsFormatterManager}
  60.  * @param  {String} file The file to read the responses from
  61.  * @return {ResponseManager} The ResponseManager that will manage the responses
  62.  */
  63. ResponseManagerFactory.createHandlebarEnabledByFile = function(file) {
  64. 	var responseProvider = new ResponseProviderByFile(file,
  65. 		{ 
  66. 			responseBuilder : new DefaultResponseBuilder()
  67. 				.withFormatterManager(new HandlebarsFormatterManager()),
  68. 			filenameFormatter : new DefaultJSONFilenameFormatter()
  69. 		}
  70. 	);
  71. 	return new DefaultResponseManager([responseProvider]);
  72. };
  74. /**
  75.  * Creates a ResponseManager that loads responses from a map and 
  76.  * uses the DefaultResponseManager and the HandlebarsFormatterManager
  77.  *
  78.  * @function
  79.  * @static
  80.  * @see  {@link DefaultResponseManager}
  81.  * @see  {@link ResponseProviderByMap}
  82.  * @see  {@link HandlebarsFormatterManager}
  83.  * @param  {String} map The map to use
  84.  * @return {ResponseManager} The ResponseManager that will manage the responses
  85.  */
  86. ResponseManagerFactory.createHandlebarEnabledByMap= function(map) {
  87. 	var responseProvider = new ResponseProviderByMap(map,
  88. 		{ 
  89. 			responseBuilder : new DefaultResponseBuilder()
  90. 				.withFormatterManager(new HandlebarsFormatterManager()),
  91. 			filenameFormatter : new DefaultJSONFilenameFormatter()
  92. 		}
  93. 	);
  94. 	return new DefaultResponseManager([responseProvider]);
  95. };
  97. /**
  98.  * Creates a ResponseManager that loads responses from a directory and 
  99.  * uses the DefaultResponseManager and the BasicFormatterManager
  100.  *
  101.  * @function
  102.  * @static
  103.  * @see  {@link DefaultResponseManager}
  104.  * @see  {@link ResponseProviderByDirectory}
  105.  * @see  {@link BasicFormatterManager}
  106.  * @param  {String} directory The directory to read the responses from
  107.  * @return {ResponseManager} The ResponseManager that will manage the responses
  108.  */
  109. ResponseManagerFactory.createByDirectory = function(directory) {
  110. 	return new DefaultResponseManager([new ResponseProviderByDirectory(directory)]);
  111. };
  113. /**
  114.  * Creates a ResponseManager that loads responses from a file and 
  115.  * uses the DefaultResponseManager and the BasicFormatterManager
  116.  *
  117.  * @function
  118.  * @static
  119.  * @see  {@link DefaultResponseManager}
  120.  * @see  {@link ResponseProviderByFile}
  121.  * @see  {@link BasicFormatterManager}
  122.  * @param  {String} file The file to read the responses from
  123.  * @return {ResponseManager} The ResponseManager that will manage the responses
  124.  */
  125. ResponseManagerFactory.createByFile = function(file) {
  126. 	return new DefaultResponseManager([new ResponseProviderByFile(file)]);
  127. };
  129. /**
  130.  * Creates a ResponseManager that loads responses from a map and 
  131.  * uses the DefaultResponseManager and the BasicFormatterManager
  132.  *
  133.  * @function
  134.  * @static
  135.  * @see  {@link DefaultResponseManager}
  136.  * @see  {@link ResponseProviderByMap}
  137.  * @see  {@link BasicFormatterManager}
  138.  * @param  {String} map The map to use
  139.  * @return {ResponseManager} The ResponseManager that will manage the responses
  140.  */
  141. ResponseManagerFactory.createByMap = function(map) {
  142. 	return new DefaultResponseManager([new ResponseProviderByMap(map)]);
  143. };
  145. module.exports = ResponseManagerFactory;