Merge pull request hapijs#249 from bbatliner/master

Twitter additional GET parameters on extended profile request
PierreGabioud · Aug 20, 2016 · 7293af0 · 7293af0
2 parents e5e816a + 1e9790f
commit 7293af0
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 1 deletion.
diff --git a/Providers.md b/Providers.md
@@ -466,6 +466,7 @@ credentials.profile = {
 - `config`:
   - `extendedProfile`: Request for more profile information
   - `getMethod`: [Twitter API](https://dev.twitter.com/rest/public) GET method to call when `extendedProfile` is enabled. Defaults to `'users/show'`
+  - `getParams`: Additional parameters to pass to the GET method. For example, the `include_email` parameter for the [`account/verify` route](https://dev.twitter.com/rest/reference/get/account/verify_credentials)
 - `temporary`: 'https://api.twitter.com/oauth/request_token'
 - `auth`: https://api.twitter.com/oauth/authenticate
 - `token`: https://api.twitter.com/oauth/access_token

diff --git a/lib/providers/twitter.js b/lib/providers/twitter.js
@@ -27,7 +27,12 @@ exports = module.exports = function (options) {
                 return callback();
             }
 
-            get(`https://api.twitter.com/1.1/${settings.getMethod}.json`, { user_id: params.user_id }, (profile) => {
+            const paramDefaults = {
+                user_id: params.user_id
+            };
+            const getParams = Hoek.applyToDefaults(paramDefaults, settings.getParams || {});
+
+            get(`https://api.twitter.com/1.1/${settings.getMethod}.json`, getParams, (profile) => {
 
                 credentials.profile.displayName = profile.name;
                 credentials.profile.raw = profile;

diff --git a/test/providers/twitter.js b/test/providers/twitter.js
@@ -158,6 +158,81 @@ describe('twitter', () => {
         });
     });
 
+    it('authenticates with mock and custom method with custom GET parameters', { parallel: false }, (done) => {
+
+        const mock = new Mock.V1();
+        mock.start((provider) => {
+
+            const server = new Hapi.Server();
+            server.connection({ host: 'localhost', port: 80 });
+            server.register(Bell, (err) => {
+
+                expect(err).to.not.exist();
+
+                const custom = Bell.providers.twitter({
+                    getMethod: 'custom/method',
+                    getParams: {
+                        param1: 'custom',
+                        param2: 'params'
+                    }
+                });
+                Hoek.merge(custom, provider);
+
+                Mock.override('https://api.twitter.com/1.1/custom/method.json', {
+                    property: 'something'
+                });
+
+                server.auth.strategy('custom', 'bell', {
+                    password: 'cookie_encryption_password_secure',
+                    isSecure: false,
+                    clientId: 'twitter',
+                    clientSecret: 'secret',
+                    provider: custom
+                });
+
+                server.route({
+                    method: '*',
+                    path: '/login',
+                    config: {
+                        auth: 'custom',
+                        handler: function (request, reply) {
+
+                            reply(request.auth.credentials);
+                        }
+                    }
+                });
+
+                server.inject('/login', (res) => {
+
+                    const cookie = res.headers['set-cookie'][0].split(';')[0] + ';';
+                    mock.server.inject(res.headers.location, (mockRes) => {
+
+                        server.inject({ url: mockRes.headers.location, headers: { cookie: cookie } }, (response) => {
+
+                            Mock.clear();
+                            expect(response.result).to.equal({
+                                provider: 'custom',
+                                token: 'final',
+                                secret: 'secret',
+                                query: {},
+                                profile: {
+                                    id: '1234567890',
+                                    username: 'Steve Stevens',
+                                    displayName: undefined,
+                                    raw: {
+                                        property: 'something'
+                                    }
+                                }
+                            });
+
+                            mock.stop(done);
+                        });
+                    });
+                });
+            });
+        });
+    });
+
     it('authenticates with mock (without extended profile)', { parallel: false }, (done) => {
 
         const mock = new Mock.V1();