LiveEngageLaravel::requestV2() - Code Metrics - Inspection of "Test enhancements and doc updates." - LivePersonInc/LiveEngageLaravel - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 074c96...5e6d2b )

by Robert
created 2018-06-27 20:00 UTC
LiveEngageLaravel::requestV2() A

↳ Parent: LiveEngageLaravel
Complexity

Conditions	2
Paths	2
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	9
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	22
ccs	9
cts	9
cp	1
rs	9.568
c	0
b	0
f	0
cc	2
nc	2
nop	4
crap	2
<?php
/**
 * Root class file for all api wrappers.
 *
 */
 
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\MetaData;
use LivePersonInc\LiveEngageLaravel\Models\AccountStatus;
use LivePersonInc\LiveEngageLaravel\Models\MessagingInfo;
use LivePersonInc\LiveEngageLaravel\Models\Payload;
use LivePersonInc\LiveEngageLaravel\Models\Visitor;
use LivePersonInc\LiveEngageLaravel\Models\Agent;
use LivePersonInc\LiveEngageLaravel\Models\Skill;
use LivePersonInc\LiveEngageLaravel\Models\Campaign;
use LivePersonInc\LiveEngageLaravel\Models\Engagement;
use LivePersonInc\LiveEngageLaravel\Models\Conversation;
use LivePersonInc\LiveEngageLaravel\Models\Message;
use LivePersonInc\LiveEngageLaravel\Collections\EngagementHistory;
use LivePersonInc\LiveEngageLaravel\Collections\Skills;
use LivePersonInc\LiveEngageLaravel\Collections\AgentParticipants;
use LivePersonInc\LiveEngageLaravel\Exceptions\LiveEngageException;
use LivePersonInc\LiveEngageLaravel\Collections\ConversationHistory;

/**
 * LiveEngageLaravel class holds all of the root package functions.
 *
 * All "setting" functions will return `$this` so method can be chained. Most methods will return a class object or Laravel collection.
 */
class LiveEngageLaravel
{
	/**
	 * account - LiveEngage account number, usually set by configuration
	 * 
	 * (default value: false)
	 * 
	 * @var long
filter:
    dependency_paths: ["lib/*"]
	 * @access private
	 */
	private $account = false;
	/**
	 * skills - holds the skills for history retrieval
	 * 
	 * (default value: [])
	 * 
	 * @var array
	 * @access private
	 */
	private $skills = [];
	/**
	 * config - holds the configuration key where keyset is stored in config/services.php
	 * 
	 * (default value: 'services.liveperson.default')
	 * 
	 * @var string
	 * @access private
	 */
	private $config = 'services.liveperson.default';
	/**
	 * version - api version
	 * 
	 * (default value: '1.0')
	 * 
	 * @var string
	 * @access private
	 */
	private $version = '1.0';
	/**
	 * history_limit - stores the history page limit
	 * 
	 * (default value: 50)
	 * 
	 * @var int
	 * @access private
	 */
	private $history_limit = 50;
	private $interactive = true;
	private $ended = true;
	/**
	 * bearer - bearer token for V2 authentication
	 * 
	 * (default value: false)
	 * 
	 * @var string
	 * @access private
	 */
	private $bearer = false;
	/**
	 * revision
	 * 
	 * (default value: 0)
	 * 
	 * @var int
	 * @access private
	 */
	private $revision = 0;

	/**
	 * domain - api domain storage
	 * 
	 * (default value: false)
	 * 
	 * @var bool
	 * @access private
	 */
	private $domain = false;

	/**
	 * retry_limit - number of times the request will attempt before it throws the exception.
	 * 
	 * (default value: 5)
	 * 
	 * @var int
	 * @access private
	 */
	private $retry_limit = 5;
	/**
	 * retry_counter - stores current count of retries.
	 * 
	 * (default value: 0)
	 * 
	 * @var int
	 * @access private
	 */
	private $retry_counter = 0;

	/**
	 * __get magic function to retrieve private properties of the class.
	 * 
	 * @access public
	 * @param mixed $attribute
	 * @return mixed
	 */
	public function __get($attribute)
	{
		return $this->$attribute;
	}

	/**
	 * __construct function.
	 * 
	 * @access public
	 * @return void
	 */
	public function __construct()
	{
		$this->account = config("{$this->config}.account");
		//$this->domain = config("{$this->config}.domain");
		$this->version = config("{$this->config}.version") ?: $this->version;
	}

