Merge pull request #399 from RedaktionsNetzwerk-Deutschland/bugfix/facebook-api-24th-oct

Fix Facebook API October 24th changes

Author: oscarotero

README.md

@@ -324,18 +324,19 @@ $client->setSettings([
 $embed = new Embed(new Crawler($client));
 ```
 
-If you need to pass settings to your detectors, you can use the `setSettings` method:
+If you need to pass settings to your detectors, you can add settings to the `ExtractorFactory`:
 
 ```php
-//Create the extractor
-$info = $embed->get($url);
+use Embed\Embed;
 
-$info->setSettings([
+$embed = new Embed();
+$embed->setSettings([
     'oembed:query_parameters' => [],  //Extra parameters send to oembed
     'twitch:parent' => 'example.com', //Required to embed twitch videos as iframe
     'facebook:token' => '1234|5678',  //Required to embed content from Facebook
     'instagram:token' => '1234|5678', //Required to embed content from Instagram
 ]);
+$info = $embed->get($url);
 ```
 
 Note: The built-in detectors does not require settings. This feature is only for convenience if you create a specific detector that requires settings.

composer.json

@@ -27,6 +27,7 @@
         "php": "^7.4",
         "ext-curl": "*",
         "ext-dom": "*",
+        "ext-json": "*",
         "ext-mbstring": "*",
         "composer/ca-bundle": "^1.0",
         "oscarotero/html-parser": "^0.1.4",

demo/index.php

@@ -6,15 +6,16 @@
 
 function getUrl(): ?string
 {
-    $url = $_GET['url'] ?? null;
+    $skipParams = ['url', 'settings'];
+    $url = getParam('url');
 
-    if (empty($url)) {
+    if (!$url) {
         return null;
     }
 
     //fix for unescaped urls
     foreach ($_GET as $name => $value) {
-        if ($name === 'url') {
+        if (in_array($name, $skipParams, true)) {
             continue;
         }
 
@@ -24,6 +25,17 @@ function getUrl(): ?string
     return $url;
 }
 
+function getParam(string $paramName): ?string
+{
+    return $_GET[$paramName] ?? null;
+}
+
+function getJsonSettings(): array
+{
+    $jsonString = getParam('settings') ?: '{}';
+    return json_decode($jsonString, true, 512, JSON_THROW_ON_ERROR);
+}
+
 function getEscapedUrl(): ?string
 {
     $url = getUrl();
@@ -120,7 +132,6 @@ function printCode(?string $code, bool $asHtml = true): void
     'cms' => 'printText',
     'language' => 'printText',
     'languages' => 'printArray',
-    'cms' => 'printText',
 ];
 ?>
 
@@ -143,7 +154,7 @@ function printCode(?string $code, bool $asHtml = true): void
             form { background: #EEE; border-bottom: solid 1px #DDD; color: #666; padding: 3em 1.5em; }
             fieldset { border: none; padding: 0; }
             label { display: block; cursor: pointer; font-weight: bold; }
-            input[type="url"] { border: none; background: white; border-radius: 2px; box-sizing: border-box; width: 100%; margin: 5px 0; font-size: 1.3em; padding: 0.5em; color: #666; }
+            input[type="url"], textarea { border: none; background: white; border-radius: 2px; box-sizing: border-box; min-width: 100%; margin: 5px 0; font-size: 1.3em; padding: 0.5em; color: #666; }
             button, summary { font-size: 1.6rem; font-weight: bold; font-family: Arial; background: yellowgreen; border: none; border-radius: 3px; padding: 0.3em 1em; cursor: pointer; margin-top: 5px; }
             button:hover, summary:hover { background: black; color: white; }
             details {
@@ -154,7 +165,7 @@ function printCode(?string $code, bool $asHtml = true): void
                 width: max-content;
                 margin: auto;
             }
-
+            .helptext { font-weight: normal; font-size: 0.75em; }
             /* result */
             main { padding: 1.5em; }
             main h1, main h2 { font-size: 2em; color: #666; letter-spacing: -0.02em; }
@@ -173,6 +184,19 @@ function printCode(?string $code, bool $asHtml = true): void
                     <span>Url to test:</span>
                     <input type="url" name="url" autofocus placeholder="http://" value="<?php echo getEscapedUrl(); ?>">
                 </label>
+                <label>
+                    <span>Settings:</span>
+                    <?php
+                    $placeholderJson = json_encode(['instagram:token' => null], JSON_PRETTY_PRINT);
+                    $currentJson = getJsonSettings();
+                    ?>
+                    <textarea name="settings" rows="3" placeholder='<?php echo $placeholderJson; ?>'><?php
+                         echo !empty($currentJson)
+                             ? json_encode($currentJson, JSON_PRETTY_PRINT | JSON_FORCE_OBJECT)
+                             : '';
+                    ?></textarea>
+                    <span class="helptext">Add settings like "instagram:token", "facebook:token", ...</span>
+                </label>
             </fieldset>
 
             <fieldset class="action">
@@ -182,7 +206,7 @@ function printCode(?string $code, bool $asHtml = true): void
             </fieldset>
         </form>
 
-        <?php if (getUrl()): ?>
+        <?php if (getUrl()) : ?>
         <main>
             <h1>Result:</h1>
 
@@ -193,10 +217,16 @@ function printCode(?string $code, bool $asHtml = true): void
                     'Accept-Language' => 'en-US,en;q=0.2',
                     'Cache-Control' => 'max-age=0,no-cache',
                 ]);
+
+                $embed->setSettings(
+                    array_merge(
+                        [
+                            'twitch:parent' => $_SERVER['SERVER_NAME'] === 'localhost' ? null : $_SERVER['SERVER_NAME'],
+                        ],
+                        getJsonSettings()
+                    )
+                );
                 $info = $embed->get(getUrl());
-                $info->setSettings([
-                    'twitch:parent' => $_SERVER['SERVER_NAME'] === 'localhost' ? null : $_SERVER['SERVER_NAME'],
-                ]);
             } catch (Exception $exception) {
                 echo '<pre>';
                 echo $exception;
@@ -206,7 +236,7 @@ function printCode(?string $code, bool $asHtml = true): void
             ?>
 
             <table>
-                <?php foreach ($detectors as $name => $fn): ?>
+                <?php foreach ($detectors as $name => $fn) : ?>
                 <tr>
                     <th><?php echo $name; ?></th>
                     <td><?php $fn($info->$name); ?></td>
@@ -250,7 +280,7 @@ function printCode(?string $code, bool $asHtml = true): void
                         </tr>
                     </table>
 
-                    <?php if (method_exists($info, 'getApi')): ?>
+                    <?php if (method_exists($info, 'getApi')) : ?>
                     <h2>API data</h2>
 
                     <table>

phpunit.xml.dist

@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.4/phpunit.xsd"
+    bootstrap="vendor/autoload.php"
     backupGlobals="false"
     backupStaticAttributes="false"
     colors="true"

src/Adapters/Facebook/OEmbed.php

@@ -26,7 +26,7 @@ protected function detectEndpoint(): ?UriInterface
 
         return $this->extractor->getCrawler()
             ->createUri($this->getEndpointByPath($uri->getPath()))
-            ->withQuery($queryParameters);
+            ->withQuery(http_build_query($queryParameters));
     }
 
     private function getEndpointByPath(string $path): string

src/Adapters/Instagram/OEmbed.php

@@ -24,6 +24,6 @@ protected function detectEndpoint(): ?UriInterface
 
         return $this->extractor->getCrawler()
             ->createUri(self::ENDPOINT)
-            ->withQuery($queryParameters);
+            ->withQuery(http_build_query($queryParameters));
     }
 }

src/ApiTrait.php

@@ -9,7 +9,7 @@
 
 trait ApiTrait
 {
-    private Extractor $extractor;
+    protected Extractor $extractor;
     private array $data;
 
     public function __construct(Extractor $extractor)

src/Embed.php

@@ -57,6 +57,11 @@ public function getExtractorFactory(): ExtractorFactory
         return $this->extractorFactory;
     }
 
+    public function setSettings(array $settings): void
+    {
+        $this->extractorFactory->setSettings($settings);
+    }
+
     private function extract(RequestInterface $request, ResponseInterface $response, bool $redirect = true): Extractor
     {
         $uri = $this->crawler->getResponseUri($response) ?: $request->getUri();

src/Extractor.php

@@ -62,7 +62,7 @@ class Extractor
     private Crawler $crawler;
 
     private Document $document;
-    private OEmbed $oembed;
+    protected OEmbed $oembed;
     private LinkedData $linkedData;
     private Metas $metas;
 

src/ExtractorFactory.php

@@ -33,6 +33,12 @@ class ExtractorFactory
         'twitch.tv' => Adapters\Twitch\Extractor::class,
     ];
     private array $customDetectors = [];
+    private array $settings;
+
+    public function __construct(?array $settings = [])
+    {
+        $this->settings = $settings ?? [];
+    }
 
     public function createExtractor(UriInterface $uri, RequestInterface $request, ResponseInterface $response, Crawler $crawler): Extractor
     {
@@ -41,7 +47,9 @@ public function createExtractor(UriInterface $uri, RequestInterface $request, Re
 
         $class = $this->adapters[$host] ?? $this->default;
 
+        /** @var Extractor $extractor */
         $extractor = new $class($uri, $request, $response, $crawler);
+        $extractor->setSettings($this->settings);
 
         foreach ($this->customDetectors as $name => $detector) {
             $extractor->addDetector($name, new $detector($extractor));
@@ -69,4 +77,9 @@ public function setDefault(string $class): void
     {
         $this->default = $class;
     }
+
+    public function setSettings(array $settings): void
+    {
+        $this->settings = $settings;
+    }
 }

tests/PagesTest.php

@@ -33,7 +33,6 @@ public function testPages()
         $this->assertEmbed('http://www.hookem.com/story/texas-shortstop-joe-baker-arrested-public-intoxication/');
         $this->assertEmbed('http://i.imgur.com/X6rkCc5.jpg');
         $this->assertEmbed('https://infogr.am/7743c36a-f3ca-4465-9a80-a8abbd5d8dc4');
-        $this->assertEmbed('https://www.instagram.com/p/ySl7G9tO_q/');
         $this->assertEmbed('http://output.jsbin.com/vonesu/10');
         $this->assertEmbed('http://jsfiddle.net/zhm5rjnz/');
         $this->assertEmbed('https://www.kickstarter.com/projects/1452363698/good-seed-craft-veggie-burgers');
@@ -91,7 +90,11 @@ public function testArchiveOrg()
 
     public function testInstagram()
     {
-        $this->assertEmbed('http://instagram.com/p/ySl7G9tO_q/');
+        if (getenv('INSTAGRAM_TOKEN') ?? false) {
+            $this->assertEmbed('http://instagram.com/p/ySl7G9tO_q/');
+        } else {
+            self::markTestSkipped('Environment variable `INSTAGRAM_TOKEN` must be provided to test instagram. See https://developers.facebook.com/docs/instagram/oembed/');
+        }
     }
 
     public function testMeetup()
@@ -127,8 +130,12 @@ public function testFlickr()
 
     public function testFacebook()
     {
-        $this->assertEmbed('https://www.facebook.com/permalink.php?story_fbid=827163017327807&id=149460691764713');
-        $this->assertEmbed('https://www.facebook.com/acolono/videos/10154107990797381/');
+        if (getenv('FACEBOOK_TOKEN') ?? false) {
+            $this->assertEmbed('https://www.facebook.com/permalink.php?story_fbid=827163017327807&id=149460691764713');
+            $this->assertEmbed('https://www.facebook.com/acolono/videos/10154107990797381/');
+        } else {
+            self::markTestSkipped('Environment variable `FACEBOOK_TOKEN` must be provided to test facebook. See https://developers.facebook.com/docs/plugins/oembed');
+        }
     }
 
     public function testGithub()

tests/PagesTestCase.php

@@ -7,6 +7,7 @@
 use Datetime;
 use Embed\Embed;
 use Embed\Extractor;
+use Embed\ExtractorFactory;
 use Embed\Http\Crawler;
 use JsonSerializable;
 use PHPUnit\Framework\TestCase;
@@ -50,7 +51,7 @@ private static function getEmbed(): Embed
         $dispatcher = new FileClient(__DIR__.'/cache');
         $dispatcher->setMode(static::CACHE);
 
-        return self::$embed = new Embed(new Crawler($dispatcher));
+        return self::$embed = new Embed(new Crawler($dispatcher), self::getExtractorFactory());
     }
 
     protected function assertEmbed(string $url)
@@ -65,6 +66,7 @@ protected function assertEmbed(string $url)
         if (!$expected || static::FIXTURES === 1) {
             self::writeData($uri, $data);
             echo PHP_EOL."Save fixture: {$url}";
+            $this->markTestSkipped('Skipped assertion for '.$url);
         } else {
             $this->assertEquals($expected, $data, $url);
         }
@@ -133,4 +135,14 @@ private static function convert($value)
 
         return $value;
     }
+
+    private static function getExtractorFactory()
+    {
+        $settings = [
+            'instagram:token' => $_ENV['INSTAGRAM_TOKEN'] ?? null,
+            'facebook:token' => $_ENV['FACEBOOK_TOKEN'] ?? null,
+        ];
+
+        return new ExtractorFactory($settings);
+    }
 }