Json Rpc Client Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require scaytrase/json-rpc-client
   

   Add to composer.json if not auto-loaded:

   "autoload": {
       "psr-4": {
           "App\\": "app/"
       }
   }
   

   Run composer dump-autoload.

2. First Request

   use Scaytrase\JsonRpc\Client;
   
   $client = new Client('http://example.com/rpc');
   $response = $client->call('methodName', [1, 2, 3]);
   

3. Basic Response Handling

   if ($response->isSuccess()) {
       $result = $response->getResult();
   } else {
       $error = $response->getError();
   }
   

First Use Case: Querying a Remote API

$client = new Client('https://api.example.com/rpc', [
    'headers' => ['Authorization' => 'Bearer token123']
]);

$balance = $client->call('getBalance', ['userId' => 123]);

Implementation Patterns

Common Workflows

1. Batch Requests

   $batch = $client->batch();
   $batch->call('method1', []);
   $batch->call('method2', ['param']);
   $responses = $client->sendBatch($batch);
   

2. Error Handling with Retries

   $client = new Client('https://api.example.com/rpc');
   $client->setRetryPolicy(3); // Retry 3 times on failure
   
   try {
       $response = $client->call('unreliableMethod', []);
   } catch (JsonRpcException $e) {
       // Log or handle specific errors
   }
   

3. Middleware for Logging/Transforming

   $client->addMiddleware(function ($request) {
       // Log request details
       return $request;
   });
   

Integration Tips

• Laravel Service Provider

  $this->app->singleton('jsonrpc.client', function ($app) {
      return new Client(config('services.jsonrpc.url'));
  });
  

• Dependency Injection

  public function __construct(Client $client) {
      $this->client = $client;
  }
  

• Configuration via .env

  JSONRPC_URL=https://api.example.com/rpc
  JSONRPC_TIMEOUT=30
  

Gotchas and Tips

Pitfalls

1. Deprecated Package

   • Last release in 2017; ensure compatibility with your PHP/Laravel version.
   • Check for forks or alternatives (e.g., rectorphp/json-rpc-client).

2. No Built-in Async Support

   • Use GuzzleHttp or ReactPHP wrappers for async requests.

3. Error Handling Quirks

   • JsonRpcException may not cover all HTTP errors (e.g., 500s). Use try-catch with GuzzleException if using HTTP transport.

Debugging Tips

• Enable Debug Mode

  $client->setDebug(true); // Logs requests/responses
  

• Inspect Raw Responses

  $rawResponse = $client->getLastRawResponse();
  

Extension Points

1. Custom Transport Layer Override Scaytrase\JsonRpc\Transport\TransportInterface for custom HTTP clients (e.g., Guzzle, Symfony HTTP).

2. Middleware for Authentication

   $client->addMiddleware(function ($request) {
       $request->setHeader('X-API-Key', config('services.jsonrpc.key'));
       return $request;
   });
   

3. Response Transformers

   $client->addResponseTransformer(function ($response) {
       return json_decode($response, true);
   });
   

Configuration Quirks

• Timeout Defaults Set explicitly to avoid silent hangs:

  $client = new Client('https://api.example.com/rpc', [
      'timeout' => 10 // seconds
  ]);
  

• SSL Verification Disable only for testing:

  $client->setVerifyPeer(false); // Not recommended for production