	/**
	 * key function sets the keyset the class should use. Setting this once will be stored for script execution, but not for the session.
	 * 
	 * @access public
	 * @param string $key (default: 'default')
	 * @return this
	 */
	public function key($key = 'default')
	{
		$this->config = "services.liveperson.$key";
		$this->__construct();

		return $this;
	}
	
	/**
	 * nonInteractive function.
	 * 
	 * @access public
	 * @return void
	 */
	public function nonInteractive()
	{
		$this->interactive = false;
		return $this;

	}
	
	/**
	 * active function.
	 * 
	 * @access public
	 * @return void
	 */
	public function active()
	{
		$this->ended = false;
		return $this;

	}

	/**
	 * limit function.
	 * 
	 * @access public
	 * @param mixed $limit
	 * @return void
	 */
	public function limit($limit)
	{
		$this->history_limit = $limit;

		return $this;

	}

	/**
	 * retry function.
	 * 
	 * @access public
	 * @param mixed $limit
	 * @return void
	 */
	public function retry($limit)
	{
		$this->retry_limit = $limit;

		return $this;

	}

	/**
	 * account function.
	 * 
	 * @access public
	 * @param mixed $accountid
	 * @return void
	 */
	public function account($accountid)
	{
		$this->account = $accountid;

		return $this;

	}

	/**
	 * domain function sets the LivePerson domain for the secified service. Like `key` it is set for the execution script, but not session. It must be run each time.
	 * 
	 * @access public
	 * @param mixed $service
	 * @return this
	 */
	public function domain($service)
	{
		$response = $this->requestV1("https://api.liveperson.net/api/account/{$this->account}/service/{$service}/baseURI.json?version={$this->version}", 'GET');
		
		$this->domain = $response->baseURI;

		return $this;
	}

