TwitterEmbedTweetBlockService - Code Metrics - Inspection of "Deprecate Guzzle with psr http-client" - sonata-project/SonataSeoBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#361)

by Christian

created 2019-12-06 21:45 UTC

TwitterEmbedTweetBlockService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	9

Importance

Changes

Metric	Value
wmc	20
lcom	2
cbo	9
dl	0
loc	232
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	configureSettings()	14	1
A	buildEditForm()	53	1
A	getBlockMetadata()	6	2
A	getSupportedApiParams()	14	1
A	__construct()	11	1
A	execute()	7	1
A	buildUri()	23	5
B	loadTweet()	56	8

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\SeoBundle\Block\Social;

use GuzzleHttp\Exception\GuzzleException;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestFactoryInterface;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\BlockBundle\Block\BlockContextInterface;
use Sonata\BlockBundle\Model\BlockInterface;
use Sonata\CoreBundle\Form\Type\ImmutableArrayType;
use Sonata\CoreBundle\Model\Metadata;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\IntegerType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * This block service allows to embed a tweet by requesting the Twitter API.
 *
 * @see https://dev.twitter.com/docs/api/1/get/statuses/oembed
 *
 * @author Hugo Briand <[email protected]>
 */
class TwitterEmbedTweetBlockService extends BaseTwitterButtonBlockService
{
    public const TWITTER_OEMBED_URI = 'https://api.twitter.com/1/statuses/oembed.json';
    public const TWEET_URL_PATTERN = '%^(https://)(www.)?(twitter.com/)(.*)(/status)(es)?(/)([0-9]*)$%i';
    public const TWEET_ID_PATTERN = '%^([0-9]*)$%';

    /**
     * @var ClientInterface|null
     */
    private $httpClient;

    /**
     * @var RequestFactoryInterface|null
     */
    private $messageFactory;

    public function __construct(
        ?string $name,
        EngineInterface $templating,
        ClientInterface $httpClient = null,
        RequestFactoryInterface $messageFactory = null
    ) {
        parent::__construct($name, $templating);

        $this->httpClient = $httpClient;
        $this->messageFactory = $messageFactory;
    }

    public function execute(BlockContextInterface $blockContext, Response $response = null)
    {
        return $this->renderResponse($blockContext->getTemplate(), [
            'block' => $blockContext->getBlock(),
            'tweet' => $this->loadTweet($blockContext),
        ], $response);
    }

