AppDetailScraper::extractTranslatedFromLocale() - Code Metrics - Inspection of "refactoring" - Ne-Lexa/google-play-scraper - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — develop (29ed49)

by Alexey
created 2019-06-15 14:57 UTC
AppDetailScraper::extractTranslatedFromLocale() A

↳ Parent: AppDetailScraper
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	6
CRAP Score	2
Importance

Changes
Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	8
ccs	6
cts	6
cp	1
crap	2
rs	10
c	0
b	0
f	0
<?php
/** @noinspection MultiAssignmentUsageInspection */
declare(strict_types=1);

/**
 * @author   Ne-Lexa
 * @license  MIT
 * @link     https://github.com/Ne-Lexa/google-play-scraper
 */

namespace Nelexa\GPlay\Scraper;

use Nelexa\GPlay\Exception\GooglePlayException;
use Nelexa\GPlay\GPlayApps;
use Nelexa\GPlay\Http\ResponseHandlerInterface;
use Nelexa\GPlay\Model\AppDetail;
use Nelexa\GPlay\Model\Builder\AppBuilder;
use Nelexa\GPlay\Model\Category;
use Nelexa\GPlay\Model\Developer;
use Nelexa\GPlay\Model\GoogleImage;
use Nelexa\GPlay\Model\HistogramRating;
use Nelexa\GPlay\Model\Video;
use Nelexa\GPlay\Scraper\Extractor\ReviewsExtractor;
use Nelexa\GPlay\Util\DateStringFormatter;
use Nelexa\GPlay\Util\LocaleHelper;
use Nelexa\GPlay\Util\ScraperUtil;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use function GuzzleHttp\Psr7\parse_query;

/**
 * @internal
 */
class AppDetailScraper implements ResponseHandlerInterface
{
    /**
     * @param RequestInterface $request
     * @param ResponseInterface $response
     * @return AppDetail
     * @throws GooglePlayException
     */
    public function __invoke(RequestInterface $request, ResponseInterface $response): AppDetail
    {
        [
            $scriptDataInfo,
            $scriptDataRating,
            $scriptDataPrice,
            $scriptDataVersion,
            $scriptDataReviews,
        ] = $this->getScriptData($request, $response);

        $query = parse_query($request->getUri()->getQuery());

        $id = $query[GPlayApps::REQ_PARAM_ID];
        $locale = $query[GPlayApps::REQ_PARAM_LOCALE] ?? GPlayApps::DEFAULT_LOCALE;
        $country = $query[GPlayApps::REQ_PARAM_COUNTRY] ?? GPlayApps::DEFAULT_COUNTRY;

        $appBuilder = AppDetail::newBuilder()
            ->setId($id)
            ->setLocale($locale)
            ->setCountry($country);

        $this->handlerDataInfo($appBuilder, $scriptDataInfo);
        $this->handlerDataRating($appBuilder, $scriptDataRating);
        $this->handlerDataPrice($appBuilder, $scriptDataPrice);
        $this->handlerDataVersion($appBuilder, $scriptDataVersion);
        $this->handlerReviews($appBuilder, $scriptDataReviews);

        return new AppDetail($appBuilder);
    }

    /**
     * @param RequestInterface $request
     * @param ResponseInterface $response
     * @return array
     * @throws GooglePlayException
     */
    private function getScriptData(RequestInterface $request, ResponseInterface $response): array
    {
        $scriptData = ScraperUtil::extractScriptData($response->getBody()->getContents());

        $scriptDataInfo = null;
        $scriptDataRating = null;
        $scriptDataPrice = null;
        $scriptDataVersion = null;
        $scriptDataReviews = [];

        foreach ($scriptData as $key => $scriptValue) {
            if (isset($scriptValue[0][12][5][5][4][2])) { // ds:5
                $scriptDataInfo = $scriptValue;
            } elseif (isset($scriptValue[0][2][0][0][0][1][0][0])) { // ds:3
                $scriptDataPrice = $scriptValue;
            } elseif (isset($scriptValue[0][0][0])
                && is_string($scriptValue[0][0][0])
                && strpos($scriptValue[0][0][0], 'gp:') === 0) { // ds:15
                $scriptDataReviews = $scriptValue;
            } elseif (isset($scriptValue[0][6][3][1])) { // ds:7
                $scriptDataRating = $scriptValue;
            } elseif (isset($scriptValue[0])
                && is_string($scriptValue[0])
                && count($scriptValue) === 3) { // ds:8
                $scriptDataVersion = $scriptValue;
            }
        }

        if (
            $scriptDataInfo === null ||
            $scriptDataRating === null ||
            $scriptDataPrice === null ||
            $scriptDataVersion === null

        ) {
            throw (new GooglePlayException('Unable to get data for this application.'))
                ->setUrl($request->getUri()->__toString());
        }
        return [$scriptDataInfo, $scriptDataRating, $scriptDataPrice, $scriptDataVersion, $scriptDataReviews];
    }

