idea-toolbox - npm Package Compare versions

Comparing version 0.10.2 to 0.11.0

index.js

@@ -35,4 +35,5 @@ 'use strict';
   createSNSPushPlatormEndpoint, publishSNSPush,
-// OTHER
-  ISODateToItalianFormat, cleanStr, joinArraysOnKeys, isEmpty
+// UTILITIES
+  ISODateToItalianFormat, cleanStr, joinArraysOnKeys, isEmpty, APIrequest, 
+  saveObjToFile, sequelizeConnectToDB
 }
@@ -448,3 +449,3 @@
 ///
-/// OTHER
+/// UTILITIES
 ///
@@ -523,2 +524,49 @@
   }
+}
+
+/**
+ * Request wrapper to enable API requests with simplified parameters
+ * @param {*} method enum: HTTP methods
+ * @param {*} options typical requests options (e.g. url, body, headers, etc.)
+ * @return Promise
+ */
+function APIrequest(method, options) {
+  return new Promise((resolve, reject) => {
+    // prepare the parameters and the options
+    method = method.toLowerCase();
+    options.body = options.body ? JSON.stringify(options.body) : null;
+    // execute the request and reject or resolve the promise
+    Request[method](options, (err, data) => {
+      if(err) reject(err);
+      else resolve(JSON.parse(data.body));
+    });
+  });
+}
+
+/**
+ * Save the content of an object to the desired folder (as a log file).
+ * @param {*} name name of the object (== filename)
+ * @param {*} obj the JSON object
+ * @param {*} folder if null, uses the Config.LOGS.FOLDER
+ */
+function saveObjToFile(name, obj, folder) {
+  folder = folder || Config.LOGS.FOLDER;
+  Fs.writeFileSync(`${folder}/${name}.json`, JSON.stringify(obj));
+}
+
+/**
+ * Connect to a db through the usual IDEA's configuration and return a usable Sequelize object.
+ * @param {*} dbConfig { 
+ *  DATABASE: string; PASSWORD: string, HOST: stirng, DIALECT: string, INSTANCE: string 
+ *  LOGGING: string 
+ * }
+ * @return Sequelize object
+ */
+function sequelizeConnectToDB(dbConfig) {
+  return new Sequelize(dbConfig.DATABASE, dbConfig.USERNAME, dbConfig.PASSWORD, {
+    host: dbConfig.HOST, 
+    dialect: dbConfig.DIALECT, 
+    logging: dbConfig.LOGGING,
+    dialectOptions: { instanceName: dbConfig.INSTANCE }
+  });
 }

package.json

 {
   "name": "idea-toolbox",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "IDEA's utility functions",
@@ -5,0 +5,0 @@ "engines": {

README.md

@@ -5,12 +5,2 @@ # IDEA's toolbox
 ## Installation
-`npm install idea-toolbox`
-
-## Release a new version on npm
-1. Commit the changes on GitHub.
-1. Update the versions in the files (find and replace, e.g. 0.0.1 -> 0.0.2).
-1. Commit the files changed in the previous point and commit them using the name of the version 
-as commit description (e.g. v0.0.2).
-1. Release the new version on npm with `npm publish`.
-
-## References
-- https://medium.com/@jdaudier/how-to-create-and-publish-your-first-node-js-module-444e7585b738
+`npm install idea-toolbox`

No alert changes

Improved metrics

Total package byte prevSize

25507

increased by6.41%

Number of package files

6

increased by20%

Lines of code

564

increased by8.67%

Worsened metrics

Number of lines in readme file

5

decreased by-66.67%

No dependency changes