juststeveking/http-slim

A slim psr compliant http client to provide better interoperability.

Fund package maintenance!
JustSteveKing

v2.1.0 2021-08-27 11:05 UTC

This package is auto-updated.

Last update: 2021-10-27 11:25:51 UTC


README

Latest Version Software License PHP Version run-tests Total Downloads

The purpose of this package is to create an interoperable http client implementation allowing a "bring you own packages" approach to connection to 3rd party services.

The main goal of this package is to adhere to the following PSRs:

Installation

Using composer:

$ composer require juststeveking/http-slim

You are then free to use it as needed within your projects.

Next steps

The next step is to install a compliant package to do the request itself.

A few packages that are recommended:

Usage

Once you have installed a PSR-18 package and a PSR-17 package we do not need to do anything else. This package support HTTP Autodiscovery for your PSR compliant Client and Request factories. However, should you choose to inject you can do!

<?php

declare(strict_types=1);

use JustSteveKing\HttpSlim\HttpClient;
use Symfony\Component\HttpClient\Psr18Client;

// Injecting Clients: 
$httpClient = HttpClient::build(
    clientInterface: new Psr18Client(),
    requestFactory: new Psr18Client(),
    streamFactory: new Psr18Client(),
);

// Using HTTP Auto-discovery
$httpClient = HttpClient::build();


// perform a get request
$httpClient->get(
    uri: 'https://api.example.com/v1/resource',
);

// perform a post request
$httpClient->post(
    uri: 'https://api.example.com/v1/resource',
    body: ['foo' => 'bar'],
);

// perform a put request
$httpClient->put(
    uri: 'https://api.example.com/v1/resource/identifier',
    body: ['foo' => 'bar'],
);

// perform a patch request
$httpClient->patch(
    uri: 'https://api.example.com/v1/resource/identifier',
    body: ['foo' => 'bar'],
);

// perform a delete request
$httpClient->delete(
    uri: 'https://api.example.com/v1/resource/identifier',
);

// perform an options request
$httpClient->options(
    uri: 'https://api.example.com/v1/resource/identifier',
    headers: ['X-OPTIONAL' => 'headers'],
);

// Adding Plugins
$httpClient->addPlugin(
    plugin: new \Http\Client\Common\Plugin\HeaderDefaultsPlugin(
        headers: ['Content-Type' => 'application/json'],
    ),
);

Tests

There is a composer script available to run the tests:

$ composer run preflight:test

However, if you are unable to run this please use the following command:

$ ./vendor/bin/phpunit --testdox

Security

If you discover any security related issues, please email juststevemcd@gmail.com instead of using the issue tracker.