refactor: add convenience methods to the framework http component and…

… refactor the url lib methods

Add convenience methods 'buildQueryString' and 'getClientInfo' to the framework http component.

src/framework/component/http/index.js

@@ -1,5 +1,6 @@
 "use strict";
 
+const methods = require("./methods");
 const StatusCodes = require("./status-codes");
 const StatusTexts = require("./status-texts").statusTexts;
 
@@ -8,4 +9,5 @@ module.exports = {
   STATUS_CODES: Object.assign(Object.create(null), StatusCodes),
   STATUS_TEXTS: Object.assign(Object.create(null), StatusTexts),
   //CacheControlDirectives: require("./cache-control-directives").HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES,
+  ...methods,
 };

src/framework/component/http/methods.js

@@ -0,0 +1,31 @@
+module.exports = {
+  buildQueryString,
+  getClientInfo,
+};
+
+function buildQueryString(obj) {
+  const strBuilder = [];
+
+  if(typeof obj !== "object" || !obj) {
+    return "";
+  }
+
+  if(typeof obj === "string" || typeof obj === "number") {
+    return obj;
+  }
+
+  for (const [prop, value] of Object.entries(obj)) {
+    if (Object.prototype.hasOwnProperty.call(obj, prop)) {
+      strBuilder.push(encodeURIComponent(prop) + "=" + encodeURIComponent(value));
+    }
+  }
+
+  return strBuilder.join("&");
+}
+
+function getClientInfo(req) {
+  return {
+    ipAddress: req.ip,
+    userAgent: req.headers["user-agent"],
+  };
+};

src/framework/lib/url.js

@@ -10,17 +10,23 @@ function getValidUrl(baseUrl, path, apiBasePath) {
   path = normalizeUrlPath(path) || "";
   apiBasePath = normalizeUrlPath(apiBasePath) || "";
 
-  return baseUrl + (apiBasePath ? `/${apiBasePath}` : "") + `/${path}`;
+  let url = baseUrl;
+
+  if(apiBasePath) {
+    url += `/${apiBasePath}`;
+  }
+
+  url += `/${path}`;
+
+  return url;
 }
 
 function normalizeUrlPath(path) {
-  path = String(path);
-
-  if(path.startsWith("/")) {
+  if(path?.startsWith("/")) {
     path = stripFirstNCharsFromString(path, 1);
   }
 
-  if(path.endsWith("/")) {
+  if(path?.endsWith("/")) {
     path = stripLastNCharsFromString(path, 1);
   }