Merge 3e26c61 into c8e357d

src/api_error.js

@@ -1,11 +1,12 @@
 const httpStatus = require('http-status');
 
 class APIError extends Error {
-  constructor(message, status = httpStatus.INTERNAL_SERVER_ERROR, stack) {
+  constructor(message, status = httpStatus.INTERNAL_SERVER_ERROR, errorCode, stack) {
     super(message);
     this.name = this.constructor.name;
     this.message = message;
     this.status = status;
+    this.errorCode = errorCode;
     this.stack = stack;
     this.stack || Error.captureStackTrace(this, this.constructor.name);
   }

src/error_messages.js

@@ -0,0 +1,14 @@
+module.exports = {
+  HEADER_SIZE_ERROR: (expectedSize, foundSize, sheetName) => ({
+    message: `The ${sheetName} sheet header should have the size (${expectedSize}) but found (${foundSize})`,
+    code: 1
+  }),
+  FETCH_SPREADSHEET_ERROR: (fetchingError, spreadsheetUrl) => ({
+    message: `The following error was found when fetching this spreadsheet: (${spreadsheetUrl}) [${fetchingError}]`,
+    code: 2
+  }),
+  XLSX_TO_JSON_ERROR: parsingError => ({
+    message: `The following error was found when converting the spreadsheet to JSON: [${parsingError}]`,
+    code: 3
+  }),
+}

src/parser.js

@@ -1,4 +1,7 @@
 const { containsSubstring } = require('./string_utils');
+const errorMessages = require('./error_messages');
+const APIError = require('./api_error');
+const httpStatus = require('http-status');
 
 /**
  * Keywords contained on each name or title.  
@@ -147,7 +150,6 @@ const _getSubsidioData = spreadSheet => {
   });
 };
 
-
 /**
  * Get the indenizacoes data from the spreadsheet.
  * 
@@ -159,6 +161,11 @@ const _getIndenizacoesData = spreadSheet => {
   const sheetkey = 'indenizacoes';
   const fixedColsSize = 9;
   const sheet = _getSheet(INDENIZACOES_KEYWORD, spreadSheet);
+  const headerSize = _getHeader(sheet).length;
+  if (headerSize < fixedColsSize) {
+    const { message, code } = errorMessages.HEADER_SIZE_ERROR(fixedColsSize, headerSize, sheetkey);
+    throw new APIError(message, httpStatus.BAD_REQUEST, code);
+  }
 
   const outraCols = _getOutraAndDetalheColumns(sheet, sheetkey, fixedColsSize);
 

src/parser_service.js

@@ -1,6 +1,7 @@
 const http = require('http');
 const xlsxService = require('./xlsx_service');
 const APIError = require('./api_error');
+const errorMessages = require('./error_messages');
 const httpStatus = require('http-status');
 
 /**
@@ -23,7 +24,8 @@ const _fetchSpreadshet = url =>
       });
     })
     .on('error', err => {
-      reject(new APIError(err.message, httpStatus.BAD_REQUEST, err.stack));
+      const {message, code} = errorMessages.FETCH_SPREADSHEET_ERROR(err, url);
+      reject(new APIError(message, httpStatus.BAD_REQUEST, code, err.stack));
     });
   });
 

src/xlsx_service.js

@@ -1,7 +1,7 @@
 const xlsx = require('xlsx');
 const APIError = require('./api_error');
 const httpStatus = require('http-status');
-
+const errorMessages = require('./error_messages');
 const convertSpreadsheetToJson = spreadsheetBuffer => {
   try {
     const workbook = xlsx.read(spreadsheetBuffer, { type: 'buffer' });
@@ -11,7 +11,8 @@ const convertSpreadsheetToJson = spreadsheetBuffer => {
     });
     return spreadsheetObj;
   } catch (e) {
-    throw new APIError(e.message, httpStatus.BAD_REQUEST, e.stack);   
+    const {message, code} = errorMessages.XLSX_TO_JSON_ERROR(e);
+    throw new APIError(message, httpStatus.BAD_REQUEST, code, e.stack);   
   }
 };
 

test/parser.test.js

@@ -9,9 +9,11 @@ const {
   INDENIZACOES_HEADERS_1, INDENIZACOES_HEADERS_2, INDENIZACOES_HEADERS_3, INDENIZACOES_HEADERS_4,
   INDENIZACOES_HEADERS_5, INDENIZACOES_HEADERS_6, INDENIZACOES_HEADERS_7, INDENIZACOES_HEADERS_8,
   INDENIZACOES_HEADERS_9, INDENIZACOES_HEADERS_10, INDENIZACOES_HEADERS_11, INDENIZACOES_HEADERS_12,
-  INDENIZACOES_HEADERS_13, INDENIZACOES_HEADERS_14, INDENIZACOES_HEADERS_15, INDENIZACOES_HEADERS_16
+  INDENIZACOES_HEADERS_13, INDENIZACOES_HEADERS_14
 } = require('./spreadsheets');
 const { convertSpreadsheetToJson } = require('../src/xlsx_service');
+const errorMessages = require('../src/error_messages');
+const httpStatus = require('http-status');
 
 describe('paser parse', () => {
   it('shoul throw not implemented error', () => {
@@ -589,4 +591,16 @@ describe('parser _getIndenizacoesData', () => {
     async () => {
       await testIndenizacoesData(INDENIZACOES_HEADERS_13, regularIndenizacoesData);
     });
+
+  it('should throw an APIError when the header is: [cpf,nome]', async () => {
+    try {
+      await testIndenizacoesData(INDENIZACOES_HEADERS_14, {});
+      fail('an error should have been thrown');
+    } catch (e) {
+      const {message, code} = errorMessages.HEADER_SIZE_ERROR(9, 2, 'indenizacoes');
+      expect(e.message).toEqual(message);
+      expect(e.errorCode).toEqual(code);
+      expect(e.status).toEqual(httpStatus.BAD_REQUEST);
+    }
+  });
 });

test/spreadsheets.js

@@ -37,7 +37,5 @@ module.exports = {
     INDENIZACOES_HEADERS_12: '/assets/indenizacoes_headers/header12.xlsx',  
     INDENIZACOES_HEADERS_13: '/assets/indenizacoes_headers/header13.xlsx',  
     INDENIZACOES_HEADERS_14: '/assets/indenizacoes_headers/header14.xlsx',  
-    INDENIZACOES_HEADERS_15: '/assets/indenizacoes_headers/header15.xlsx',  
-    INDENIZACOES_HEADERS_16: '/assets/indenizacoes_headers/header16.xlsx',  
     getSpreadsheet: path => readFileAsync(__dirname + path) 
 };

test/xlsx_service.test.js

@@ -48,7 +48,7 @@ describe('xlsx_service convertpreadsheetToJson should', () => {
     } catch (e) {
       expect(e instanceof APIError).toBe(true);
       expect(e.status).toBe(httpStatus.BAD_REQUEST);
-      expect(e.message).toBe('File is password-protected');
+      expect(e.message).toBe('The following error was found when converting the spreadsheet to JSON: [Error: File is password-protected]');
     }
   });
 });