Update doc

.travis.yml

@@ -14,11 +14,11 @@ php:
 matrix:
     include:
         - php: 5.4
-          env: COMPOSER_FLAGS="--prefer-lowest"
+          env: SYMFONY_VERSION='2.3.*'
         - php: 5.5
-          env: COMPOSER_FLAGS="--prefer-lowest"
+          env: SYMFONY_VERSION='2.3.*'
         - php: 5.6
-          env: COMPOSER_FLAGS="--prefer-lowest"
+          env: SYMFONY_VERSION='2.3.*'
         - php: 5.6
           env: SYMFONY_VERSION='2.7.*'
         - php: 5.6

Controller/ApiController.php

@@ -192,9 +192,9 @@ protected function onError(FormInterface $form)
     {
         $view = View::create()
             ->setStatusCode(Codes::HTTP_BAD_REQUEST)
-            ->setData(array(
-                'form' => $form,
-            ))
+            ->setData([
+                'errors' => $form,
+            ])
         ;
 
         return $view;

Resources/config/routing.yml

@@ -1,19 +1,19 @@
 GundanDistributedConfigurationBundle_get:
-    path:      /configuration/{key}
+    path:      /keys/{key}
     defaults:  { _controller: GundanDistributedConfigurationBundle:Api:get }
     methods:  [GET]
 
 GundanDistributedConfigurationBundle_create:
-    path:      /configuration
+    path:      /keys
     defaults:  { _controller: GundanDistributedConfigurationBundle:Api:create }
     methods:  [POST]
 
 GundanDistributedConfigurationBundle_update:
-    path:      /configuration/{key}
+    path:      /keys/{key}
     defaults:  { _controller: GundanDistributedConfigurationBundle:Api:update }
     methods:  [PUT, PATCH]
 
 GundanDistributedConfigurationBundle_delete:
-    path:      /configuration/{key}
+    path:      /keys/{key}
     defaults:  { _controller: GundanDistributedConfigurationBundle:Api:delete }
     methods:  [DELETE]

Resources/doc/index.md

@@ -35,6 +35,24 @@ gundan_distributed_configuration:
             path: "%kernel.root_dir%/test.json"
 ```
 
+Configure your routing file in `app/config/routing.yml`:
+
+``` yaml
+# app/config/routing.yml
+gundan_distributed_configuration_api:
+    resource: "@GundanDistributedConfigurationBundle/Resources/config/routing.yml"
+    prefix: /v1
+
+fos_rest:
+    format_listener:
+        rules:
+            - { path: '^/v1/', priorities: ['json'], fallback_format: json, prefer_extension: false }
+```
+
 ## Usage
 
-TODO
+Use your favorite http client
+
+```php
+$response = $client->request('POST','/v1/keys', ['body' => json_encode(['client_uri' => 'http://api.example.org'])]);
+```

Tests/ApiTest.php

@@ -33,7 +33,7 @@ public function testApiCreate()
     {
         $this->client->request(
             'POST',
-            '/distributed_configuration/configuration',
+            '/v1/keys',
             [],
             [],
             ['HTTP_CONTENT_TYPE' => 'application/json', 'CONTENT_TYPE' => 'application/json'],
@@ -52,13 +52,29 @@ public function testApiCreate()
         $this->assertEquals(201, $this->client->getResponse()->getStatusCode());
     }
 
+    public function testApiPatch()
+    {
+        $this->createKeyValue('key_to_patch');
+
+        $this->client->request(
+            'PATCH',
+            '/v1/keys/key_to_patch',
+            [],
+            [],
+            ['HTTP_CONTENT_TYPE' => 'application/json', 'CONTENT_TYPE' => 'application/json'],
+            json_encode(['value' => 'value_to_patch'])
+        );
+
+        $this->assertEquals(204, $this->client->getResponse()->getStatusCode());
+    }
+
     public function testApiUpdate()
     {
         $this->createKeyValue('key_to_update');
 
         $this->client->request(
             'PUT',
-            '/distributed_configuration/configuration/key_to_update',
+            '/v1/keys/key_to_update',
             [],
             [],
             ['HTTP_CONTENT_TYPE' => 'application/json', 'CONTENT_TYPE' => 'application/json'],
@@ -74,7 +90,7 @@ public function testApiDelete()
 
         $this->client->request(
             'DELETE',
-            '/distributed_configuration/configuration/key with space',
+            '/v1/keys/key with space',
             [],
             [],
             ['HTTP_CONTENT_TYPE' => 'application/json', 'CONTENT_TYPE' => 'application/json']

Tests/App/config/config.yml

@@ -17,4 +17,4 @@ gundan_distributed_configuration:
 fos_rest:
     format_listener:
         rules:
-            - { path: '^/distributed_configuration', priorities: ['json'], fallback_format: json, prefer_extension: false }
+            - { path: '^/v1/', priorities: ['json'], fallback_format: json, prefer_extension: false }

Tests/App/config/routing.yml

@@ -1,3 +1,3 @@
 gundan_distributed_configuration_api:
     resource: "@GundanDistributedConfigurationBundle/Resources/config/routing.yml"
-    prefix: /distributed_configuration
+    prefix: /v1