    /**
     * @param AppBuilder $appBuilder
     * @param array $scriptDataInfo
     */
    private function handlerDataInfo(AppBuilder $appBuilder, array $scriptDataInfo): void
    {
        $name = $scriptDataInfo[0][0][0];
        $description = $this->extractDescription($scriptDataInfo);
        $translatedFromLocale = $this->extractTranslatedFromLocale($scriptDataInfo, $appBuilder->getLocale());
        $translatedFromLocale = $this->extractTranslatedFromLocale($scriptDataInfo, /** @scrutinizer ignore-type */ $appBuilder->getLocale());
        $developer = $this->extractDeveloper($scriptDataInfo);
        $category = $this->extractCategory($scriptDataInfo[0][12][13][0]);
        $summary = $this->extractSummary($scriptDataInfo);
        $installs = $scriptDataInfo[0][12][9][2] ?? 0;
        $offersIAPCost = $scriptDataInfo[0][12][12][0] ?? null;
        $containsAds = (bool)$scriptDataInfo[0][12][14][0];
        $editorsChoice = !empty($scriptDataInfo[0][12][15][1][1]);
        $privacyPoliceUrl = $scriptDataInfo[0][12][7][2] ?? '';
        $categoryFamily = $this->extractCategory($scriptDataInfo[0][12][13][1] ?? []);
        $icon = $this->extractIcon($scriptDataInfo);
        $cover = $this->extractCover($scriptDataInfo);
        $screenshots = $this->extractScreenshots($scriptDataInfo);
        $video = $this->extractVideo($scriptDataInfo);
        $contentRating = $scriptDataInfo[0][12][4][0] ?? '';
        $released = $this->extractReleaseDate($scriptDataInfo, $appBuilder->getLocale());
        $released = $this->extractReleaseDate($scriptDataInfo, /** @scrutinizer ignore-type */ $appBuilder->getLocale());
        $updated = $this->extractUpdatedDate($scriptDataInfo);
        $recentChanges = $this->extractRecentChanges($scriptDataInfo);

        $appBuilder
            ->setName($name)
            ->setDescription($description)
            ->setTranslatedFromLocale($translatedFromLocale)
            ->setSummary($summary)
            ->setIcon($icon)
            ->setCover($cover)
            ->setScreenshots($screenshots)
            ->setDeveloper($developer)
            ->setCategory($category)
            ->setCategoryFamily($categoryFamily)
            ->setVideo($video)
            ->setRecentChanges($recentChanges)
            ->setEditorsChoice($editorsChoice)
            ->setPrivacyPoliceUrl($privacyPoliceUrl)
            ->setInstalls($installs)
            ->setRecentChanges($recentChanges)
            ->setEditorsChoice($editorsChoice)
            ->setPrivacyPoliceUrl($privacyPoliceUrl)
            ->setInstalls($installs)
            ->setOffersIAPCost($offersIAPCost)
            ->setContainsAds($containsAds)
            ->setContentRating($contentRating)
            ->setReleased($released)
            ->setUpdated($updated);
    }

    /**
     * @param array $scriptDataInfo
     * @return string
     */
    private function extractDescription(array $scriptDataInfo): string
    {
        if (isset($scriptDataInfo[0][19][0][0][1])) {
            return ScraperUtil::html2text($scriptDataInfo[0][19][0][0][1]);
        }

        return ScraperUtil::html2text($scriptDataInfo[0][10][0][1]);
    }

    /**
     * @param $scriptDataInfo
     * @param string $locale
     * @return string|null
     */
    private function extractTranslatedFromLocale(array $scriptDataInfo, string $locale): ?string
    {
        return isset($scriptDataInfo[0][19][1]) ?
            LocaleHelper::findPreferredLanguage(
                $locale,
                $scriptDataInfo[0][19][1]
            ) :
            null;
    }

