Merge pull request #9 from optimizely/devel

Merge into master

Author: aliabbasrizvi

CONTRIBUTING.md

@@ -17,7 +17,27 @@ We welcome contributions and feedback! All contributors must sign our [Contribut
 
 ##License
 
-By contributing your code, you agree to license your contribution under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
+All contributions are under the CLA mentioned above. For this project, Optimizely uses the Apache 2.0 license, and so asks that by contributing your code, you agree to license your contribution under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). Your contributions should also include the following header:
+
+```
+/**
+ * Copyright YEAR, 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.
+ */
+```
+
+The YEAR above should be the year of the contribution. If work on the file has been done over multiple years, list each year in the section above. Example: Optimizely writes the file and releases it in 2014. No changes are made in 2015. Change made in 2016. YEAR should be “2014, 2016”.
 
 ##Contact
 If you have questions, please contact [email protected].

src/Optimizely/Bucketer.php

@@ -15,8 +15,10 @@
  * limitations under the License.
  */
 namespace Optimizely;
+use Monolog\Logger;
 use Optimizely\Entity\Experiment;
 use Optimizely\Entity\Variation;
+use Optimizely\Logger\LoggerInterface;
 
 /**
  * Class Bucketer
@@ -45,6 +47,20 @@ class Bucketer
      */
     private static $MAX_HASH_VALUE = 0x100000000;
 
+    /**
+     * @var LoggerInterface Logger for logging messages.
+     */
+    private $_logger;
+
+    /**
+     * Bucketer constructor.
+     * @param LoggerInterface $logger
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->_logger = $logger;
+    }
+
     /**
      * Generate a hash value to be used in determining which variation the user will be put in.
      *
@@ -82,8 +98,8 @@ private function findBucket($userId, $parentId, $trafficAllocations)
     {
         // Generate bucketing ID based on combination of user ID and experiment ID or group ID.
         $bucketingId = $userId.$parentId;
-
         $bucketingNumber = $this->generateBucketValue($bucketingId);
+        $this->_logger->log(Logger::DEBUG, sprintf('Assigned bucket %s to user "%s".', $bucketingNumber, $userId));
 
         forEach ($trafficAllocations as $trafficAllocation)
         {
@@ -113,9 +129,15 @@ public function bucket(ProjectConfig $config, Experiment $experiment, $userId)
 
         // Check if user is whitelisted for a variation.
         $forcedVariations = $experiment->getForcedVariations();
-        if (!is_null($forcedVariations) and isset($forcedVariations[$userId])) {
+        if (!is_null($forcedVariations) && isset($forcedVariations[$userId])) {
             $variationKey = $forcedVariations[$userId];
             $variation = $config->getVariationFromKey($experiment->getKey(), $variationKey);
+            if ($variationKey) {
+                $this->_logger->log(
+                    Logger::INFO,
+                    sprintf('User "%s" is forced in variation "%s".', $userId, $variationKey)
+                );
+            }
             return $variation;
         }
 
@@ -129,21 +151,37 @@ public function bucket(ProjectConfig $config, Experiment $experiment, $userId)
 
             $userExperimentId = $this->findBucket($userId, $group->getId(), $group->getTrafficAllocation());
             if (is_null($userExperimentId)) {
+                $this->_logger->log(Logger::INFO, sprintf('User "%s" is in no experiment.', $userId));
                 return new Variation();
             }
 
             if ($userExperimentId != $experiment->getId()) {
+                $this->_logger->log(
+                    Logger::INFO,
+                    sprintf('User "%s" is not in experiment %s of group %s.',
+                        $userId, $experiment->getKey(), $experiment->getGroupId()
+                    ));
                 return new Variation();
             }
+
+            $this->_logger->log(Logger::INFO,
+                sprintf('User "%s" is in experiment %s of group %s.',
+                    $userId, $experiment->getKey(), $experiment->getGroupId()
+                ));
         }
 
         // Bucket user if not in whitelist and in group (if any).
         $variationId = $this->findBucket($userId, $experiment->getId(), $experiment->getTrafficAllocation());
         if (!is_null($variationId)) {
             $variation = $config->getVariationFromId($experiment->getKey(), $variationId);
+            $this->_logger->log(Logger::INFO,
+                sprintf('User "%s" is in variation %s of experiment %s.',
+                    $userId, $variation->getKey(), $experiment->getKey()
+                ));
             return $variation;
         }
 
+        $this->_logger->log(Logger::INFO,  sprintf('User "%s" is in no variation.', $userId));
         return new Variation();
     }
 }

src/Optimizely/Entity/Audience.php

@@ -34,6 +34,11 @@ class Audience
      */
     private $_conditions;
 
