Add listener for scrape fails

Author: josemanuel-cardona

src/Scraper/Listeners/ScrapeFailedListener.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Softonic\LaravelIntelligentScraper\Scraper\Listeners;
+
+use Softonic\LaravelIntelligentScraper\Scraper\Events\ScrapeFailed;
+
+class ScrapeFailedListener
+{
+    private $listeners;
+
+    public function __construct($listeners)
+    {
+        $this->listeners = $listeners;
+    }
+
+    public function handle(ScrapeFailed $scraped)
+    {
+        if (isset($this->listeners[$scraped->scrapeRequest->type])) {
+            resolve($this->listeners[$scraped->scrapeRequest->type])->handle($scraped);
+        }
+    }
+}

src/ScraperProvider.php

@@ -11,6 +11,7 @@
 use Softonic\LaravelIntelligentScraper\Scraper\Listeners\ConfigureScraper;
 use Softonic\LaravelIntelligentScraper\Scraper\Listeners\Scrape;
 use Softonic\LaravelIntelligentScraper\Scraper\Listeners\ScrapedListener;
+use Softonic\LaravelIntelligentScraper\Scraper\Listeners\ScrapeFailedListener;
 use Softonic\LaravelIntelligentScraper\Scraper\Listeners\UpdateDataset;
 
 class ScraperProvider extends EventServiceProvider
@@ -75,7 +76,13 @@ public function register()
         $this->app->when(ScrapedListener::class)
             ->needs('$listeners')
             ->give(function () {
-                return config('scraper.listeners');
+                return config('scraper.listeners.scraped');
+            });
+
+        $this->app->when(ScrapeFailedListener::class)
+            ->needs('$listeners')
+            ->give(function () {
+                return config('scraper.listeners.scrape-failed');
             });
     }
 }

src/config/scraper.php

@@ -14,20 +14,31 @@
         'ignore-identifiers' => '/^react_.*$/',
     ],
     /*
-     * Configure listener per Scraped type
+     * Configure listener per event type
      *
      * Format:
      *      [
      *          'type' => 'handler class',
      *      ].
      *
+     * Declare in the "scraped" key the listener you want to attend the scrapes done successfully.
+     * Declare in the "scrape-failed" key the listener you want to attend the scrapes that could not retrieve the
+     * information.
+     *
      * Example:
-     *      [
-     *          'news' => App\NewsHandler::class,
-     *          'post' => App\PostHandler::class
-     *      ]
+     * 'scraped' => [
+     *       'post' => App\CreatePostHandler::class
+     *   ],
+     *   'scrape-failed' => [
+     *       'post' => App\NotifyErrorHandler::class
+     *   ]
      */
     'listeners' => [
-        //
+        'scraped' => [
+            //
+        ],
+        'scrape-failed' => [
+            //
+        ],
     ],
 ];

tests/Unit/Scraper/Listeners/ScrapeFailedListenerTest.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Softonic\LaravelIntelligentScraper\Scraper\Listeners;
+
+use Softonic\LaravelIntelligentScraper\Scraper\Events\ScrapeFailed;
+use Softonic\LaravelIntelligentScraper\Scraper\Events\ScrapeRequest;
+use Tests\TestCase;
+
+class ScrapeFailedListenerTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function whenReceiveAnUnknownScrapeFailedTypeItShouldDoNothing()
+    {
+        $listener = \Mockery::mock(ScrapeFailedListener::class);
+        \App::instance(get_class($listener), $listener);
+
+        $scrapeFailedListener = new ScrapeFailedListener([
+            'known_type' => get_class($listener),
+        ]);
+
+        $scrapeFailedEvent = new ScrapeFailed(
+            new ScrapeRequest(
+                'http://uri',
+                'unknown_type'
+            ),
+            [],
+            1
+        );
+
+        $listener->shouldNotReceive('handle');
+
+        $scrapeFailedListener->handle($scrapeFailedEvent);
+    }
+
+    /**
+     * @test
+     */
+    public function whenReceiveAKnownScrapeFailedTypeItShouldHandleTheEventWithTheSpecificDependency()
+    {
+        $listener = \Mockery::mock(ScrapeFailedListener::class);
+        \App::instance(get_class($listener), $listener);
+
+        $scrapeFailedListener = new ScrapeFailedListener([
+            'known_type' => get_class($listener),
+        ]);
+
+        $scrapeFailedEvent = new ScrapeFailed(
+            new ScrapeRequest(
+                'http://uri',
+                'known_type'
+            ),
+            [],
+            1
+        );
+
+        $listener->shouldReceive('handle')
+            ->once()
+            ->with($scrapeFailedEvent);
+
+        $scrapeFailedListener->handle($scrapeFailedEvent);
+    }
+}