    /**
     * @param array $scriptDataInfo
     * @return Developer
     */
    private function extractDeveloper(array $scriptDataInfo): Developer
    {
        $developerPage = GPlayApps::GOOGLE_PLAY_URL . $scriptDataInfo[0][12][5][5][4][2];
        $developerId = parse_query(parse_url($developerPage, PHP_URL_QUERY))[GPlayApps::REQ_PARAM_ID];
        $developerName = $scriptDataInfo[0][12][5][1];
        $developerEmail = $scriptDataInfo[0][12][5][2][0];
        $developerWebsite = $scriptDataInfo[0][12][5][3][5][2];
        $developerAddress = $scriptDataInfo[0][12][5][4][0];
//        $developerInternalID = (int)$scriptDataInfo[0][12][5][0][0];

        return new Developer(
            Developer::newBuilder()
                ->setId($developerId)
                ->setUrl($developerPage)
                ->setName($developerName)
                ->setEmail($developerEmail)
                ->setAddress($developerAddress)
                ->setWebsite($developerWebsite)
        );
    }

    /**
     * @param array $data
     * @return Category|null
     */
    private function extractCategory(array $data): ?Category
    {
        if (isset($data[0]) && $data[0] !== null && $data[2] !== null) {
            $genreId = (string)$data[2];
            $genreName = (string)$data[0];
            return new Category($genreId, $genreName);
        }
        return null;
    }

    /**
     * @param $scriptDataInfo
     * @return string|null
     */
    private function extractSummary(array $scriptDataInfo): ?string
    {
        return empty($scriptDataInfo[0][10][1][1]) ?
            null :
            ScraperUtil::html2text($scriptDataInfo[0][10][1][1]);
    }

    /**
     * @param array $scriptDataInfo
     * @return GoogleImage|null
     */
    private function extractIcon(array $scriptDataInfo): ?GoogleImage
    {
        return empty($scriptDataInfo[0][12][1][3][2]) ?
            null :
            new GoogleImage($scriptDataInfo[0][12][1][3][2]);
    }

    /**
     * @param array $scriptDataInfo
     * @return GoogleImage|null
     */
    private function extractCover(array $scriptDataInfo): ?GoogleImage
    {
        return empty($scriptDataInfo[0][12][2][3][2]) ?
            null :
            new GoogleImage($scriptDataInfo[0][12][2][3][2]);
    }

    /**
     * @param array $scriptDataInfo
     * @return GoogleImage[]
     */
    private function extractScreenshots(array $scriptDataInfo): array
    {
        return !empty($scriptDataInfo[0][12][0]) ? array_map(static function (array $v) {
            return new GoogleImage($v[3][2]);
        }, $scriptDataInfo[0][12][0]) : [];
    }

    /**
     * @param array $scriptDataInfo
     * @return Video|null
     */
    private function extractVideo(array $scriptDataInfo): ?Video
    {
        if (
            isset($scriptDataInfo[0][12][3][0][3][2]) &&
            $scriptDataInfo[0][12][3][0][3][2] !== null &&
            $scriptDataInfo[0][12][3][1][3][2] !== null
        ) {
            $videoThumb = (string)$scriptDataInfo[0][12][3][1][3][2];
            $videoUrl = (string)$scriptDataInfo[0][12][3][0][3][2];

            return new Video($videoThumb, $videoUrl);
        }
        return null;
    }

    /**
     * @param array $scriptDataInfo
     * @param string $locale
     * @return \DateTimeInterface|null
     */
    private function extractReleaseDate(array $scriptDataInfo, string $locale): ?\DateTimeInterface
    {
        if (isset($scriptDataInfo[0][12][36])) {
            return DateStringFormatter::formatted($locale, $scriptDataInfo[0][12][36]);
        }
        return null;
    }

    /**
     * @param array $scriptDataInfo
     * @return \DateTimeInterface|null
     */
    private function extractUpdatedDate(array $scriptDataInfo): ?\DateTimeInterface
    {
        if (isset($scriptDataInfo[0][12][8][0])) {
            return DateStringFormatter::unixTimeToDateTime($scriptDataInfo[0][12][8][0]);
        }
        return null;
    }

