Update to support ivory-google-map refactor regarding psr/http* packages

Author: evertharmeling

.github/workflows/build.yml

@@ -16,27 +16,18 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php: [8.3]
+                php: [8.2]
                 stability: [ prefer-stable ]
-                symfony-version: [ '7.0.*' ]
+                symfony-version: [ '7.3' ]
                 include:
-                  - php: '8.1'
-                    symfony-version: 6.4.*
+                  - symfony-version: 6.4
+                    php: '8.1'
                     stability: prefer-lowest
-                  - php: '8.1'
-                    symfony-version: 6.4.*
+                  - symfony-version: 6.4
+                    php: '8.1'
                     stability: prefer-stable
-                  - php: '8.2'
-                    symfony-version: 6.4.*
-                    stability: prefer-stable
-                  - php: '8.2'
-                    symfony-version: 7.0.*
-                    stability: prefer-stable
-                  - php: '8.3'
-                    symfony-version: 7.0.*
-                    stability: prefer-stable
-                  - php: '8.4'
-                    symfony-version: 7.0.*
+                  - symfony-version: 7.3
+                    php: '8.4'
                     stability: prefer-stable
 
         env:

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+### 7.0.0 (xxx)
+
+ * updated to support `ivory/google-map:7.0`, full PSR-17 and PSR-18 compatibility
+
 ### 3.0.4 (2020-06-13)
 
  * updated documentation

DependencyInjection/Configuration.php

@@ -86,7 +86,7 @@ private function createServiceNode(string $service, bool $http): ArrayNodeDefini
                 ->isRequired()
                 ->cannotBeEmpty()
                 ->end()
-                ->scalarNode('message_factory')
+                ->scalarNode('request_factory')
                 ->isRequired()
                 ->cannotBeEmpty()
                 ->end()

DependencyInjection/IvoryGoogleMapExtension.php

