feat: add bank pagi scraper (#880)

Co-authored-by: Avraham wales <[email protected]>

src/definitions.ts

@@ -22,6 +22,7 @@ export enum CompanyTypes {
   behatsdaa = 'behatsdaa',
   beyahadBishvilha = 'beyahadBishvilha',
   oneZero = 'oneZero',
+  pagi = 'pagi',
 }
 
 export const SCRAPERS = {
@@ -101,6 +102,10 @@ export const SCRAPERS = {
     name: 'Behatsdaa',
     loginFields: ['id', PASSWORD_FIELD],
   },
+  [CompanyTypes.pagi]: {
+    name: 'Pagi',
+    loginFields: ['username', PASSWORD_FIELD],
+  },
 };
 
 export enum ScraperProgressTypes {

src/scrapers/factory.ts

@@ -15,6 +15,7 @@ import MercantileScraper from './mercantile';
 import MizrahiScraper from './mizrahi';
 import OneZeroScraper from './one-zero';
 import OtsarHahayalScraper from './otsar-hahayal';
+import PagiScraper from './pagi';
 import UnionBankScraper from './union-bank';
 import VisaCalScraper from './visa-cal';
 import YahavScraper from './yahav';
@@ -63,6 +64,8 @@ export default function createScraper(options: ScraperOptions): Scraper<ScraperC
       return new OneZeroScraper(options);
     case CompanyTypes.behatsdaa:
       return new BehatsdaaScraper(options);
+    case CompanyTypes.pagi:
+      return new PagiScraper(options);
     default:
       return assertNever(options.companyId, `unknown company id ${options.companyId}`);
   }

src/scrapers/pagi.test.ts

@@ -0,0 +1,50 @@
+import { SCRAPERS } from '../definitions';
+import { exportTransactions, extendAsyncTimeout, getTestsConfig, maybeTestCompanyAPI } from '../tests/tests-utils';
+import { LoginResults } from './base-scraper-with-browser';
+import PagiScraper from './pagi';
+
+
+const COMPANY_ID = 'pagi'; // TODO this property should be hard-coded in the provider
+const testsConfig = getTestsConfig();
+
+describe('Pagi legacy scraper', () => {
+  beforeAll(() => {
+    extendAsyncTimeout(); // The default timeout is 5 seconds per async test, this function extends the timeout value
+  });
+  test('should expose login fields in scrapers constant', () => {
+    expect(SCRAPERS.pagi).toBeDefined();
+    expect(SCRAPERS.pagi.loginFields).toContain('username');
+    expect(SCRAPERS.pagi.loginFields).toContain('password');
+  });
+
+  maybeTestCompanyAPI(COMPANY_ID, (config) => config.companyAPI.invalidPassword)('should fail on invalid user/password"', async () => {
+    const options = {
+      ...testsConfig.options,
+      companyId: COMPANY_ID,
+    };
+
+    const scraper = new PagiScraper(options);
+
+    const result = await scraper.scrape({ username: 'e10s12', password: '3f3ss3d' });
+
+    expect(result).toBeDefined();
+    expect(result.success).toBeFalsy();
+    expect(result.errorType).toBe(LoginResults.InvalidPassword);
+  });
+
+  maybeTestCompanyAPI(COMPANY_ID)('should scrape transactions"', async () => {
+    const options = {
+      ...testsConfig.options,
+      companyId: COMPANY_ID,
+    };
+
+    const scraper = new PagiScraper(options);
+    const result = await scraper.scrape(testsConfig.credentials.pagi);
+    expect(result).toBeDefined();
+    const error = `${result.errorType || ''} ${result.errorMessage || ''}`.trim();
+    expect(error).toBe('');
+    expect(result.success).toBeTruthy();
+
+    exportTransactions(COMPANY_ID, result.accounts || []);
+  });
+});

src/scrapers/pagi.ts

@@ -0,0 +1,12 @@
+import BeinleumiGroupBaseScraper from './base-beinleumi-group';
+
+class PagiScraper extends BeinleumiGroupBaseScraper {
+  BASE_URL = 'https://online.pagi.co.il/';
+
+  LOGIN_URL = `${this.BASE_URL}/MatafLoginService/MatafLoginServlet?bankId=PAGIPORTAL&site=Private&KODSAFA=HE`;
+
+  TRANSACTIONS_URL = `${this.BASE_URL}/wps/myportal/FibiMenu/Online/OnAccountMngment/OnBalanceTrans/PrivateAccountFlow`;
+
+}
+
+export default PagiScraper;

src/tests/.tests-config.tpl.js

@@ -28,7 +28,8 @@ module.exports = {
     // yahav: {username: '', nationalID: '', password: ''}
     // beyahadBishvilha: { id: '', password: ''},
     // behatsdaa: { id: '', password: ''},
-    // oneZero: { email: '', password: '', otpCode: '', otpToken: null }
+    // oneZero: { email: '', password: '', otpCode: '', otpToken: null },
+    // pagi: { username: '', password: ''},
   },
   companyAPI: { // enable companyAPI to execute tests against the real companies api
     enabled: true,