scaytrase/json-rpc-client

JSON-RPC 2.0 Client implementation

1.0.2 2017-04-27 13:53 UTC

This package is auto-updated.

Last update: 2021-11-25 22:40:24 UTC


README

Build Status Code Coverage Scrutinizer Code Quality SensioLabsInsight

Latest Stable Version Total Downloads Latest Unstable Version

JSON-RPC 2.0 Client implementation

Extension of scaytrase/rpc-common

  • JSON RPC Interfaces
  • JSON RPC client
  • Async with Guzzle
  • Automatic batch with multiple requests or LazyClientDecorator

JSON-RPC 2.0 Specification

Usage

  1. Configure a Guzzle client.
  2. Instantiate the client:
use ScayTrase\Api\JsonRpc\JsonRpcClient;

$client = new JsonRpcClient($guzzleClient, 'http://endpoint/url/');
  1. Optionally pass the ID generator as third argument and the PSR-3 logger as the fourth argument

Simple UUID generator and PSR-3 NullLogger are used by default. ID is generated for RpcRequestInterface instances. If request is instance of JsonRpcRequestInterface and does not contain an ID assigned, the request is traited as notification request and will not receive the response from server.

  1. Create a RpcRequestInterface instance

With JsonRpcRequest class:

$request = new \ScayTrase\Api\JsonRpc\JsonRpcRequest('my/method', ['param1' => 'val1'], 'request_id');
$notification = new \ScayTrase\Api\JsonRpc\JsonRpcRequest('my/method', ['param1' => 'val1']);

With JsonRpcNotification class:

$notification = new \ScayTrase\Api\JsonRpc\JsonRpcNotification('my/method', ['param1' => 'val1']);

With custom RpcRequestInterface implementation:

final class MyRpcRequest implements \ScayTrase\Api\Rpc\RpcRequestInterface 
{
    public function getMethod() 
    {
        return 'my/method';
    }
    
    public function getParameters() 
    {
        return ['param1' => 'val1'];      
    }
}

$request = new MyRpcRequest;
  1. Call the client
/** @var \ScayTrase\Api\Rpc\RpcClientInterface $client */
/** @var \ScayTrase\Api\Rpc\RpcRequestInterface $request */
 
$collection = $client->invoke($request);
$collection = $client->invoke([$request]);

The collection object contains the mapping between the requests and the responses

/** @var \ScayTrase\Api\Rpc\RpcRequestInterface $request */
/** @var \ScayTrase\Api\Rpc\ResponseCollectionInterface $collection */

$response = $collection->getResponse($request);

Decorating

Refer scaytrase/rpc-common base library for some useful decorators:

  • CacheableRpcClient
  • LazyRpcClient
  • LoggableRpcClient
  • ProfiledClient
  • TraceableClient