Added search functionality and 6 unit tests

Author: karissarjacobsen

Gemfile

@@ -65,11 +65,12 @@ group :test do
   gem 'selenium-webdriver', '~> 3.142.7'
   # Easy installation and use of chromedriver to run system tests with Chrome
   gem 'chromedriver-helper', '~> 2.1.1'
+  gem 'test-unit'
 end
 
 gem 'docusign_admin', '~> 1.1.0'
 gem 'docusign_click', '~> 1.2.2'
-gem 'docusign_esign', '~> 3.19.0'
+gem 'docusign_esign', '~> 3.20.0'
 gem 'docusign_monitor', '~> 1.1.0'
 gem 'docusign_rooms', '~> 1.2.0.rc1'
 gem 'omniauth-oauth2', '~> 1.7.1'
@@ -78,3 +79,5 @@ gem 'omniauth-rails_csrf_protection'
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', '~> 1.2022.1', '>= 1.2022.1'
 gem 'wdm', '>= 0.1.0', platforms: %i[mingw mswin x64_mingw]
+
+gem "matrix", "~> 0.4.2"

Gemfile.lock

@@ -108,7 +108,7 @@ GEM
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
-    docusign_esign (3.19.0)
+    docusign_esign (3.20.0)
       addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
@@ -147,12 +147,13 @@ GEM
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.19.0)
+    loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (1.0.2)
+    matrix (0.4.2)
     method_source (0.9.2)
     mini_mime (1.1.2)
     minitest (5.16.3)
@@ -167,9 +168,11 @@ GEM
     net-smtp (0.3.2)
       net-protocol
     nio4r (2.5.8)
-    nokogiri (1.13.8-x64-mingw-ucrt)
+    nokogiri (1.13.10-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-darwin)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.10-x86_64-linux)
       racc (~> 1.4)
     oauth2 (2.0.9)
       faraday (>= 0.17.3, < 3.0)
@@ -191,6 +194,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    power_assert (2.0.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -201,7 +205,7 @@ GEM
     public_suffix (5.0.0)
     puma (5.6.5)
       nio4r (~> 2.0)
-    racc (1.6.0)
+    racc (1.6.1)
     rack (2.2.4)
     rack-protection (3.0.2)
       rack
@@ -224,8 +228,8 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
+    rails-html-sanitizer (1.4.4)
+      loofah (~> 2.19, >= 2.19.1)
     railties (7.0.4)
       actionpack (= 7.0.4)
       activesupport (= 7.0.4)
@@ -283,6 +287,8 @@ GEM
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.4)
+    test-unit (3.5.3)
+      power_assert
     thor (1.2.1)
     tilt (2.0.11)
     timeout (0.3.0)
@@ -314,6 +320,7 @@ GEM
 PLATFORMS
   x64-mingw-ucrt
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bootsnap (~> 1.7.3)
@@ -322,12 +329,13 @@ DEPENDENCIES
   chromedriver-helper (~> 2.1.1)
   coffee-rails (~> 5.0.0)
   docusign_admin (~> 1.1.0)
-  docusign_click (~> 1.2.0)
-  docusign_esign (~> 3.19.0)
+  docusign_click (~> 1.2.2)
+  docusign_esign (~> 3.20.0)
   docusign_monitor (~> 1.1.0)
   docusign_rooms (~> 1.2.0.rc1)
   jbuilder (~> 2.11.5)
   listen (~> 3.7.1)
+  matrix (~> 0.4.2)
   omniauth-oauth2 (~> 1.7.1)
   omniauth-rails_csrf_protection
   pry-nav (~> 0.3.0)
@@ -340,6 +348,7 @@ DEPENDENCIES
   spring (~> 2.1.0)
   spring-watcher-listen (~> 2.0.1)
   sqlite3 (~> 1.4.4)
+  test-unit
   turbolinks (~> 5.2.1)
   tzinfo-data (~> 1.2022.1, >= 1.2022.1)
   uglifier (~> 4.2.0)

app/assets/javascripts/search.js

