Wallogit.com
2017 © Pedro Peláez
A lightweight and highly customized CURL wrapper for making RESt calls and a wrapper for call dynamically SOAP requests.
, (*1)
A lightweight PSR-7 implementation and and highly customized CURL wrapper for making RESt calls., (*2)
This class implements: * PSR-7 Request and Response; * PSR-18 Http Client * Helper to create Request instances with the most common use cases; * Wrapper to execute several requests in parallel;, (*3)
Since the implementation follow the PSR7 implementation there is no much explanation about the usage., (*4)
The key elements are:, (*5)
More information about the PSR-7 here., (*6)
The implementation to send the request object is defined by the class HttpClient.
This class follow partially the PSR-18 implementation.
So, once you have a Request instance defined just need to call HttpClient::sendRequest($request);, (*7)
<?php
$uri = \ByJG\Util\Uri::getInstanceFromString('http://www.example.com/page');
$request = \ByJG\WebRequest\Psr7\Request::getInstance($uri);
$response = \ByJG\WebRequest\HttpClient::getInstance()->sendRequest($request);
<?php
$uri = \ByJG\Util\Uri::getInstanceFromString('http://www.example.com/page')
->withQuery(http_build_query(['param'=>'value']));
$request = \ByJG\WebRequest\Psr7\Request::getInstance($uri);
$response = \ByJG\WebRequest\HttpClient::getInstance()->sendRequest($request);
The WebRequest package has Helper classes to make it easy to create Request instances for some use cases., (*8)
<?php
$uri = \ByJG\Util\Uri::getInstanceFromString('http://www.example.com/page');
$request = \ByJG\WebRequest\Helper\RequestJson::build(
$uri,
"POST",
'{teste: "value"}' // Support an associate array
);
$response = \ByJG\WebRequest\HttpClient::getInstance()->sendRequest($request);
<?php
$uri = \ByJG\Util\Uri::getInstanceFromString('http://www.example.com/page');
$request = \ByJG\WebRequest\Helper\RequestFormUrlEncoded::build(
$uri,
["param" => "value"]
);
$response = \ByJG\WebRequest\HttpClient::getInstance()->sendRequest($request);
<?php
$uri = \ByJG\Util\Uri::getInstanceFromString('http://www.example.com/page');
// Define the contents to upload using a list of MultiPartItem objects
$uploadFile = [];
$uploadFile[] = new \ByJG\WebRequest\MultiPartItem('field1', 'value1');
$uploadFile[] = new \ByJG\WebRequest\MultiPartItem(
'field2',
'{"key": "value2"}',
'filename.json',
'application/json; charset=UTF-8'
);
$uploadFile[] = new \ByJG\WebRequest\MultiPartItem('field3', 'value3');
// Use the Wrapper to create the Request
$request = \ByJG\WebRequest\Helper\RequestMultiPart::build(Uri::getInstanceFromString($uri),
"POST",
$uploadFile
);
// Do the request as usual
$response = \ByJG\WebRequest\HttpClient::getInstance()->sendRequest($request);
The customizations options are:, (*9)
<?php
$client = \ByJG\WebRequest\HttpClient::getInstance()
->withNoFollowRedirect() // HttpClient will not follow redirects (status codes 301 and 302). Default is follow
->withNoSSLVerification() // HttpClient will not validate the SSL certificate. Default is validate.
->withProxy($uri) // Define a http Proxy based on the URI.
->withCurlOption($key, $value) // Set an arbitrary CURL option (use with caution)
;
You can use the HttpClient to do several differents requests in parallel., (*10)
To use this funcionallity you need:, (*11)
The results will be processed as soon is ready., (*12)
Below a basic example:, (*13)
<?php
// Create the instances of the requirements
$httpClient = \ByJG\WebRequest\HttpClient::getInstance();
$onSucess = function ($response, $id) {
// Do something with Response object
};
$onError = function ($error, $id) use (&$fail) {
// Do something
};
// Create the HttpClientParallel
$multi = new \ByJG\WebRequest\HttpClientParallel(
$httpClient,
$onSucess,
$onError
);
// Add the request to run in parallel
$request1 = Request::getInstance($uri1);
$request2 = Request::getInstance($uri2);
$request3 = Request::getInstance($uri3);
$multi
->addRequest($request1)
->addRequest($request2)
->addRequest($request3);
// Start execute and wait to finish
// The results will be get from the closure defined above.
$multi->execute();
The class MockClient has the same methods that HttpClient except by:, (*14)
<?php
$expectedResponse = new Response(200);
$mock = $this->object = new MockClient($expectedResponse);
$response = $mock->sendRequest(new Request("http://example.com"));
assertEquals($expectedResponse, $response);
<?php
$expectedResponse = new Response(200);
$mock = $this->object = new MockClient($expectedResponse);
$response = $mock->sendRequest(new Request("http://example.com"));
$expectedCurlOptions = [
CURLOPT_CONNECTTIMEOUT => 30,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADER => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERAGENT => "Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)",
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_SSL_VERIFYPEER => 1,
CURLOPT_HTTPHEADER => [
'Host: localhost:8080'
],
];
assertEquals($expectedCurlOptions, $mock->getCurlConfiguration());
The methods below are available after the execution of the method sendRequest():, (*15)
composer install "byjg/webrequest"
We provide a docker-compose to enable start the test server easily., (*16)
docker-compose up -d
vendor/bin/phpunit
docker-compose down
flowchart TD
byjg/webrequest --> psr/http-message
byjg/webrequest --> psr/http-client
byjg/webrequest --> ext-json
byjg/webrequest --> byjg/uri
Open source ByJG, (*17)
A lightweight and highly customized CURL wrapper for making RESt calls and a wrapper for call dynamically SOAP requests.
MIT
A lightweight and highly customized CURL wrapper for making RESt calls and a wrapper for call dynamically SOAP requests.
MIT