Source: morphology.js

  1. /**
  2.  * Analytics API.
  3.  *
  4.  * @copyright 2016-2024 Basis Technology Corporation.
  5.  *
  6.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
  7.  * with the License. You may obtain a copy of the License at
  8.  * @license http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software distributed under the License is
  11.  * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and limitations under the License.
  13.  **/
  14. "use strict";
  16. var URL = require("url");
  18. var RosetteConstants = require("./rosetteConstants");
  19. var RosetteException = require("./rosetteExceptions");
  20. var rosetteRequest = require("./rosetteRequest");
  22. /**
  23.  * @class
  24.  *
  25.  * @copyright 2016-2024 Basis Technology Corporation.
  26.  * @license http://www.apache.org/licenses/LICENSE-2.0
  27.  */
  28. function morphology() {
  29. //constructor function
  30. }
  32. /**
  33.  * Makes an HTTP request to the specified Analytics API endpoint and returns the result
  34.  * @param {string} parameters - The Analytics API endpoint parameters
  35.  * @param {string} userKey - The Analytics API user access key
  36.  * @param {string} serviceURL - The base service URL to be used to access the Analytics API
  37.  * @param {function} callback - Callback function to be executed after the function to which it is passed is complete
  38.  */
  39. morphology.prototype.getResults = function(parameters, userKey, protocol, serviceURL, callback) {
  41.     if (parameters.documentFile != null) {
  42.         parameters.loadFile(parameters.documentFile, parameters, userKey, protocol, serviceURL, `morphology/${parameters.morphology}`, callback);
  43.     } else {
  44.         var responseMessage = "bad arguments";
  45.         // validate parameters
  46.         if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
  47.             return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", responseMessage));
  48.         } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
  49.             return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", responseMessage));
  50.         } else if (!parameters.morphology) {
  51.             return callback(new RosetteException("badArgument", "Must supply type of morphology", responseMessage));
  52.         } else {
  53.             // configure URL
  54.             var urlParts = URL.parse(serviceURL + `morphology/${parameters.morphology}`);
  55.             var req = new rosetteRequest();
  56.             req.makeRequest('POST', userKey, protocol, urlParts, parameters, callback);
  57.         }
  58.     }
  59. };
  61. module.exports = morphology;