MediaConvert::path() - Code Metrics - Inspection of "[1.0] Introducing the "Simple Usage" API" - meemalabs/laravel-media-converter - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — main (#14)

by Chris
created 2021-03-16 02:38 UTC
MediaConvert::path() A

↳ Parent: MediaConvert
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	5
rs	10
<?php

namespace Meema\MediaConverter\Converters;

use Aws\Credentials\Credentials;
use Aws\MediaConvert\MediaConvertClient;
use Meema\MediaConverter\Contracts\Converter;

class MediaConvert implements Converter
{
    /**
     * Client instance of AWS MediaConvert.
     *
     * @var \Aws\MediaConvert\MediaConvertClient
     */
    protected $client;

    /**
     * The MediaConvert job's settings.
     *
     * @var array
     */
    public array $jobSettings;

    /**
     * Construct converter.
     *
     * @param \Aws\MediaConvert\MediaConvertClient $client
     */
    public function __construct(MediaConvertClient $client)
    public function __construct(/** @scrutinizer ignore-unused */ MediaConvertClient $client)
    {
        $config = config('media-converter');

        $this->jobSettings = (new $config['job_settings'])::get();

        $this->client = new MediaConvertClient([
            'version' => $config['version'],
            'region' => $config['region'],
            'credentials' => new Credentials($config['credentials']['key'], $config['credentials']['secret']),
            'endpoint' => $config['url'],
        ]);
    }

    /**
     * Get the MediaConvert Client.
     *
     * @return \Aws\MediaConvert\MediaConvertClient
     */
    public function getClient(): MediaConvertClient
    {
        return $this->client;
    }

    /**
     * Sets the path of the file input.
     *
     * @param string $path - represents the S3 path, e.g path/to/file.mp4
     * @param string|null $bucket - reference to the S3 Bucket name. Defaults to config value.
     * @return \Meema\MediaConverter\Converters\MediaConvert
     */
    public function path(string $path, $bucket = null): MediaConvert
    {
        $this->setFileInput($path, $bucket);

        return $this;
    }

    /**
     * Generates a web optimized MP4.
     *
     * @return \Meema\MediaConverter\Converters\MediaConvert
     */
    public function optimizeForWeb(): MediaConvert
    {
        // At the moment, we can simply return $this, because this method is simply used for readability purposes.
        // The "default job" has all the proper settings already to generate a web optimized mp4.
        return $this;
    }

    /**
     * Sets the settings required to generate the proper amount of thumbnails.
     *
     * @param int $framerateNumerator
     * @param int $framerateDenominator
     * @param int $maxCaptures
     * @param int|null $width
     * @param string|null $nameModifier
     * @param int $imageQuality
     * @return \Meema\MediaConverter\Converters\MediaConvert
     */
    public function withThumbnails(int $framerateNumerator, int $framerateDenominator, int $maxCaptures, $width = null, $nameModifier = null, $imageQuality = 80): MediaConvert
    {
        $this->jobSettings['OutputGroups'][0]['Outputs'][0]['VideoDescription']['CodecSettings']['FrameCaptureSettings'] = [
            'FramerateNumerator' => $framerateNumerator,
            'FramerateDenominator' => $framerateDenominator,
            'MaxCaptures' => $maxCaptures,
            'Quality' => $imageQuality,
        ];

        if ($width) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $this->jobSettings['OutputGroups'][0]['Outputs'][0]['VideoDescription']['Width'] = $width;
        }

        if ($nameModifier) {
            $this->jobSettings['OutputGroups'][0]['Outputs'][0]['NameModifier'] = $nameModifier;
        }

        return $this;
    }

    /**
     * Sets the S3 path & executes the job.
     *
     * @param string $s3Path
     * @param string|null $s3bucket
     * @return \Meema\MediaConverter\Converters\MediaConvert
     */
    public function saveTo(string $s3Path, $s3bucket = null): MediaConvert
    {
        $destination = 's3://'.($s3bucket ?? config('filesystems.disks.s3.bucket'));

        $this->jobSettings['OutputGroups'][0]['OutputGroupSettings']['FileGroupSettings']['Destination'] = $destination.'/thumbnails/';
        $this->jobSettings['OutputGroups'][1]['OutputGroupSettings']['FileGroupSettings']['Destination'] = $destination.'/mp4/';

        return $this;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * Cancels an active job.
     *
     * @param string $id
     * @return \Aws\Result
     */
    public function cancelJob(string $id)
    {
        return $this->client->cancelJob([
            'Id' => $id,
        ]);
    }

    /**
     * Creates a new job based on the settings passed.
     *
     * @param array $settings
     * @param array $metaData
     * @param int $priority
     * @return \Aws\Result
     */
    public function createJob(array $settings, array $metaData = [], int $priority = 0)
    {
        return $this->client->createJob([
            'Role' => config('media-converter.iam_arn'),
            'Settings' => $settings,
            'Queue' => config('media-converter.queue_arn'),
            'UserMetadata' => $metaData,
            'StatusUpdateInterval' => $this->getStatusUpdateInterval(),
            'Priority' => $priority,
        ]);
    }

    /**
     * Gets the job.
     *
     * @param string $id
     * @return \Aws\Result
     */
    public function getJob(string $id)
    {
        return $this->client->getJob([
            'Id' => $id,
        ]);
    }

    /**
     * Lists all of the jobs based on your options provided.
     *
     * @param array $options
     * @return \Aws\Result
     */
    public function listJobs(array $options)
    {
        return $this->client->listJobs($options);
    }

    protected function getStatusUpdateInterval(): string
    {
        $webhookInterval = config('media-converter.webhook_interval');
        $allowedValues = [10, 12, 15, 20, 30, 60, 120, 180, 240, 300, 360, 420, 480, 540, 600];

        if (in_array($webhookInterval, [$allowedValues])) {
            return 'SECONDS_'.$webhookInterval;
        }

        return 'SECONDS_60'; // gracefully default to this value, in case the config value is missing or incorrect
    }

    /**
     * Sets the S3 input file path.
     *
     * @param string $path
     * @param string|null $bucket
     */
    protected function setFileInput(string $path, $bucket = null)
    {
        $fileInput = 's3://'.($bucket ?? config('filesystems.disks.s3.bucket')).'/'.$path;

        $this->jobSettings['Inputs'][0]['FileInput'] = $fileInput;
    }
}

meemalabs / laravel-media-converter

Pull Request — main (#14)

MediaConvert::path() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