@@ -0,0 +1,266 @@
+const DS_SEARCH = (function () {
+  const API_TYPES = {
+    ESIGNATURE: "esignature",
+    MONITOR: "monitor",
+    CLICK: "click",
+    ROOMS: "rooms",
+    ADMIN: "admin",
+  };
+
+  const processJSONData = function () {
+    const json_raw = $("#api_json_data").text();
+    const json = json_raw ? JSON.parse(json_raw) : false;
+
+    return json;
+  }
+
+  let processCFR11Value = function () {
+    let json_raw = $("#cfr11_data").text();
+
+    return json_raw;
+}
+
+  function checkIfExampleMatches(example, matches) {
+    const name = example.ExampleName;
+    const description = example.ExampleDescription;
+    const pathNames = example.LinksToAPIMethod.map((a) => a.PathName);
+
+    for (let i = 0; i < matches.length; i++) {
+      if (
+        name === matches[i].value ||
+        description === matches[i].value ||
+        pathNames.indexOf(matches[i].value) > -1
+      ) {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  function clearNonMatchingExamples(examples, matches) {
+    for (let i = examples.length - 1; i >= 0; i--) {
+      if (!checkIfExampleMatches(examples[i], matches)) {
+        examples.splice(i, 1);
+      }
+    }
+  }
+
+  function clearResultsAfterMatching(api, matches) {
+    const groups = api.Groups;
+
+    for (let i = groups.length - 1; i >= 0; i--) {
+      const group = groups[i];
+      clearNonMatchingExamples(group.Examples, matches);
+
+      if (group.Examples.length === 0) {
+        groups.splice(i, 1);
+      }
+    }
+  }
+
+  const findCodeExamplesByKeywords = function(json, pattern) {
+    const options = {
+      isCaseSensitive: false,
+      threshold: -0.0,
+      includeMatches: true,
+      ignoreLocation: true,
+      useExtendedSearch: true,
+      keys: [
+        "Groups.Examples.ExampleName",
+        "Groups.Examples.ExampleDescription",
+        "Groups.Examples.LinksToAPIMethod.PathName",
+      ],
+    };
+
+    let clearJSON = JSON.stringify(json).replace(/<\/?[^>]+(>|$)/g, "");
+        const fuse = new Fuse(JSON.parse(clearJSON), options);
+
+        var searchResults = fuse.search(JSON.stringify(pattern));
+
+        searchResults.forEach(searchResult => {
+            return clearResultsAfterMatching(searchResult.item, searchResult.matches)
+        });
+
+        return searchResults;
+  }
+
+  const getExamplesByAPIType = function (apiType, codeExamples) {
+    let codeExamplesByAPI = codeExamples.find(
+      (x) => x.Name.toLowerCase() === apiType
+    );
+
+    if (codeExamplesByAPI != null) {
+      return [codeExamplesByAPI];
+    } else {
+      return null;
+    }
+  };
+
+  const getEnteredAPIType = function (inputValue) {
+    const inputLength = inputValue.length;
+
+    for (const key in API_TYPES) {
+      if (Object.hasOwnProperty.call(API_TYPES, key)) {
+        const apiType = API_TYPES[key];
+        const comparedValue = apiType.substr(0, inputLength);
+
+        if (inputValue === comparedValue) {
+          return apiType;
+        }
+      }
+    }
+
+    return null;
+  };
+
+  function getLinkForApiType(apiName) {
+    switch (apiName) {
+      case API_TYPES.ADMIN:
+        return "aeg";
+      case API_TYPES.CLICK:
+        return "ceg";
+      case API_TYPES.ROOMS:
+        return "reg";
+      case API_TYPES.MONITOR:
+        return "meg";
+      case API_TYPES.ESIGNATURE:
+        return "eg";
+    }
+  }
+
+  let addCodeExampleToHomepage = function (codeExamples) {
+    var cfrPart11 = processCFR11Value();
+
+    codeExamples.forEach(
+        element => {
+            let linkToCodeExample = getLinkForApiType(element.Name.toLowerCase());
+
+            element.Groups.forEach(
+                group => {
+                    $("#filtered_code_examples").append("<h2>" + group.Name + "</h2>");
+
+                    group.Examples.forEach(
+                        example => {
+                            if (!example.SkipForLanguages || !example.SkipForLanguages.toLowerCase().includes("c#")) {
+                                if (element.Name.toLowerCase() !== API_TYPES.ESIGNATURE.toLowerCase() ||
+                                    ((example.CFREnabled == "AllAccounts") ||
+                                    ((cfrPart11 == "enabled") && (example.CFREnabled == "CFROnly")) ||
+                                        ((cfrPart11 != "enabled") && (example.CFREnabled == "NonCFR")))) {
+                                    $("#filtered_code_examples").append(
+                                        "<h4 id="
+                                        + "example".concat("0".repeat(3 - example.ExampleNumber.toString().length)).concat(example.ExampleNumber) + ">"
+                                        + "<a href = "
+                                        + linkToCodeExample.concat("0".repeat(3 - example.ExampleNumber.toString().length)).concat(example.ExampleNumber)
+                                        + " >"
+                                        + example.ExampleName
+                                        + "</a ></h4 >"
+                                    );
+
+                                    $("#filtered_code_examples").append("<p>" + example.ExampleDescription + "</p>");
+
+                                    $("#filtered_code_examples").append("<p>");
+
+                                    if (example.LinksToAPIMethod.length == 1) {
+                                        $("#filtered_code_examples").append(processJSONData().SupportingTexts.APIMethodUsed);
+                                    }
+                                    else {
+                                        $("#filtered_code_examples").append(processJSONData().SupportingTexts.APIMethodUsedPlural);
+                                    }
+
+                                    for (let index = 0; index < example.LinksToAPIMethod.length; index++) {
+                                        $("#filtered_code_examples").append(
+                                            " <a target='_blank' href='"
+                                            + example.LinksToAPIMethod[index].Path
+                                            + "'>"
+                                            + example.LinksToAPIMethod[index].PathName
+                                            + "</a>"
+                                        );
+
+                                        if (index + 1 === example.LinksToAPIMethod.length) {
+                                            $("#filtered_code_examples").append("<span></span>");
+                                        }
+                                        else if (index + 1 === example.LinksToAPIMethod.length - 1) {
+                                            $("#filtered_code_examples").append("<span> and </span>");
+                                        }
+                                        else {
+                                            $("#filtered_code_examples").append("<span>, </span>");
+                                        }
+
+                                    }
+
+                                    $("#filtered_code_examples").append("</p> ");
+                                }
+                            }
+                        }
+                    );
+                }
+            );
+        }
+    );
+}
+
+  const textCouldNotBeFound = function () {
+    $("#filtered_code_examples").append(
+      processJSONData().SupportingTexts.SearchFailed
+    );
+  };
+
+  return {
+    processJSONData: processJSONData,
+    getEnteredAPIType: getEnteredAPIType,
+    getExamplesByAPIType: getExamplesByAPIType,
+    findCodeExamplesByKeywords: findCodeExamplesByKeywords,
+    textCouldNotBeFound: textCouldNotBeFound,
+    addCodeExampleToHomepage: addCodeExampleToHomepage,
+  };
+})();
+
+const input = document.getElementById("code_example_search");
+const log = document.getElementById("values");
+
+input.addEventListener("input", updateValue);
+
+function updateValue(esearchPattern) {
+  document.getElementById("filtered_code_examples").innerHTML = "";
+
+  const inputValue = esearchPattern.target.value.toLowerCase();
+  const json = DS_SEARCH.processJSONData().APIs;
+
+  if (inputValue === "") {
+    DS_SEARCH.addCodeExampleToHomepage(json);
+  } else {
+    const apiType = DS_SEARCH.getEnteredAPIType(inputValue);
+
+    if (apiType !== null) {
+      const adminExamples = DS_SEARCH.getExamplesByAPIType(apiType, json);
+      DS_SEARCH.addCodeExampleToHomepage(adminExamples);
+    } else {
+      const result = DS_SEARCH.findCodeExamplesByKeywords(json, inputValue);
+      if (result.length < 1) {
+        DS_SEARCH.textCouldNotBeFound();
+      } else {
+        result.forEach(x => {
+          var api = json.filter(api => {
+              return api.Name === x.item.Name;
+          })[0];
+
+          x.item.Groups.forEach((group, groupIndex) => {
+              var unfilteredGroup = api.Groups.filter(apiGroup => {
+                  return apiGroup.Name === group.Name;
+              })[0];
+
+              group.Examples.forEach((example, index) => {
+                  var clearedExample = unfilteredGroup.Examples.filter(apiExample => {
+                      return apiExample.ExampleNumber === example.ExampleNumber;
+                  })[0];
+                  x.item.Groups[groupIndex].Examples[index] = clearedExample;
+              });
+          });
+
+          DS_SEARCH.addCodeExampleToHomepage([x.item]);
+      });
+      }
+    }
+  }
+}