+    /**
+     * @var array De-serialized audience conditions
+     */
+    private $_conditionsList;
+
 
     public function __construct($id = null, $name = null, $conditions = null) {
         $this->_id = $id;
@@ -88,4 +93,20 @@ public function setConditions($conditions)
     {
         $this->_conditions = $conditions;
     }
+
+    /**
+     * @return array De-serialized audience conditions.
+     */
+    public function getConditionsList()
+    {
+        return $this->_conditionsList;
+    }
+
+    /**
+     * @param $conditionsList array De-serialized audience conditions.
+     */
+    public function setConditionsList($conditionsList)
+    {
+        $this->_conditionsList = $conditionsList;
+    }
 }

src/Optimizely/Entity/Experiment.php

@@ -21,6 +21,16 @@
 
 class Experiment
 {
+    /**
+     * @const string String denoting running state of experiment.
+     */
+    const STATUS_RUNNING = 'Running';
+
+    /**
+     * @const string String denoting policy of mutually exclusive group.
+     */
+    const MUTEX_GROUP_POLICY = 'random';
+
     /**
      * @var string Experiment ID.
      */
@@ -204,7 +214,7 @@ public function getForcedVariations()
      */
     public function setForcedVariations($forcedVariations)
     {
-        $this->_forcedVariations = get_object_vars($forcedVariations);
+        $this->_forcedVariations = $forcedVariations;
     }
 
     /**
@@ -262,6 +272,28 @@ public function setTrafficAllocation($trafficAllocation)
      */
     public function isInMutexGroup()
     {
-        return !is_null($this->_groupPolicy) && $this->_groupPolicy == 'random';
+        return !is_null($this->_groupPolicy) && $this->_groupPolicy == self::MUTEX_GROUP_POLICY;
+    }
+
+    /**
+     * Determine if experiment is running or not.
+     *
+     * @return boolean True if experiment has status "Running". False otherwise.
+     */
+    public function isExperimentRunning()
+    {
+        return !is_null($this->_status) && $this->_status == self::STATUS_RUNNING;
+    }
+
+    /**
+     * Determine if user is in forced variation of experiment.
+     *
+     * @param $userId string ID of the user.
+     * @return boolean True if user is in forced variation of experiment. False otherwise.
+     */
+    public function isUserInForcedVariation($userId)
+    {
+        $forcedVariations = $this->getForcedVariations();
+        return !is_null($forcedVariations) && isset($forcedVariations[$userId]);
     }
 }

src/Optimizely/Event/Builder/EventBuilder.php

@@ -38,12 +38,12 @@ class EventBuilder
     /**
      * @var string URL to send impression event to.
      */
-    private static $IMPRESSION_ENDPOINT = 'https://p13nlog.dz.optimizely.com/log/decision';
+    private static $IMPRESSION_ENDPOINT = 'https://logx.optimizely.com/log/decision';
 
     /**
      * @var string URL to send conversion event to.
      */
-    private static $CONVERSION_ENDPOINT = 'https://p13nlog.dz.optimizely.com/log/event';
+    private static $CONVERSION_ENDPOINT = 'https://logx.optimizely.com/log/event';
 
     /**
      * @var string HTTP method to be used when making call to log endpoint.