Merge pull request #9 from rmamchyk/feat/AP-1515

chore: add composer scripts and readme

Author: robertsevernsentient

.gitignore

@@ -1,5 +1,7 @@
 /node_modules
 /vendor
+/docs
+/.phpdoc
 /.idea
 /php.ini
 .env

App/Beacon.php

@@ -2,13 +2,11 @@
 
 declare(strict_types=1);
 
-namespace App;
+namespace Evolv;
 
-use App\EvolvContext;
+use Evolv\EvolvContext;
 
 require __DIR__ . '/../vendor/autoload.php';
-require_once __DIR__ . '/EvolvStore.php';
-require_once __DIR__ . '/Beacon.php';
 
 const ENDPOINT_PATTERN = "/\/(v\d+)\/\w+\/([a-z]+)$/i";
 
@@ -31,8 +29,6 @@ private function send($payload) {
 
         $data = json_encode($payload);
 
-        echo $this->endpoint;
-
         $curl = curl_init();
 
         curl_setopt($curl, CURLOPT_URL, $this->endpoint);
@@ -45,22 +41,9 @@ private function send($payload) {
             "Content-Type: application/json",
         );
         curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
-
-        $data = <<<DATA
-        $data
-        DATA;
-
-        echo '<pre>';
-        print_r($data);
-        echo '</pre>';
-
         curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
 
-        $res = curl_exec($curl);
-
-        echo "<pre>";
-        print_r($res);
-        echo "</pre>";
+        curl_exec($curl);
 
         curl_close($curl);
 

App/EvolvClient.php

@@ -2,19 +2,13 @@
 
 declare(strict_types=1);
 
-namespace App;
+namespace Evolv;
 
-use App\EvolvContext;
-use App\EvolvStore;
-use App\Beacon;
-
-use function App\Utils\waitFor;
-use function App\Utils\emit;
+use function Evolv\Utils\waitFor;
+use function Evolv\Utils\emit;
+use Evolv\HttpClient;
 
 require __DIR__ . '/../vendor/autoload.php';
-require_once __DIR__ . '/EvolvStore.php';
-require_once __DIR__ . '/Beacon.php';
-require_once __DIR__ . '/Utils/waitForIt.php';
 
 class EvolvClient
 {
@@ -30,7 +24,13 @@ class EvolvClient
     private Beacon $contextBeacon;
     private Beacon $eventBeacon;
 
-    public function __construct(string $environment, string $endpoint = 'https://participants.evolv.ai/', bool $autoconfirm = true)
+    /**
+     * @param string $environment
+     * @param string $endpoint
+     * @param bool $autoconfirm
+     * @return object
+     */
+    public function __construct(string $environment, string $endpoint = 'https://participants.evolv.ai/',  bool $autoconfirm = true, $llist = false)
     {
         $this->context = new EvolvContext();
         $this->store = new EvolvStore($environment, $endpoint);
@@ -39,29 +39,33 @@ public function __construct(string $environment, string $endpoint = 'https://par
         $this->eventBeacon = new Beacon($endpoint . 'v1/' . $environment . '/events', $this->context);
 
         $this->autoconfirm = $autoconfirm;
+
     }
 
     /**
      * Initializes the client with required context information.
      *
-     * @param {String} uid A globally unique identifier for the current participant.
-     * @param {String} sid A globally unique session identifier for the current participant.
-     * @param {Object} remoteContext A map of data used for evaluating context predicates and analytics.
-     * @param {Object} localContext A map of data used only for evaluating context predicates.
+     * @param string $uid A globally unique identifier for the current participant.
+     * @param object $remoteContext A map of data used for evaluating context predicates and analytics.
+     * @param object $localContext A map of data used only for evaluating context predicates.
+     * @return array
      */
 
-    public function initialize(string $uid, array $remoteContext = [], array $localContext = [])
+    public function initialize(string $uid, array $remoteContext = [], array $localContext = [], $httpClient = null)
     {
+
         if ($this->initialized) {
             throw new \Exception('Evolv: Client is already initialized');
+            exit('Evolv: Client is already initialized');
         }
 
         if (!$uid) {
             throw new \Exception('Evolv: "uid" must be specified');
+            exit('Evolv: "uid" must be specified');
         }
 
         $this->context->initialize($uid, $remoteContext, $localContext);
-        $this->store->initialize($this->context);
+        $this->store->initialize($this->context, $httpClient);
 
         if ($this->autoconfirm) {
             $this->confirm();
@@ -113,10 +117,10 @@ public function initialize(string $uid, array $remoteContext = [], array $localC
      * * "contaminated" - Called when the consumer is contaminated (topic)
      * * "event.emitted" - Called when an event is emitted through the beacon (topic, type, score)
      *
-     * @param string topic The event topic on which the listener should be invoked.
-     * @param callable listener The listener to be invoked for the specified topic.
-     * @method
-     * @see {@link EvolvClient#once} for listeners that should only be invoked once.
+     * @param string $topic The event topic on which the listener should be invoked.
+     * @param callable $listener The listener to be invoked for the specified topic.
+     * @function
+     * @see  EvolvClient for listeners that should only be invoked once.
      */
     public function on(string $topic, callable $listener)
     {
@@ -126,9 +130,9 @@ public function on(string $topic, callable $listener)
     /**
      * Send an event to the events endpoint.
      *
-     * @param {String} type The type associated with the event.
-     * @param metadata {Object} Any metadata to attach to the event.
-     * @param flush {Boolean} If true, the event will be sent immediately.
+     * @param string $type The type associated with the event.
+     * @param object $metadata  Any metadata to attach to the event.
+     * @param boolean $flush If true, the event will be sent immediately.
      */
     public function emit(string $type, $metadata, bool $flush = false)
     {
@@ -143,10 +147,10 @@ public function emit(string $type, $metadata, bool $flush = false)
     /**
      * Check all active keys that start with the specified prefix.
      *
-     * @param {String} prefix The prefix of the keys to check.
+     * @param string $prefix The prefix of the keys to check.
      * @returns {SubscribablePromise.<Object|Error>} A SubscribablePromise that resolves to object
      * describing the state of active keys.
-     * @method
+     * @function
      */
     public function getActiveKeys(string $prefix = '', callable $listener = null)
     {
@@ -156,9 +160,9 @@ public function getActiveKeys(string $prefix = '', callable $listener = null)
     /**
      * Get the value of a specified key.
      *
-     * @param {String} key The key of the value to retrieve.
+     * @param string $key The key of the value to retrieve.
      * @returns @mixed A value of the specified key.
-     * @method
+     * @function
      */
     public function get(string $key = '', callable $listener = null)
     {
@@ -211,11 +215,11 @@ public function confirm()
             $this->context->update(['experiments' => ['confirmations' => $newConfirmations]]);
 
             foreach ($confirmableAllocations as $alloc) {
-                $this->eventBeacon->emit('confirmation', array_merge([
+                $this->eventBeacon->emit('confirmation', [
                     'uid' => $alloc['uid'],
                     'eid' => $alloc['eid'],
                     'cid' => $alloc['cid']
-                ], $this->context->remoteContext));
+                ]);
             };
 
             $this->eventBeacon->flush();
@@ -227,9 +231,9 @@ public function confirm()
      * Marks a consumer as unsuccessfully retrieving and / or applying requested values, making them ineligible for
      * inclusion in optimization statistics.
      *
-     * @param details {Object} Optional. Information on the reason for contamination. If provided, the object should
+     * @param  object $details Optional. Information on the reason for contamination. If provided, the object should
      * contain a reason. Optionally, a 'details' value should be included for extra debugging info
-     * @param {boolean} allExperiments If true, the user will be excluded from all optimizations, including optimization
+     * @param boolean $allExperiments If true, the user will be excluded from all optimizations, including optimization
      * not applicable to this page
      */
     public function contaminate($details, bool $allExperiments = false)
@@ -267,12 +271,12 @@ public function contaminate($details, bool $allExperiments = false)
         $this->context->update(['experiments' => ['contaminations' => $newContaminations]]);
 
         foreach ($contaminatableAllocations as $alloc) {
-            $this->eventBeacon->emit('contamination', array_merge([
+            $this->eventBeacon->emit('contamination', [
                 'uid' => $alloc['uid'],
                 'eid' => $alloc['eid'],
                 'cid' => $alloc['cid'],
                 'contaminationReason' => $details
-            ], $this->context->remoteContext));
+            ]);
         };
 
         $this->eventBeacon->flush();

App/EvolvContext.php

@@ -2,19 +2,19 @@
 
 declare(strict_types=1);
 
-namespace App;
+namespace Evolv;
 
-use function App\Utils\getValueForKey;
-use function App\Utils\setKeyToValue;
-use function App\Utils\removeValueForKey;
-use function App\Utils\emit;
-use function App\Utils\flatten;
+use function Evolv\Utils\getValueForKey;
+use function Evolv\Utils\setKeyToValue;
+use function Evolv\Utils\removeValueForKey;
+use function Evolv\Utils\emit;
+use function Evolv\Utils\flatten;
+
+require_once __DIR__ . '/Utils/flatten.php';
 require_once __DIR__ . '/Utils/getValueForKey.php';
 require_once __DIR__ . '/Utils/setKeyToValue.php';
 require_once __DIR__ . '/Utils/removeValueForKey.php';
 require_once __DIR__ . '/Utils/waitForIt.php';
-require_once __DIR__ . '/Utils/flatten.php';
-
 
 const CONTEXT_CHANGED = 'context.changed';
 const CONTEXT_INITIALIZED = 'context.initialized';
@@ -108,7 +108,7 @@ public function set(string $key, $value, bool $local = false): void
     /**
      * Retrieve a value from the context.
      *
-     * @param {String} key The kay associated with the value to retrieve.
+     * @param string $key The kay associated with the value to retrieve.
      * @returns {*} The value associated with the specified key.
      */
     public function get(string $key)
@@ -128,7 +128,7 @@ public function get(string $key)
      *
      * Note: This will cause the effective genome to be recomputed.
      *
-     * @param key {String} The key to remove from the context.
+     * @param  string $key  The key to remove from the context.
      */
     public function remove(string $key)
     {
@@ -151,8 +151,8 @@ public function remove(string $key)
      *
      * Note: This will cause the effective genome to be recomputed.
      *
-     * @param update {Object} The values to update the context with.
-     * @param local {Boolean} If true, the values will only be added to the localContext.
+     * @param array $update The values to update the context with.
+     * @param boolean $local If true, the values will only be added to the localContext.
      */
     public function update(array $update, $local = false) {
         $this->ensureInitialized();
@@ -187,8 +187,8 @@ public function update(array $update, $local = false) {
     /**
      * Checks if the specified key is currently defined in the context.
      *
-     * @param key The key to check.
-     * @returns {boolean} True if the key has an associated value in the context.
+     * @param $key The key to check.
+     * @returns bool True if the key has an associated value in the context.
      */
     public function contains(string $key)
     {
@@ -200,11 +200,11 @@ public function contains(string $key)
     /**
      * Adds value to specified array in context. If array doesnt exist its created and added to.
      *
-     * @param key The array to add to.
-     * @param value Value to add to the array.
-     * @param local {Boolean} If true, the value will only be added to the localContext.
-     * @param limit {Number} Max length of array to maintain.
-     * @returns {boolean} True if value was successfully added.
+     * @param string $key The array to add to.
+     * @param array $value Value to add to the array.
+     * @param bool $local {Boolean} If true, the value will only be added to the localContext.
+     * @param int $limit {Number} Max length of array to maintain.
+     * @returns boolean True if value was successfully added.
      */
     public function pushToArray(string $key, $value, $local = false, $limit = null)
     {