AM-3581 - fix based on review comments

Author: rbhojan

api/src/main/java/com/stormpath/sdk/provider/social/SocialUserInfoMappingRules.java

@@ -1,5 +1,5 @@
 /*
-* Copyright 2015 Stormpath, Inc.
+* Copyright 2016 Stormpath, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

api/src/main/java/com/stormpath/sdk/provider/social/UserInfoMappingRule.java

@@ -1,52 +1,51 @@
 package com.stormpath.sdk.provider.social;
 
-import com.stormpath.sdk.saml.AttributeStatementMappingRules;
-
 import java.util.Set;
 
 /**
- * A rule that indicates how a SAML Attribute Statement should populate one or more Stormpath Account field values.  By
- * creating rules, you configure which SAML Attribute values should be copied to Stormpath Account field values.
- * <p>{@code AttributeStatementMappingRule}s are immutable.  If you want to change the mapping rules for Accounts in a
- * particular SAML Directory, you must remove and add new {@code AttributeStatementMappingRule} instances to the
- * Directory Provider's {@link AttributeStatementMappingRules} instance.
+ * A rule that indicates how a userInfo attribute from a Social Provider should populate one or more Stormpath Account field values.  By
+ * creating rules, you configure which userInfo attribute values from the Social Provider should be copied to Stormpath Account field values.
+ * <p>{@code UserInfoMappingRule}s are immutable.  If you want to change the mapping rules for Accounts in a
+ * particular Social Directory, you must remove and add new {@code UserInfoMappingRule} instances to the
+ * Directory Provider's {@link UserInfoMappingRules} instance.
  *
  * <h4>How does it work?</h4>
- * <p>Each {@code AttributeStatementMappingRule} has a {@code name} and a collection of Stormpath account
+ * <p>Each {@code UserInfoMappingRule} has a {@code name} and a collection of Stormpath account
  * {@link #getAccountAttributes() attribute names}.</p>
- * <p>When a SAML Attribute Statement is encountered, every SAML Attribute with a matching name will have its value
- * copied to the corresponding specified Stormpath account fields.</p>
+ * <p>When a userInfo attribute from a Social Provider is encountered, every userInfo attribute from the Social Provider
+ * with a matching name will have its value copied to the corresponding specified Stormpath account fields.</p>
  *
  * <h5>Example</h5>
  * <p>For example, assume that a mapping rule's {@code name} is {@code foo}, and the rule's
  * {@link #getAccountAttributes() accountAttributes} collection contains the Stormpath Account field names
  * of {@code givenName} and {@code surname}.</p>
- * <p>If an Attribute Statement named {@code foo} is encountered on login to have a value of {@code bar}, then
+ * <p>If a userInfo attribute named {@code foo} is encountered on login to have a value of {@code bar}, then
  * {@code bar} will automatically be copied to the specified Stormpath Account fields for that user.  This user would
  * then automatically have a {@code givenName} of {@code bar} and a {@code surname} of {@code bar}.</p>
  *
- * @since 1.0.RC8
+ * @since 1.3.0
  */
 public interface UserInfoMappingRule {
 
     /**
-     * Returns the SAML Attribute name, that when encountered, should have its value applied as Account field values.
-     * When this name is encountered when processing a SAML Attribute Statement, its associated value will be set as the
-     * value for all Stormpath Account field names specified in the
+     * Returns the UserInfo attribute name for a Social Provider, that when encountered, should have its value applied
+     * as Account field values.
+     * When this name is encountered when processing UserInfo from a Social Provider, its associated value will be set
+     * as the value for all Stormpath Account field names specified in the
      * {@link #getAccountAttributes() accountAttributes} collection.
      *
-     * @return SAML Attribute name, that when encountered, should have its value set on the
+     * @return UserInfo attribute name, that when encountered, should have its value set on the
      * {@link #getAccountAttributes() specified} Account fields.
      */
     String getName();
 
     /**
      * Returns the Stormpath account fields that should be updated when encountering {@link #getName() named}
-     * SAML Attribute name.  If discovered, that SAML Attribute value will be set on all of the Stormpath account
+     * UserInfo attribute name.  If discovered, that UserInfo attribute value will be set on all of the Stormpath account
      * fields named in this collection.
      *
      * @return the Stormpath account fields that should be updated when encountering {@link #getName() named}
-     * SAML Attribute name.
+     * UserInfo attribute name.
      */
     Set<String> getAccountAttributes();
 }

api/src/main/java/com/stormpath/sdk/provider/social/UserInfoMappingRuleBuilder.java