    /**
     * {@inheritdoc}
     */
    public function configureSettings(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            'template' => '@SonataSeo/Block/block_twitter_embed.html.twig',
            'tweet' => '',
            'maxwidth' => null,
            'hide_media' => false,
            'hide_thread' => false,
            'omit_script' => false,
            'align' => 'none',
            'related' => null,
            'lang' => null,
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function buildEditForm(FormMapper $form, BlockInterface $block)
    {
        $form->add('settings', ImmutableArrayType::class, [
            'keys' => [
                ['tweet', TextareaType::class, [
                    'required' => true,
                    'label' => 'form.label_tweet',
                    'sonata_help' => 'form.help_tweet',
                ]],
                ['maxwidth', IntegerType::class, [
                    'required' => false,
                    'label' => 'form.label_maxwidth',
                    'sonata_help' => 'form.help_maxwidth',
                ]],
                ['hide_media', CheckboxType::class, [
                    'required' => false,
                    'label' => 'form.label_hide_media',
                    'sonata_help' => 'form.help_hide_media',
                ]],
                ['hide_thread', CheckboxType::class, [
                    'required' => false,
                    'label' => 'form.label_hide_thread',
                    'sonata_help' => 'form.help_hide_thread',
                ]],
                ['omit_script', CheckboxType::class, [
                    'required' => false,
                    'label' => 'form.label_omit_script',
                    'sonata_help' => 'form.help_omit_script',
                ]],
                ['align', ChoiceType::class, [
                    'required' => false,
                    'choices' => [
                        'left' => 'form.label_align_left',
                        'right' => 'form.label_align_right',
                        'center' => 'form.label_align_center',
                        'none' => 'form.label_align_none',
                    ],
                    'label' => 'form.label_align',
                ]],
                ['related', TextType::class, [
                    'required' => false,
                    'label' => 'form.label_related',
                    'sonata_help' => 'form.help_related',
                ]],
                ['lang', ChoiceType::class, [
                    'required' => true,
                    'choices' => $this->languageList,
                    'label' => 'form.label_lang',
                ]],
            ],
            'translation_domain' => 'SonataSeoBundle',
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function getBlockMetadata($code = null)
    {
        return new Metadata($this->getName(), (null !== $code ? $code : $this->getName()), false, 'SonataSeoBundle', [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'class' => 'fa fa-twitter',
        ]);
    }

    /**
     * Returns supported API parameters from settings.
     *
     * @return array
     */
    protected function getSupportedApiParams()
    {
        return [
            'maxwidth',
            'hide_media',
            'hide_thread',
            'omit_script',
            'align',
            'related',
            'lang',
            'url',
            'id',
        ];
    }

    /**
     * Builds the API query URI based on $settings.
     *
     * @param bool $uriMatched
     *
     * @return string
     */
    protected function buildUri($uriMatched, array $settings)
    {
        $apiParams = $settings;
        $supportedParams = $this->getSupportedApiParams();

        if ($uriMatched) {
            // We matched the uri
            $apiParams['url'] = $settings['tweet'];
        } else {
            $apiParams['id'] = $settings['tweet'];
        }

        unset($apiParams['tweet']);

        $parameters = [];
        foreach ($apiParams as $key => $value) {
            if ($value && \in_array($key, $supportedParams, true)) {
                $parameters[] = $key.'='.$value;
            }
        }

        return sprintf('%s?%s', self::TWITTER_OEMBED_URI, implode('&', $parameters));
    }

    /**
     * Loads twitter tweet.
     */
    private function loadTweet(BlockContextInterface $blockContext): ?string
    {
        $uriMatched = preg_match(self::TWEET_URL_PATTERN, $blockContext->getSetting('tweet'));

        if (!$uriMatched || !preg_match(self::TWEET_ID_PATTERN, $blockContext->getSetting('tweet'))) {
            return null;
        }

        if (null !== $this->httpClient && null !== $this->messageFactory) {
            try {
                $response = $this->httpClient->sendRequest(
                    $this->messageFactory->createRequest(
                        'GET',
                        $this->buildUri($uriMatched, $blockContext->getSettings())
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    )
                );
            } catch (ClientExceptionInterface $e) {
                // log error
                return null;
            }

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

            return $apiTweet['html'];
        }

        // NEXT_MAJOR: Remove the old guzzle implementation

        // We matched an URL or an ID, we'll need to ask the API
        if (false === class_exists('GuzzleHttp\Client')) {
            throw new \RuntimeException(
                'The guzzle http client library is required to call the Twitter API.'.
                'Make sure to add psr/http-client or guzzlehttp/guzzle to your composer.json.'
            );
        }

        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            'The direct Guzzle implementation is deprecated since 2.x and will be removed with the next major release.',
            E_USER_DEPRECATED
        );

        // TODO cache API result
        $client = new \GuzzleHttp\Client();
        $client->setConfig(['curl.options' => [CURLOPT_CONNECTTIMEOUT_MS => 1000]]);

        try {
            $request = $client->get($this->buildUri($uriMatched, $blockContext->getSettings()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $apiTweet = json_decode($request->send()->getBody(true), true);


            return $apiTweet['html'];
        } catch (GuzzleException $e) {
            // log error
            return null;
        }
        // END NEXT_MAJOR
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\SeoBundle\Block\Social;
15
16			use GuzzleHttp\Exception\GuzzleException;
17			use Psr\Http\Client\ClientExceptionInterface;
18			use Psr\Http\Client\ClientInterface;
19			use Psr\Http\Message\RequestFactoryInterface;
20			use Sonata\AdminBundle\Form\FormMapper;
21			use Sonata\BlockBundle\Block\BlockContextInterface;
22			use Sonata\BlockBundle\Model\BlockInterface;
23			use Sonata\CoreBundle\Form\Type\ImmutableArrayType;
24			use Sonata\CoreBundle\Model\Metadata;
25			use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
26			use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
27			use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
28			use Symfony\Component\Form\Extension\Core\Type\IntegerType;
29			use Symfony\Component\Form\Extension\Core\Type\TextareaType;
30			use Symfony\Component\Form\Extension\Core\Type\TextType;
31			use Symfony\Component\HttpFoundation\Response;
32			use Symfony\Component\OptionsResolver\OptionsResolver;
33
34			/**
35			* This block service allows to embed a tweet by requesting the Twitter API.
36			*
37			* @see https://dev.twitter.com/docs/api/1/get/statuses/oembed
38			*
39			* @author Hugo Briand <[email protected]>
40			*/
41			class TwitterEmbedTweetBlockService extends BaseTwitterButtonBlockService
42			{
43			public const TWITTER_OEMBED_URI = 'https://api.twitter.com/1/statuses/oembed.json';
44			public const TWEET_URL_PATTERN = '%^(https://)(www.)?(twitter.com/)(.)(/status)(es)?(/)([0-9])$%i';
45			public const TWEET_ID_PATTERN = '%^([0-9]*)$%';
46
47			/**
48			* @var ClientInterface\|null
49			*/
50			private $httpClient;
51
52			/**
53			* @var RequestFactoryInterface\|null
54			*/
55			private $messageFactory;
56
57			public function __construct(
58			?string $name,
59			EngineInterface $templating,
60			ClientInterface $httpClient = null,
61			RequestFactoryInterface $messageFactory = null
62			) {
63			parent::__construct($name, $templating);
64
65			$this->httpClient = $httpClient;
66			$this->messageFactory = $messageFactory;
67			}
68
69			public function execute(BlockContextInterface $blockContext, Response $response = null)
70			{
71			return $this->renderResponse($blockContext->getTemplate(), [
72			'block' => $blockContext->getBlock(),
73			'tweet' => $this->loadTweet($blockContext),
74			], $response);
75			}
76
77			/**
78			* {@inheritdoc}
79			*/
80			public function configureSettings(OptionsResolver $resolver)
81			{
82			$resolver->setDefaults([
83			'template' => '@SonataSeo/Block/block_twitter_embed.html.twig',
84			'tweet' => '',
85			'maxwidth' => null,
86			'hide_media' => false,
87			'hide_thread' => false,
88			'omit_script' => false,
89			'align' => 'none',
90			'related' => null,
91			'lang' => null,
92			]);
93			}
94
95			/**
96			* {@inheritdoc}
97			*/
98			public function buildEditForm(FormMapper $form, BlockInterface $block)
99			{
100			$form->add('settings', ImmutableArrayType::class, [
101			'keys' => [
102			['tweet', TextareaType::class, [
103			'required' => true,
104			'label' => 'form.label_tweet',
105			'sonata_help' => 'form.help_tweet',
106			]],
107			['maxwidth', IntegerType::class, [
108			'required' => false,
109			'label' => 'form.label_maxwidth',
110			'sonata_help' => 'form.help_maxwidth',
111			]],
112			['hide_media', CheckboxType::class, [
113			'required' => false,
114			'label' => 'form.label_hide_media',
115			'sonata_help' => 'form.help_hide_media',
116			]],
117			['hide_thread', CheckboxType::class, [
118			'required' => false,
119			'label' => 'form.label_hide_thread',
120			'sonata_help' => 'form.help_hide_thread',
121			]],
122			['omit_script', CheckboxType::class, [
123			'required' => false,
124			'label' => 'form.label_omit_script',
125			'sonata_help' => 'form.help_omit_script',
126			]],
127			['align', ChoiceType::class, [
128			'required' => false,
129			'choices' => [
130			'left' => 'form.label_align_left',
131			'right' => 'form.label_align_right',
132			'center' => 'form.label_align_center',
133			'none' => 'form.label_align_none',
134			],
135			'label' => 'form.label_align',
136			]],
137			['related', TextType::class, [
138			'required' => false,
139			'label' => 'form.label_related',
140			'sonata_help' => 'form.help_related',
141			]],
142			['lang', ChoiceType::class, [
143			'required' => true,
144			'choices' => $this->languageList,
145			'label' => 'form.label_lang',
146			]],
147			],
148			'translation_domain' => 'SonataSeoBundle',
149			]);
150			}
151
152			/**
153			* {@inheritdoc}
154			*/
155			public function getBlockMetadata($code = null)
156			{
157			return new Metadata($this->getName(), (null !== $code ? $code : $this->getName()), false, 'SonataSeoBundle', [
			0 ignored issues – show Bug Best Practice introduced 2019-01-10 07:41 UTC by Report Bug Copy Issue Report The return type of `return new \Sonata\CoreB...' => 'fa fa-twitter'));` (`Sonata\CoreBundle\Model\Metadata`) is incompatible with the return type declared by the interface `Sonata\BlockBundle\Block...rface::getBlockMetadata` of type `Sonata\BlockBundle\Meta\MetadataInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history... Deprecated Code introduced 2019-04-24 01:23 UTC by Report Bug Copy Issue Report The class `Sonata\CoreBundle\Model\Metadata` has been deprecated with message: since version 3.13.0, to be removed in 4.0. Use Sonata\BlockBundle\Meta\Metadata instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
158			'class' => 'fa fa-twitter',
159			]);
160			}
161
162			/**
163			* Returns supported API parameters from settings.
164			*
165			* @return array
166			*/
167			protected function getSupportedApiParams()
168			{
169			return [
170			'maxwidth',
171			'hide_media',
172			'hide_thread',
173			'omit_script',
174			'align',
175			'related',
176			'lang',
177			'url',
178			'id',
179			];
180			}
181
182			/**
183			* Builds the API query URI based on $settings.
184			*
185			* @param bool $uriMatched
186			*
187			* @return string
188			*/
189			protected function buildUri($uriMatched, array $settings)
190			{
191			$apiParams = $settings;
192			$supportedParams = $this->getSupportedApiParams();
193
194			if ($uriMatched) {
195			// We matched the uri
196			$apiParams['url'] = $settings['tweet'];
197			} else {
198			$apiParams['id'] = $settings['tweet'];
199			}
200
201			unset($apiParams['tweet']);
202
203			$parameters = [];
204			foreach ($apiParams as $key => $value) {
205			if ($value && \in_array($key, $supportedParams, true)) {
206			$parameters[] = $key.'='.$value;
207			}
208			}
209
210			return sprintf('%s?%s', self::TWITTER_OEMBED_URI, implode('&', $parameters));
211			}
212
213			/**
214			* Loads twitter tweet.
215			*/
216			private function loadTweet(BlockContextInterface $blockContext): ?string
217			{
218			$uriMatched = preg_match(self::TWEET_URL_PATTERN, $blockContext->getSetting('tweet'));
219
220			if (!$uriMatched \|\| !preg_match(self::TWEET_ID_PATTERN, $blockContext->getSetting('tweet'))) {
221			return null;
222			}
223
224			if (null !== $this->httpClient && null !== $this->messageFactory) {
225			try {
226			$response = $this->httpClient->sendRequest(
227			$this->messageFactory->createRequest(
228			'GET',
229			$this->buildUri($uriMatched, $blockContext->getSettings())
			0 ignored issues – show Documentation introduced 2018-06-01 17:49 UTC by Report Bug Copy Issue Report `$uriMatched` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
230			)
231			);
232			} catch (ClientExceptionInterface $e) {
233			// log error
234			return null;
235			}
236
237			$apiTweet = json_decode($response->getBody(), true);
238
239			return $apiTweet['html'];
240			}
241
242			// NEXT_MAJOR: Remove the old guzzle implementation
243
244			// We matched an URL or an ID, we'll need to ask the API
245			if (false === class_exists('GuzzleHttp\Client')) {
246			throw new \RuntimeException(
247			'The guzzle http client library is required to call the Twitter API.'.
248			'Make sure to add psr/http-client or guzzlehttp/guzzle to your composer.json.'
249			);
250			}
251
252			@trigger_error(
			0 ignored issues – show Security Best Practice introduced 2019-01-15 18:44 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
253			'The direct Guzzle implementation is deprecated since 2.x and will be removed with the next major release.',
254			E_USER_DEPRECATED
255			);
256
257			// TODO cache API result
258			$client = new \GuzzleHttp\Client();
259			$client->setConfig(['curl.options' => [CURLOPT_CONNECTTIMEOUT_MS => 1000]]);
260
261			try {
262			$request = $client->get($this->buildUri($uriMatched, $blockContext->getSettings()));
			0 ignored issues – show Documentation introduced 2018-06-01 14:14 UTC by Report Bug Copy Issue Report `$uriMatched` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
263			$apiTweet = json_decode($request->send()->getBody(true), true);
			0 ignored issues – show Bug introduced 2018-06-01 15:42 UTC by Report Bug Copy Issue Report The method `send()` does not seem to exist on `object<Psr\Http\Message\ResponseInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
264
265			return $apiTweet['html'];
266			} catch (GuzzleException $e) {
267			// log error
268			return null;
269			}
270			// END NEXT_MAJOR
271			}
272			}
273

sonata-project / SonataSeoBundle

Pull Request — 2.x (#361)

TwitterEmbedTweetBlockService A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

Duplication Side-by-Side

Filter issues like