send_sample_request.js 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. define([
  2. 'jquery'
  3. ], function($) {
  4. var initDynamic = function() {
  5. // Button send
  6. $(".sample-request-send").off("click");
  7. $(".sample-request-send").on("click", function(e) {
  8. e.preventDefault();
  9. var $root = $(this).parents("article");
  10. var group = $root.data("group");
  11. var name = $root.data("name");
  12. var version = $root.data("version");
  13. sendSampleRequest(group, name, version, $(this).data("sample-request-type"));
  14. });
  15. // Button clear
  16. $(".sample-request-clear").off("click");
  17. $(".sample-request-clear").on("click", function(e) {
  18. e.preventDefault();
  19. var $root = $(this).parents("article");
  20. var group = $root.data("group");
  21. var name = $root.data("name");
  22. var version = $root.data("version");
  23. clearSampleRequest(group, name, version);
  24. });
  25. }; // initDynamic
  26. function sendSampleRequest(group, name, version, type)
  27. {
  28. var $root = $('article[data-group="' + group + '"][data-name="' + name + '"][data-version="' + version + '"]');
  29. // Optional header
  30. var header = {};
  31. $root.find(".sample-request-header:checked").each(function(i, element) {
  32. var group = $(element).data("sample-request-header-group-id");
  33. $root.find("[data-sample-request-header-group=\"" + group + "\"]").each(function(i, element) {
  34. var key = $(element).data("sample-request-header-name");
  35. var value = element.value;
  36. if ( ! element.optional && element.defaultValue !== '') {
  37. value = element.defaultValue;
  38. }
  39. header[key] = value;
  40. });
  41. });
  42. // create JSON dictionary of parameters
  43. var param = {};
  44. var paramType = {};
  45. $root.find(".sample-request-param:checked").each(function(i, element) {
  46. var group = $(element).data("sample-request-param-group-id");
  47. $root.find("[data-sample-request-param-group=\"" + group + "\"]").each(function(i, element) {
  48. var key = $(element).data("sample-request-param-name");
  49. var value = element.value;
  50. if ( ! element.optional && element.defaultValue !== '') {
  51. value = element.defaultValue;
  52. }
  53. param[key] = value;
  54. paramType[key] = $(element).next().text();
  55. });
  56. });
  57. // grab user-inputted URL
  58. var url = $root.find(".sample-request-url").val();
  59. // Insert url parameter
  60. var pattern = pathToRegexp(url, null);
  61. var matches = pattern.exec(url);
  62. for (var i = 1; i < matches.length; i++) {
  63. var key = matches[i].substr(1);
  64. if (param[key] !== undefined) {
  65. url = url.replace(matches[i], encodeURIComponent(param[key]));
  66. // remove URL parameters from list
  67. delete param[key];
  68. }
  69. } // for
  70. $root.find(".sample-request-response").fadeTo(250, 1);
  71. $root.find(".sample-request-response-json").html("Loading...");
  72. refreshScrollSpy();
  73. _.each( param, function( val, key ) {
  74. var t = paramType[ key ].toLowerCase();
  75. if ( t === 'object' || t === 'array' ) {
  76. try {
  77. param[ key ] = JSON.parse( val );
  78. } catch (e) {
  79. }
  80. }
  81. });
  82. // send AJAX request, catch success or error callback
  83. var ajaxRequest = {
  84. url : url,
  85. headers : header,
  86. data : param,
  87. type : type.toUpperCase(),
  88. success : displaySuccess,
  89. error : displayError
  90. };
  91. $.ajax(ajaxRequest);
  92. function displaySuccess(data, status, jqXHR) {
  93. var jsonResponse;
  94. try {
  95. jsonResponse = JSON.parse(jqXHR.responseText);
  96. jsonResponse = JSON.stringify(jsonResponse, null, 4);
  97. } catch (e) {
  98. jsonResponse = data;
  99. }
  100. $root.find(".sample-request-response-json").html(jsonResponse);
  101. refreshScrollSpy();
  102. };
  103. function displayError(jqXHR, textStatus, error) {
  104. var message = "Error " + jqXHR.status + ": " + error;
  105. var jsonResponse;
  106. try {
  107. jsonResponse = JSON.parse(jqXHR.responseText);
  108. jsonResponse = JSON.stringify(jsonResponse, null, 4);
  109. } catch (e) {
  110. jsonResponse = escape(jqXHR.responseText);
  111. }
  112. if (jsonResponse)
  113. message += "<br>" + jsonResponse;
  114. // flicker on previous error to make clear that there is a new response
  115. if($root.find(".sample-request-response").is(":visible"))
  116. $root.find(".sample-request-response").fadeTo(1, 0.1);
  117. $root.find(".sample-request-response").fadeTo(250, 1);
  118. $root.find(".sample-request-response-json").html(message);
  119. refreshScrollSpy();
  120. };
  121. }
  122. function clearSampleRequest(group, name, version)
  123. {
  124. var $root = $('article[data-group="' + group + '"][data-name="' + name + '"][data-version="' + version + '"]');
  125. // hide sample response
  126. $root.find(".sample-request-response-json").html("");
  127. $root.find(".sample-request-response").hide();
  128. // reset value of parameters
  129. $root.find(".sample-request-param").each(function(i, element) {
  130. element.value = "";
  131. });
  132. // restore default URL
  133. var $urlElement = $root.find(".sample-request-url");
  134. $urlElement.val($urlElement.prop("defaultValue"));
  135. refreshScrollSpy();
  136. }
  137. function refreshScrollSpy()
  138. {
  139. $('[data-spy="scroll"]').each(function () {
  140. $(this).scrollspy("refresh");
  141. });
  142. }
  143. function escapeHtml(str) {
  144. var div = document.createElement("div");
  145. div.appendChild(document.createTextNode(str));
  146. return div.innerHTML;
  147. }
  148. /**
  149. * Exports.
  150. */
  151. return {
  152. initDynamic: initDynamic
  153. };
  154. });