Applied PR corrections

CHANGELOG.md

@@ -7,4 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 ### Added
-- Solr DB Driver Package
+- Solr DB Driver Package
+- `endpoint` helper
+- `filters` helper
+- `query` helper
+- `request` helper
+- `response` helper
+- `schema` helper
+- `utils` helper
+- `insert` and `multiInsert` methods
+- `remove` and `multiRemove` methods
+- `get` and `getTotals` methods
+- `distinct` method
+- `createSchemas`, `updateSchemas` and `createCore` methods

lib/helpers/endpoint.js

@@ -16,6 +16,13 @@ class Endpoint {
 		};
 	}
 
+	/**
+	 * Creates a Solr endpoint
+	 * @param {String} endpoint The endpoint to create
+	 * @param {String} url The solr url
+	 * @param {String} core The solr core name
+	 * @param {Object} replacements The replacements to apply to the endpoint
+	 */
 	static create(endpoint, url, core, replacements) {
 		return this._buildEndpoint(path.join(ENDPOINT_BASE, endpoint), { url, core, ...replacements });
 	}

lib/helpers/filters.js

@@ -8,6 +8,11 @@ const DEFAULT_FILTER_TYPE = 'equal';
 
 class Filters {
 
+	/**
+	 * Builds the filters for Solr legibility
+	 * @param {Object} filters The filters
+	 * @param {Object} modelFields The model fields
+	 */
 	static build(filters, modelFields) {
 
 		const filtersGroup = this._parseFilterGroup(filters, modelFields);
@@ -58,18 +63,6 @@ class Filters {
 		});
 	}
 
-	static get _formatters() {
-
-		return {
-			equal: this._formatEq.bind(this),
-			notEqual: this._formatNe.bind(this),
-			greater: this._formatGt,
-			greaterOrEqual: this._formatGte,
-			lesser: this._formatLt,
-			lesserOrEqual: this._formatLte
-		};
-	}
-
 	static _formatByType(filtersGroup) {
 
 		return Object.entries(filtersGroup).reduce((filtersByType, [field, filterData]) => {
@@ -94,6 +87,18 @@ class Filters {
 		}, {});
 	}
 
+	static get _formatters() {
+
+		return {
+			equal: this._formatEq.bind(this),
+			notEqual: this._formatNe.bind(this),
+			greater: this._formatGt,
+			greaterOrEqual: this._formatGte,
+			lesser: this._formatLt,
+			lesserOrEqual: this._formatLte
+		};
+	}
+
 	static _formatEq(field, value) {
 		return `${field}:"${value}"`;
 	}

lib/helpers/schema.js

@@ -14,6 +14,11 @@ const FIELD_TYPES = {
 
 class Schema {
 
+	/**
+	 * Builds a schema query for Solr
+	 * @param {String} method The method to use for building the schema api query
+	 * @param {Object} schemas The model schemas
+	 */
 	static buildQuery(method, schemas) {
 
 		const builtSchemas = Object.entries(schemas).reduce((fields, [field, schema]) => {

lib/helpers/utils.js

@@ -1,12 +1,16 @@
 'use strict';
 
-function isObject(object) {
-	return object !== null && typeof object === 'object' && !Array.isArray(object);
-}
+/**
+ * Validates if the received object is an JSON object and not an array
+ * @param {Object} object The object to validate
+ */
+const isObject = object => (object !== null && typeof object === 'object' && !Array.isArray(object));
 
-function base64(value) {
-	return Buffer.from(value).toString('base64');
-}
+/**
+ * Encodes the received value into a base64 string
+ * @param {String} value value
+ */
+const base64 = value => (Buffer.from(value).toString('base64'));
 
 module.exports = {
 	isObject,

lib/solr.js

@@ -199,7 +199,7 @@ class Solr {
 	 * @example
 	 * await multiRemove(model, { myField: { type: 'greater', value: 10 } });
 	 */
-	async mutliRemove(model, filters) {
+	async multiRemove(model, filters) {
 
 		this._validateModel(model);
 

tests/solr-test.js

@@ -255,7 +255,6 @@ describe('Solr', () => {
 		});
 
 		[
-
 			null,
 			undefined,
 			'string',
@@ -677,7 +676,7 @@ describe('Solr', () => {
 					}
 				});
 
-			await assert.doesNotReject(solr.mutliRemove(model, { field: 'value', otherField: { type: 'lesserOrEqual', value: 10 } }));
+			await assert.doesNotReject(solr.multiRemove(model, { field: 'value', otherField: { type: 'lesserOrEqual', value: 10 } }));
 
 			request.done();
 		});
@@ -692,7 +691,7 @@ describe('Solr', () => {
 					}
 				});
 
-			await assert.rejects(solr.mutliRemove(model), {
+			await assert.rejects(solr.multiRemove(model), {
 				name: 'SolrError',
 				code: SolrError.codes.REQUEST_FAILED
 			});
@@ -712,7 +711,7 @@ describe('Solr', () => {
 					}
 				});
 
-			await assert.rejects(solr.mutliRemove(model, { field: 'value' }), {
+			await assert.rejects(solr.multiRemove(model, { field: 'value' }), {
 				name: 'SolrError',
 				code: SolrError.codes.INTERNAL_SOLR_ERROR
 			});
@@ -722,7 +721,7 @@ describe('Solr', () => {
 
 		it('Should throw when the received model is invalid', async () => {
 
-			await assert.rejects(solr.mutliRemove(), {
+			await assert.rejects(solr.multiRemove(), {
 				name: 'SolrError',
 				code: SolrError.codes.INVALID_MODEL
 			});