osb/app/Classes/External/Supplier.php

126 lines
3.3 KiB
PHP
Raw Permalink Normal View History

<?php
namespace App\Classes\External;
use GuzzleHttp\Client;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
2021-07-02 06:15:45 +00:00
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
abstract class Supplier
{
private const LOGKEY = 'AS-';
protected $o = NULL;
protected $_columns = [];
public function __construct(Model $o)
{
$this->o = $o;
$this->_columns = collect();
}
/**
* Connect and pull down traffic data
*
* @return Collection
*/
public function fetch(): Collection
{
if ($x=$this->mustPause()) {
Log::notice(sprintf('%s:API Throttle, waiting [%s]...',self::LOGKEY,$x),['m'=>__METHOD__]);
sleep($x);
}
Log::debug(sprintf('%s:Supplier [%d], fetch data for [%s]...',self::LOGKEY,$this->o->id,$this->o->stats_lastupdate),['m'=>__METHOD__]);
2021-07-02 06:15:45 +00:00
$key = 'Supplier:'.$this->o->id.$this->o->stats_lastupdate;
$result = Cache::remember($key,86400,function() {
$client = $this->getClient();
2021-07-02 06:15:45 +00:00
$response = Http::get($this->o->stats_url,[
$this->login_user_field => $this->o->stats_username,
$this->login_pass_field => $this->o->stats_password,
$this->date_field => $this->o->stats_lastupdate->format('Y-m-d'),
]);
2021-07-02 06:15:45 +00:00
// @todo These API rate limiting is untested.
$api_remain = $response->header('X-RateLimit-Remaining');
$api_reset = $response->header('X-RateLimit-Reset');
if ($api_remain === 0 AND $api_reset) {
Log::notice(sprintf('%s:API Throttle [%d].',self::LOGKEY,$api_reset),['m'=>__METHOD__]);
Cache::put('api_throttle',$api_reset,now()->addSeconds($api_reset));
}
2021-07-02 06:15:45 +00:00
//dd($response->header('Content-Type'),$response->headers());
// Assume the supplier provides an ASCII output for text/html
2021-07-02 06:15:45 +00:00
if (preg_match('#^text/html;#',$x=$response->header('Content-Type'))) {
return collect(explode("\n",$response->body()))->filter();
} else {
Log::error(sprintf('%s:Havent handled header type [%s]',self::LOGKEY,$x),['m'=>__METHOD__]);
throw new \Exception('Unhandled Content Type');
}
});
Log::debug(sprintf('%s:Supplier [%d], records returned [%d]...',self::LOGKEY,$this->o->id,$result->count()),['m'=>__METHOD__]);
return $result;
}
/**
* Return the API HTTP client
* @return Client
*/
protected function getClient(): Client
{
return new Client(['base_uri'=>$this->o->stats_url]);
}
/**
* Return the expected columns from a supplier traffic import
*
* @param string $line
* @param Collection $expect
* @return Collection
*/
2020-05-28 05:08:13 +00:00
public function getColumns(string $line,Collection $expect): Collection
{
$fields = collect(explode(',',$line))->filter();
$this->_columns = $expect;
if ($this->_columns->diff($fields)->count()) {
abort('500','Missing columns in data: '.join('|',$this->_columns->diff($fields)->toArray()).' got: '.join('|',$fields));
}
return $fields->intersect($this->_columns);
}
/**
* Return the key ID for a column
*
* @param string $key
* @return mixed
*/
2020-05-28 05:08:13 +00:00
public function getColumnKey(string $key)
{
return $this->_columns->search($key);
}
2020-05-28 05:08:13 +00:00
public function header(): array
{
return static::$header;
}
/**
* If the supplier has API throttling...
*
* @return mixed
*/
protected function mustPause()
{
return Cache::get('api_throttle');
}
}