juststeveking/laravel-transporter

Transporter is a futuristic way to send API requests in PHP. This is an OOP approach to handle API requests.

0.8.0 2021-08-13 10:54 UTC

This package is auto-updated.

Last update: 2021-09-13 11:20:11 UTC


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

Transporter is a futuristic way to send API requests in PHP. This is an OOP approach to handle API requests.

Installation

You can install the package via composer:

composer require juststeveking/laravel-transporter

You can publish the config file with:

php artisan vendor:publish --provider="JustSteveKing\Transporter\TransporterServiceProvider" --tag="transporter-config"

The contents of the published config file:

return [
    'base_uri' => env('TRANSPORTER_BASE_URI'),
];

Generating Request

To generate an API request to use with Transporter, you can use the Artisan make command:

php artisan make:api-request NameOfYourRequest

This will by default publish as: app/Transporter/Requests/NameOfYourRequest.php

Usage

Transporter Requests are an extention of Laravels PendingRequest so all of the methods available on a Pending Request is available to you on your requests.

Also when you send the request, you will receive a Illuminate\Http\Client\Response back, allowing you to do things such as collect($key) and json() and failed() very easily. We are simply just shifting how we send it into a class based approach.

TestRequest::build()
    ->withToken('foobar')
    ->withData([
        'title' => 'Build a package'
    ])
    ->send()
    ->json();

When building your request to send, you can override the following:

  • Request Data using withData(array $data)
  • Request Query Params using withQuery(array $query)
  • Request Path using setPath(string $path)

Faking a Request

To fake a request, all you need to do is replace the build method with the fake method:

TestRequest::fake()
    ->withToken('foobar')
    ->withData([
        'title' => 'Build a package'
    ])->withFakeData([
        'data' => 'faked'
    ])->send();

Which will return a response with the data you pass through to withFakeData, which internally will merge what is on the class with what you pass it. So you can build up an initial state of faked data per class.

Testing

To run the tests in parallel:

composer run test

To run the tests with a coverage report:

composer run test-coverage

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.