@@ -1,5 +1,5 @@
 /*
-* Copyright 2015 Stormpath, Inc.
+* Copyright 2016 Stormpath, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -33,18 +33,18 @@
 public interface UserInfoMappingRuleBuilder {
 
     /**
-     * Sets the SAML Attribute name, that when encountered, should have its value applied as Account field values.
-     * When this name is encountered when processing a SAML Attribute Statement, its associated value will be set as the
+     * Sets the UserInfo attribute name, that when encountered, should have its value applied as Account field values.
+     * When this name is encountered when processing UserInfo from a Social Provider, its associated value will be set as the
      * value for all Stormpath Account field names specified in the
      * {@link UserInfoMappingRule#getAccountAttributes() accountAttributes} collection.
      *
-     * @param name the SAML Attribute name that when encountered, should have its value applied as Account field values.
+     * @param name the UserInfo attribute name that when encountered, should have its value applied as Account field values.
      */
     UserInfoMappingRuleBuilder setName(String name);
 
     /**
      * Sets the Stormpath account fields that should be updated when encountering {@link UserInfoMappingRule#getName() named}
-     * field from the userInfo provided by the social provider.  If discovered, that SAML Attribute value will be set on
+     * field from the userInfo provided by the social provider.  If discovered, that UserInfo attribute value will be set on
      * all of the Stormpath account fields named in this collection.
      *
      * @param accountAttributes the account fields that should be updated when there's a match with a field name in userInfo
@@ -54,7 +54,7 @@ public interface UserInfoMappingRuleBuilder {
 
     /**
      * Sets the Stormpath account fields that should be updated when encountering {@link UserInfoMappingRule#getName() named}
-     * field from the userInfo provided by the social provider.  If discovered, that SAML Attribute value will be set on
+     * field from the userInfo provided by the social provider.  If discovered, that UserInfo attribute value will be set on
      * all of the Stormpath account fields named in this collection.
      *
      * @param accountAttributes the account fields that should be updated when there's a match with a field name in userInfo

api/src/main/java/com/stormpath/sdk/provider/social/UserInfoMappingRules.java

@@ -7,26 +7,34 @@
 
 import java.util.List;
 
+/**
+ * A collection of rules that indicates how a userInfo attribute from a Social Provider should populate one or more
+ * Stormpath Account field values.
+ * By creating rules, you configure which userInfo attribute values from the Social Provider should be copied to the
+ * Stormpath Account field values.
+ *
+ * <p> Also see {@link UserInfoMappingRule} </p>
+ *
+ * @since 1.3.0
+ */
 public interface UserInfoMappingRules extends Resource, Saveable, Auditable {
 
     /**
-     * Specifies the Set of all {@link UserInfoMappingRule}s that indicate how SAML Attribute Statements should
-     * populate one or more Stormpath Account field values after a successful SAML login.
+     * Specifies the Set of all {@link UserInfoMappingRule}s that indicate how UserInfo attribute should
+     * populate one or more Stormpath Account field values after a successful Social (provider) login.
      *
      * @param userInfoMappingRules the set of {@link UserInfoMappingRule userInfoMappingRules}s to build a Social provider.
      *
      * @return this instance for method chaining.
-     * @since 1.3.0
      */
     void setItems(List<UserInfoMappingRule> userInfoMappingRules);
 
     /**
-     * Returns the Set of all {@link UserInfoMappingRule}s that indicate how SAML Attribute Statements should
-     * populate one or more Stormpath Account field values after a successful SAML login.
+     * Returns the Set of all {@link UserInfoMappingRule}s that indicate how UserInfo attribute should
+     * populate one or more Stormpath Account field values after a successful Social (provider) login.
      *
-     * @return the Set of all {@link UserInfoMappingRule}s that indicate how SAML Attribute Statements should
-     * populate one or more Stormpath Account field values after a successful SAML login.
-     * @since 1.3.0
+     * @return the Set of all {@link UserInfoMappingRule}s that indicate how UserInfo attribute should
+     * populate one or more Stormpath Account field values after a successful Social (provider) login.
      */
     List<UserInfoMappingRule> getItems();
 }

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

@@ -44,7 +44,10 @@ import org.testng.annotations.Test
 import java.lang.reflect.Field
 import java.util.concurrent.TimeUnit
 
-import static org.testng.Assert.*
+import static org.testng.Assert.assertNull
+import static org.testng.Assert.assertTrue
+import static org.testng.Assert.fail
+
 /**
  *
  * @since 0.8.1

impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultFacebookCreateProviderRequestBuilder.java

@@ -35,7 +35,7 @@ protected CreateProviderRequest doBuild(Map<String, Object> map) {
         DefaultFacebookProvider provider = new DefaultFacebookProvider(null, map);
         provider.setClientId(super.clientId);
         provider.setClientSecret(super.clientSecret);
-        if(super.userInfoMappingRules != null) {
+        if (super.userInfoMappingRules != null) {
             provider.setUserInfoMappingRules(super.userInfoMappingRules);
         }
 

impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultGithubCreateProviderRequestBuilder.java

@@ -35,7 +35,7 @@ protected CreateProviderRequest doBuild(Map<String, Object> map) {
         DefaultGithubProvider provider = new DefaultGithubProvider(null, map);
         provider.setClientId(super.clientId);
         provider.setClientSecret(super.clientSecret);
-        if(super.userInfoMappingRules != null) {
+        if (super.userInfoMappingRules != null) {
             provider.setUserInfoMappingRules(super.userInfoMappingRules);
         }
         return new DefaultCreateProviderRequest(provider);

impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultGoogleCreateProviderRequestBuilder.java

@@ -48,7 +48,7 @@ protected CreateProviderRequest doBuild(Map<String, Object> map) {
         provider.setClientId(super.clientId);
         provider.setClientSecret(super.clientSecret);
         provider.setRedirectUri(this.redirectUri);
-        if(super.userInfoMappingRules != null) {
+        if (super.userInfoMappingRules != null) {
             provider.setUserInfoMappingRules(super.userInfoMappingRules);
         }
         return new DefaultCreateProviderRequest(provider);

impl/src/main/java/com/stormpath/sdk/impl/provider/DefaultLinkedInCreateProviderRequestBuilder.java

@@ -49,7 +49,7 @@ protected CreateProviderRequest doBuild(Map<String, Object> map) {
             provider.setRedirectUri(redirectUri);
         }
 
-        if(super.userInfoMappingRules != null) {
+        if (super.userInfoMappingRules != null) {
             provider.setUserInfoMappingRules(super.userInfoMappingRules);
         }
         return new DefaultCreateProviderRequest(provider);