Initial Commit

Author: ahmard

.gitignore

@@ -0,0 +1,6 @@
+/vendor/
+
+/composer.lock
+/.phpunit.result.cache
+
+/test.php

.idea/.gitignore

@@ -0,0 +1,45 @@
+# ReactPHP QueryList
+
+This library brought [ReactPHP](https://github.com/reactphp/http) and [QueryList](https://github.com/jae-jae/QueryList)
+together.
+
+## Installation
+
+```
+composer require ahmard/reactphp-querylist
+```
+
+## Usage
+
+- Playing with **QueryList**(scraping)
+```php
+use ReactphpQuerylist\Client;
+use ReactphpQuerylist\Queryable;
+
+require 'vendor/autoload.php';
+
+Client::get('https://google.com')
+    ->then(function (Queryable $queryable){
+        $title = $queryable->queryList()->find('head title')->text();
+        var_dump($title);
+    })
+    ->otherwise(function ($error){
+        echo $error;
+    });
+```
+
+- Working with response object
+```php
+use ReactphpQuerylist\Client;
+use ReactphpQuerylist\Queryable;
+
+require 'vendor/autoload.php';
+
+Client::get('https://google.com')
+    ->then(function (Queryable $queryable){
+        var_dump($queryable->response()->getReasonPhrase());
+    })
+    ->otherwise(function ($error){
+        echo $error;
+    });
+```

README.md

@@ -0,0 +1,38 @@
+{
+    "name": "ahmard/reactphp-querylist",
+    "description": "ReactPHP QueryList Scrapper",
+    "type": "library",
+    "require": {
+        "php": "^7.4 || ^8.0",
+        "ext-json": "*",
+        "jaeger/querylist": "^4.2",
+        "react/http": "^1.5"
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^0.12.99",
+        "phpunit/phpunit": "^9.5",
+        "clue/block-react": "^1.4"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "ReactphpQuerylist\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "ReactphpQuerylist\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "analyse": "phpstan analyse",
+        "analyze": "@analyse",
+        "test": "phpunit"
+    },
+    "authors": [
+        {
+            "name": "ahmard",
+            "email": "ahmard06@gmail.com"
+        }
+    ]
+}

composer.json

@@ -0,0 +1,8 @@
+parameters:
+    level: 6
+    paths: ['src']
+    checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false
+    ignoreErrors:
+        - '#Unsafe usage of new static\(\)#'
+        - '#Call to an undefined method React\\Promise\\PromiseInterface::otherwise\(\)#'

phpstan.neon

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+>
+    <testsuites>
+        <testsuite name="ReactPHP QueryList Tests">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

phpunit.xml

@@ -0,0 +1,161 @@
+<?php
+
+namespace ReactphpQuerylist;
+
+use Psr\Http\Message\ResponseInterface;
+use React\Http\Browser;
+use React\Promise\Deferred;
+use React\Promise\PromiseInterface;
+use React\Stream\ReadableStreamInterface;
+
+class Client
+{
+    /**
+     * @param string $requestMethod
+     * @param string $url
+     * @param array $headers
+     * @param ReadableStreamInterface|string $body
+     * @return PromiseInterface
+     */
+    public function execute(
+        string $requestMethod,
+        string $url,
+        array  $headers = [],
+               $body = ''
+    ): PromiseInterface
+    {
+        return $this->prepareQueryable(
+            (new Browser())->request($requestMethod, $url, $headers, $body)
+        );
+    }
+
+    /**
+     * Construct QueryList object from response body
+     *
+     * @param PromiseInterface $promise
+     * @return PromiseInterface
+     */
+    protected function prepareQueryable(PromiseInterface $promise): PromiseInterface
+    {
+        $deferred = new Deferred();
+
+        // Construct queryable object when request is success
+        $promise->then(function (ResponseInterface $response) use ($deferred) {
+            $deferred->resolve(new Queryable($response));
+        });
+
+        // Forward any error to child promise
+        $promise->otherwise(fn($reason) => $deferred->reject($reason));
+
+        return $deferred->promise();
+    }
+
+    /**
+     * Send http GET request
+     *
+     * @param string $url
+     * @param array $headers
+     * @return PromiseInterface
+     */
+    public static function get(string $url, array $headers = []): PromiseInterface
+    {
+        return (new static())->execute('GET', $url, $headers);
+    }
+
+    /**
+     * Send http POST request
+     *
+     * @param string $url
+     * @param array $headers
+     * @param ReadableStreamInterface|string $body
+     * @return PromiseInterface
+     */
+    public static function post(string $url, array $headers = [], $body = ''): PromiseInterface
+    {
+        return (new static())->execute('POST', $url, $headers, $body);
+    }
+
+    /**
+     * Send http HEAD request
+     *
+     * @param string $url
+     * @param array $headers
+     * @return PromiseInterface
+     */
+    public static function head(string $url, array $headers = []): PromiseInterface
+    {
+        return (new static())->execute('HEAD', $url, $headers);
+    }
+
+    /**
+     * Send http PATCH request
+     *
+     * @param string $url
+     * @param array $headers
+     * @param ReadableStreamInterface|string $body
+     * @return PromiseInterface
+     */
+    public static function patch(string $url, array $headers = [], $body = ''): PromiseInterface
+    {
+        return (new static())->execute('PATCH', $url, $headers, $body);
+    }
+
+    /**
+     * Send http PUT request
+     *
+     * @param string $url
+     * @param array $headers
+     * @param ReadableStreamInterface|string $body
+     * @return PromiseInterface
+     */
+    public static function put(string $url, array $headers = [], $body = ''): PromiseInterface
+    {
+        return (new static())->execute('PUT', $url, $headers, $body);
+    }
+
+    /**
+     * Send http DELETE request
+     *
+     * @param string $url
+     * @param array $headers
+     * @return PromiseInterface
+     */
+    public static function delete(string $url, array $headers = []): PromiseInterface
+    {
+        return (new static())->execute('DELETE', $url, $headers);
+    }
+
+    /**
+     * Submit post request with json body
+     *
+     * @param string $url
+     * @param array $payload ['key' => 'value']
+     * @param array $headers
+     * @return PromiseInterface
+     */
+    public static function postJson(string $url, array $payload, array $headers = []): PromiseInterface
+    {
+        return self::post(
+            $url,
+            array_merge(['Content-Type' => 'application/json'], $headers),
+            json_encode($payload)
+        );
+    }
+
+    /**
+     * Submit form
+     *
+     * @param string $url
+     * @param array $fields ['name' => 'John Doe']
+     * @param array $headers
+     * @return PromiseInterface
+     */
+    public static function postForm(string $url, array $fields, array $headers = []): PromiseInterface
+    {
+        return self::post(
+            $url,
+            array_merge(['Content-Type' => 'application/x-www-form-urlencoded'], $headers),
+            http_build_query($fields)
+        );
+    }
+}

src/Client.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace ReactphpQuerylist;
+
+use Psr\Http\Message\ResponseInterface;
+use QL\QueryList;
+
+class Queryable
+{
+    protected ResponseInterface $response;
+    protected QueryList $queryList;
+
+
+    public function __construct(ResponseInterface $response)
+    {
+        $this->response = $response;
+        $this->queryList = QueryList::getInstance()->setHtml($response->getBody()->getContents());
+    }
+
+    /**
+     * @return QueryList
+     */
+    public function queryList(): QueryList
+    {
+        return $this->queryList;
+    }
+
+    /**
+     * @return ResponseInterface
+     */
+    public function response(): ResponseInterface
+    {
+        return $this->response;
+    }
+}

src/Queryable.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace ReactphpQuerylist\Tests;
+
+use ReactphpQuerylist\Queryable;
+use Exception;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ResponseInterface;
+use QL\QueryList;
+use React\EventLoop\Loop;
+use React\Promise\PromiseInterface;
+use function Clue\React\Block\await;
+
+class ClientTest extends TestCase
+{
+    public function testRequestMethods(): void
+    {
+        self::assertInstanceOf(PromiseInterface::class, TestableClient::get('/'));
+        self::assertInstanceOf(PromiseInterface::class, TestableClient::post('/'));
+        self::assertInstanceOf(PromiseInterface::class, TestableClient::head('/'));
+        self::assertInstanceOf(PromiseInterface::class, TestableClient::delete('/'));
+        self::assertInstanceOf(PromiseInterface::class, TestableClient::put('/'));
+        self::assertInstanceOf(PromiseInterface::class, TestableClient::patch('/'));
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function testQueryAble(): void
+    {
+        $queryAble = await(TestableClient::get('/'), Loop::get());
+
+        self::assertInstanceOf(Queryable::class, $queryAble);
+        self::assertInstanceOf(ResponseInterface::class, $queryAble->response());
+        self::assertInstanceOf(QueryList::class, $queryAble->queryList());
+    }
+}

tests/ClientTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace ReactphpQuerylist\Tests;
+
+use ReactphpQuerylist\Client;
+use React\Http\Message\Response;
+use React\Promise\Deferred;
+use React\Promise\PromiseInterface;
+
+class TestableClient extends Client
+{
+    public function execute(string $requestMethod, string $url, array $headers = [], $body = ''): PromiseInterface
+    {
+        $deferred = new Deferred();
+
+        $deferred->resolve(new Response(200, [], uniqid()));
+
+        return $this->prepareQueryable($deferred->promise());
+    }
+}