ksuzuki2016/laravel-http-client

The Laravel Http Facade Expansion

2.0.5 2024-04-21 21:05 UTC

Requires

• php: >=7.3 || >=8.0
• ext-dom: *
• ext-json: *
• ext-mbstring: *
• ext-simplexml: *
• ext-zlib: *
• guzzlehttp/guzzle: ^7.0
• laravel/dusk: ^6.0
• php-webdriver/webdriver: ^1.8
• symfony/dom-crawler: ^5.0
• symfony/process: ^5.1||^6.0

Requires (Dev)

• mockery/mockery: ^1.4
• orchestra/testbench: ^7.0
• orchestra/testbench-core: ^7.0
• phpunit/phpunit: ^9.4
• roave/security-advisories: dev-master
• vimeo/psalm: ^4.1

MIT

• laravel
• httpclient

README

LaravelのHttpファサードを拡張して利用するライブラリ

基本的な機能はLaravel HTTPクライアントと同じ、その他いくつかの機能追加

インストール

$ composer require KSuzuki2016/laravel-http-client

Chromeをサーバーへインストール

google-chromeとかgoogle-chrome-stableあたりが入ってれば大丈夫

sudo wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
sudo sh -c 'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
sudo apt-get update
sudo apt-get install -y google-chrome-stable

ドライバの追加

現状で利用可能なバーションは70から73のバージョン限定

php artisan dusk:chrome-driver 70

設定

<?php

return [

    'binPath' => env('HTTP_CLIENT_CHROME_PATH') ,

    /*
    |--------------------------------------------------------------------------
    | Http Request Driver
    |--------------------------------------------------------------------------
    | dusk is alias for dusk-chrome
    |
    | Drivers: "guzzle", "dusk" , "dusk-chrome"
    |
    */
    'default' => env('HTTP_CLIENT_DRIVER', 'guzzle') ,

    'http_facade_overwrite' => env('HTTP_FACADE_OVERWRITE', false ) ,

];

使い方

managerクラスからクライアントドライバを呼び出して使うかhttp-clientを呼び出す

HTTP_FACADE_OVERWRITEにtrueが設定されていればHttpファサードを上書きする

<?php

use KSuzuki2016\HttpClient\DriverManager ;

$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')->get('URL') ;

// 又は

$manager = app('http-client') ;
$manager->get('URL') ;

chromedriver

HTTP_CLIENT_CHROME_PATHに設定したディレクトリ内のドライバを利用

HTTP_CLIENT_CHROME_PATH="/vagrant/vendor/ksuzuki2016/laravel-http-client/bin"

Response拡張

responseにcrawlerとstacksを追加

crawlerはSymfony\Component\DomCrawler\Crawlerを返す

stacksは配列を返す

<?php
use KSuzuki2016\HttpClient\DriverManager ;

$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')->get('URL')->crawler() ;
$manager->driver('dusk')->get('URL')->stacks() ;

2021.3.27 schemaを追加

<script type="application/ld+json">...</script>のデータを取得してCollectionとして返す

<?php
use KSuzuki2016\HttpClient\DriverManager ;

$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->get('URL')->schema() ;

javascript browser macro

javascriptの実行が可能

browserCallbackに設定

<?php
use KSuzuki2016\HttpClient\DriverManager ;

$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')->browserCallback( new BrowserMacro )->get('URL') ;

例

戻り値はレスポンスヘッダーのstacksに格納される

<?php
namespace HttpClient\Macros;

use KSuzuki2016\HttpClient\Drivers\ChromeBrowser;

class TestMacro
{
    /**
     * @param ChromeBrowser $browser
     * @return void|string|null
     */
    public function __invoke(ChromeBrowser $browser)
    {
        // Browser Macro
    }
}

スクリプトエラー

マクロ実行中に発生したエラーログはレスポンスヘッダーのerrorsに格納されます

$response->header('errors');
/*
unknown error: Runtime.evaluate threw exception: SyntaxError: Unexpected identifier
  (Session info: headless chrome=87.0.4280.66)
  (Driver info: chromedriver=70.0.3538.97 (d035916fe243477005bc95fe2a5778b8f20b6ae1),platform=Linux 4.15.0-96-generic x86_64) screenshot path to screen
*/

Response Observer

レスポンスに対して処理を行う

responseObserverに設定

<?php
use KSuzuki2016\HttpClient\DriverManager ;

$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')
        ->responseObserver( new ResponseLogObserver )
        ->responseObserver( new ResponseObserver )
        ->get('URL') ;

実装方法

ResponseObserverInterfaceを実装して作成するかResponseObserverを継承する

連続したObserverの処理を止めたい場合はgetObservationからfalseを返却する

successfulとfailedのから返却されたHttpClientResponseで次の処理を行う(返却しなければオリジナルの値を使う)

例

<?php
namespace KSuzuki2016\HttpClient\Logging;

use KSuzuki2016\HttpClient\Contracts\ResponseObserver;
use KSuzuki2016\HttpClient\Http\Client\HttpClientResponse;

class ResponseLogObserver extends ResponseObserver
{
    public function successful(HttpClientResponse $response)
    {
        // 処理を書く
    }

    public function failed(HttpClientResponse $response)
    {
        // ResponseObserverを継承していれば
        // 以降の処理を止める場合にbreakObservationを呼び出して停止可能
        $this->breakObservation();
    }
}

HttpClientResponseの値を操作する

ResponseObserver等で値の変更が可能

setStacks( array $stacks ):self

シンプルな例

public function successful(HttpClientResponse $response)
{
    $stacks = array_merge( $response->stacks() , $response->json() ) ;
    $response->setStacks( $stacks ) ;
}

setJson( $key , $value = null ):self

値を変更して次の処理へ渡す場合returnで返却

public function successful(HttpClientResponse $response)
{
    return $response->setJson( 'key' , 'new value' ) ;
}

Make Command

stubからひな形を作成できます

Browser Macro

Browser Macroのひな形を作成

$ php artisan make:http:macro CustomMacro

Response Observer

Response Observerのひな形を作成

$ php artisan make:http:Observer CustomObserver

Http Client Request

パラメーターを設定したPendingRequestを呼び出す為のクラス

user agentを設定したクライアントの例

<?php
namespace App\HttpClients ;

use KSuzuki2016\HttpClient\Contracts\HttpClientRequest;

class MobileClient extends HttpClientRequest
{
    /**
     * observer brawserCallback の設定等を行う場合
     * プロパティでも設定可能
     * @property HttpClientFactory app
     * 
     * サービスプロバイダの bindings の様な設定も可能
     * @property array observers
     * @property array macros
    */

    protected $headers = [
        'user-agent' => 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.91 Mobile Safari/537.36'
    ] ;
}

利用方法

$client = new MobileClient ;
$client->get('http://...') ;

// ResponseObserver BrowserMacro の利用
$client->observe( ResponseObserver )->macro( BrowserMacro )->get('http://...') ;

// デバッグを行う場合
$client->debug()->get('http://...') ;