feat: add fn to scm-base (#98)

* feat: add fn to scm-base

* add readme

---------

Co-authored-by: ppaul <pritam.paul@yahooinc.com>

Author: pritamstyz4ever

README.md

@@ -550,6 +550,19 @@ An object containing information of new pull request
 #### Expected Response
 1. Pull request object
 
+#### isEnterpriseUser
+Required parameters:
+
+| Parameter        | Type  |  Description |
+| :-------------   | :---- | :-------------|
+| config     | Object | The config object |
+| config.token | String | The github token to interact with the graphql api |
+| config.slug     | String | The github enterprise slug |
+| config.login    | String | The github user's login name |
+
+#### Expected Outcome
+1. Returns True or False
+
 ## Extending
 To make use of the validation functions, the functions to override are:
 
@@ -579,7 +592,8 @@ To make use of the validation functions, the functions to override are:
 1. `_getBranchList`
 1. `_openPr`
 1. `getDisplayName` (overriding needs only the case of `scm-router`)
-1. `getReadOnlyInfo` (overriding needs only the case of `scm-router`) 
+1. `getReadOnlyInfo` (overriding needs only the case of `scm-router`)
+1. `_isEnterpriseUser`
 
 
 ```js

index.js

@@ -709,6 +709,29 @@ class ScmBase {
     _openPr() {
         return Promise.reject(new Error('Not implemented'));
     }
+
+    /**
+     * check if scm user is a member of an enterprise
+     * @method isEnterpriseUser
+     * @param  {Object} config       The configuration object
+     * @param {String} config.token  The token used to authenticate to the SCM
+     * @param {String} config.slug   The slug of the enterprise
+     * @param {String} config.login  The login of the Github user
+     * @return {Promise}             Resolves when operation completed without failure
+     * @return {Boolean}             True if user is a member of an enterprise
+     *                               False if user is not a member of an enterprise
+     */
+    isEnterpriseUser(config) {
+        return this._isEnterpriseUser(config);
+    }
+
+    /**
+     * Abstract method to return false for non enterprise scm users
+     * @returns False
+     */
+    _isEnterpriseUser() {
+        return Promise.resolve(false);
+    }
 }
 
 module.exports = ScmBase;

test/index.test.js

@@ -1326,4 +1326,31 @@ describe('index test', () => {
                 assert.strictEqual(err.message, 'Not implemented');
             }));
     });
+
+    describe('isEnterpriseUser', () => {
+        const config = {
+            scmContext: 'github:github.com',
+            token
+        };
+
+        it('returns data from underlying method', () => {
+            instance._isEnterpriseUser = () => Promise.resolve(true);
+
+            return instance.isEnterpriseUser(config).then(output => {
+                assert.deepEqual(output, true);
+            });
+        });
+
+        it('does not throw error when not implemented', () => {
+            instance
+                .isEnterpriseUser(config)
+                .then(output => {
+                    assert.equal(output, false);
+                })
+                .catch(err => {
+                    // does not reach here
+                    assert.strictEqual(err.message, 'Not implemented');
+                });
+        });
+    });
 });