ZCS-2691 Create DataSource implementation for LinkedIn contacts via oAuth #44

chinmay15 · 2018-07-24T14:07:47Z

Problem/Task: create datasource implementation for Linkedin contacts sync using oAuth2

Fix:

Authorize and authenticate using oAuth2 rest api provided by Linkedin
Folder created is with name as <username>-contact-linkedin, as profile call for linkedin needs "r_fullprofile" permission and this permission in given by linkedin on request. Request with linkedin support is raised.

Testing done:

Contact folder and datasource is created in user account.
Tested functionality manually.

zmprov gds cp1
# name [email protected]
# type oauth2contact
objectClass: zimbraDataSource
zimbraCreateTimestamp: 20180724133602.672Z
zimbraDataSourceConnectionType: cleartext
zimbraDataSourceEnabled: TRUE
zimbraDataSourceFolderId: 60020
zimbraDataSourceHost: www.linkedin.com
zimbraDataSourceId: 54e84c2e-50e5-405f-aa60-9c008d41aac0
zimbraDataSourceImportClassName: com.zimbra.oauth.handlers.impl.LinkedinContactsImport
zimbraDataSourceImportOnly: FALSE
zimbraDataSourceName: [email protected]
zimbraDataSourceOAuthRefreshToken: VALUE-BLOCKED
zimbraDataSourcePollingInterval: 1d
zimbraDataSourceType: oauth2contact

Testing needs to be done by QA:

go to https://www.linkedin.com/developer/apps
create app from - my apps -> create app
select default app permissions "r_basicprofile" and "r_emailaddress"
add "https://<your_host_name>/service/extension/oauth2/authenticate/linkedin" OAuth 2.0 authorized redirect url
set zimbraOAuthConsumerRedirectUri: https://cpathak.zdev.local/service/extension/oauth2/authenticate/linkedin:linkedin
set zimbraOAuthConsumerCredentials: <app_client_id>:<app_client_secret>:linkedin
Make sure, Authorization and Authentication is done using oAuth2
Make sure, contacts folder and datasource is created as mentioned above

Linked PR:
Zimbra/zm-mailbox#696

…Auth

desouzas · 2018-07-24T19:53:32Z

src/java/com/zimbra/oauth/handlers/impl/LinkedinContactsImport.java