@@ -141,7 +141,7 @@ private function loadServiceConfig(
         if ($http) {
             $definition
                 ->addArgument(new Reference($config['client']))
-                ->addArgument(new Reference($config['message_factory']));
+                ->addArgument(new Reference($config['request_factory']));
         }
 
         if ($http && isset($config['format'])) {

Resources/doc/installation.md

@@ -26,22 +26,20 @@ $ composer require ivory/google-map-bundle
 If you want to use the [Direction](/Resources/doc/service/direction.md), 
 [Distance Matrix](/Resources/doc/service/distance_matrix.md), [Elevation](/Resources/doc/service/elevation.md), 
 [Geocoder](/Resources/doc/service/geocoder.md), [Place](/Resources/doc/service/place/index.md) or 
-[Time Zone](/Resources/doc/service/time_zone.md) services, you will need an http client and message factory via 
-[Httplug](https://httplug.io/) which is an http client abstraction library as well as the 
-[Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library. 
+[Time Zone](/Resources/doc/service/time_zone.md) services, you will need an [PSR-18](https://www.php-fig.org/psr/psr-18/) 
+http client and [PSR-17](https://www.php-fig.org/psr/psr-17/) request factory as well as the
+[Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
 
-[Httplug](https://httplug.io/) and [Ivory Serializer](https://github.com/egeloen/ivory-serializer) provide bundles, so 
-let's install them to ease our life:
+The simplest implementation of PSR compatible libraries is using Symfony's [HttpClient](https://github.com/symfony/http-client)
+and a lightweight [PSR-7 library](https://github.com/Nyholm/psr7) by [Tobias Nyholm](https://github.com/Nyholm).
+Next to that use the [Ivory Serializer](https://github.com/egeloen/ivory-serializer) bundle, so let's install them to ease our life:
 
 ``` bash
 $ composer require egeloen/serializer-bundle
-$ composer require php-http/guzzle7-adapter
-$ composer require php-http/httplug-bundle
+$ composer require symfony/http-client
+$ composer require nyholm/psr7
 ```
 
-Here, I have chosen to use [Guzzle7](https://docs.guzzlephp.org/en/latest/psr7.html) but since Httplug supports the 
-most popular http clients, you can install your preferred one instead.
-
 ## Register the bundle
 
 Then, add the bundle in your `AppKernel`:
@@ -57,7 +55,14 @@ public function registerBundles()
 
         // Optionally
         new Ivory\SerializerBundle\IvorySerializerBundle(),
-        new Http\HttplugBundle\HttplugBundle(),
     ];
 }
 ```
+
+When using the [FrameworkBundle](https://github.com/symfony/framework-bundle) you will have a PSR-18 client service available 
+under `psr18.http_client`. Otherwise you would need to create a service definition for the 
+`Symfony\Component\HttpClient\Psr18Client` class and use that in the following Google service definitions in this bundle.
+
+The request factory implementation will be available as `nyholm.psr7.psr17_factory` when you use Symfony Flex in your 
+project. If not you must add a service definition for `Nyholm\Psr7\Factory\Psr17Factory` to be able to complete the 
+configuration.

Resources/doc/service/direction.md

@@ -7,9 +7,9 @@ or as latitude/longitude coordinates. The Direction API can return multi-part di
 
 ## Dependencies
 
-The Direction API requires an http client and a serializer. The library relies respectively on 
-[Httplug](http://httplug.io/) which is an http client abstraction library and the 
-[Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library. 
+The Direction API requires an [PSR-18](https://www.php-fig.org/psr/psr-18/) http client and a serializer. Any PSR-18 
+http client library is suitable, [HttpClient](https://github.com/symfony/http-client) is a popular and steady choice nowadays. 
+And the [Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library. 
 
 To install them, read this [documentation](/Resources/doc/installation.md).
 
@@ -21,26 +21,14 @@ By default, the direction service is disabled. In order to enable the service, y
 
 The http client and message factory are mandatory. They define which http client and message factory the direction 
 service will use for issuing http requests.
- 
-First, configure the [Httplug](http://httplug.io/) bundle.
 
-``` yaml
-httplug:
-    classes:
-        client: Http\Adapter\Guzzle7\Client
-        message_factory: Http\Message\MessageFactory\GuzzleMessageFactory
-    clients:
-        acme:
-            factory: httplug.factory.guzzle7
-```
-
-Then, configure the Google Map bundle:
+Configure the Google Map bundle:
 
 ``` yaml
 ivory_google_map:
     direction:
-        client: httplug.client.default
-        message_factory: httplug.message_factory.default
+        client: psr18.http_client
+        message_factory: nyholm.psr7.psr17_factory
 ```
 
 ### Format

Resources/doc/service/distance_matrix.md

@@ -9,9 +9,9 @@ single origin and destination to the [Direction API](/Resources/doc/service/dire
 
 ## Dependencies
 
-The Distance Matrix API requires an http client and a serializer. The library relies respectively on 
-[Httplug](http://httplug.io/) which is an http client abstraction library and the 
-[Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
+The Distance Matrix API requires an [PSR-18](https://www.php-fig.org/psr/psr-18/) http client and a serializer. Any PSR-18
+http client library is suitable, [HttpClient](https://github.com/symfony/http-client) is a popular and steady choice nowadays.
+And the [Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
 
 To install them, read this [documentation](/Resources/doc/installation.md).
 
@@ -24,25 +24,13 @@ By default, the distance matrix service is disabled. In order to enable the serv
 The http client and message factory are mandatory. They define which http client and message factory the distance 
 matrix service will use for issuing http requests.
 
-First, configure the [Httplug](http://httplug.io/) bundle.
-
-``` yaml
-httplug:
-    classes:
-        client: Http\Adapter\Guzzle7\Client
-        message_factory: Http\Message\MessageFactory\GuzzleMessageFactory
-    clients:
-        acme:
-            factory: httplug.factory.guzzle7
-```
-
-Then, configure the Google Map bundle:
+Configure the Google Map bundle:
 
 ``` yaml
 ivory_google_map:
     distance_matrix:
-        client: httplug.client.default
-        message_factory: httplug.message_factory.default
+        client: psr18.http_client
+        request_factory: nyholm.psr7.psr17_factory
 ```
 
 ### Format

Resources/doc/service/elevation.md

@@ -6,9 +6,9 @@ routes.
 
 ## Dependencies
 
-The Elevation API requires an http client and a serializer. The library relies respectively on 
-[Httplug](http://httplug.io/) which is an http client abstraction library and the 
-[Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
+The Elevation API requires an [PSR-18](https://www.php-fig.org/psr/psr-18/) http client and a serializer. Any PSR-18
+http client library is suitable, [HttpClient](https://github.com/symfony/http-client) is a popular and steady choice nowadays.
+And the [Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
 
 To install them, read this [documentation](/Resources/doc/installation.md).
 
@@ -21,25 +21,13 @@ By default, the elevation service is disabled. In order to enable the service, y
 The http client and message factory are mandatory. They define which http client and message factory the direction 
 service will use for issuing http requests.
 
-First, configure the [Httplug](http://httplug.io/) bundle.
-
-``` yaml
-httplug:
-    classes:
-        client: Http\Adapter\Guzzle7\Client
-        message_factory: Http\Message\MessageFactory\GuzzleMessageFactory
-    clients:
-        acme:
-            factory: httplug.factory.guzzle7
-```
-
-Then, configure the Google Map bundle:
+Configure the Google Map bundle:
 
 ``` yaml
 ivory_google_map:
     elevation:
-        client: httplug.client.default
-        message_factory: httplug.message_factory.default
+        client: psr18.http_client
+        request_factory: nyholm.psr7.psr17_factory
 ```
 
 ### Format

Resources/doc/service/geocoder.md

@@ -7,9 +7,9 @@ process is known as "reverse geocoding".
 
 ## Dependencies
 
-The Geocoder API requires an http client and a serializer. The library relies respectively on 
-[Httplug](http://httplug.io/) which is an http client abstraction library and the 
-[Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
+The Geocoder API requires an [PSR-18](https://www.php-fig.org/psr/psr-18/) http client and a serializer. Any PSR-18
+http client library is suitable, [HttpClient](https://github.com/symfony/http-client) is a popular and steady choice nowadays.
+And the [Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
 
 To install them, read this [documentation](/Resources/doc/installation.md).
 
@@ -22,25 +22,13 @@ By default, the geocoder service is disabled. In order to enable the service, yo
 The http client and message factory are mandatory. They define which http client and message factory the geocoder 
 service will use for issuing http requests.
 
-First, configure the [Httplug](http://httplug.io/) bundle.
-
-``` yaml
-httplug:
-    classes:
-        client: Http\Adapter\Guzzle7\Client
-        message_factory: Http\Message\MessageFactory\GuzzleMessageFactory
-    clients:
-        acme:
-            factory: httplug.factory.guzzle7
-```
-
-Then, configure the Google Map bundle:
+Configure the Google Map bundle:
 
 ``` yaml
 ivory_google_map:
     geocoder:
-        client: httplug.client.default
-        message_factory: httplug.message_factory.default
+        client: psr18.http_client
+        request_factory: nyholm.psr7.psr17_factory
 ```
 
 ### Format

Resources/doc/service/place/autocomplete.md

@@ -12,9 +12,9 @@ request for more information about any of the places which are returned.
 
 ## Dependencies
 
-The Place Autocomplete API requires an http client and a serializer. The library relies respectively on 
-[Httplug](http://httplug.io/) which is an http client abstraction library and the 
-[Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library. 
+The Place Autocomplete API requires an [PSR-18](https://www.php-fig.org/psr/psr-18/) http client and a serializer. Any PSR-18
+http client library is suitable, [HttpClient](https://github.com/symfony/http-client) is a popular and steady choice nowadays.
+And the [Ivory Serializer](https://github.com/egeloen/ivory-serializer) which is an advanced (de)-serialization library.
 
 To install them, read this [documentation](/Resources/doc/installation.md).
 
@@ -25,27 +25,15 @@ By default, the place autocomplete service is disabled. In order to enable the s
 ### Http client and message factory
 
 The http client and message factory are mandatory. They define which http client and message factory the place 
-autocomplete service will use for issuing http requests.
- 
-First, configure the [Httplug](http://httplug.io/) bundle.
+autocomplete service will use for issuing http requests. Here we use `symfony/http-client` and `nyholm/psr7`.
 
-``` yaml
-httplug:
-    classes:
-        client: Http\Adapter\Guzzle7\Client
-        message_factory: Http\Message\MessageFactory\GuzzleMessageFactory
-    clients:
-        acme:
-            factory: httplug.factory.guzzle7
-```
-
-Then, configure the Google Map bundle:
+Configure the Google Map bundle:
 
 ``` yaml
 ivory_google_map:
     place_autocomplete:
-        client: httplug.client.default
-        message_factory: httplug.message_factory.default
+        client: psr18.http_client
+        message_factory: nyholm.psr7.psr17_factory
 ```
 
 ### Format