LiveEngageLaravel::retrieveHistory() - Code Metrics - Inspection of "Updates to the library." - LivePersonInc/LiveEngageLaravel - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Branch — master (901d12)

by Robert
created 2018-06-12 21:44 UTC
LiveEngageLaravel::retrieveHistory() B

↳ Parent: LiveEngageLaravel
Complexity

Conditions	4
Paths	4
Size

Total Lines	26
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	26
c	0
b	0
f	0
rs	8.5806
cc	4
eloc	15
nc	4
nop	3
<?php

namespace LivePersonInc\LiveEngageLaravel;

use Carbon\Carbon;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Subscriber\Oauth\Oauth1;
use LivePersonInc\LiveEngageLaravel\Models\Info;
use LivePersonInc\LiveEngageLaravel\Models\Payload;
use LivePersonInc\LiveEngageLaravel\Models\Visitor;
use LivePersonInc\LiveEngageLaravel\Models\Campaign;
use LivePersonInc\LiveEngageLaravel\Models\Engagement;
use LivePersonInc\LiveEngageLaravel\Models\Conversation;
use LivePersonInc\LiveEngageLaravel\Collections\EngagementHistory;
use LivePersonInc\LiveEngageLaravel\Exceptions\LiveEngageException;
use LivePersonInc\LiveEngageLaravel\Collections\ConversationHistory;

class LiveEngageLaravel
{
    private $account = false;
    private $results = [];
    private $skills = [];
    private $next = false;
    private $prev = false;
    private $start;
    private $end;
    private $config = 'services.liveperson.default';
    private $version = '1.0';
    private $history_limit = 50;
    private $history = false;
    private $context = 'interactionHistoryRecords';
    private $interactive = true;
    private $ended = true;

    private $domain = false;

    private $retry_limit = 5;
    private $retry_counter = 0;

    public function __get($attribute)
    {
        return $this->$attribute;
    }

    public function __set($attribute, $value)
    {
        return $this->$attribute = $value;
    }

    public function __construct()
    {
        $this->account = config("{$this->config}.account");
        $this->domain = config("{$this->config}.domain");
        $this->version = config("{$this->config}.version") ?: $this->version;
    }

    public function key($key = 'default')
    {
        $this->config = "services.liveperson.$key";

        return $this;
    }
    
    public function nonInteractive()
    {
	    $this->interactive = false;
	    return $this;
    }
    
    public function active()
    {
	    $this->ended = false;
	    return $this;
    }

    public function limit($limit)
    {
        $this->history_limit = $limit;

        return $this;
    }

    public function skills($skills)
    {
        $this->skills = $skills;

        return $this;
    }

    public function retry($limit)
    {
        $this->retry_limit = $limit;

        return $this;
    }

    public function get()
    {
        return $this->results;
    }

    public function account($accountid)
    {
        $this->account = $accountid;

        return $this;
    }

