Merge pull request #1148 from stormpath/issue-1141-generic-oauth2-provider-support

Issue 1141 generic oauth2 provider support

Author: rbhojan

api/src/main/java/com/stormpath/sdk/provider/AccessTokenType.java

@@ -0,0 +1,59 @@
+package com.stormpath.sdk.provider;
+
+
+import com.stormpath.sdk.lang.Assert;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * A value specifying how to present the accessToken credential when interacting with the authorizationEndpoint and/or
+ * the tokenEndpoint.
+ * Possible values are bearer (token as part of authorization header), access_token and oauth_token (both of which are
+ * query parameters).
+ *
+ * Different OAuth2 providers support different ways to present the accessToken. Please read the provider's "OAuth2"
+ * implementation documentation in detail to identify and pick the type that they support. This allows us to support
+ * any current OAuth2 provider.
+ * Additionally, we can support new types as they emerge by updating this enum.
+ *
+ * @since 1.3.0
+ */
+public enum AccessTokenType {
+
+    BEARER("bearer"),
+    ACCESS_TOKEN_PARAMETER("access_token"),
+    OAUTH_TOKEN_PARAMETER("oauth_token");
+
+    private static final Map<String, AccessTokenType> TOKEN_TYPE_MAP;
+
+    static {
+        TOKEN_TYPE_MAP = new HashMap<>();
+
+        for (AccessTokenType accessTokenType : AccessTokenType.values()) {
+            TOKEN_TYPE_MAP.put(accessTokenType.nameKey, accessTokenType);
+        }
+    }
+
+    private String nameKey;
+
+    AccessTokenType(String nameKey) {
+        this.nameKey = nameKey;
+    }
+
+    public static AccessTokenType fromNameKey(String nameKey) {
+
+        Assert.notNull(nameKey, "accessTokenType is required.");
+
+        AccessTokenType accessTokenType = TOKEN_TYPE_MAP.get(nameKey.toLowerCase());
+
+        Assert.notNull(accessTokenType, "Invalid accessTokenType : " + nameKey);
+
+        return accessTokenType;
+    }
+
+    public String getNameKey() {
+        return this.nameKey;
+    }
+
+}

api/src/main/java/com/stormpath/sdk/provider/GenericOAuth2CreateProviderRequestBuilder.java

@@ -0,0 +1,51 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link CreateProviderRequestBuilder} interface for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2CreateProviderRequestBuilder extends CreateProviderRequestBuilder<GenericOAuth2CreateProviderRequestBuilder> {
+
+    /**
+     * Setter for the authorizationEndpoint for the OAuth2 provider.
+     *
+     * @param authorizationEndpoint the authorizationEndpoint for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setAuthorizationEndpoint(String authorizationEndpoint);
+
+    /**
+     * Setter for the tokenEndpoint for the OAuth2 provider.
+     *
+     * @param tokenEndpoint the tokenEndpoint for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setTokenEndpoint(String tokenEndpoint);
+
+    /**
+     * Setter for the resourceEndpoint for the OAuth2 provider.
+     *
+     * @param resourceEndpoint the resourceEndpoint for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setResourceEndpoint(String resourceEndpoint);
+
+    /**
+     * Setter for the accessTokenType for the OAuth2 provider.
+     *
+     * @param accessTokenType the accessTokenType for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setAccessTokenType(AccessTokenType accessTokenType);
+
+    /**
+     * Setter for the provider id of the OAuth2 provider(e.g. "amazon").
+     *
+     * @param providerId the provider id of the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setClientId(String providerId);
+
+    GenericOAuth2CreateProviderRequestBuilder setProviderId(String providerId);
+}

api/src/main/java/com/stormpath/sdk/provider/GenericOAuth2Provider.java

@@ -0,0 +1,19 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link Provider} Resource for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2Provider extends OAuthProvider {
+
+    GenericOAuth2Provider setProviderId(String providerId);
+
+    String getAuthorizationEndpoint();
+
+    String getTokenEndpoint();
+
+    String getResourceEndpoint();
+
+    AccessTokenType getAccessType();
+}

api/src/main/java/com/stormpath/sdk/provider/GenericOAuth2ProviderAccountRequestBuilder.java

@@ -0,0 +1,17 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link ProviderAccountRequestBuilder} interface for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2ProviderAccountRequestBuilder extends ProviderAccountRequestBuilder<GenericOAuth2ProviderAccountRequestBuilder> {
+
+    /**
+     * Setter for the provider id of the OAuth2 Provider (as provided when creating the provider directory).
+     *
+     * @param providerId the provider id of the OAuth2 Provider
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2ProviderAccountRequestBuilder setProviderId(String providerId);
+}

api/src/main/java/com/stormpath/sdk/provider/GenericOAuth2ProviderData.java

@@ -0,0 +1,19 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link ProviderData} Resource for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2ProviderData extends ProviderData {
+
+    /**
+     * Getter for the OAuth2 provider's access token.
+     *
+     * @return the OAuth2 provider's access token.
+     */
+    String getAccessToken();
+
+    GenericOAuth2ProviderData setProviderId(String providerId);
+
+}

