Merge pull request #590 from api-platform/serializer_listener

Refactor the responder to ease usage of content negotiation

Author: dunglas

features/content_negotiation.feature

@@ -12,13 +12,51 @@ Feature: Content Negotiation support
         <name>XML!</name>
     </root>
     """
-    Then the header "Content-Type" should be equal to "application/xml"
+    Then the response status code should be 201
+    And the header "Content-Type" should be equal to "application/xml"
     And the response should be equal to
     """
 <?xml version="1.0"?>
 <response><id>1</id><name>XML!</name><alias/><description/><dummyDate/><dummyPrice/><jsonData/><relatedDummy/><dummyBoolean/><dummy/><relatedDummies/><nameConverted/></response>
     """
 
+  Scenario:  Retrieve a collection in XML
+    When I add "Accept" header equal to "text/xml"
+    And I send a "GET" request to "/dummies"
+    Then the response status code should be 200
+    And the header "Content-Type" should be equal to "text/xml; charset=UTF-8"
+    And the response should be equal to
+    """
+<?xml version="1.0"?>
+<response><item key="0"><id>1</id><name>XML!</name><alias/><description/><dummyDate/><dummyPrice/><jsonData/><relatedDummy/><dummyBoolean/><dummy/><relatedDummies/><nameConverted/></item></response>
+    """
+
+  Scenario:  Retrieve a collection in JSON
+    When I add "Accept" header equal to "application/json"
+    And I send a "GET" request to "/dummies"
+    Then the response status code should be 200
+    And the header "Content-Type" should be equal to "application/json"
+    And the response should be in JSON
+    And the JSON should be equal to:
+    """
+[
+  {
+    "id": 1,
+    "name": "XML!",
+    "alias": null,
+    "description": null,
+    "dummyDate": null,
+    "dummyPrice": null,
+    "jsonData": [],
+    "relatedDummy": null,
+    "dummyBoolean": null,
+    "dummy": null,
+    "relatedDummies": [],
+    "nameConverted": null
+  }
+]
+    """
+
   @dropSchema
   Scenario: Requesting an unknown format should return JSON-LD
     When I add "Accept" header equal to "text/plain"

features/doctrine/boolean-filter.feature renamed to features/doctrine/boolean_filter.feature

@@ -10,6 +10,7 @@ Feature: Create-Retrieve-Update-Delete
     """
     {
       "fullname": "Dummy User",
+      "username": "dummy.user",
       "email": "[email protected]",
       "plainPassword": "azerty"
     }

features/doctrine/date-filter.feature renamed to features/doctrine/date_filter.feature

@@ -1,14 +1,14 @@
-Feature: Create-Retrieve-Update-Delete with custom attribute
+Feature: Create-Retrieve-Update-Delete with a Overridden Operation context
   In order to use an hypermedia API
   As a client software developer
   I need to be able to retrieve, create, update and delete JSON-LD encoded resources.
 
   @createSchema
   Scenario: Create a resource