    public function domain($service)
    {
        $response = $this->request("https://api.liveperson.net/api/account/{$this->account}/service/{$service}/baseURI.json?version={$this->version}", 'GET');
        if (is_a($response, 'Exception')) {
        if (is_a(/** @scrutinizer ignore-type */ $response, 'Exception')) {
            throw new \Exception('Unable to get LivePerson account domain', 101);
        } else {
            $this->domain = $response->baseURI;

            return $this;
        }
    }

    public function visitor($visitorID, $sessionID, $setData = false)
    {
        if (! $this->domain) {
            $this->domain('smt');
        }

        if ($setData) {
            $url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/events?v=1&sid={$sessionID}";

            return $this->request($url, 'POST', $setData);
        } else {
            $url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/state?v=1&sid={$sessionID}";

            return $this->request($url, 'GET');
        }
    }

    public function agentStatus()
    {
        if (! $this->domain) {
            $this->domain('msgHist');
        }

        $url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/agent-view/status";

        return $this->request($url, 'POST', new Payload(['skillIds' => $this->skills]));
    }

    final public function retrieveHistory(Carbon $start, Carbon $end, $url = false)
    {
        if (! $this->domain) {
            $this->domain('engHistDomain');
        }

        $url = $url ?: "https://{$this->domain}/interaction_history/api/account/{$this->account}/interactions/search?limit={$this->history_limit}&offset=0";

        $start_str = $start->toW3cString();
        $end_str = $end->toW3cString();

        $data = [
            'interactive' => $this->interactive,
            'ended' => $this->ended,
            'start' => [
                'from' => strtotime($start_str).'000',
                'to' => strtotime($end_str).'000',
            ],
        ];
        if (count($this->skills)) {
            $data['skillIds'] = $this->skills;
        }

        $data = new Payload($data);

        return $this->request($url, 'POST', $data);
    }

    final public function retrieveMsgHistory(Carbon $start, Carbon $end, $url = false)
    {
        if (! $this->domain) {
            $this->domain('msgHist');
        }

        $url = $url ?: "https://{$this->domain}/messaging_history/api/account/{$this->account}/conversations/search?limit={$this->history_limit}&offset=0";

        $start_str = $start->toW3cString();
        $end_str = $end->toW3cString();

        $data = [
            'interactive' => $this->interactive,
            'ended' => $this->ended,
            'start' => [
                'from' => strtotime($start_str).'000',
                'to' => strtotime($end_str).'000',
            ],
        ];
        if (count($this->skills)) {
            $data['skillIds'] = $this->skills;
        }

        $data = new Payload($data);

        return $this->request($url, 'POST', $data);
    }

    public function messagingHistory(Carbon $start = null, Carbon $end = null)
    {
        $this->retry_counter = 0;

        $start = $start ?: (new Carbon())->today();
        $end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);

        $this->start = $start;
        $this->end = $end;

        $results_object = $this->retrieveMsgHistory($start, $end);
        $results = $results_object->conversationHistoryRecords;

        if (property_exists($results_object->_metadata, 'next')) {

            $this->next = $results_object->_metadata->next->href;
        }
        if (property_exists($results_object->_metadata, 'prev')) {
            $this->prev = $results_object->_metadata->prev->href;
        }

        $history = [];
        foreach ($results as $item) {
            if (property_exists($item, 'info')) {
                $item->info = new Info((array) $item->info);
            }

            if (property_exists($item, 'visitorInfo')) {
                $item->visitorInfo = new Visitor((array) $item->visitorInfo);
            }

            if (property_exists($item, 'campaign')) {
                $item->campaign = new Campaign((array) $item->campaign);
            }

            $history[] = new Conversation((array) $item);
        }

        return new ConversationHistory($history, $this);
    }

    public function history(Carbon $start = null, Carbon $end = null)
    {
        $this->retry_counter = 0;

        $start = $start ?: (new Carbon())->today();
        $end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);

        $this->start = $start;
        $this->end = $end;

        $results_object = $this->retrieveHistory($start, $end);
        $results = $results_object->interactionHistoryRecords;

        if (property_exists($results_object->_metadata, 'next')) {

            $this->next = $results_object->_metadata->next->href;
        }
        if (property_exists($results_object->_metadata, 'prev')) {
            $this->prev = $results_object->_metadata->prev->href;
        }

        $history = [];
        foreach ($results as $item) {
            if (property_exists($item, 'info')) {
                $item->info = new Info((array) $item->info);
            }

            if (property_exists($item, 'visitorInfo')) {
                $item->visitorInfo = new Visitor((array) $item->visitorInfo);
            }

            if (property_exists($item, 'campaign')) {
                $item->campaign = new Campaign((array) $item->campaign);
            }

            $history[] = new Engagement((array) $item);
        }
        
        $collection = new EngagementHistory($history, $this);
        $collection->metaData = $results_object->_metadata;

        
        return $collection;
    }

    private function request($url, $method, $payload = false)
    {
        $consumer_key = config("{$this->config}.key");
        $consumer_secret = config("{$this->config}.secret");
        $token = config("{$this->config}.token");
        $secret = config("{$this->config}.token_secret");

        $stack = HandlerStack::create();
        $auth = new Oauth1([
            'consumer_key'    => $consumer_key,
            'consumer_secret' => $consumer_secret,
            'token'           => $token,
            'token_secret'    => $secret,
            'signature_method'=> Oauth1::SIGNATURE_METHOD_HMAC,
        ]);
        $stack->push($auth);

        $client = new Client([
            'handler' => $stack,
        ]);

        $args = [
            'auth' => 'oauth',
            'headers' => [
                'content-type' => 'application/json',
            ],
        ];

        if ($payload !== false) {
            $args['body'] = json_encode($payload);
        }

        try {
            $res = $client->request($method, $url, $args);

            $response = json_decode($res->getBody());
        } catch (\GuzzleHttp\Exception\ConnectException $connection) {
            return $connection;
        } catch (\Exception $e) {
            if ($this->retry_counter < $this->retry_limit || $this->retry_limit == -1) {
                usleep(1500);
                $this->retry_counter++;
                $response = $this->request($url, $payload);
            } else {
                throw $e; //new LiveEngageException("Retry limit has been exceeded ($this->retry_limit)", 100);
            }
        }

        return $response;
    }
}

LivePersonInc / LiveEngageLaravel

Branch — master (901d12)

LiveEngageLaravel::retrieveHistory() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