api/src/main/java/com/stormpath/sdk/provider/GenericOAuth2ProviderRequestFactory.java

@@ -0,0 +1,9 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link ProviderRequestFactory} interface for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2ProviderRequestFactory extends ProviderRequestFactory<GenericOAuth2ProviderAccountRequestBuilder, GenericOAuth2CreateProviderRequestBuilder> {
+}

api/src/main/java/com/stormpath/sdk/provider/OAuthProvider.java

@@ -51,4 +51,11 @@ public interface OAuthProvider extends Provider {
      * @since 1.3.0
      */
     UserInfoMappingRules getUserInfoMappingRules();
+
+    /**
+     * Returns the Type of the Provider (e.g. "facebook" or "google", "oauth2").
+     * @return the Type of the Provider.
+     * @since 1.3.0
+     */
+    String getProviderType();
 }

api/src/main/java/com/stormpath/sdk/provider/Providers.java

@@ -93,5 +93,13 @@ private Providers() {
      */
     public static final TwitterRequestFactory TWITTER = (TwitterRequestFactory) Classes.newInstance("com.stormpath.sdk.impl.provider.DefaultTwitterRequestFactory");
 
+    /**
+     * Returns a new {@link GenericOAuth2ProviderRequestFactory} instance, used to construct Twitter requests, like Twitter Account creation and retrieval.
+     *
+     * @return a new {@link GenericOAuth2ProviderRequestFactory} instance, used to construct Twitter requests, like Twitter Account creation and retrieval.
+     * @since 1.3.0
+     */
+    public static final GenericOAuth2ProviderRequestFactory OAUTH2 = (GenericOAuth2ProviderRequestFactory) Classes.newInstance("com.stormpath.sdk.impl.provider.DefaultGenericOAuth2ProviderRequestFactory");
+
 }
 

extensions/httpclient/src/test/groovy/com/stormpath/sdk/client/DirectoryIT.groovy

@@ -444,6 +444,30 @@ class DirectoryIT extends ClientIT {
 
     }
 
+    /**
+     * @since 1.3.0
+     */
+    @Test(enabled = false) //TODO : enable this when the generic OAuth2 changes are there in prod (api.stormpath.com)
+    void testCreateGenericOAuth2DirectoryWithUserInfoMappingRules() {
+        Directory dir = client.instantiate(Directory)
+        dir.name = uniquify("Java SDK: DirectoryIT.testCreateGenericOAuth2DirectoryRequest")
+
+        def request = Directories.newCreateRequestFor(dir)
+                .forProvider(Providers.OAUTH2.builder().setProviderId("imgur")
+                .setClientId("73i1dq2fko01s2")
+                .setClientSecret("wJhXc81l63qEOc43")
+                .setAccessTokenType(AccessTokenType.BEARER)
+                .setAuthorizationEndpoint("https://api.imgur.com/oauth2/authorize")
+                .setTokenEndpoint("https://api.imgur.com/oauth2/token")
+                .setResourceEndpoint("https://api.imgur.com/oauth2/token")
+                .setUserInfoMappingRules(buildSampleUserInfoMappingRules()).build()).build()
+        dir = client.createDirectory(request);
+        deleteOnTeardown(dir)
+        assertNotNull dir.href
+        assertUserInfoMappingRuleWasCreatedAndUpdate((AbstractOAuthProvider<TwitterProvider>) dir.provider)
+
+    }
+
     void assertUserInfoMappingRuleWasCreatedAndUpdate(AbstractOAuthProvider provider) {
 
         UserInfoMappingRules rules = provider.getUserInfoMappingRules()

extensions/httpclient/src/test/groovy/com/stormpath/sdk/impl/application/ApplicationIT.groovy

@@ -679,7 +679,8 @@ class ApplicationIT extends ClientIT {
         } catch (com.stormpath.sdk.resource.ResourceException e) {
             assertEquals(e.getStatus(), 400)
             assertEquals(e.getCode(), 7200)
-            assertTrue(e.getDeveloperMessage().contains("Stormpath was not able to complete the request to Google: this can be caused by either a bad Google Directory configuration, or the provided Account credentials are not valid."))
+            assertTrue(e.getDeveloperMessage().contains("Stormpath was not able to complete the request to"))
+            assertTrue(e.getDeveloperMessage().contains("Google") || e.getDeveloperMessage().contains("google"))
         }
     }