integrate user profile service (#98)

* add UserProfileService to Optimizely
* integrate user profile service into decision service
* remove old UserProfile.java
* add new UserProfile.java
* add Decision.java
* we no longer clean the user profile for the developers
* Remove ProjectValidationUtils.java and UserProfileUtilsTest.java

Author: wangjoshuah

core-api/src/main/java/com/optimizely/ab/Optimizely.java

@@ -1,25 +1,24 @@
-/**
- *
- *    Copyright 2016-2017, Optimizely and contributors
- *
- *    Licensed under the Apache License, Version 2.0 (the "License");
- *    you may not use this file except in compliance with the License.
- *    You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- *    Unless required by applicable law or agreed to in writing, software
- *    distributed under the License is distributed on an "AS IS" BASIS,
- *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *    See the License for the specific language governing permissions and
- *    limitations under the License.
- */
+/****************************************************************************
+ * Copyright 2016-2017, Optimizely, Inc. and contributors                   *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
 package com.optimizely.ab;
 
 import com.optimizely.ab.annotations.VisibleForTesting;
 import com.optimizely.ab.bucketing.Bucketer;
 import com.optimizely.ab.bucketing.DecisionService;
-import com.optimizely.ab.bucketing.UserProfile;
+import com.optimizely.ab.bucketing.UserProfileService;
 import com.optimizely.ab.config.Attribute;
 import com.optimizely.ab.config.EventType;
 import com.optimizely.ab.config.Experiment;
@@ -40,7 +39,6 @@
 import com.optimizely.ab.event.internal.payload.Event.ClientEngine;
 import com.optimizely.ab.internal.EventTagUtils;
 import com.optimizely.ab.internal.ReservedEventKey;
-import com.optimizely.ab.internal.UserProfileUtils;
 import com.optimizely.ab.notification.NotificationBroadcaster;
 import com.optimizely.ab.notification.NotificationListener;
 import org.slf4j.Logger;
@@ -92,26 +90,26 @@ public class Optimizely {
     @VisibleForTesting final EventHandler eventHandler;
     @VisibleForTesting final ErrorHandler errorHandler;
     @VisibleForTesting final NotificationBroadcaster notificationBroadcaster = new NotificationBroadcaster();
-    @Nullable private final UserProfile userProfile;
+    @Nullable private final UserProfileService userProfileService;
 
     private Optimizely(@Nonnull ProjectConfig projectConfig,
                        @Nonnull DecisionService decisionService,
                        @Nonnull EventHandler eventHandler,
                        @Nonnull EventBuilder eventBuilder,
                        @Nonnull ErrorHandler errorHandler,
-                       @Nullable UserProfile userProfile) {
+                       @Nullable UserProfileService userProfileService) {
         this.projectConfig = projectConfig;
         this.decisionService = decisionService;
         this.eventHandler = eventHandler;
         this.eventBuilder = eventBuilder;
         this.errorHandler = errorHandler;
-        this.userProfile = userProfile;
+        this.userProfileService = userProfileService;
     }
 
     // Do work here that should be done once per Optimizely lifecycle
     @VisibleForTesting
     void initialize() {
-        UserProfileUtils.cleanUserProfiles(userProfile, projectConfig);
+
     }
 
     //======== activate calls ========//
@@ -506,11 +504,10 @@ private static ProjectConfig getProjectConfig(String datafile) throws ConfigPars
     }
 
     @Nullable
-    public UserProfile getUserProfile() {
-        return userProfile;
+    public UserProfileService getUserProfileService() {
+        return userProfileService;
     }
 
-
     //======== Notification listeners ========//
 
     /**
@@ -709,7 +706,7 @@ public static class Builder {
         private ClientEngine clientEngine;
         private String clientVersion;
         private ProjectConfig projectConfig;
-        private UserProfile userProfile;
+        private UserProfileService userProfileService;
 
         public Builder(@Nonnull String datafile,
                        @Nonnull EventHandler eventHandler) {
@@ -732,8 +729,8 @@ public Builder withErrorHandler(ErrorHandler errorHandler) {
             return this;
         }
 
-        public Builder withUserProfile(UserProfile userProfile) {
-            this.userProfile = userProfile;
+        public Builder withUserProfileService(UserProfileService userProfileService) {
+            this.userProfileService = userProfileService;
             return this;
         }
 
@@ -775,9 +772,6 @@ public Optimizely build() throws ConfigParseException {
                 clientVersion = BuildVersionInfo.VERSION;
             }
 
-            if (decisionService == null) {
-                decisionService = new DecisionService(bucketer, projectConfig, userProfile);
-            }
 
             if (eventBuilder == null) {
                 eventBuilder = new EventBuilderV2(clientEngine, clientVersion);
@@ -787,7 +781,11 @@ public Optimizely build() throws ConfigParseException {
                 errorHandler = new NoOpErrorHandler();
             }
 
-            Optimizely optimizely = new Optimizely(projectConfig, decisionService, eventHandler, eventBuilder, errorHandler, userProfile);
+            if (decisionService == null) {
+                decisionService = new DecisionService(bucketer, errorHandler, projectConfig, userProfileService);
+            }
+
+            Optimizely optimizely = new Optimizely(projectConfig, decisionService, eventHandler, eventBuilder, errorHandler, userProfileService);
             optimizely.initialize();
             return optimizely;
         }

core-api/src/main/java/com/optimizely/ab/OptimizelyRuntimeException.java

@@ -23,6 +23,10 @@ public class OptimizelyRuntimeException extends RuntimeException {
 
     public OptimizelyRuntimeException() { }
 
+    public OptimizelyRuntimeException(Exception exception) {
+        super(exception);
+    }
+
     public OptimizelyRuntimeException(String message) {
         super(message);
     }

core-api/src/main/java/com/optimizely/ab/bucketing/Decision.java

@@ -0,0 +1,58 @@
+/****************************************************************************
+ * Copyright 2017, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+package com.optimizely.ab.bucketing;
+
+import javax.annotation.Nonnull;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * A class representing a stored decision.
+ */
+public class Decision {
+
+    /** The ID of the {@link com.optimizely.ab.config.Variation} the user was bucketed into. */
+    @Nonnull public String variationId;
+
+    /**
+     * Initialize a Decision object.
+     * @param variationId The ID of the variation the user was bucketed into.
+     */
+    public Decision(@Nonnull String variationId) {
+        this.variationId = variationId;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        Decision decision = (Decision) o;
+
+        return variationId.equals(decision.variationId);
+    }
+
+    @Override
+    public int hashCode() {
+        return variationId.hashCode();
+    }
+
+    public Map<String, String> toMap() {
+        Map<String, String> decisionMap = new HashMap<String, String>(1);
+        decisionMap.put(UserProfileService.variationIdKey, variationId);
+        return decisionMap;
+    }
+}