rackbeat/laravel-client

Laravel PHP Client Library for our API

dev-master 2022-08-01 04:40 UTC

This package is auto-updated.

Last update: 2024-04-29 04:21:30 UTC


README

**~~~~~~ BY NO MEANS READY YET! ~~~~~~**

API Laravel SDK

Build Status Coverage Total Downloads Latest Stable Version License

Installation

You just require using composer and you're good to go!

composer require rackbeat/laravel-client

Usage

Coming soon...

Testing

The API class comes with a handful of mocking tools. You can mock a response or just assert that endpoints has been called.

Assert calls has been made

// Set up the API class to use mocking
\Rackbeat\API::mock();

// Has not been called yet 
\Rackbeat\API::assertNotCalled( 'get', '/lots' );

// Make a API call to GET /lots
\Rackbeat\API::lots()->index();

// Has now been called
\Rackbeat\API::assertCalled( 'get', '/lots' );

Mock the response

// Set up the API class to use mocking
\Rackbeat\API::mock();
\Rackbeat\API::mockResponse('GET', '/lots', 'no lots');

// Make a API call to GET /lots
\Rackbeat\API::lots()->index();

// Assert that the response was 'no lots'
\Rackbeat\API::assertResponded( 'get', '/lots', 'no lots' );

Contributors

...

Requirements

  • PHP >= 7.4
  • Laravel >= 6.0