@friggframework/api-module-pipedrive 1.0.1-v1-alpha.5 → 2.1.0-canary.56.2dc58f9.0

package/api.js

@@ -1,117 +0,0 @@
-const { get, OAuth2Requester } = require('@friggframework/core');
-
-class Api extends OAuth2Requester {
-    constructor(params) {
-        super(params);
-
-        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;
-        this.client_secret = process.env.PIPEDRIVE_CLIENT_SECRET;
-        this.redirect_uri = `${process.env.REDIRECT_URI}/pipedrive`;
-        this.scopes = process.env.PIPEDRIVE_SCOPES;
-
-        this.URLs = {
-            activities: '/v1/activities',
-            activityFields: '/v1/activityFields',
-            activityById: (activityId) => `/v1/activities/${activityId}`,
-            getUser: '/v1/users/me',
-            users: '/v1/users',
-            deals: '/v1/deals',
-        };
-
-        this.authorizationUri = encodeURI(
-            `https://oauth.pipedrive.com/oauth/authorize?client_id=${this.client_id}&redirect_uri=${this.redirect_uri}&response_type=code&scope=${this.scopes}`
-        );
-
-        this.tokenUri = 'https://oauth.pipedrive.com/oauth/token';
-    }
-
-    async setTokens(params) {
-        await this.setCompanyDomain(params.api_domain);
-        return super.setTokens(params);
-    }
-
-    async setCompanyDomain(companyDomain) {
-        this.companyDomain = companyDomain;
-    }
-    // **************************   Deals   **********************************
-    async listDeals() {
-        const options = {
-            url: this.baseURL() + this.URLs.deals,
-        };
-        const res = await this._get(options);
-        return res;
-    }
-    // **************************   Activities   **********************************
-    async listActivityFields() {
-        const options = {
-            url: this.baseURL() + this.URLs.activityFields,
-        };
-        const res = await this._get(options);
-        return res;
-    }
-
-    async listActivities(params) {
-        const options = {
-            url: this.baseURL() + this.URLs.activities,
-        };
-        if (params.query) {
-            options.query = params.query;
-        }
-        const res = await this._get(options);
-        return res;
-    }
-
-    async deleteActivity(activityId) {
-        const options = {
-            url: this.baseURL() + this.URLs.activityById(activityId),
-        };
-        const res = await this._delete(options);
-        return res;
-    }
-
-    async updateActivity(activityId, task) {
-        const options = {
-            url: this.baseURL() + this.URLs.activityById(activityId),
-            body: task,
-        };
-        const res = await this._patch(options);
-        return res;
-    }
-
-    async createActivity(params) {
-        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 },
-            headers: {
-                'Content-Type': 'application/json',
-            },
-        };
-        const res = await this._post(options);
-        return res;
-    }
-    // **************************   Users   **********************************
-    async getUser() {
-        const options = {
-            url: this.baseURL() + this.URLs.getUser,
-        };
-        const res = await this._get(options);
-        return res;
-    }
-
-    async listUsers() {
-        const options = {
-            url: this.baseURL() + this.URLs.users,
-        };
-        const res = await this._get(options);
-        return res;
-    }
-}
-module.exports = { Api };

package/index.js

@@ -1,13 +0,0 @@
-const { Api } = require('./api');
-const { Credential } = require('./models/credential');
-const { Entity } = require('./models/entity');
-const ModuleManager = require('./manager');
-const Config = require('./defaultConfig');
-
-module.exports = {
-    Api,
-    Credential,
-    Entity,
-    ModuleManager,
-    Config,
-};

package/jest-setup.js

@@ -1,2 +0,0 @@
-const { globalSetup } = require('@friggframework/devtools');
-module.exports = globalSetup;

package/jest-teardown.js

@@ -1,2 +0,0 @@
-const { globalTeardown } = require('@friggframework/devtools');
-module.exports = globalTeardown;

package/jest.config.js