-    When I send a "POST" request to "/custom_attribute_dummies" with body:
+    When I send a "POST" request to "/overridden_operation_dummies" with body:
     """
     {
-      "name": "My Custom Attribute Dummy",
+      "name": "My Overridden Operation Dummy",
       "description" : "Gerard",
       "alias": "notWritable"
     }
@@ -19,52 +19,63 @@ Feature: Create-Retrieve-Update-Delete with custom attribute
     And the JSON should be equal to:
     """
     {
-      "@context": "/contexts/CustomAttributeDummy",
-      "@id": "/custom_attribute_dummies/1",
-      "@type": "CustomAttributeDummy",
-      "name": "My Custom Attribute Dummy",
+      "@context": "/contexts/OverriddenOperationDummy",
+      "@id": "/overridden_operation_dummies/1",
+      "@type": "OverriddenOperationDummy",
+      "name": "My Overridden Operation Dummy",
       "alias": null,
       "description": "Gerard"
     }
     """
 
   Scenario: Get a resource
-    When I send a "GET" request to "/custom_attribute_dummies/1"
+    When I send a "GET" request to "/overridden_operation_dummies/1"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json"
     And the JSON should be equal to:
     """
     {
-      "@context": "/contexts/CustomAttributeDummy",
-      "@id": "/custom_attribute_dummies/1",
-      "@type": "CustomAttributeDummy",
-      "name": "My Custom Attribute Dummy",
+      "@context": "/contexts/OverriddenOperationDummy",
+      "@id": "/overridden_operation_dummies/1",
+      "@type": "OverriddenOperationDummy",
+      "name": "My Overridden Operation Dummy",
       "alias": null,
       "description": "Gerard"
     }
     """
 
+  Scenario: Get a resource in XML
+    When I add "Accept" header equal to "application/xml"
+    And I send a "GET" request to "/overridden_operation_dummies/1"
+    Then the response status code should be 200
+    And the header "Content-Type" should be equal to "application/xml"
+    And the response should be equal to
+    """
+<?xml version="1.0"?>
+<response><name>My Overridden Operation Dummy</name><alias/><description>Gerard</description></response>
+    """
+
   Scenario: Get a not found exception
-    When I send a "GET" request to "/custom_attribute_dummies/42"
+    When I send a "GET" request to "/overridden_operation_dummies/42"
     Then the response status code should be 404
 
   Scenario: Get a collection
-    When I send a "GET" request to "/custom_attribute_dummies"
+    When I send a "GET" request to "/overridden_operation_dummies"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json"
     And the JSON should be equal to:
     """
     {
-     "@context": "/contexts/CustomAttributeDummy",
-     "@id": "\/custom_attribute_dummies",
+     "@context": "/contexts/OverriddenOperationDummy",
+     "@id": "\/overridden_operation_dummies",
      "@type": "hydra:Collection",
      "hydra:member": [
           {
-             "@id": "\/custom_attribute_dummies\/1",
-             "@type": "CustomAttributeDummy",
-             "name": "My Custom Attribute Dummy",
+             "@id": "\/overridden_operation_dummies\/1",
+             "@type": "OverriddenOperationDummy",
+             "name": "My Overridden Operation Dummy",
              "alias": null,
              "description": "Gerard"
            }
@@ -74,10 +85,10 @@ Feature: Create-Retrieve-Update-Delete with custom attribute
     """
 
   Scenario: Update a resource
-    When I send a "PUT" request to "/custom_attribute_dummies/1" with body:
+    When I send a "PUT" request to "/overridden_operation_dummies/1" with body:
       """
       {
-        "@id": "/custom_attribute_dummies/1",
+        "@id": "/overridden_operation_dummies/1",
         "name": "A nice dummy",
         "alias": "Dummy"
       }
@@ -88,32 +99,33 @@ Feature: Create-Retrieve-Update-Delete with custom attribute
     And the JSON should be equal to:
       """
       {
-        "@context": "/contexts/CustomAttributeDummy",
-        "@id": "/custom_attribute_dummies/1",
-        "@type": "CustomAttributeDummy",
+        "@context": "/contexts/OverriddenOperationDummy",
+        "@id": "/overridden_operation_dummies/1",
+        "@type": "OverriddenOperationDummy",
         "alias": "Dummy",
         "description": "Gerard"
       }
       """
 
   Scenario: Get the final resource
-    When I send a "GET" request to "/custom_attribute_dummies/1"
+    When I send a "GET" request to "/overridden_operation_dummies/1"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json"
     And the JSON should be equal to:
     """
     {
-      "@context": "/contexts/CustomAttributeDummy",
-      "@id": "/custom_attribute_dummies/1",
-      "@type": "CustomAttributeDummy",
-      "name": "My Custom Attribute Dummy",
+      "@context": "/contexts/OverriddenOperationDummy",
+      "@id": "/overridden_operation_dummies/1",
+      "@type": "OverriddenOperationDummy",
+      "name": "My Overridden Operation Dummy",
       "alias": "Dummy",
       "description": "Gerard"
     }
     """
+
   @dropSchema
   Scenario: Delete a resource
-    When I send a "DELETE" request to "/custom_attribute_dummies/1"
+    When I send a "DELETE" request to "/overridden_operation_dummies/1"
     Then the response status code should be 204
     And the response should be empty