LivePersonInc /
LiveEngageLaravel
| Total Complexity | 58 |
| Total Lines | 402 |
| Duplicated Lines | 0 % |
| Coverage | 0% |
| Changes | 0 | ||
Complex classes like LiveEngageLaravel often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use LiveEngageLaravel, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 22 | class LiveEngageLaravel |
||
| 23 | { |
||
| 24 | private $account = false; |
||
| 25 | private $results = []; |
||
| 26 | private $skills = []; |
||
| 27 | private $next = false; |
||
| 28 | private $prev = false; |
||
| 29 | private $start; |
||
| 30 | private $end; |
||
| 31 | private $config = 'services.liveperson.default'; |
||
| 32 | private $version = '1.0'; |
||
| 33 | private $history_limit = 50; |
||
| 34 | private $history = false; |
||
| 35 | private $context = 'interactionHistoryRecords'; |
||
| 36 | private $interactive = true; |
||
| 37 | private $ended = true; |
||
| 38 | private $bearer = false; |
||
| 39 | |||
| 40 | private $domain = false; |
||
| 41 | |||
| 42 | private $retry_limit = 5; |
||
| 43 | private $retry_counter = 0; |
||
| 44 | |||
| 45 | public function __get($attribute) |
||
| 48 | } |
||
| 49 | |||
| 50 | public function __set($attribute, $value) |
||
| 51 | { |
||
| 52 | return $this->$attribute = $value; |
||
| 53 | } |
||
| 54 | |||
| 55 | public function __construct() |
||
| 60 | } |
||
| 61 | |||
| 62 | public function key($key = 'default') |
||
| 63 | { |
||
| 64 | $this->config = "services.liveperson.$key"; |
||
| 65 | |||
| 66 | return $this; |
||
| 67 | } |
||
| 68 | |||
| 69 | public function nonInteractive() |
||
| 70 | { |
||
| 71 | $this->interactive = false; |
||
| 72 | return $this; |
||
| 73 | } |
||
| 74 | |||
| 75 | public function active() |
||
| 76 | { |
||
| 77 | $this->ended = false; |
||
| 78 | return $this; |
||
| 79 | } |
||
| 80 | |||
| 81 | public function limit($limit) |
||
| 82 | { |
||
| 83 | $this->history_limit = $limit; |
||
| 84 | |||
| 85 | return $this; |
||
| 86 | } |
||
| 87 | |||
| 88 | public function skills($skills) |
||
| 89 | { |
||
| 90 | $this->skills = $skills; |
||
| 91 | |||
| 92 | return $this; |
||
| 93 | } |
||
| 94 | |||
| 95 | public function retry($limit) |
||
| 96 | { |
||
| 97 | $this->retry_limit = $limit; |
||
| 98 | |||
| 99 | return $this; |
||
| 100 | } |
||
| 101 | |||
| 102 | public function get() |
||
| 103 | { |
||
| 104 | return $this->results; |
||
| 105 | } |
||
| 106 | |||
| 107 | public function account($accountid) |
||
| 108 | { |
||
| 109 | $this->account = $accountid; |
||
| 110 | |||
| 111 | return $this; |
||
| 112 | } |
||
| 113 | |||
| 114 | public function domain($service) |
||
| 115 | { |
||
| 116 | $response = $this->requestV1("https://api.liveperson.net/api/account/{$this->account}/service/{$service}/baseURI.json?version={$this->version}", 'GET'); |
||
| 117 | if (is_a($response, 'Exception')) { |
||
|
Bug
introduced
by
|
|||
| 118 | throw new \Exception('Unable to get LivePerson account domain', 101); |
||
| 119 | } else { |
||
| 120 | $this->domain = $response->baseURI; |
||
| 121 | |||
| 122 | return $this; |
||
| 123 | } |
||
| 124 | } |
||
| 125 | |||
| 126 | public function visitor($visitorID, $sessionID, $setData = false) |
||
| 127 | { |
||
| 128 | $this->domain('smt'); |
||
| 129 | |||
| 130 | if ($setData) { |
||
| 131 | $url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/events?v=1&sid={$sessionID}"; |
||
| 132 | |||
| 133 | return $this->requestV1($url, 'POST', $setData); |
||
| 134 | } else { |
||
| 135 | $url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/state?v=1&sid={$sessionID}"; |
||
| 136 | |||
| 137 | return $this->requestV1($url, 'GET'); |
||
| 138 | } |
||
| 139 | } |
||
| 140 | |||
| 141 | final public function retrieveHistory(Carbon $start, Carbon $end, $url = false) |
||
| 142 | { |
||
| 143 | $this->domain('engHistDomain'); |
||
| 144 | |||
| 145 | $url = $url ?: "https://{$this->domain}/interaction_history/api/account/{$this->account}/interactions/search?limit={$this->history_limit}&offset=0"; |
||
| 146 | |||
| 147 | $start_str = $start->toW3cString(); |
||
| 148 | $end_str = $end->toW3cString(); |
||
| 149 | |||
| 150 | $data = [ |
||
| 151 | 'interactive' => $this->interactive, |
||
| 152 | 'ended' => $this->ended, |
||
| 153 | 'start' => [ |
||
| 154 | 'from' => strtotime($start_str).'000', |
||
| 155 | 'to' => strtotime($end_str).'000', |
||
| 156 | ], |
||
| 157 | ]; |
||
| 158 | if (count($this->skills)) { |
||
| 159 | $data['skillIds'] = $this->skills; |
||
| 160 | } |
||
| 161 | |||
| 162 | $data = new Payload($data); |
||
| 163 | |||
| 164 | return $this->requestV1($url, 'POST', $data); |
||
| 165 | } |
||
| 166 | |||
| 167 | final public function retrieveMsgHistory(Carbon $start, Carbon $end, $url = false) |
||
| 168 | { |
||
| 169 | $this->domain('msgHist'); |
||
| 170 | |||
| 171 | $url = $url ?: "https://{$this->domain}/messaging_history/api/account/{$this->account}/conversations/search?limit={$this->history_limit}&offset=0&sort=start:desc"; |
||
| 172 | |||
| 173 | $start_str = $start->toW3cString(); |
||
| 174 | $end_str = $end->toW3cString(); |
||
| 175 | |||
| 176 | $data = [ |
||
| 177 | 'status' => $this->ended ? ['CLOSE'] : ['OPEN'], |
||
| 178 | 'start' => [ |
||
| 179 | 'from' => strtotime($start_str).'000', |
||
| 180 | 'to' => strtotime($end_str).'000', |
||
| 181 | ], |
||
| 182 | ]; |
||
| 183 | if (count($this->skills)) { |
||
| 184 | $data['skillIds'] = $this->skills; |
||
| 185 | } |
||
| 186 | |||
| 187 | $data = new Payload($data); |
||
| 188 | |||
| 189 | return $this->requestV1($url, 'POST', $data); |
||
| 190 | } |
||
| 191 | |||
| 192 | public function getAgentStatus($skills) |
||
| 193 | { |
||
| 194 | $skills = is_array($skills) ? $skills : [$skills]; |
||
| 195 | |||
| 196 | $this->domain('msgHist'); |
||
| 197 | |||
| 198 | $url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/agent-view/status"; |
||
| 199 | |||
| 200 | $data['skillIds'] = $skills; |
||
| 201 | |||
| 202 | $response = $this->requestV1($url, 'POST', $data); |
||
| 203 | $agents = []; |
||
| 204 | |||
| 205 | foreach ($response->agentStatusRecords as $agent) { |
||
| 206 | $agents[] = new Agent((array) $agent); |
||
| 207 | } |
||
| 208 | |||
| 209 | $collection = new Humans($agents); |
||
| 210 | $collection->metaData = $response->_metadata; |
||
| 211 | |||
| 212 | return $collection; |
||
| 213 | |||
| 214 | } |
||
| 215 | |||
| 216 | public function messagingHistory(Carbon $start = null, Carbon $end = null) |
||
| 217 | { |
||
| 218 | $this->retry_counter = 0; |
||
| 219 | |||
| 220 | $start = $start ?: (new Carbon())->today(); |
||
| 221 | $end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59); |
||
| 222 | |||
| 223 | $this->start = $start; |
||
| 224 | $this->end = $end; |
||
| 225 | |||
| 226 | $results_object = $this->retrieveMsgHistory($start, $end); |
||
| 227 | |||
| 228 | if (is_object($results_object)) { |
||
| 229 | |||
| 230 | $results = $results_object->conversationHistoryRecords; |
||
| 231 | if (property_exists($results_object->_metadata, 'next')) { |
||
| 232 | $this->next = $results_object->_metadata->next->href; |
||
| 233 | } else { |
||
| 234 | $this->next = false; |
||
| 235 | } |
||
| 236 | if (property_exists($results_object->_metadata, 'prev')) { |
||
| 237 | $this->prev = $results_object->_metadata->prev->href; |
||
| 238 | } else { |
||
| 239 | $this->prev = false; |
||
| 240 | } |
||
| 241 | |||
| 242 | $history = []; |
||
| 243 | foreach ($results as $item) { |
||
| 244 | if (property_exists($item, 'info')) { |
||
| 245 | $item->info = new MessagingInfo((array) $item->info); |
||
| 246 | } |
||
| 247 | |||
| 248 | if (property_exists($item, 'visitorInfo')) { |
||
| 249 | $item->visitorInfo = new Visitor((array) $item->visitorInfo); |
||
| 250 | } |
||
| 251 | |||
| 252 | if (property_exists($item, 'campaign')) { |
||
| 253 | $item->campaign = new Campaign((array) $item->campaign); |
||
| 254 | } |
||
| 255 | |||
| 256 | $history[] = new Conversation((array) $item); |
||
| 257 | } |
||
| 258 | |||
| 259 | $collection = new ConversationHistory($history, $this); |
||
| 260 | $collection->metaData = $results_object->_metadata; |
||
| 261 | |||
| 262 | return $collection; |
||
| 263 | |||
| 264 | } else { |
||
| 265 | return false; |
||
| 266 | } |
||
| 267 | } |
||
| 268 | |||
| 269 | public function history(Carbon $start = null, Carbon $end = null) |
||
| 270 | { |
||
| 271 | $this->retry_counter = 0; |
||
| 272 | |||
| 273 | $start = $start ?: (new Carbon())->today(); |
||
| 274 | $end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59); |
||
| 275 | |||
| 276 | $this->start = $start; |
||
| 277 | $this->end = $end; |
||
| 278 | |||
| 279 | $results_object = $this->retrieveHistory($start, $end); |
||
| 280 | |||
| 281 | if (is_object($results_object)) { |
||
| 282 | |||
| 283 | $results = $results_object->interactionHistoryRecords; |
||
| 284 | if (property_exists($results_object->_metadata, 'next')) { |
||
| 285 | $this->next = $results_object->_metadata->next->href; |
||
| 286 | } else { |
||
| 287 | //$this->next = false; |
||
| 288 | } |
||
| 289 | if (property_exists($results_object->_metadata, 'prev')) { |
||
| 290 | $this->prev = $results_object->_metadata->prev->href; |
||
| 291 | } else { |
||
| 292 | //$this->prev = false; |
||
| 293 | } |
||
| 294 | |||
| 295 | $history = []; |
||
| 296 | foreach ($results as $item) { |
||
| 297 | if (property_exists($item, 'info')) { |
||
| 298 | $item->info = new Info((array) $item->info); |
||
| 299 | } |
||
| 300 | |||
| 301 | if (property_exists($item, 'visitorInfo')) { |
||
| 302 | $item->visitorInfo = new Visitor((array) $item->visitorInfo); |
||
| 303 | } |
||
| 304 | |||
| 305 | if (property_exists($item, 'campaign')) { |
||
| 306 | $item->campaign = new Campaign((array) $item->campaign); |
||
| 307 | } |
||
| 308 | |||
| 309 | $history[] = new Engagement((array) $item); |
||
| 310 | } |
||
| 311 | |||
| 312 | $collection = new EngagementHistory($history, $this); |
||
| 313 | $collection->metaData = $results_object->_metadata; |
||
| 314 | |||
| 315 | return $collection; |
||
| 316 | |||
| 317 | } else { |
||
| 318 | return false; |
||
| 319 | } |
||
| 320 | } |
||
| 321 | |||
| 322 | public function login() |
||
| 347 | } |
||
| 348 | |||
| 349 | private function requestV2($url, $method, $payload = false) |
||
| 350 | { |
||
| 371 | } |
||
| 372 | |||
| 373 | private function requestV1($url, $method, $payload = false) |
||
| 374 | { |
||
| 375 | $consumer_key = config("{$this->config}.key"); |
||
| 376 | $consumer_secret = config("{$this->config}.secret"); |
||
| 377 | $token = config("{$this->config}.token"); |
||
| 424 | } |
||
| 425 | } |
||
| 426 |
Loading history...