	/**
	 * visitor function gets or sets visitor attribute information - this only works for CHAT, not messaging.
	 * 
	 * @access public
	 * @param string $visitorID
	 * @param string $sessionID
	 * @param mixed $setData (default: false)
	 * @return mixed
	 * @codeCoverageIgnore
	 */
	public function visitor($visitorID, $sessionID, $setData = false)
	{
		$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->requestV1($url, 'POST', $setData);
		} else {
			$url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/state?v=1&sid={$sessionID}";

			return $this->requestV1($url, 'GET');
		}
	}
	
	/**
	 * chat function
	 *
     * @codeCoverageIgnore
     *
     * @todo connect this to the server chat api - this function currently does nothing.
     */
	public function chat()
	{
		$this->domain('conversationVep');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/chat/request?v=1&NC=true";
		
		$args = [
			
		];
		$payload = new Payload($args);
		
		$response = $this->requestV1($url, 'POST', $payload);
		$response = $this->requestV1($url, 'POST', /** @scrutinizer ignore-type */ $payload);
		
		return $response;
	}

	/**
	 * retrieveHistory function.
	 * 
	 * @access public
	 * @final
	 * @param Carbon $start
	 * @param Carbon $end
	 * @param string $url (default: false)
	 * @return mixed
	 */
	final public function retrieveHistory(Carbon $start, Carbon $end, $url = false)
	{
		$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 = new Payload([
			'interactive' => $this->interactive,
			'ended' => $this->ended,
			'start' => [
				'from' => strtotime($start_str) . '000',
				'to' => strtotime($end_str) . '000',
			],
			'skillIds' => $this->skills
		]);

		return $this->requestV1($url, 'POST', $data);
		return $this->requestV1($url, 'POST', /** @scrutinizer ignore-type */ $data);
	}

	/**
	 * retrieveMsgHistory function.
	 * 
	 * @access public
	 * @final
	 * @param Carbon $start
	 * @param Carbon $end
	 * @param string $url (default: false)
	 * @return mixed
	 */
	final public function retrieveMsgHistory(Carbon $start, Carbon $end, $url = false)
	{
		$this->domain('msgHist');

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

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

		$data = new Payload([
			'status' => $this->ended ? ['CLOSE'] : ['OPEN', 'CLOSE'],
			'start' => [
				'from' => strtotime($start_str) . '000',
				'to' => strtotime($end_str) . '000',
			],
			'skillIds' => $this->skills
		]);
		
		return $this->requestV1($url, 'POST', $data);
		return $this->requestV1($url, 'POST', /** @scrutinizer ignore-type */ $data);
	}
	
	/**
	 * skills function gets collection of skills associated with the account.
	 * 
	 * @access public
	 * @return Collections\Skills
	 */
	public function skills()
	{
		$this->domain('accountConfigReadOnly');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/skills?v=4.0";
		
		return new Skills($this->requestV2($url, 'GET'));
		return new Skills(/** @scrutinizer ignore-type */ $this->requestV2($url, 'GET'));
	}
	
	/**
	 * getSkill function gets skill object based on ID.
	 * 
	 * @access public
	 * @param int $skillId
	 * @return Models\Skill
	 */
	public function getSkill($skillId)
	{
		$this->domain('accountConfigReadOnly');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/skills/{$skillId}?v=4.0";
		
		return new Skill((array) $this->requestV2($url, 'GET'));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
	}
	
	/**
	 * getAgent function gets agent object based on ID.
	 * 
	 * @access public
	 * @param int $userId
	 * @return Models\Agent
	 */
	public function getAgent($userId)
	{
		$this->domain('accountConfigReadOnly');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/users/{$userId}?v=4.0";
		
		return new Agent((array) $this->requestV2($url, 'GET'));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
	}
	
	/**
	 * updateAgent function.
	 * 
	 * @access public
	 * @param mixed $userId
	 * @param mixed $properties
	 * @return void
	 * @codeCoverageIgnore
	 */
	public function updateAgent($userId, $properties)
	{
		$agent = $this->getAgent($userId);

		
		$this->domain('accountConfigReadWrite');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/users/{$userId}?v=4.0";
		$headers = [
			'X-HTTP-Method-Override' => 'PUT',
			'if-Match' => '*'
		];
		
		return new Agent((array) $this->requestV2($url, 'PUT', $properties, $headers));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
	}
	
	/**
	 * agents function gets collection of agents from account.
	 * 
	 * @access public
	 * @return Collections\AgentParticipants
	 */
	public function agents()
	{
		$this->domain('accountConfigReadOnly');
		
		$select = implode(',', [
			'id',
			'pid',
			'deleted',
			'loginName',
			'skills',
			'nickname',
			'dateCreated',
			'userTypeId',
			'isApiUser',
			'profileIds',
			'permissionGroups',
			'allowedAppKeys',
			'changePwdNextLogin',
			'maxChats',
			'skillIds',
			'lpaCreatedUser',
			'email',
			'lobs',
			'profiles',
			'fullName',
			'employeeId',
			'managedAgentGroups',
			'dateUpdated',
			'isEnabled',
			'lastPwdChangeDate'
		]);
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/users?v=4.0&select=$select";
		
		return new AgentParticipants($this->requestV2($url, 'GET'));
		return new AgentParticipants(/** @scrutinizer ignore-type */ $this->requestV2($url, 'GET'));
	}
	
	/**
	 * getAgentStatus function gets status of agents based on provided Skill IDs.
	 * 
	 * @access public
	 * @param int/array $skills

	 * @return Collections\AgentParticipants
	 */
	public function getAgentStatus($skills)
	{
		$skills = is_array($skills) ? $skills : [$skills];
	
		$this->domain('msgHist');
		
		$url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/agent-view/status";
		
		$data = ['skillIds' => $skills];
		
		$response = $this->requestV1($url, 'POST', $data);
		$collection = new AgentParticipants($response->agentStatusRecords);
		$collection->metaData = new MetaData((array) $response->_metadata);
		
		return $collection;
		
	}
	
	/**
	 * conversationHistory function.
	 * 
	 * @access public
	 * @param Carbon $start (default: null)
	 * @param Carbon $end (default: null)
	 * @param int/array $skills (default: [])

	 * @return Collections\ConversationHistory
	 */
	public function conversationHistory(Carbon $start = null, Carbon $end = null, $skills = [])
	{
		$this->retry_counter = 0;
		$this->skills = $skills;

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

		$results_object = $this->retrieveMsgHistory($start, $end);
		
		$results_object->_metadata->start = $start;
		$results_object->_metadata->end = $end;
	
		$meta = new MetaData((array) $results_object->_metadata);
		
		$collection = new ConversationHistory($results_object->conversationHistoryRecords);
		$collection->metaData = $meta;
		
		return $collection;
			
	}
	
	/**
	 * getConversation function.
	 * 
	 * @access public
	 * @param mixed $conversationId
	 * @return Models\Conversation
	 */
	public function getConversation($conversationId)
	{
		$this->domain('msgHist');
		
		$url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/conversations/conversation/search";
		
		$data = new Payload([
			'conversationId' => $conversationId
		]);
		
		$result = $this->requestV1($url, 'POST', $data);
		$result = $this->requestV1($url, 'POST', /** @scrutinizer ignore-type */ $data);
		if (!count($result->conversationHistoryRecords)) {
			return null; // @codeCoverageIgnore
		}
		
		return new Conversation((array) $result->conversationHistoryRecords[0]);
	}

	/**
	 * engagementHistory function.
	 * 
	 * @access public
	 * @param Carbon $start (default: null)
	 * @param Carbon $end (default: null)
	 * @param int/array $skills (default: [])

	 * @return Collections\EngagementHistory
	 */
	public function engagementHistory(Carbon $start = null, Carbon $end = null, $skills = [])
	{
		$this->retry_counter = 0;
		$this->skills = $skills;

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

		$results_object = $this->retrieveHistory($start, $end);
		
		$results_object->_metadata->start = $start;
		$results_object->_metadata->end = $end;
	
		$meta = new MetaData((array) $results_object->_metadata);
		
		$collection = new EngagementHistory($results_object->interactionHistoryRecords);
		$collection->metaData = $meta;
		
		return $collection;
			
	}
	
	/**
	 * status function gets status of the account.
	 * 
	 * @access public
	 * @return Models\AccountStatus
	 */
	public function status()
	{
		$url = "https://status.liveperson.com/json?site={$this->account}";
		
		$response = $this->requestV1($url, 'GET');
		
		return new AccountStatus((array) $response);
	}
	
	/**
	 * login function.
	 * 
	 * @access public
	 * @return this
	 */
	public function login()
	{
		$this->domain('agentVep');
		
		$consumer_key = config("{$this->config}.key");
		$consumer_secret = config("{$this->config}.secret");
		$token = config("{$this->config}.token");
		$secret = config("{$this->config}.token_secret");
		$username = config("{$this->config}.user_name");
		
		$auth = [
			'username'		  => $username,
			'appKey'			=> $consumer_key,
			'secret'			=> $consumer_secret,
			'accessToken'		=> $token,
			'accessTokenSecret' => $secret,
		];
		
		$url = "https://{$this->domain}/api/account/{$this->account}/login?v=1.3";
		
		$response = $this->requestV1($url, 'POST', $auth);
		
		$this->bearer = $response->bearer;
		
		return $this;
	}
	
	/**
	 * requestV2 function.
	 * 
	 * @access private
	 * @param mixed $url
	 * @param mixed $method
	 * @param mixed $payload (default: [])
	 * @param mixed $headers (default: [])
	 * @return void
	 */
	private function requestV2($url, $method, $payload = [], $headers = [])
	{
		$this->login();
		
		$client = new Client();
		$args = [
			'headers' => array_merge([
				'content-type' => 'application/json',
				'Authorization' => 'Bearer ' . $this->bearer
			], $headers),
			'body' => json_encode($payload)
		];
		
		// @codeCoverageIgnoreStart
		try {
			$res = $client->request($method, $url, $args);
		} catch (\Exception $e) {
			throw $e;
		}
		// @codeCoverageIgnoreEnd
		
		return json_decode($res->getBody());
	}
	
	/**
	 * requestClient function.
	 * 
	 * @access private
	 * @return \GuzzleHttp\Client
	 */
	private function requestClient()
	{
		$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,
		]);
		
		return $client;
	}
	
	/**
	 * requestV1 - request bootstrap for older oauth supported APIs.
	 * 
	 * @access private
	 * @param string $url
	 * @param string $method
	 * @param array $payload (default: [])
	 * @return mixed
	 */
	private function requestV1($url, $method, $payload = [])
	{
		$client = $this->requestClient();

		$args = [
			'auth' => 'oauth',
			'headers' => [
				'content-type' => 'application/json',
			],
			'body' => json_encode($payload)
		];

		try {
			$res = $client->request($method, $url, $args);
			$response = json_decode($res->getBody());
		} catch (\Exception $e) {
			// @codeCoverageIgnoreStart
			if ($this->retry_counter < $this->retry_limit || $this->retry_limit == -1) {
				usleep(1500);
				$this->retry_counter++;
				$response = $this->requestV1($url, $payload);
				$response = $this->requestV1($url, /** @scrutinizer ignore-type */ $payload);
			} else {
				throw $e;
			}
			// @codeCoverageIgnoreEnd
		}

		return $response;
	}
}
LivePersonInc / LiveEngageLaravel

Push — master ( 074c96...5e6d2b )

LiveEngageLaravel::requestV2() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