@@ -1,20 +0,0 @@
-/*
- * 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: './jest-setup.js',
-
-    // A path to a module which exports an async function that is triggered once after all test suites
-    globalTeardown: './jest-teardown.js',
-};

package/manager.js

@@ -1,193 +0,0 @@
-const {
-    ModuleManager,
-    ModuleConstants,
-    flushDebugLog,
-    debug
-} = require('@friggframework/core');
-const {Api} = require('./api.js');
-const {Entity} = require('./models/entity');
-const {Credential} = require('./models/credential');
-const Config = require('./defaultConfig.json');
-
-class Manager extends ModuleManager {
-    static
-    Entity = Entity;
-
-    static
-    Credential = Credential;
-
-    constructor(params) {
-        super(params);
-    }
-
-    static getName() {
-        return Config.name;
-    }
-
-    static
-    async getInstance(params) {
-        const instance = new this(params);
-
-        const apiParams = {delegate: instance};
-        if (params.entityId) {
-            instance.entity = await instance.entityMO.get(params.entityId);
-            instance.credential = await instance.credentialMO.get(
-                instance.entity.credential
-            );
-        } else if (params.credentialId) {
-            instance.credential = await instance.credentialMO.get(
-                params.credentialId
-            );
-        }
-        if (instance.entity?.credential) {
-            apiParams.access_token = instance.credential.accessToken;
-            apiParams.refresh_token = instance.credential.refreshToken;
-            apiParams.companyDomain = instance.credential.companyDomain;
-        }
-        instance.api = await new Api(apiParams);
-
-        return instance;
-    }
-
-    async getAuthorizationRequirements(params) {
-        return {
-            url: this.api.authorizationUri,
-            type: ModuleConstants.authType.oauth2,
-        };
-    }
-
-    async testAuth() {
-        let validAuth = false;
-        try {
-            if (await this.api.getUser()) validAuth = true;
-        } catch (e) {
-            await this.markCredentialsInvalid();
-            flushDebugLog(e);
-        }
-        return validAuth;
-    }
-
-    async processAuthorizationCallback(params) {
-        const code = get(params.data, 'code');
-        await this.api.getTokenFromCode(code);
-        await this.testAuth();
-
-        const userProfile = await this.api.getUser();
-        await this.findOrCreateEntity({
-            companyId: userProfile.data.company_id,
-            companyName: userProfile.data.company_name,
-        });
-
-        return {
-            credential_id: this.credential.id,
-            entity_id: this.entity.id,
-            type: Manager.getName(),
-        };
-    }
-
-    async findOrCreateEntity(params) {
-        const companyId = get(params, 'companyId');
-        const companyName = get(params, 'companyName');
-
-        const search = await this.entityMO.list({
-            user: this.userId,
-            externalId: companyId,
-        });
-        if (search.length === 0) {
-            // validate choices!!!
-            // create entity
-            const createObj = {
-                credential: this.credential.id,
-                user: this.userId,
-                name: companyName,
-                externalId: companyId,
-            };
-            this.entity = await this.entityMO.create(createObj);
-        } else if (search.length === 1) {
-            this.entity = search[0];
-        } else {
-            debug(
-                'Multiple entities found with the same Company ID:',
-                companyId
-            );
-        }
-
-        return {
-            entity_id: this.entity.id,
-        };
-    }
-
-    async deauthorize() {
-        this.api = new Api();
-
-        const entity = await this.entityMO.getByUserId(this.userId);
-        if (entity.credential) {
-            await this.credentialMO.delete(entity.credential);
-            entity.credential = undefined;
-            await entity.save();
-        }
-    }
-
-    async receiveNotification(notifier, delegateString, object = null) {
-        if (notifier instanceof Api) {
-            if (delegateString === this.api.DLGT_TOKEN_UPDATE) {
-                const userProfile = await this.api.getUser();
-                const pipedriveUserId = userProfile.data.id;
-                const updatedToken = {
-                    user: this.userId,
-                    accessToken: this.api.access_token,
-                    refreshToken: this.api.refresh_token,
-                    accessTokenExpire: this.api.accessTokenExpire,
-                    externalId: pipedriveUserId,
-                    companyDomain: object.api_domain,
-                    auth_is_valid: true,
-                };
-
-                if (!this.credential) {
-                    let credentialSearch = await this.credentialMO.list({
-                        externalId: pipedriveUserId,
-                    });
-                    if (credentialSearch.length === 0) {
-                        this.credential = await this.credentialMO.create(
-                            updatedToken
-                        );
-                    } else if (credentialSearch.length === 1) {
-                        if (
-                            credentialSearch[0].user.toString() ===
-                            this.userId.toString()
-                        ) {
-                            this.credential = await this.credentialMO.update(
-                                credentialSearch[0],
-                                updatedToken
-                            );
-                        } else {
-                            debug(
-                                'Somebody else already created a credential with the same User ID:',
-                                pipedriveUserId
-                            );
-                        }
-                    } else {
-                        // Handling multiple credentials found with an error for the time being
-                        debug(
-                            'Multiple credentials found with the same User ID:',
-                            pipedriveUserId
-                        );
-                    }
-                } else {
-                    this.credential = await this.credentialMO.update(
-                        this.credential,
-                        updatedToken
-                    );
-                }
-            }
-            if (delegateString === this.api.DLGT_TOKEN_DEAUTHORIZED) {
-                await this.deauthorize();
-            }
-            if (delegateString === this.api.DLGT_INVALID_AUTH) {
-                await this.markCredentialsInvalid();
-            }
-        }
-    }
-}
-
-module.exports = Manager;

package/manager.test.js

@@ -1,26 +0,0 @@
-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/mocks/activities/createActivity.js

@@ -1,172 +0,0 @@
-module.exports = {
-    data: {
-        type: 'task',
-        id: 31,
-        attributes: {
-            action: 'email',
-            autoskipAt: null,
-            compiledSequenceTemplateHtml: null,
-            completed: false,
-            completedAt: null,
-            createdAt: '2021-11-06T02:52:48.000Z',
-            dueAt: '2021-11-06T02:52:48.000Z',
-            note: null,
-            opportunityAssociation: null,
-            scheduledAt: null,
-            state: 'incomplete',
-            stateChangedAt: null,
-            taskType: 'manual',
-            updatedAt: '2021-11-06T02:52:48.000Z',
-        },
-        relationships: {
-            account: {
-                data: {
-                    type: 'account',
-                    id: 1,
-                },
-            },
-            call: {
-                data: null,
-            },
-            calls: {
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/calls?filter%5Btask%5D%5Bid%5D=31',
-                },
-            },
-            completer: {
-                data: null,
-            },
-            creator: {
-                data: {
-                    type: 'user',
-                    id: 1,
-                },
-            },
-            defaultPluginMapping: {
-                data: null,
-            },
-            mailing: {
-                data: null,
-            },
-            mailings: {
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/mailings?filter%5Btask%5D%5Bid%5D=31',
-                },
-            },
-            opportunity: {
-                data: null,
-            },
-            owner: {
-                data: {
-                    type: 'user',
-                    id: 1,
-                },
-            },
-            prospect: {
-                data: null,
-            },
-            prospectAccount: {
-                data: null,
-            },
-            prospectContacts: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/emailAddresses?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            prospectOwner: {
-                data: null,
-            },
-            prospectPhoneNumbers: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/phoneNumbers?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            prospectStage: {
-                data: null,
-            },
-            sequence: {
-                data: null,
-            },
-            sequenceSequenceSteps: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/sequenceSteps?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            sequenceState: {
-                data: null,
-            },
-            sequenceStateSequenceStep: {
-                data: null,
-            },
-            sequenceStateSequenceStepOverrides: {
-                data: [],
-                meta: {
-                    count: 0,
-                },
-            },
-            sequenceStateStartingTemplate: {
-                data: null,
-            },
-            sequenceStep: {
-                data: null,
-            },
-            sequenceStepOverrideTemplates: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/templates?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            sequenceTemplate: {
-                data: null,
-            },
-            sequenceTemplateTemplate: {
-                data: null,
-            },
-            subject: {
-                data: {
-                    type: 'account',
-                    id: 1,
-                },
-            },
-            taskPriority: {
-                data: {
-                    type: 'taskPriority',
-                    id: 3,
-                },
-            },
-            taskTheme: {
-                data: {
-                    type: 'taskTheme',
-                    id: 1,
-                },
-            },
-            template: {
-                data: null,
-            },
-        },
-        links: {
-            self: 'https://api.pipedrive.io/api/v2/tasks/31',
-        },
-    },
-};

package/mocks/activities/deleteActivity.js

@@ -1,3 +0,0 @@
-module.exports = {
-    status: 204,
-};