+import com.zimbra.oauth.utilities.LdapConfiguration;
+
+/**
+ * The FacebookContactsImport class.<br>


LinkedinContactsImport

Also missing this docblock header on the handler class.

desouzas · 2018-07-24T19:55:14Z

src/java/com/zimbra/oauth/handlers/impl/LinkedinOAuth2Handler.java

+        AUTHENTICATE_URI("https://www.linkedin.com/oauth/v2/accessToken"),
+        ACCESS_TOKEN("access_token"),
+        EXPIRES_IN("expires_in")
+        ;


Put this on the line before for consistency with the project. Same below.

desouzas · 2018-07-24T19:55:30Z

src/java/com/zimbra/oauth/handlers/impl/LinkedinOAuth2Handler.java

+        ID("id"),
+        FIRST_NAME("firstName"),
+        LAST_NAME("lastName")
+        ;


desouzas · 2018-07-24T19:57:25Z

src/java/com/zimbra/oauth/handlers/impl/LinkedinOAuth2Handler.java

+        ERROR_DESCRIPTION("error_description"),
+        DEFAULT_ERROR("default_error"),
+        SERVICE_ERROR_CODE("serviceErrorCode"),
+        ERROR_MESSAGE("message"),


Is this and error_description a key? Move each of the response keys to the general LinkedInOAuth2Constants Keep your error codes in here.

desouzas · 2018-07-24T20:00:51Z

src/java/com/zimbra/oauth/handlers/impl/LinkedinOAuth2Handler.java

+        // get zimbra mailbox
+        final ZMailbox mailbox = getZimbraMailbox(oauthInfo.getZmAuthToken());
+
+        // store refreshToken


// store accessToken

May not be unreasonable to note that linkedin tokens are short-lived only. But that could be left for the import implementation where a small change may be necessary in syncDatasource to not set a polling time.

// store accessToken

desouzas · 2018-07-24T20:05:44Z

src/java/com/zimbra/oauth/handlers/impl/OAuth2Handler.java

@@ -60,6 +60,21 @@
 * @copyright Copyright © 2018
 */
 public abstract class OAuth2Handler {
+    // for relay encoding
+    public enum RelayEnum {
+        RELAY("relay"),


These constants already exist in the project.
https://github.com/Zimbra/zm-oauth-social/blob/develop/src/java/com/zimbra/oauth/utilities/OAuth2HttpConstants.java#L38

Also "relay" isn't used anymore since the tickets with the ds type updates - it's now "state" into the authorize call, and whatever the social service uses out to the social service (typically "state" - but configurable for each service), and same thing on return into authenticate (whatever the service uses).

this enum is not used anywhere, so removed. I added it while i was testing JweUtil to pass the relay values but i removed that part of code.

desouzas · 2018-07-24T20:07:16Z

src/java/com/zimbra/oauth/handlers/impl/LinkedinOAuth2Handler.java

+    }
+
+    @Override
+    protected String getPrimaryEmail(JsonNode credentials, Account account) throws ServiceException {


Format all of this method's source (lines appear too long).

formatted code

desouzas · 2018-08-09T04:19:57Z

Don't merge this since we're putting linked aside for now.

chinmay15 added 2 commits July 24, 2018 18:56

ZCS-2691 Create DataSource implementation for LinkedIn contacts via o…

c733f9b

…Auth

uncommented code which was commented while testing

4dda4ac

chinmay15 added the enhancement New feature or request label Jul 24, 2018

chinmay15 self-assigned this Jul 24, 2018

chinmay15 requested review from desouzas, naijenn, rupalid, swapnilpingle89, Prashantsurana, piyush4360, shrikant-prasad and jdavid-synacor July 24, 2018 14:07

chinmay15 mentioned this pull request Jul 24, 2018

ZCS-2691 Create DataSource implementation for LinkedIn contacts via oAuth Zimbra/zm-mailbox#696

Open

desouzas reviewed Jul 24, 2018

View reviewed changes

chinmay15 added 2 commits July 25, 2018 18:29

Resolving review comments

0ff7998

Code formatting

3fbcdac

desouzas approved these changes Jul 25, 2018

View reviewed changes

rupalid approved these changes Jul 26, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ZCS-2691 Create DataSource implementation for LinkedIn contacts via oAuth #44

ZCS-2691 Create DataSource implementation for LinkedIn contacts via oAuth #44

chinmay15 commented Jul 24, 2018 •

edited

Loading

desouzas Jul 24, 2018 •

edited

Loading

chinmay15 Jul 25, 2018

desouzas Jul 24, 2018

chinmay15 Jul 25, 2018

desouzas Jul 24, 2018

chinmay15 Jul 25, 2018

desouzas Jul 24, 2018 •

edited

Loading

chinmay15 Jul 25, 2018

desouzas Jul 24, 2018

chinmay15 Jul 25, 2018

desouzas Jul 24, 2018 •

edited

Loading

chinmay15 Jul 25, 2018

desouzas Jul 24, 2018 •

edited

Loading

chinmay15 Jul 25, 2018

desouzas commented Aug 9, 2018

ZCS-2691 Create DataSource implementation for LinkedIn contacts via oAuth #44

Are you sure you want to change the base?

ZCS-2691 Create DataSource implementation for LinkedIn contacts via oAuth #44

Conversation

chinmay15 commented Jul 24, 2018 • edited Loading

desouzas Jul 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

desouzas Jul 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

desouzas Jul 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

desouzas Jul 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

desouzas commented Aug 9, 2018

chinmay15 commented Jul 24, 2018 •

edited

Loading

desouzas Jul 24, 2018 •

edited

Loading

desouzas Jul 24, 2018 •

edited

Loading

desouzas Jul 24, 2018 •

edited

Loading

desouzas Jul 24, 2018 •

edited

Loading