@friggframework/api-module-pipedrive 0.8.4 → 0.8.7

package/api.js

@@ -1,12 +1,13 @@
-const OAuth2Base = require('../../base/auth/OAuth2Base');
+const { OAuth2Requester } = require('@friggframework/module-plugin');
+const { get } = require('@friggframework/assertions');
 
-class Api extends OAuth2Base {
+class Api extends OAuth2Requester {
     constructor(params) {
         super(params);
 
-        this.access_token = this.getParam(params, 'access_token', null);
-        this.refresh_token = this.getParam(params, 'refresh_token', null);
-        this.companyDomain = this.getParam(params, 'companyDomain', null);
+        this.access_token = get(params, 'access_token', null);
+        this.refresh_token = get(params, 'refresh_token', null);
+        this.companyDomain = get(params, 'companyDomain', null);
         this.baseURL = () => `${this.companyDomain}/api`;
 
         this.client_id = process.env.PIPEDRIVE_CLIENT_ID;
@@ -84,9 +85,9 @@ class Api extends OAuth2Base {
     }
 
     async createActivity(params) {
-        const dealId = this.getParam(params, 'dealId', null);
-        const subject = this.getParam(params, 'subject');
-        const type = this.getParam(params, 'type');
+        const dealId = get(params, 'dealId', null);
+        const subject = get(params, 'subject');
+        const type = get(params, 'type');
         const options = {
             url: this.baseURL() + this.URLs.activities,
             body: { ...params },

package/defaultConfig.json

@@ -1,5 +1,6 @@
 {
     "name": "pipedrive",
+    "label": "PipeDrive CRM",
     "productUrl": "https://pipedrive.com",
     "apiDocs": "https://developer.pipedrive.com",
     "logoUrl": "https://friggframework.org/assets/img/pipedrive.jpeg",

package/jest.config.js

@@ -1,3 +1,21 @@
-module.exports = async () => {
-    preset: '@friggframework/test-environment';
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+    // preset: '@friggframework/test-environment',
+    coverageThreshold: {
+        global: {
+            statements: 13,
+            branches: 0,
+            functions: 1,
+            lines: 13,
+        },
+    },
+    // A path to a module which exports an async function that is triggered once before all test suites
+    globalSetup: '../../scripts/set-up-tests.js',
+
+    // A path to a module which exports an async function that is triggered once after all test suites
+    globalTeardown: '../../scripts/tear-down-tests.js',
 };

package/manager.js

@@ -2,13 +2,14 @@ const _ = require('lodash');
 const { Api } = require('./api.js');
 const { Entity } = require('./models/entity');
 const { Credential } = require('./models/credential');
-const LHModuleManager = require('../../base/managers/LHModuleManager');
-const ModuleConstants = require('../ModuleConstants');
-const { update } = require('lodash');
-const { flushDebugLog, debug } = require('../../utils/logger');
+const {
+    ModuleManager,
+    ModuleConstants,
+} = require('@friggframework/module-plugin');
+const { flushDebugLog, debug } = require('@friggframework/logs');
 const Config = require('./defaultConfig.json');
 
-class Manager extends LHModuleManager {
+class Manager extends ModuleManager {
     static Entity = Entity;
 
     static Credential = Credential;
@@ -64,7 +65,7 @@ class Manager extends LHModuleManager {
     }
 
     async processAuthorizationCallback(params) {
-        const code = this.getParam(params.data, 'code');
+        const code = get(params.data, 'code');
         await this.api.getTokenFromCode(code);
         await this.testAuth();
 
@@ -82,8 +83,8 @@ class Manager extends LHModuleManager {
     }
 
     async findOrCreateEntity(params) {
-        const companyId = this.getParam(params, 'companyId');
-        const companyName = this.getParam(params, 'companyName');
+        const companyId = get(params, 'companyId');
+        const companyName = get(params, 'companyName');
 
         const search = await this.entityMO.list({
             user: this.userId,

package/manager.test.js

@@ -0,0 +1,26 @@
+const Manager = require('./manager');
+const mongoose = require('mongoose');
+const config = require('./defaultConfig.json');
+
+describe(`Should fully test the ${config.label} Manager`, () => {
+    let manager, userManager;
+
+    beforeAll(async () => {
+        await mongoose.connect(process.env.MONGO_URI);
+        manager = await Manager.getInstance({
+            userId: new mongoose.Types.ObjectId(),
+        });
+    });
+
+    afterAll(async () => {
+        await Manager.Credential.deleteMany();
+        await Manager.Entity.deleteMany();
+        await mongoose.disconnect();
+    });
+
+    it('should return auth requirements', async () => {
+        const requirements = await manager.getAuthorizationRequirements();
+        expect(requirements).exists;
+        expect(requirements.type).toEqual('oauth2');
+    });
+});

package/models/credential.js

@@ -15,5 +15,7 @@ const schema = new mongoose.Schema({
     companyDomain: { type: String },
 });
 
-const Credential = Parent.discriminator('PipedriveCredentials', schema);
+const name = 'PipedriveCredential';
+const Credential =
+    Parent.discriminators?.[name] || Parent.discriminator(name, schema);
 module.exports = { Credential };

package/models/entity.js

@@ -1,26 +1,9 @@
 'use strict';
 const mongoose = require('mongoose');
-const MongooseUtil = require('../../../utils/MongooseUtil');
-const Parent = require('../../../base/models/Entity');
-
-const collectionName = 'PipedriveEntity';
-const parentModelObject = new Parent();
-
-const _schema = new mongoose.Schema({});
-
-const _model = MongooseUtil.createModel(
-    collectionName,
-    _schema,
-    parentModelObject
-);
-
-class Entity extends Parent {
-    static Schema = _schema;
-    static Model = _model;
-
-    constructor(model = _model) {
-        super(model);
-    }
-}
+const { Entity: Parent } = require('@friggframework/module-plugin');
 
+const schema = new mongoose.Schema({});
+const name = 'PipedriveEntity';
+const Entity =
+    Parent.discriminators?.[name] || Parent.discriminator(name, schema);
 module.exports = { Entity };

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "0.8.4",
+    "version": "0.8.7",
     "name": "@friggframework/api-module-pipedrive",
     "prettier": "@friggframework/prettier-config",
     "description": "",
@@ -11,15 +11,15 @@
     "author": "",
     "license": "MIT",
     "devDependencies": {
-        "@friggframework/eslint-config": "^1.0.0",
-        "@friggframework/test-environment": "^1.0.0",
-        "eslint": "^7.32.0",
-        "jest": "^27.4.7",
-        "prettier": "^2.5.1",
-        "sinon": "^12.0.1"
+        "@friggframework/eslint-config": "^1.0.7",
+        "@friggframework/test-environment": "^1.1.3",
+        "eslint": "^8.22.0",
+        "jest": "^28.1.3",
+        "prettier": "^2.7.1",
+        "sinon": "^14.0.0"
     },
     "dependencies": {
-        "@friggframework/module-plugin": "^1.0.4",
-        "@friggframework/assertions": "^1.0.1"
+        "@friggframework/module-plugin": "^1.0.11",
+        "@friggframework/assertions": "^1.0.4"
     }
 }