Merge pull request #1146 from stormpath/issue-1140-twitter

rbhojan · web-flow · commit 72a38affa7cb · 2016-12-28T17:04:34.000-08:00
Issue 1140 twitter
diff --git a/api/src/main/java/com/stormpath/sdk/provider/FacebookProviderData.java b/api/src/main/java/com/stormpath/sdk/provider/FacebookProviderData.java
@@ -23,9 +23,9 @@
 public interface FacebookProviderData extends ProviderData {
 
     /**
-     * Getter for the Facebook authorization code.
+     * Getter for the Facebook access token.
      *
-     * @return the Facebook authorization code.
+     * @return the Facebook access token.
      */
     String getAccessToken();
 
diff --git a/api/src/main/java/com/stormpath/sdk/provider/GithubProviderData.java b/api/src/main/java/com/stormpath/sdk/provider/GithubProviderData.java
@@ -23,9 +23,9 @@
 public interface GithubProviderData extends ProviderData {
 
     /**
-     * Getter for the Github authorization code.
+     * Getter for the Github access token.
      *
-     * @return the Github authorization code.
+     * @return the Github access token.
      */
     String getAccessToken();
 
diff --git a/api/src/main/java/com/stormpath/sdk/provider/LinkedInProviderData.java b/api/src/main/java/com/stormpath/sdk/provider/LinkedInProviderData.java
@@ -23,9 +23,9 @@
 public interface LinkedInProviderData extends ProviderData {
 
     /**
-     * Getter for the LinkedIn authorization code.
+     * Getter for the LinkedIn access token.
      *
-     * @return the LinkedIn authorization code.
+     * @return the LinkedIn access token.
      */
     String getAccessToken();
 
diff --git a/api/src/main/java/com/stormpath/sdk/provider/Providers.java b/api/src/main/java/com/stormpath/sdk/provider/Providers.java
@@ -84,5 +84,14 @@ private Providers() {
      * @since 1.0.RC8
      */
     public static final SamlRequestFactory SAML = (SamlRequestFactory) Classes.newInstance("com.stormpath.sdk.impl.provider.saml.DefaultSamlRequestFactory");
+
+    /**
+     * Returns a new {@link TwitterRequestFactory} instance, used to construct Twitter requests, like Twitter Account creation and retrieval.
+     *
+     * @return a new {@link TwitterRequestFactory} instance, used to construct Twitter requests, like Twitter Account creation and retrieval.
+     * @since 1.3.0
+     */
+    public static final TwitterRequestFactory TWITTER = (TwitterRequestFactory) Classes.newInstance("com.stormpath.sdk.impl.provider.DefaultTwitterRequestFactory");
+
 }
 
diff --git a/api/src/main/java/com/stormpath/sdk/provider/TwitterAccountRequestBuilder.java b/api/src/main/java/com/stormpath/sdk/provider/TwitterAccountRequestBuilder.java
@@ -0,0 +1,17 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * Twitter's specific {@link ProviderAccountRequestBuilder} interface.
+ *
+ * @since 1.3.0
+ */
+public interface TwitterAccountRequestBuilder extends ProviderAccountRequestBuilder<TwitterAccountRequestBuilder> {
+
+    /**
+     * Setter for the Provider App access token.
+     *
+     * @param accessToken the Provider App access token.
+     * @return the builder instance for method chaining.
+     */
+    TwitterAccountRequestBuilder setAccessTokenSecret(String accessToken);
+}
diff --git a/api/src/main/java/com/stormpath/sdk/provider/TwitterCreateProviderRequestBuilder.java b/api/src/main/java/com/stormpath/sdk/provider/TwitterCreateProviderRequestBuilder.java
@@ -0,0 +1,10 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * Twitter's specific {@link CreateProviderRequestBuilder} interface.
+ *
+ * @since 1.3.0
+ */
+public interface TwitterCreateProviderRequestBuilder extends CreateProviderRequestBuilder<TwitterCreateProviderRequestBuilder> {
+
+}
diff --git a/api/src/main/java/com/stormpath/sdk/provider/TwitterProvider.java b/api/src/main/java/com/stormpath/sdk/provider/TwitterProvider.java
@@ -0,0 +1,9 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * A Twitter-specific {@link Provider} Resource.
+ *
+ * @since 1.3.0
+ */
+public interface TwitterProvider extends OAuthProvider {
+}
diff --git a/api/src/main/java/com/stormpath/sdk/provider/TwitterProviderData.java b/api/src/main/java/com/stormpath/sdk/provider/TwitterProviderData.java
@@ -0,0 +1,24 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * Twitter-specific {@link com.stormpath.sdk.provider.ProviderData} Resource.
+ *
+ * @since 1.3.0
+ */
+public interface TwitterProviderData extends ProviderData {
+
+    /**
+     * Getter for the Twitter access token.
+     *
+     * @return the Twitter access token.
+     */
+    String getAccessToken();
+
+    /**
+     * Getter for the Twitter access token secret.
+     *
+     * @return the Twitter access token secret.
+     */
+    String getAccessTokenSecret();
+
+}
diff --git a/api/src/main/java/com/stormpath/sdk/provider/TwitterRequestFactory.java b/api/src/main/java/com/stormpath/sdk/provider/TwitterRequestFactory.java
@@ -0,0 +1,9 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * Twitter-specific {@link ProviderRequestFactory} interface.
+ *
+ * @since 1.3.0
+ */
+public interface TwitterRequestFactory extends ProviderRequestFactory<TwitterAccountRequestBuilder, TwitterCreateProviderRequestBuilder> {
+}
diff --git a/extensions/httpclient/src/test/groovy/com/stormpath/sdk/client/DirectoryIT.groovy b/extensions/httpclient/src/test/groovy/com/stormpath/sdk/client/DirectoryIT.groovy
@@ -30,11 +30,7 @@ import com.stormpath.sdk.mail.EmailStatus
 import com.stormpath.sdk.organization.Organization
 import com.stormpath.sdk.organization.OrganizationStatus
 import com.stormpath.sdk.organization.Organizations
-import com.stormpath.sdk.provider.FacebookProvider
-import com.stormpath.sdk.provider.GithubProvider
-import com.stormpath.sdk.provider.GoogleProvider
-import com.stormpath.sdk.provider.LinkedInProvider
-import com.stormpath.sdk.provider.Providers
+import com.stormpath.sdk.provider.*
 import com.stormpath.sdk.provider.saml.SamlProvider
 import com.stormpath.sdk.provider.social.SocialUserInfoMappingRules
 import com.stormpath.sdk.provider.social.UserInfoMappingRule
@@ -428,6 +424,26 @@ class DirectoryIT extends ClientIT {
 
     }
 
+    /**
+     * @since 1.3.0
+     */
+    @Test
+    void testCreateTwitterDirectoryWithUserInfoMappingRules() {
+        Directory dir = client.instantiate(Directory)
+        dir.name = uniquify("Java SDK: DirectoryIT.testCreateTwitterDirectoryRequest")
+
+        def request = Directories.newCreateRequestFor(dir)
+                .forProvider(Providers.TWITTER.builder()
+                .setClientId("73i1dq2fko01s2")
+                .setClientSecret("wJhXc81l63qEOc43")
+                .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()
diff --git a/extensions/servlet/src/main/java/com/stormpath/sdk/servlet/config/filter/TwitterCallbackFilterFactory.java b/extensions/servlet/src/main/java/com/stormpath/sdk/servlet/config/filter/TwitterCallbackFilterFactory.java
@@ -0,0 +1,14 @@
+package com.stormpath.sdk.servlet.config.filter;
+
+import com.stormpath.sdk.servlet.mvc.provider.TwitterCallbackController;
+
+/**
+ * @since 1.3.0
+ */
+public class TwitterCallbackFilterFactory extends SocialCallbackControllerFilterFactory<TwitterCallbackController> {
+
+    @Override
+    protected TwitterCallbackController newController() {
+        return new TwitterCallbackController();
+    }
+}
diff --git a/extensions/servlet/src/main/java/com/stormpath/sdk/servlet/mvc/provider/TwitterCallbackController.java b/extensions/servlet/src/main/java/com/stormpath/sdk/servlet/mvc/provider/TwitterCallbackController.java
@@ -0,0 +1,22 @@
+package com.stormpath.sdk.servlet.mvc.provider;
+
+import com.stormpath.sdk.provider.ProviderAccountRequest;
+import com.stormpath.sdk.provider.Providers;
+import com.stormpath.sdk.servlet.mvc.AbstractSocialCallbackController;
+import com.stormpath.sdk.servlet.util.ServletUtils;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * @since 1.3.0
+ */
+public class TwitterCallbackController extends AbstractSocialCallbackController {
+
+    @Override
+    protected ProviderAccountRequest getAccountProviderRequest(HttpServletRequest request) {
+        String accessToken = ServletUtils.getCleanParam(request, "accessToken");
+        String accessTokenSecret = ServletUtils.getCleanParam(request, "accessTokenSecret");
+
+        return Providers.TWITTER.account().setAccessToken(accessToken).setAccessTokenSecret(accessTokenSecret).build();
+    }
+}
diff --git a/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterAccountRequestBuilder.java b/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterAccountRequestBuilder.java
@@ -0,0 +1,47 @@
+package com.stormpath.sdk.impl.provider;
+
+import com.stormpath.sdk.lang.Assert;
+import com.stormpath.sdk.provider.ProviderAccountRequest;
+import com.stormpath.sdk.provider.ProviderData;
+import com.stormpath.sdk.provider.TwitterAccountRequestBuilder;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static com.stormpath.sdk.lang.Strings.hasText;
+
+/**
+ * @since 1.3.0
+ */
+public class DefaultTwitterAccountRequestBuilder extends AbstractSocialProviderAccountRequestBuilder<TwitterAccountRequestBuilder> implements TwitterAccountRequestBuilder {
+
+    protected String accessTokenSecret;
+
+    @Override
+    protected ProviderAccountRequest doBuild(Map<String, Object> map) {
+        Assert.state(hasText(super.accessToken) && hasText(this.accessTokenSecret), "Both accessToken and accessTokenSecret must be provided before building.");
+        Map<String, Object> properties = new HashMap<>(map);
+        properties.put("accessToken", accessToken);
+        properties.put("accessTokenSecret", accessTokenSecret);
+
+        ProviderData providerData = newProviderData(properties);
+
+        return new DefaultProviderAccountRequest(providerData, redirectUri);
+    }
+
+    @Override
+    protected String getConcreteProviderId() {
+        return IdentityProviderType.TWITTER.getNameKey();
+    }
+
+    @Override
+    protected ProviderData newProviderData(Map<String, Object> properties) {
+        return new DefaultTwitterProviderData(null, properties);
+    }
+
+    @Override
+    public TwitterAccountRequestBuilder setAccessTokenSecret(String accessTokenSecret) {
+        this.accessTokenSecret = accessTokenSecret;
+        return this;
+    }
+}
diff --git a/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterCreateProviderRequestBuilder.java b/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterCreateProviderRequestBuilder.java
@@ -0,0 +1,29 @@
+package com.stormpath.sdk.impl.provider;
+
+import com.stormpath.sdk.provider.CreateProviderRequest;
+import com.stormpath.sdk.provider.TwitterCreateProviderRequestBuilder;
+
+import java.util.Map;
+
+/**
+ * @since 1.3.0
+ */
+public class DefaultTwitterCreateProviderRequestBuilder extends AbstractCreateProviderRequestBuilder<TwitterCreateProviderRequestBuilder> implements TwitterCreateProviderRequestBuilder {
+
+    @Override
+    protected String getConcreteProviderId() {
+        return IdentityProviderType.TWITTER.getNameKey();
+    }
+
+    @Override
+    protected CreateProviderRequest doBuild(Map<String, Object> map) {
+        DefaultTwitterProvider provider = new DefaultTwitterProvider(null, map);
+        provider.setClientId(super.clientId);
+        provider.setClientSecret(super.clientSecret);
+        if(super.userInfoMappingRules != null) {
+            provider.setUserInfoMappingRules(super.userInfoMappingRules);
+        }
+
+        return new DefaultCreateProviderRequest(provider);
+    }
+}
diff --git a/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterProvider.java b/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterProvider.java
@@ -0,0 +1,36 @@
+package com.stormpath.sdk.impl.provider;
+
+import com.stormpath.sdk.impl.ds.InternalDataStore;
+import com.stormpath.sdk.impl.resource.Property;
+import com.stormpath.sdk.provider.TwitterProvider;
+
+import java.util.Map;
+
+/**
+ * @since 1.3.0
+ */
+public class DefaultTwitterProvider extends AbstractOAuthProvider<TwitterProvider> implements TwitterProvider {
+
+    static final Map<String,Property> PROPERTY_DESCRIPTORS = createPropertyDescriptorMap(PROVIDER_ID, CREATED_AT, MODIFIED_AT, CLIENT_ID, CLIENT_SECRET, SCOPE, USER_INFO_MAPPING_RULES);
+
+    public DefaultTwitterProvider(InternalDataStore dataStore) {
+        super(dataStore);
+    }
+
+    public DefaultTwitterProvider(InternalDataStore dataStore, Map<String, Object> properties) {
+        super(dataStore, properties);
+    }
+
+    @Override
+    public Map<String, Property> getPropertyDescriptors() {
+        return PROPERTY_DESCRIPTORS;
+    }
+
+    @Override
+    protected String getConcreteProviderId() {
+        return IdentityProviderType.TWITTER.getNameKey();
+    }
+
+
+}
+
diff --git a/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterProviderData.java b/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterProviderData.java
@@ -0,0 +1,50 @@
+package com.stormpath.sdk.impl.provider;
+
+import com.stormpath.sdk.impl.ds.InternalDataStore;
+import com.stormpath.sdk.impl.resource.Property;
+import com.stormpath.sdk.impl.resource.StringProperty;
+import com.stormpath.sdk.provider.TwitterProviderData;
+
+import java.util.Map;
+
+/**
+ * @since 1.3.0
+ */
+public class DefaultTwitterProviderData extends AbstractProviderData<TwitterProviderData> implements TwitterProviderData {
+
+    static final StringProperty ACCESS_TOKEN_SECRET = new StringProperty("accessTokenSecret");
+
+    static final Map<String,Property> PROPERTY_DESCRIPTORS = createPropertyDescriptorMap(PROVIDER_ID, CREATED_AT, MODIFIED_AT, ACCESS_TOKEN, ACCESS_TOKEN_SECRET);
+
+    public DefaultTwitterProviderData(InternalDataStore dataStore) {
+        super(dataStore);
+    }
+
+    public DefaultTwitterProviderData(InternalDataStore dataStore, Map<String, Object> properties) {
+        super(dataStore, properties);
+        this.setProperty(ACCESS_TOKEN_SECRET, properties.get(ACCESS_TOKEN_SECRET.getName()));
+    }
+
+    @Override
+    public Map<String, Property> getPropertyDescriptors() {
+        return PROPERTY_DESCRIPTORS;
+    }
+
+
+    @Override
+    protected String getConcreteProviderId() {
+        return IdentityProviderType.TWITTER.getNameKey();
+    }
+
+
+    @Override
+    public String getAccessTokenSecret() {
+        return getString(ACCESS_TOKEN_SECRET);
+    }
+
+    @SuppressWarnings("unchecked")
+    public TwitterProviderData setAccessTokenSecret(String accessTokenSecret) {
+        setProperty(ACCESS_TOKEN_SECRET, accessTokenSecret);
+        return this;
+    }
+}
diff --git a/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterRequestFactory.java b/impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultTwitterRequestFactory.java
@@ -0,0 +1,23 @@
+package com.stormpath.sdk.impl.provider;
+
+import com.stormpath.sdk.lang.Classes;
+import com.stormpath.sdk.provider.TwitterAccountRequestBuilder;
+import com.stormpath.sdk.provider.TwitterCreateProviderRequestBuilder;
+import com.stormpath.sdk.provider.TwitterRequestFactory;
+
+/**
+ * @since 1.3.0
+ */
+public class DefaultTwitterRequestFactory implements TwitterRequestFactory {
+
+    @Override
+    public TwitterAccountRequestBuilder account() {
+        return (TwitterAccountRequestBuilder) Classes.newInstance("com.stormpath.sdk.impl.provider.DefaultTwitterAccountRequestBuilder");
+    }
+
+    @Override
+    public TwitterCreateProviderRequestBuilder builder() {
+        return (TwitterCreateProviderRequestBuilder) Classes.newInstance("com.stormpath.sdk.impl.provider.DefaultTwitterCreateProviderRequestBuilder");
+    }
+
+}
diff --git a/impl/src/main/java/com/stormpath/sdk/impl/provider/IdentityProviderType.java b/impl/src/main/java/com/stormpath/sdk/impl/provider/IdentityProviderType.java
diff --git a/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterAccountRequestBuilderTest.groovy b/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterAccountRequestBuilderTest.groovy
diff --git a/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterCreateProviderRequestBuilderTest.groovy b/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterCreateProviderRequestBuilderTest.groovy
diff --git a/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterProviderDataTest.groovy b/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterProviderDataTest.groovy
diff --git a/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterProviderTest.groovy b/impl/src/test/groovy/com/stormpath/sdk/impl/provider/DefaultTwitterProviderTest.groovy
diff --git a/impl/src/test/groovy/com/stormpath/sdk/impl/provider/IdentityProviderTypeTest.groovy b/impl/src/test/groovy/com/stormpath/sdk/impl/provider/IdentityProviderTypeTest.groovy
