Merge pull request #5 from TrueSparrowSystems/branding-changes

branding changes

Author: kedarchandrayan

CHANGELOG.md

@@ -1,7 +1,10 @@
+## Queue v2.0.0
+- Republished package under @truesparrow
+
 ## Queue v1.0.1
 - LICENSE changes.
 - README changes.
 
 ## Queue v1.0.0
-- PLG Works Queue is implemented to publish critical events using EventEmitter and RabbitMQ.
+- True Sparrow Queue is implemented to publish critical events using EventEmitter and RabbitMQ.
 

LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright © 2022 PLG Works
+Copyright © 2022 True Sparrow Systems Pvt. Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,8 +1,8 @@
 # Queue
 
-![npm version](https://img.shields.io/npm/v/@plgworks/queue.svg?style=flat)
+![npm version](https://img.shields.io/npm/v/@truesparrow/queue.svg?style=flat)
 
-PLG Works Queue helps in publishing and subscribing tasks over [RabbitMQ](https://www.rabbitmq.com/). Internally it uses topic-based exchange.
+True Sparrow Queue helps in publishing and subscribing tasks over [RabbitMQ](https://www.rabbitmq.com/). Internally it uses topic-based exchange.
 
 One use-case is to publish tasks for asynchronous processing. For example, **API worker process** can publish tasks which will be taken up by **asynchronous worker processes** which have subscribed for such tasks.
 
@@ -12,11 +12,11 @@ One use-case is to publish tasks for asynchronous processing. For example, **API
 ## Install
 
 ```bash
-npm install @plgworks/queue --save
+npm install @truesparrow/queue --save
 ```
 
 ## Initialize
-`configStrategy` is passed to initialize PLG Works Queue. `configStrategy` is an object with `rabbitmq` as a key. The value of `rabbitmq` is an object with following keys:
+`configStrategy` is passed to initialize True Sparrow Queue. `configStrategy` is an object with `rabbitmq` as a key. The value of `rabbitmq` is an object with following keys:
 - **username** [string] (mandatory) RabbitMQ connection username
 - **password** [string] (mandatory) RabbitMQ connection password
 - **host** [string] (mandatory) RabbitMQ host
@@ -27,12 +27,12 @@ npm install @plgworks/queue --save
 - **switchHostAfterSec** [integer] (optional) Wait time before switching RMQ host.
 - **connectionTimeoutSec** [integer] (optional) Wait time for connection to establish.
 
-Following snippet initializes PLG Works Queue Manager:
+Following snippet initializes True Sparrow Queue Manager:
 
 ```js
-const Queue = require('@plgworks/queue');
+const Queue = require('@truesparrow/queue');
 
-// Config Strategy for PLG Works Queue.
+// Config Strategy for True Sparrow Queue.
 configStrategy = {
 	'rabbitmq': {
         'username': 'guest',
@@ -79,9 +79,9 @@ const queueManager = await Queue.getInstance(configStrategy);
 Following snippet subscribes to specific topics over a queue.
 
 ```js
-const Queue = require('@plgworks/queue');
+const Queue = require('@truesparrow/queue');
 
-// Config Strategy for PLG Works Queue.
+// Config Strategy for True Sparrow Queue.
 configStrategy = {
 	'rabbitmq': {
         'username': 'guest',
@@ -184,7 +184,7 @@ subscribe();
 Following snippet publishes a task for specific topics.
 
 ```js
-// Config Strategy for PLG Works Queue.
+// Config Strategy for True Sparrow Queue.
 configStrategy = {
 	'rabbitmq': {
         'username': 'guest',
@@ -206,7 +206,7 @@ const message = {
 };
 
 // Import the Queue module.
-const Queue = require('@plgworks/queue');
+const Queue = require('@truesparrow/queue');
 const publish = async function() {
   const queueManager = await Queue.getInstance(configStrategy);
   queueManager.publishEvent.perform(
@@ -229,7 +229,7 @@ Such tasks can be published by using the `publishAfter` parameter. Internally, w
 **Important Note**: Do not use arbitrary values of delays. Internally, the message is stored in a delay specific queue for the waiting duration. As the number of allowed delays increases, so do the number of waiting queues. Having too many queues, can hamper RabbitMQ performance.
 
 ```js
-// Config Strategy for PLG Works Queue.
+// Config Strategy for True Sparrow Queue.
 configStrategy = {
 	'rabbitmq': {
         'username': 'guest',
@@ -251,7 +251,7 @@ const message = {
 };
 
 // Import the Queue module.
-const Queue = require('@plgworks/queue');
+const Queue = require('@truesparrow/queue');
 const publish = async function() {
   const queueManager = await Queue.getInstance(configStrategy);
   queueManager.publishEvent.perform(

VERSION

@@ -1 +1 @@
-1.0.1
+2.0.0

config/coreConstant.js

@@ -19,7 +19,7 @@ class CoreConstants {
    * @returns {string}
    */
   get icNameSpace() {
-    return 'PLGWorksQueue';
+    return 'Queue';
   }
 
   /**

index.js

@@ -1,11 +1,11 @@
-const PLGWorksBase = require('@plgworks/base');
+const Base = require('@truesparrow/base');
 
 const rootPrefix = '.',
   version = require(rootPrefix + '/package.json').version,
   rabbitmqHelper = require(rootPrefix + '/lib/rabbitmq/helper'),
   coreConstant = require(rootPrefix + '/config/coreConstant');
 
-const InstanceComposer = PLGWorksBase.InstanceComposer;
+const InstanceComposer = Base.InstanceComposer;
 
 require(rootPrefix + '/lib/rabbitmq/helper');
 require(rootPrefix + '/lib/rabbitmq/connection');

lib/formatter/response.js

@@ -4,7 +4,7 @@
  * @module lib/formatter/response
  */
 
-const PLGWorksBase = require('@plgworks/base'),
-  responseHelper = new PLGWorksBase.responseHelper({ moduleName: 'PLGWorksQueue' });
+const Base = require('@truesparrow/base'),
+  responseHelper = new Base.responseHelper({ moduleName: 'Queue' });
 
 module.exports = responseHelper;

lib/logger/customConsoleLogger.js

@@ -3,12 +3,12 @@
  *
  * @module lib/logger/customConsoleLogger
  */
-const PLGWorksBase = require('@plgworks/base');
+const Base = require('@truesparrow/base');
 
 const rootPrefix = '../..',
   coreConstants = require(rootPrefix + '/config/coreConstant');
 
-const Logger = PLGWorksBase.Logger;
+const Logger = Base.Logger;
 
 // Following is to ensure that INFO logs are printed when debug is off.
 let loggerLevel;
@@ -18,4 +18,4 @@ if (1 === Number(coreConstants.DEBUG_ENABLED)) {
   loggerLevel = Logger.LOG_LEVELS.INFO;
 }
 
-module.exports = new Logger('plgworks-queue', loggerLevel);
+module.exports = new Logger('truesparrow-queue', loggerLevel);

lib/rabbitmq/connection.js

@@ -4,7 +4,7 @@
  * @module lib/rabbitmq/connection
  */
 
-const PLGWorksBase = require('@plgworks/base');
+const Base = require('@truesparrow/base');
 
 const rootPrefix = '../..',
   amqp = require('amqplib/callback_api'),
@@ -13,7 +13,7 @@ const rootPrefix = '../..',
   logger = require(rootPrefix + '/lib/logger/customConsoleLogger'),
   coreConstant = require(rootPrefix + '/config/coreConstant');
 
-const InstanceComposer = PLGWorksBase.InstanceComposer;
+const InstanceComposer = Base.InstanceComposer;
 
 const rmqIdToConnectionMap = {},
   rmqIdToInProcessRequestsMap = {};

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@plgworks/queue",
-  "version": "1.0.1",
+  "name": "@truesparrow/queue",
+  "version": "2.0.0",
   "description": "Queue helps publish critical events using EventEmitter and RabbitMQ.",
   "main": "index.js",
   "scripts": {
@@ -9,22 +9,22 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/PLG-Works/queue.git"
+    "url": "https://github.com/TrueSparrowSystems/queue.git"
   },
   "keywords": [
-    "PLG Works Queue",
+    "True Sparrow Queue",
     "Event Emitter",
     "RabbitMQ",
     "PubSub"
   ],
-  "author": "PLG Works",
+  "author": "True Sparrow",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/PLG-Works/queue/issues"
+    "url": "https://github.com/TrueSparrowSystems/queue/issues"
   },
-  "homepage": "https://github.com/PLG-Works/queue#readme",
+  "homepage": "https://github.com/TrueSparrowSystems/queue#readme",
   "dependencies": {
-    "@plgworks/base": "1.0.0",
+    "@truesparrow/base": "2.0.0",
     "amqplib": "0.8.0",
     "uuid": "8.3.2"
   },