Initial base commit for laravel web analyser application

Author: SurajAdsul

.gitignore

@@ -0,0 +1,15 @@
+/application/vendor
+/node_modules
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+/.idea
+/.vscode
+/.vagrant
+Homestead.json
+Homestead.yaml
+npm-debug.log
+yarn-error.log
+.env
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Suraj Adsul
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

application/.gitattributes

@@ -0,0 +1,5 @@
+* text=auto
+*.css linguist-vendored
+*.scss linguist-vendored
+*.js linguist-vendored
+CHANGELOG.md export-ignore

application/.gitignore

@@ -0,0 +1,12 @@
+/node_modules
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+/.idea
+/.vagrant
+Homestead.json
+Homestead.yaml
+npm-debug.log
+yarn-error.log
+.env

application/app/Analyser/Checker.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace App\Analyser;
+
+use App\Checkers\Levels;
+use GuzzleHttp\Psr7\Uri;
+use Illuminate\Contracts\Container\Container;
+
+class Checker
+{
+    private $container;
+    private $client;
+
+    public function __construct(Container $container, HttpClient $client)
+    {
+        $this->container = $container;
+        $this->client = $client;
+    }
+
+    /**
+     * Extract info using different checkers.
+     *
+     * @param $url
+     * @return \Generator
+     */
+    public function check($url)
+    {
+        $url = new Uri($url);
+
+        $response = $this->client->fetchData($url);
+
+        if (! $this->client->isSuccessful()) {
+            return yield [
+                'passed' => false,
+                'message' => $this->client->getStatusMessage(),
+            ];
+        }
+
+        $crawler = new Crawler($response, $url);
+
+        foreach (config('analysers') as $analyserClassName) {
+            $checker = $this->container->make($analyserClassName);
+
+            try {
+                $result = $checker->check($crawler, $response, $url);
+                yield [
+                    'passed' => $result,
+                    'message' => $result ? $checker->successMessage : $checker->failedMessage,
+                    'level' => $checker->level(),
+                ];
+            } catch (\Exception $e) {
+                yield [
+                    'passed' => false,
+                    'message' => "Error checking rule `{$analyserClassName}`.",
+                    'level' => Levels::ERROR,
+                ];
+            }
+        }
+    }
+}

application/app/Analyser/Crawler.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Analyser;
+
+use Psr\Http\Message\ResponseInterface;
+use Symfony\Component\CssSelector\CssSelectorConverter;
+use Symfony\Component\DomCrawler\Crawler as BaseCrawler;
+
+class Crawler extends BaseCrawler
+{
+    protected $rawHtml;
+
+    /**
+     * @param mixed $node A Node to use as the base for the crawling
+     * @param string $currentUri The current URI
+     * @param string $baseHref The base href value
+     */
+    public function __construct($node = null, $currentUri = null, $baseHref = null)
+    {
+        if ($node instanceof ResponseInterface) {
+            $node = (string) $node->getBody();
+        }
+
+        parent::__construct($node, $currentUri, $baseHref);
+    }
+}

application/app/Analyser/HttpClient.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace App\Analyser;
+
+use GuzzleHttp\Client;
+use Symfony\Component\HttpFoundation\Response;
+
+class HttpClient
+{
+    /**
+     * @var
+     */
+    private $client;
+    private $statusCode;
+
+    /**
+     * HttpClient constructor.
+     * @param Client|null $client
+     */
+    public function __construct(Client $client = null)
+    {
+        $this->setClient($client ?: new Client());
+    }
+
+    /**
+     * @param Client $client
+     */
+    private function setClient(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * @param $url
+     * @return $response
+     */
+    public function fetchData($url)
+    {
+        $response = $this->client->get($url, ['exceptions' => false]);
+
+        $this->statusCode = $response->getStatusCode();
+
+        return $response;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isSuccessful(): bool
+    {
+        return $this->statusCode >= Response::HTTP_OK && $this->statusCode < Response::HTTP_MULTIPLE_CHOICES;
+    }
+
+    /**
+     * @return string
+     */
+    public function getStatusMessage(): string
+    {
+        return $this->statusCode.': '.Response::$statusTexts[$this->statusCode];
+    }
+}

application/app/Analyser/Markdown.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Analyser;
+
+use Parsedown;
+
+class Markdown
+{
+    /**
+     * @var Parsedown
+     */
+    private $parsedown;
+
+    /**
+     * Markdown constructor.
+     * @param Parsedown|null $parsedown
+     */
+    public function __construct(Parsedown $parsedown = null)
+    {
+        $this->parsedown = $parsedown ?: new Parsedown();
+    }
+
+    /**
+     * Parse markdown into HTML.
+     *
+     * @param $text string The markdown text.
+     *
+     * @return string
+     */
+    public function parse($text): string
+    {
+        return $this->parsedown->parse($text);
+    }
+}

application/app/Checkers/AbstractChecker.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Checkers;
+
+use App\Analyser\Crawler;
+use App\Facades\Markdown;
+use Psr\Http\Message\UriInterface;
+use Psr\Http\Message\ResponseInterface;
+
+abstract class AbstractChecker implements CheckerInterface
+{
+    abstract public function check(Crawler $crawler, ResponseInterface $response, UriInterface $uri);
+
+    public function level(): string
+    {
+        return Levels::WARNING;
+    }
+
+    public function successMessage(): string
+    {
+        throw new \Exception('Method not implemented');
+    }
+
+    public function failedMessage(): string
+    {
+        throw new \Exception('Method not implemented');
+    }
+
+    public function __get($name): string
+    {
+        if (in_array($name, ['successMessage', 'failedMessage'], true)) {
+            return Markdown::parse($this->$name());
+        }
+
+        return $this->$name;
+    }
+}

application/app/Checkers/CheckerInterface.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace App\Checkers;
+
+use App\Analyser\Crawler;
+use Psr\Http\Message\UriInterface;
+use Psr\Http\Message\ResponseInterface;
+
+interface CheckerInterface
+{
+    /**
+     * Extract info using checkers.
+     *
+     * @param Crawler $crawler
+     * @param ResponseInterface $response
+     * @param UriInterface $uri
+     *
+     * @return bool
+     */
+    public function check(Crawler $crawler, ResponseInterface $response, UriInterface $uri);
+
+    /**
+     * Get the critical level of the checker.
+     *
+     * @return string
+     */
+    public function level();
+
+    /**
+     * Get the message if the rule is passed.
+     *
+     * @return string
+     */
+    public function successMessage();
+
+    /**
+     * Get the message if the checker failed.
+     *
+     * @return string
+     */
+    public function failedMessage();
+}