Merge branch 'feature/11'

Close #11

Author: weierophinney

README.md

@@ -3,5 +3,5 @@ Api-Problem: ZF2 Module for API-Problem representations
 
 This module provides data structures and rendering for the API-Problem format.
 
-- [Problem API](http://tools.ietf.org/html/draft-nottingham-http-problem-02),
+- [Problem API](http://tools.ietf.org/html/draft-nottingham-http-problem-05),
   used for reporting API problems

docs/api/phpdoc/classes/PhlyRestfully.ApiProblem.html

@@ -87,16 +87,16 @@ <h3>
 <i class="icon-custom icon-method"></i> Methods</h3>
 <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
 <h2>Constructor</h2>
-<pre>__construct(int $httpStatus, string $detail, string $describedBy, string $title, array $additional) </pre>
+<pre>__construct(int $status, string $detail, string $describedBy, string $title, array $additional) </pre>
 <div class="labels"></div>
 <div class="row collapse"><div class="detail-description">
 <div class="long_description"><p>Create an instance using the provided information. If nothing is
 provided for the describedBy field, the class default will be used;
-if the httpStatus matches any known, the title field will be selected
+if the status matches any known, the title field will be selected
 from $problemStatusTitles as a result.</p></div>
 <h3>Parameters</h3>
 <div class="subelement argument">
-<h4>$httpStatus</h4>
+<h4>$status</h4>
 <code>int</code>
 </div>
 <div class="subelement argument">

docs/api/phpdoc/classes/PhlyRestfully.ResourceController.html

@@ -126,7 +126,7 @@
 </tr>
 <tr>
 <th>see</th>
-<td><a href="">\PhlyRestfully\http://tools.ietf.org/html/draft-nottingham-http-problem-02</a></td>
+<td><a href="">\PhlyRestfully\http://tools.ietf.org/html/draft-nottingham-http-problem-05</a></td>
 </tr>
 </table>
 <h3>

docs/api/phpdoc/classes/PhlyRestfully.View.RestfulJsonStrategy.html

@@ -88,7 +88,7 @@
 
 <ul>
 <li>application/hal+json for a result that contains HAL-compliant links</li>
-<li>application/api-problem+json for a result that contains a Problem
+<li>application/problem+json for a result that contains a Problem
 API-formatted response</li>
 <li>application/json for all other responses</li>
 </ul></div>

docs/api/phpdoc/structure.xml

@@ -306,9 +306,9 @@
           <description>Constructor</description>
           <long-description>&lt;p&gt;Create an instance using the provided information. If nothing is
 provided for the describedBy field, the class default will be used;
-if the httpStatus matches any known, the title field will be selected
+if the status matches any known, the title field will be selected
 from $problemStatusTitles as a result.&lt;/p&gt;</long-description>
-          <tag line="118" name="param" description="" type="int" variable="$httpStatus">
+          <tag line="118" name="param" description="" type="int" variable="$status">
             <type by_reference="false">int</type>
           </tag>
           <tag line="118" name="param" description="" type="string" variable="$detail">
@@ -322,7 +322,7 @@ from $problemStatusTitles as a result.&lt;/p&gt;</long-description>
           </tag>
         </docblock>
         <argument line="131">
-          <name>$httpStatus</name>
+          <name>$status</name>
           <default></default>
           <type/>
         </argument>
@@ -1944,7 +1944,7 @@ a Content-Type header appropriate to the response it describes.</description>
 
 &lt;ul&gt;
 &lt;li&gt;application/hal+json for a result that contains HAL-compliant links&lt;/li&gt;
-&lt;li&gt;application/api-problem+json for a result that contains a Problem
+&lt;li&gt;application/problem+json for a result that contains a Problem
 API-formatted response&lt;/li&gt;
 &lt;li&gt;application/json for all other responses&lt;/li&gt;
 &lt;/ul&gt;</long-description>
@@ -2553,7 +2553,7 @@ to allow injecting the specific resource you wish to use (and its listeners),
 which will also allow you to have multiple instances of the controller when
 desired.&lt;/p&gt;</long-description>
         <tag line="16" name="see" description="\PhlyRestfully\http://tools.ietf.org/html/draft-kelly-json-hal-03" refers="\PhlyRestfully\http://tools.ietf.org/html/draft-kelly-json-hal-03"/>
-        <tag line="16" name="see" description="\PhlyRestfully\http://tools.ietf.org/html/draft-nottingham-http-problem-02" refers="\PhlyRestfully\http://tools.ietf.org/html/draft-nottingham-http-problem-02"/>
+        <tag line="16" name="see" description="\PhlyRestfully\http://tools.ietf.org/html/draft-nottingham-http-problem-05" refers="\PhlyRestfully\http://tools.ietf.org/html/draft-nottingham-http-problem-05"/>
       </docblock>
       <method final="false" abstract="false" static="false" visibility="public" namespace="PhlyRestfully" line="129" package="Default">
         <name>__construct</name>

docs/basics/resources.rst

@@ -76,7 +76,7 @@ needs to define the following methods:
 - **getDescribedBy()**, which should return a URI for the "describedBy" field.
 - **getTitle()**, which should return a string for the "title" field.
 
-The exception code and message will be used for the "httpStatus" and "detail",
+The exception code and message will be used for the "status" and "detail",
 respectively.
 
 The ``CreationException``, ``UpdateException``, and ``PatchException`` types all

docs/index.rst

@@ -9,13 +9,13 @@ implementing RESTful JSON APIs in `Hypermedia Application Language (HAL)
 <http://stateless.co/hal_specification.html>`_. It provides a workflow for
 mapping persistence to resources to expose via your API.
 
-For error reporting, it uses `API-Problem <http://tools.ietf.org/html/draft-nottingham-http-problem-02>`_.
+For error reporting, it uses `API-Problem <http://tools.ietf.org/html/draft-nottingham-http-problem-05>`_.
 
 Contents:
 
 .. toctree::
    :hidden:
-   
+
    halprimer
    problems
    options

docs/problems.rst

@@ -17,13 +17,13 @@ returning ``Api-Problem`` payloads.
 API-Problem
 -----------
 
-This mediatype, ``application/api-problem+json`` is `via the IETF
-<http://tools.ietf.org/html/draft-nottingham-http-problem-02>`_, and actually
+This mediatype, ``application/problem+json`` is `via the IETF
+<http://tools.ietf.org/html/draft-nottingham-http-problem-05>`_, and actually
 also includes an XML variant. The structure includes the following properties:
 
 - **describedBy**: a URL to a document describing the error condition (required)
 - **title**: a brief title for the error condition (required)
-- **httpStatus**: the HTTP status code for the current request (optional)
+- **status**: the HTTP status code for the current request (optional)
 - **detail**: error details specific to this request (optional)
 - **supportId**: a URL to the specific problem occurrence (e.g., to a log message) (optional)
 
@@ -32,12 +32,12 @@ As an example payload:
 .. code-block:: http
 
     HTTP/1.1 500 Internal Error
-    Content-Type: application/api-problem+json
-    
+    Content-Type: application/problem+json
+
     {
         "describedBy": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
         "detail": "Status failed validation",
-        "httpStatus": 500,
+        "status": 500,
         "title": "Internal Server Error"
     }
 

docs/ref/alternate-resource-return-values.rst

@@ -20,7 +20,7 @@ HalResource and HalCollection
 ``PhlyRestfully\HalResource`` and ``PhlyRestfully\HalCollection`` are simply
 wrappers for the resources and collections you create, and provide the ability
 to aggregate referential links. Links are aggregated in a
-``PhlyRestfully\LinkCollection`` as individual ``PhlyRestfully\Link`` objects. 
+``PhlyRestfully\LinkCollection`` as individual ``PhlyRestfully\Link`` objects.
 
 ``HalResource`` requires that you pass a resource and its identifier in the
 constructor, and then allows you to aggregate links:
@@ -71,8 +71,8 @@ addition of several relational links.
 .. code-block:: php
     :linenos:
 
-    use PhlyRestfully\HalCollection; 
-    use PhlyRestfully\Link; 
+    use PhlyRestfully\HalCollection;
+    use PhlyRestfully\Link;
 
     // Assume $users is an iterable set of users for seeding the collection.
     $collection = new HalCollection($users);
@@ -142,7 +142,7 @@ The signature of the constructor is:
     :linenos:
 
     public function __construct(
-        $httpStatus,                // HTTP status code used for the response
+        $status,                    // HTTP status code used for the response
         $detail,                    // Summary of what happened
         $describedBy = null,        // URI to a description of the problem
         $title = null,              // Generic title for the problem
@@ -156,7 +156,7 @@ listener, and it will be used directly.
     :linenos:
 
     use PhlyRestfully\ApiProblem;
-    
+
     return new ApiProblem(
         418,
         'Exceeded rate limit',

docs/ref/api-problem-listener.rst

@@ -48,7 +48,7 @@ exception, setting it as the result.
 
 This latter bit, the ``Accept`` header matching, is configurable. If you want to
 allow an API-Problem response for other than the default set of mediatypes
-(``application/hal+json``, ``application/api-problem+json``, and
+(``application/hal+json``, ``application/problem+json``, and
 ``application/json``), you can do so via your configuration. Set the value in
 the ``accept_filters`` subkey of the ``zf-hal`` configuration; the value
 should be a comma-separated set of mimetypes.