    /**
     * @param $scriptDataInfo
     * @return string|null
     */
    private function extractRecentChanges($scriptDataInfo): ?string
    {
        return empty($scriptDataInfo[0][12][6][1]) ?
            null :
            ScraperUtil::html2text($scriptDataInfo[0][12][6][1]);
    }

    /**
     * @param AppBuilder $appBuilder
     * @param array $scriptDataRating
     */
    private function handlerDataRating(AppBuilder $appBuilder, array $scriptDataRating): void
    {
        $score = (float)($scriptDataRating[0][6][0][1] ?? 0);
        $numberVoters = (int)($scriptDataRating[0][6][2][1] ?? 0);
        $numberReviews = (int)($scriptDataRating[0][6][3][1] ?? 0);
        $histogramRating = $this->extractHistogramRating($scriptDataRating);

        $appBuilder
            ->setScore($score)
            ->setScore($score)
            ->setNumberVoters($numberVoters)
            ->setHistogramRating($histogramRating)
            ->setNumberReviews($numberReviews);
    }

    /**
     * @param array $scriptDataRating
     * @return HistogramRating
     */
    private function extractHistogramRating(array $scriptDataRating): HistogramRating
    {
        return new HistogramRating(
            $scriptDataRating[0][6][1][5][1] ?? 0,
            $scriptDataRating[0][6][1][4][1] ?? 0,
            $scriptDataRating[0][6][1][3][1] ?? 0,
            $scriptDataRating[0][6][1][2][1] ?? 0,
            $scriptDataRating[0][6][1][1][1] ?? 0
        );
    }

    /**
     * @param AppBuilder $appBuilder
     * @param array $scriptDataPrice
     */
    private function handlerDataPrice(AppBuilder $appBuilder, array $scriptDataPrice): void
    {
        $price = $this->extractPrice($scriptDataPrice);
        $currency = $scriptDataPrice[0][2][0][0][0][1][0][1];
        $priceText = $scriptDataPrice[0][2][0][0][0][1][0][2] ?: null;

        $appBuilder
            ->setPrice($price)
            ->setCurrency($currency)
            ->setPriceText($priceText);
    }

    /**
     * @param array $scriptDataPrice
     * @return float
     */
    private function extractPrice(array $scriptDataPrice): ?float
    {
        return isset($scriptDataPrice[0][2][0][0][0][1][0][0]) ?
            (float)($scriptDataPrice[0][2][0][0][0][1][0][0] / 1000000) :
            0.0;
    }

    /**
     * @param AppBuilder $appBuilder
     * @param $scriptDataVersion
     */
    private function handlerDataVersion(AppBuilder $appBuilder, $scriptDataVersion): void
    {
        [$size, $appVersion, $androidVersion] = $scriptDataVersion;
        if (LocaleHelper::isDependOnDevice($appBuilder->getLocale(), $size)) {
        if (LocaleHelper::isDependOnDevice(/** @scrutinizer ignore-type */ $appBuilder->getLocale(), $size)) {
            $size = null;
        }
        if (LocaleHelper::isDependOnDevice($appBuilder->getLocale(), $appVersion)) {
            $appVersion = null;
        }
        if (LocaleHelper::isDependOnDevice($appBuilder->getLocale(), $androidVersion)) {
            $androidVersion = null;
            $minAndroidVersion = null;
        } else {
            $minAndroidVersion = preg_replace('~.*?(\d+(\.\d+)*).*~', '$1', $androidVersion);
        }

        $appBuilder
            ->setSize($size)
            ->setAppVersion($appVersion)
            ->setAndroidVersion($androidVersion)
            ->setMinAndroidVersion($minAndroidVersion);
    }

    /**
     * @param AppBuilder $appBuilder
     * @param array $scriptDataReviews
     * @param int $limit
     */
    private function handlerReviews(AppBuilder $appBuilder, array $scriptDataReviews, int $limit = 4): void
    {
        if (!empty($scriptDataReviews[0])) {
            $reviews = ReviewsExtractor::extractReviews(
                $appBuilder->buildAppId(),
                array_slice($scriptDataReviews[0], 0, $limit)
            );

            $appBuilder->setReviews($reviews);
        }
    }
}

Ne-Lexa / google-play-scraper

Branch — develop (29ed49)

AppDetailScraper::extractTranslatedFromLocale() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
