dukt / twitter

src/services/Api.php

<?php
/**
 * @link      https://dukt.net/twitter/
 * @copyright Copyright (c) Dukt
 * @license   https://github.com/dukt/twitter/blob/master/LICENSE.md
 */

namespace dukt\twitter\services;

use Craft;
use craft\helpers\FileHelper;
use dukt\twitter\helpers\TwitterHelper;
use dukt\twitter\models\Tweet;
use dukt\twitter\Plugin;
use League\OAuth1\Client\Credentials\TokenCredentials;
use yii\base\Component;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Subscriber\Oauth\Oauth1;
use DateTime;
use GuzzleHttp\Exception\GuzzleException;

/**
 * Api Service
 *
 * @author Dukt <support@dukt.net>
 * @since  3.0
 */
class Api extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Performs a get request on the Twitter API.
     *
     * @param string     $uri
     * @param array|null $query
     * @param array|null $headers
     * @param array      $options
     * @param bool|null  $enableCache
     * @param null|int   $cacheExpire
     *
     * @return array|null
     * @throws GuzzleException
     */
    public function get($uri, array $query = null, array $headers = null, array $options = [], $enableCache = null, $cacheExpire = null)
    {
        // Add query to the request’s options

        if ($query) {
            $options['query'] = $query;
        }

        // Enable Cache

        if (null === $enableCache) {
            $enableCache = Plugin::getInstance()->getSettings()->enableCache;
        }


        // Try to get response from cache

        if ($enableCache) {
            $response = Plugin::getInstance()->getCache()->get([$uri, $headers, $options]);

            if ($response) {
                return $response;
            }
        }


        // Otherwise request the API

        $client = $this->getClient();

        $url = $uri.'.json';

        if ($headers) {
            $options['headers'] = $headers;
        }

        $response = $client->request('GET', $url, $options);

        $jsonResponse = json_decode($response->getBody(), true);

        if ($enableCache) {
            Plugin::getInstance()->getCache()->set([$uri, $headers, $options], $jsonResponse, $cacheExpire);

It seems like $cacheExpire can also be of type integer; however, parameter $expire of dukt\twitter\services\Cache::set() does only seem to accept null, maybe add an additional type check?

        }

        return $jsonResponse;
    }

    /**
     * Returns a tweet by its URL or ID.
     *
     * @param string|int $urlOrId
     * @param array|null $query
     *
     * @return Tweet|null
     * @throws GuzzleException
     * @throws \yii\base\Exception
     */
    public function getTweet($urlOrId, array $query = null)
    {
        $tweetId = TwitterHelper::extractTweetId($urlOrId);

        if ($tweetId) {

The expression $tweetId of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            return $this->getTweetById($tweetId, $query);
        }

        return null;
    }

    /**
     * Returns a user by their ID.
     *
     * @param int|string $userId
     * @param array      $query
     *
     * @return array|null
     * @throws GuzzleException
     */
    public function getUserById($userId, $query = [])
    {
        $userId = (int)$userId;

        $query = array_merge($query, ['user_id' => $userId]);

        return $this->get('users/show', $query);
    }

    /**
     * Parses tweet data and returns a tweet model.
     *
     * @param array $data
     * @return Tweet
     */
    public function parseTweetData(array $data): Tweet
    {
        $tweet = new Tweet();

        $this->populateTweetFromData($tweet, $data);

        return $tweet;
    }

    /**
     * Populate tweet object from data array.
     *
     * @param Tweet $tweet
     * @param array $data
     *
     * @return Tweet
     */
    public function populateTweetFromData(Tweet $tweet, array $data): Tweet
    {
        if (isset($data['created_at'])) {
            $tweet->createdAt = DateTime::createFromFormat('D M d H:i:s O Y', $data['created_at']);

It seems like DateTime::createFromFormat('D M d H:i:s O Y', $data['created_at']) of type DateTime is incompatible with the declared type dukt\twitter\models\The of property $createdAt.

        }

        $tweet->data = $data;

It seems like $data of type array is incompatible with the declared type dukt\twitter\models\Raw of property $data.

        $tweet->text = $data['full_text'] ?? null;
        $tweet->remoteId = $data['id'] ?? null;
        $tweet->remoteUserId = $data['user']['id'] ?? null;
        $tweet->username = $data['user']['name'] ?? null;
        $tweet->userProfileRemoteImageSecureUrl = $data['user']['profile_image_url_https'] ?? null;
        $tweet->userProfileRemoteImageUrl = $data['user']['profile_image_url'] ?? null;
        $tweet->userScreenName = $data['user']['screen_name'] ?? null;

        return $tweet;
    }

    /**
     * Saves the original user profile image for a twitter user ID
     *
     * @param $userId
     * @param $remoteImageUrl
     *
     * @return string|null
     * @throws GuzzleException
     * @throws \yii\base\Exception
     */
    public function saveOriginalUserProfileImage($userId, $remoteImageUrl)
    {
        if (!$userId || !$remoteImageUrl) {
            return null;
        }

        $originalFolderPath = Craft::$app->path->getRuntimePath().'/twitter/userimages/'.$userId.'/original/';

The method getRuntimePath() does not exist on null.

        if (!is_dir($originalFolderPath)) {
            FileHelper::createDirectory($originalFolderPath);
        }

        $files = FileHelper::findFiles($originalFolderPath);

        if (count($files) > 0) {
            $imagePath = $files[0];

            return $imagePath;
        }

        $remoteImageUrl = str_replace('_normal', '', $remoteImageUrl);
        $fileName = pathinfo($remoteImageUrl, PATHINFO_BASENAME);
        $imagePath = $originalFolderPath.$fileName;

Are you sure $fileName of type array|string can be used in concatenation?

        $client = Craft::createGuzzleClient();
        $response = $client->request('GET', $remoteImageUrl, [
            'sink' => $imagePath
        ]);

        if (!$response->getStatusCode() != 200) {
            return null;
        }

        return $imagePath;
    }

    // Private Methods
    // =========================================================================

    /**
     * Returns the authenticated client.
     *
     * @return Client
     */
    private function getClient()
    {
        $options = [
            'base_uri' => 'https://api.twitter.com/1.1/'
        ];

        $token = Plugin::getInstance()->getOauth()->getToken();

        if ($token) {
            $stack = $this->getStack($token);

            $options['auth'] = 'oauth';
            $options['handler'] = $stack;
        }

        return Craft::createGuzzleClient($options);
    }

    /**
     * Get stack
     *
     * @param TokenCredentials $token
     *
     * @return HandlerStack
     */
    private function getStack(TokenCredentials $token)
    {
        $stack = HandlerStack::create();

        $oauthConsumerKey = Plugin::getInstance()->getConsumerKey();
        $oauthConsumerSecret = Plugin::getInstance()->getConsumerSecret();

        $middleware = new Oauth1([
            'consumer_key' => $oauthConsumerKey,
            'consumer_secret' => $oauthConsumerSecret,
            'token' => $token->getIdentifier(),
            'token_secret' => $token->getSecret(),
            'signature_method' => 'HMAC-SHA1'
        ]);

        $stack->push($middleware);

        return $stack;
    }

    /**
     * Returns a tweet by its ID.
     *
     * @param            $tweetId
     * @param array|null $query
     *
     * @return Tweet|null
     * @throws GuzzleException
     * @throws \yii\base\Exception
     */
    private function getTweetById($tweetId, array $query = null)
    {
        $tweetId = (int)$tweetId;

        if(!$query) {
            $query = [];
        }

        $query = array_merge($query, [
            'id' => $tweetId,
            'tweet_mode' => 'extended'
        ]);

        $data = $this->get('statuses/show', $query);

        if (!$data) {
            return null;
        }

        $tweet = new Tweet();
        $this->populateTweetFromData($tweet, $data);

        // generate user profile image
        $this->saveOriginalUserProfileImage($tweet->remoteUserId, $tweet->userProfileRemoteImageSecureUrl);

        return $tweet;
    }
}