smokills / laravel-http-client-default-options

Extends the native Laravel Http Client, so that you can define default options

Set default available options to the Laravel Http Client.

Installation

Install the package via composer:

composer require smokills/laravel-http-client-default-options

Laravel

In a Laravel environment, the package will be autoregistered thanks to the Laravel Package Auto-Discovery

Lumen

If You would like use this package within a Lumen installation, you have to register the Service Provider in the app/bootstrap.php

$app->register(Smokills\Http\ServiceProvider::class);

Usage

You may define global options for the Http client in following way

// In a boot Service provider method (ex: the AppServiceProvider)

public function boot()
{
    ...

    Http::withDefaultOptions([
        'base_uri' => 'https://foo.com',
        'headers' => [
            'X-Bar-Header' => 'bar'
        ],
    ]);
}

From now on, all subsequent request will use the default options we have provided:

// Somewhere in the code

/**
 * Since we have defined the base_uri as default option, we can simply make a
 * request using only the uri.
 */
$response = Http::get('/baz');

We can still continue add other options or helpers if we need:

// Somewhere in the code

/**
 * The debug option and the basic auth will be used together the default options defined before.
 */
$response = Http::withOptions([
    'debug' => 'true'
])->withBasicAuth('username', 'password')->get('/baz');

If you need to remove several or even all of the the default options, in order to make other requests, you may use the withoutDefaultOptions method.

// Remove all of the default options...
$response = Http::withoutDefaultOptions()->get('https://bar.com');

// Remove some of the global options
$response = Http::withoutDefaultOptions([
    'option', 'another-option'
])->get('https://bar.com');

// You can pass options to remove as arguments as well
$response = Http::withoutDefaultOptions('option', 'another-option')->get('https://bar.com');

// If you would like to remove deeply nested options, you may use the the dot notation syntax
$response = Http::withoutDefaultOptions('header.X-Some-Header')->get('https://bar.com');

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• Vito Famiglietti
• All Contributors

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.

laravel-http-client-default-options's Issues

PHP 8 support

Hi,
Great package, any chance to have PHP 8 support?
Thanks,

How to set default options per instance?

In Guzzle I can do this:

        $this->client = new Client(
            [
                'base_uri' => 'https://www.example.com',
                'headers' => [
                    'some' => 'header',
                ],
            ]
        );

I do that in a base class common to several different subclasses that call APIs relative to this common base URL.

I'm looking at switching to the built-in Http Laravel class, and found your package while looking for how to do this. From your docs I can only see that you allow setting these options globally, across all instances of the Http client, which I don't want to do as I have other scripts that don't need those defaults, or per-request, which is messy. So I'm looking to create an instance on which I can set default properties.

I've tried using:

        $this->client = (new Http())->withOptions(
            [
                'base_uri' => 'https://www.example.com',
                'headers' => [
                    'some' => 'header',
                ],
            ]
        );

but that doesn't seem to work as it expects a request rather than a client instance. Is this possible? Is there another way? Or should I stick with native Guzzle?

it is not installing in laravel v9.x-dev

Your requirements could not be resolved to an installable set of packages.

Problem 1
- smokills/laravel-http-client-default-options[v2.0.0, ..., v2.0.2] require illuminate/http ^8.0 -> found illuminate/http[v8.0.0, ..., 8.x-dev] but these were not loaded, likely because it conflicts with another require.
- Root composer.json requires smokills/laravel-http-client-default-options ^2.0 -> satisfiable by smokills/laravel-http-client-default-options[v2.0.0, v2.0.1, v2.0.2].

You can also try re-running composer require with an explicit version constraint, e.g. "composer require smokills/laravel-http-client-default-options:*" to figure out if any version is installable, or "composer require smokills/laravel-http-client-default-options:^2.1" if you know which you need.