Merge pull request #5 from tormjens/master

Enable changing the route group prefix

README.md

@@ -139,6 +139,21 @@ You can get the countries list using a custom locale:
 GET /galahad/addressing/countries?locale=pt
 ```
 
+### Changing the route group prefix
+
+By default the routes returning the JSON responses are prefixed with `galahad/addressing`. If you would like to change this, you need to publish the configuration file using `php artisan vendor:publish --provider="Galahad\LaravelAddressing\ServiceProvider"`. This will create a config file (`addressing.php`) in your `config` directory with:
+
+```php 
+<?php
+
+return [
+    'route' => [
+        'prefix' => 'countries' // change this to whatever you'd like
+    ],
+];
+```
+
+
 ### Thanks!
 
 Special thanks to [Commerce Guys](https://github.com/commerceguys) for their amazing [addressing](https://github.com/commerceguys/addressing) and [intl](https://github.com/commerceguys/intl) packages, which this project relies heavily on.

config/addressing.php

@@ -0,0 +1,12 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Route Configuration
+    |--------------------------------------------------------------------------
+    */
+    'route' => [
+        'prefix' => 'countries', // change this to whatever you'd like
+    ],
+];

src/ServiceProvider.php

@@ -11,7 +11,6 @@
 /**
  * Class ServiceProvider
  *
- * @package Galahad\LaravelAddressing
  * @author Chris Morrell
  * @author Junior Grossi <[email protected]>
  */
@@ -24,6 +23,9 @@ public function boot()
     {
         $this->bootRoutes();
         $this->loadTranslationsFrom(__DIR__.'/../lang', 'laravel-addressing');
+        $this->publishes([
+            __DIR__.'/../config/addressing.php' => config_path('addressing.php'),
+        ]);
     }
 
     /**
@@ -51,7 +53,8 @@ protected function bootRoutes()
 
         try {
             $route = $this->app->make('router');
-            $route->group(['prefix' => 'galahad/addressing'], function ($route) {
+            $prefix = config('addressing.route.prefix', 'galahad/addressing');
+            $route->group(['prefix' => $prefix], function ($route) use ($prefix) {
                 $route->get('/{country}/administrative-areas', [
                     'as' => 'galahad.addressing.administrative-areas',
                     'uses' => '\\Galahad\\LaravelAddressing\\Controller@getAdministrativeAreas',
@@ -81,10 +84,14 @@ protected function registerValidators()
             $validator->extend('country_name', CountryValidator::class.'@validateCountryName');
 
             // Administrative Area validators
-            $validator->extend('administrative_area_code',
-                AdministrativeAreaValidator::class.'@validateAdministrativeAreaCode');
-            $validator->extend('administrative_area_name',
-                AdministrativeAreaValidator::class.'@validateAdministrativeAreaName');
+            $validator->extend(
+                'administrative_area_code',
+                AdministrativeAreaValidator::class.'@validateAdministrativeAreaCode'
+            );
+            $validator->extend(
+                'administrative_area_name',
+                AdministrativeAreaValidator::class.'@validateAdministrativeAreaName'
+            );
             $validator->extend('administrative_area', AdministrativeAreaValidator::class.'@validateAdministrativeArea');
 
             // Postal Code validator