BilginPro\Agency\Aa\Crawler

Complexity

Total Complexity

26

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes	9
Bugs	1	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	crawl()	0	20	3
A	newsmlToNews()	0	23	3
A	getDocumentLink()	0	4	1
A	document()	0	8	1
A	search()	0	19	3
A	createSummary()	0	13	3
A	setParameters()	0	14	4
A	setAttributes()	0	6	2
A	fetchUrl()	0	9	2
A	shortenString()	0	10	2
A	titleCase()	0	5	1

<?php

namespace BilginPro\Agency\Aa;

use BilginPro\Agency\Aa\Exceptions\AuthenticationException;
use BilginPro\Agency\Aa\Exceptions\NoDataFoundException;
use Carbon\Carbon;
use GuzzleHttp;

/**
 * Class Crawler
 * @package BilginPro\Ajans\Aa
 */
class Crawler
{
    /**
     * Base URL of AA API
     */
    const API_BASE_URL = 'https://api.aa.com.tr';

    /**
     * @var string
     */
    protected $user_name = '';

    /**
     * @var string
     */
    protected $password = '';

    /**
     * @var int
     */
    protected $summary_length = 150;

    /**
     * @var array
     */
    protected $attributes = [
        'filter_language' => '1',
        'filter_type' => '1',
        'limit' => '5',
    ];

    /**
     * @var array
     */
    protected $auth = ['', ''];

    /**
     * Create a new Crawler Instance
     */
    public function __construct($config)
    {
        $this->setParameters($config);
    }

    /**
     * @param array $attributes
     * @return array
     */
    public function crawl($attributes = [])
    {
        $this->setAttributes($attributes);

        $result = [];

        usleep(500000);
        $search = $this->search();

        usleep(500000);
        foreach ($search->data->result as $item) {
            $newsml = $this->document($item->id);
            if (!empty($newsml)) {
                $news = $this->newsmlToNews($newsml);
                $result[] = $news;
            }
            usleep(500000);
        }
        return $result;
    }


    /**
     * Creates a news object from NewsML SimpleXmlElement instance.
     * @param \SimpleXMLElement $xml
     * @return \stdClass
     */
    protected function newsmlToNews($xml)
    {
        $news = new \stdClass();
        $xml->registerXPathNamespace("n", "http://iptc.org/std/nar/2006-10-01/");
        $news->code = (string)($xml->itemSet->newsItem['guid']);
        $news->title = (string)$xml->itemSet->newsItem->contentMeta->headline;
        $news->summary = (string)$xml->itemSet->newsItem->contentSet->inlineXML->nitf->body->{'body.head'}->abstract;
        $news->content = (string)$xml->itemSet->newsItem->contentSet->inlineXML->nitf->body->{'body.content'};
        $news->created_at = (new Carbon($xml->itemSet->newsItem->itemMeta->versionCreated))
            ->addHours(3)->format('d.m.Y H:i:s');
        $news->category = (string)$xml->xpath('//n:subject/n:name[@xml:lang="tr"]')[0];
        $news->city = '';
        if (isset($xml->xpath('//n:contentMeta/n:located[@type="cptype:city"]/n:name[@xml:lang="tr"]')[0])) {
            $news->city = (string)$xml
                ->xpath('//n:contentMeta/n:located[@type="cptype:city"]/n:name[@xml:lang="tr"]')[0];
        }
        $news->images = [];
        if (isset($xml->xpath('//n:newsItem/n:itemMeta/n:link[@rel="irel:seeAlso"]')[0]['residref'])) {
            $picture_id = (string)$xml->xpath('//n:newsItem/n:itemMeta/n:link[@rel="irel:seeAlso"]')[0]['residref'];
            $news->images[] = $this->getDocumentLink($picture_id, 'print');
        }
        return $news;
    }

    /**
     * Creates document link for next requests.
     * @param string $id
     * @param string $format
     * @return string
     */
    protected function getDocumentLink($id, $format)
    {
        return self::API_BASE_URL . '/abone/document/' . $id . '/' . $format;
    }

    /**
     * Fetches NewsML document, creates a SimpleXMLElement instance and returns it.
     * @param $id
     * @return null|\SimpleXMLElement
     */
    protected function document($id)
    {
        $xml = null;

$xml is not used, you could remove the assignment.

        $url = self::API_BASE_URL . '/abone/document/' . $id . '/newsml29?v=2' . rand(1000, 9999);
        $newsml = $this->fetchUrl($url, 'GET', ['auth' => $this->auth]);
        $xml = simplexml_load_string($newsml);
        return $xml;
    }

    /**
     * Searchs documents with given filter attributes.
     * @return mixed
     */
    protected function search()
    {
        $res = $this->fetchUrl(self::API_BASE_URL . '/abone/search', 'POST', [
            'auth' => $this->auth,
            'form_params' => $this->attributes
        ]);

        $search = json_decode($res);

        switch ($search->response->code) {
            case 200:
                break;
            case 401:
                throw new AuthenticationException;
            default:
                throw new NoDataFoundException;
        }
        return $search;
    }

    /**
     * Creates short summary of the news, strip credits.
     * @param string $text
     * @return string
     */
    protected function createSummary($text)
    {
        if (strpos($text, '(DHA)') > 0) {
            $split = explode('(DHA)', $text);
            if (count($split) > 1) {
                $text = $split[1];
                $text = trim($text, ' \t\n\r\0\x0B-');
            }
        }
        $summary = (string)$this->shortenString(strip_tags($text), $this->summary_length);

        return $summary;
    }

    /**
     * Sets config parameters.
     * @param $config
     */
    protected function setParameters($config)
    {
        if (!is_array($config)) {
            throw new \InvalidArgumentException('$config variable must be an array.');
        }
        if (array_key_exists('user_name', $config)) {
            $this->user_name = $config['user_name'];
        }
        if (array_key_exists('password', $config)) {
            $this->password = $config['password'];
        }

        $this->auth = [$this->user_name, $this->password];
    }

    /**
     * Sets filter attributes.
     * @param $attributes array
     */
    protected function setAttributes($attributes)
    {
        foreach ($attributes as $key => $value) {
            $this->attributes[$key] = $value;
        }
    }


    /**
     * Fethches given url and returns response as string.
     * @param string $url
     * @param string $method
     * @param array $options
     *
     * @return string
     */
    protected function fetchUrl($url, $method = 'GET', $options = [])
    {
        $client = new GuzzleHttp\Client();
        $res = $client->request($method, $url, $options);
        if ($res->getStatusCode() == 200) {
            return (string)$res->getBody();
        }
        return '';
    }

    /**
     * Cuts the given string from the end of the appropriate word.
     * @param string $str
     * @param int $len
     * @return string
     */
    protected function shortenString($str, $len)
    {
        if (strlen($str) > $len) {
            $str = rtrim(mb_substr($str, 0, $len, 'UTF-8'));
            $str = substr($str, 0, strrpos($str, ' '));
            $str .= '...';
            $str = str_replace(',...', '...', $str);
        }
        return $str;
    }

    /**
     * Converts a string to "Title Case"
     * @param $str
     * @return string
     */
    protected function titleCase($str)
    {
        $str = mb_convert_case($str, MB_CASE_TITLE, 'UTF-8');
        return $str;
    }
}