Merge pull request #80 from peter-gribanov/configuration_path

Update configuration docs
gpslab · Jul 12, 2021 · a5eb193 · a5eb193
2 parents b11fdd3 + 0070290
commit a5eb193
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -61,6 +61,8 @@ URL in the configuration.
 
 ```yml
 gpslab_geoip:
+    license: 'XXXXXXXXXXXXXXXX'
+    edition: 'GeoLite2-City'
     url: 'https://example.com/GeoLite2-City.tar.gz'
 ```
 
@@ -73,6 +75,8 @@ environment may not be optimal. You can choose a common directory for all enviro
 
 ```yml
 gpslab_geoip:
+    license: 'XXXXXXXXXXXXXXXX'
+    edition: 'GeoLite2-City'
     path: '%kernel.project_dir%/var/GeoLite2-City.mmdb'
 ```
 
@@ -83,6 +87,8 @@ locales for fallback.
 
 ```yml
 gpslab_geoip:
+    license: 'XXXXXXXXXXXXXXXX'
+    edition: 'GeoLite2-City'
     locales: [ 'ru', 'en' ]
 ```
 
@@ -192,6 +198,8 @@ gpslab_geoip:
             locales: [ 'fr' ] # customize locales
         city:
             edition: 'GeoLite2-City'
+            url: 'https://example.com/GeoLite2-City.tar.gz' # customize url
+            path: '%kernel.project_dir%/var/GeoLite2-City.mmdb' # customize path
         country:
             edition: 'GeoLite2-Country'
             license: 'YYYYYYYYYYYYYYYY' # customize license

diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -272,6 +272,46 @@ public function getConfigs(): iterable
                 ]];
             }
 
+            yield [$cache_dir, [
+                'gpslab_geoip' => [
+                    'license' => 'LICENSE',
+                    'edition' => 'GeoLite2-City',
+                    'url' => 'https://example.com/GeoLite2-City.tar.gz',
+                ],
+            ], [
+                'default_database' => 'default',
+                'databases' => [
+                    'default' => [
+                        'license' => 'LICENSE',
+                        'edition' => 'GeoLite2-City',
+                        'url' => 'https://example.com/GeoLite2-City.tar.gz',
+                        'path' => sprintf(self::PATH, $real_cache_dir, 'GeoLite2-City'),
+                        'locales' => ['en'],
+                    ],
+                ],
+                'locales' => ['en'],
+            ]];
+
+            yield [$cache_dir, [
+                'gpslab_geoip' => [
+                    'license' => 'LICENSE',
+                    'edition' => 'GeoLite2-City',
+                    'path' => '%kernel.project_dir%/var/GeoLite2-City.mmdb',
+                ],
+            ], [
+                'default_database' => 'default',
+                'databases' => [
+                    'default' => [
+                        'license' => 'LICENSE',
+                        'edition' => 'GeoLite2-City',
+                        'path' => '%kernel.project_dir%/var/GeoLite2-City.mmdb',
+                        'url' => sprintf(self::URL, 'GeoLite2-City', 'LICENSE'),
+                        'locales' => ['en'],
+                    ],
+                ],
+                'locales' => ['en'],
+            ]];
+
             yield [$cache_dir, [
                 'gpslab_geoip' => [
                     'default_database' => 'foo',
@@ -284,6 +324,8 @@ public function getConfigs(): iterable
                             'license' => 'LICENSE_2',
                             'edition' => 'GeoLite2-City',
                             'locales' => ['ru'],
+                            'url' => 'https://example.com/GeoLite2-City.tar.gz',
+                            'path' => '%kernel.project_dir%/var/GeoLite2-City.mmdb',
                         ],
                         'baz' => [
                             'license' => 'LICENSE_3',
@@ -306,8 +348,8 @@ public function getConfigs(): iterable
                         'license' => 'LICENSE_2',
                         'edition' => 'GeoLite2-City',
                         'locales' => ['ru'],
-                        'url' => sprintf(self::URL, 'GeoLite2-City', 'LICENSE_2'),
-                        'path' => sprintf(self::PATH, $real_cache_dir, 'GeoLite2-City'),
+                        'url' => 'https://example.com/GeoLite2-City.tar.gz',
+                        'path' => '%kernel.project_dir%/var/GeoLite2-City.mmdb',
                     ],
                     'baz' => [
                         'license' => 'LICENSE_3',