Merge pull request #20 from wildcardlabs/pass-response-to-error-serializer

Pass response to error serializer

Author: BenMorganIO

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## 0.3.0
 
+*   Support `status` and `code` for Error Objects
+
+    When an error is handed back to the user, we now provide the status and the
+    code keys. This adds another feature to the API that is supported by the
+    JSON API specification.
+
+    [Ben A. Morgan](https://github.com/BenMorganIO)
+
 *   Add Friendly ID Support for `Spree::Product`
 
     When a request came in for `/api/v2/products/example-product` and there was

README.md

@@ -37,8 +37,8 @@ Below, you'll see a bullet list of requirements that are both specific to the ap
   - [ ] `id`
   - [ ] `links`
      - [ ] `about`
-  - [ ] `status`
-  - [ ] `code`
+  - [x] `status`
+  - [x] `code`
   - [x] `title`
   - [x] `detail`
   - [ ] `source`

app/controllers/concerns/spree/api/v2/renderable.rb

@@ -24,8 +24,14 @@ def filter_params
 
         private
 
-        def error_response(resource)
-          Spree::ErrorSerializer.new(resource).as_json
+        def render_error(resource, options = {})
+          response.status = options.delete(:status) || 400
+          options[:response] = response
+          render json: error_response(resource, options)
+        end
+
+        def error_response(resource, options = {})
+          Spree::ErrorSerializer.new(resource, options).as_json
         end
 
         def filter_attributes

app/controllers/spree/api/v2/line_items_controller.rb

@@ -20,15 +20,15 @@ def line_item_params
         end
 
         def render_range_error
-          render json: error_response(:quantity_too_high), status: 400
+          render_error :quantity_too_high
         end
 
         def render_insufficient_stock_error
-          render json: error_response(:product_out_of_stock), status: 400
+          render_error :product_out_of_stock
         end
 
         def render_record_not_found_error
-          render json: error_response(:record_not_found), status: 400
+          render_error :record_not_found
         end
       end
     end

app/serializers/spree/error_serializer.rb

@@ -1,9 +1,10 @@
 module Spree
   class ErrorSerializer
-    attr_accessor :resource, :options
+    attr_accessor :resource, :options, :response
 
     def initialize(resource, options = {})
       @resource = resource
+      @response = options.delete(:response)
       @options = options
     end
 
@@ -40,7 +41,15 @@ def error_object(title, detail, pointer: '')
         title: title.to_s.titleize
       }
 
+      error.merge!(response_attributes) if response.present?
       pointer.present? ? error.merge(pointer: pointer) : error
     end
+
+    def response_attributes
+      {
+        status: response.status_message,
+        code: response.code
+      }
+    end
   end
 end

docs/source/includes/_line_items.md

@@ -13,35 +13,35 @@ curl "https://example.com/api/v2/line_items"
 
 ```json
 {
-  "data" : {
-    "attributes" : {
-      "additional_tax_total" : "0",
-      "adjustment_total" : "0.0",
-      "amount" : "10.0",
-      "cost_price" : "17.0",
-      "currency" : "CAD",
-      "display_amount" : "$10.00 CAD",
-      "display_price" : "$10.00 CAD",
-      "display_total" : "$10.00 CAD",
-      "order_id" : 1,
-      "price" : "10.0",
-      "quantity" : 1,
-      "total" : "10.0",
-      "variant_id" : 1
+  "data": {
+    "attributes": {
+      "additional_tax_total": "0",
+      "adjustment_total": "0.0",
+      "amount": "10.0",
+      "cost_price": "17.0",
+      "currency": "CAD",
+      "display_amount": "$10.00 CAD",
+      "display_price": "$10.00 CAD",
+      "display_total": "$10.00 CAD",
+      "order_id": 1,
+      "price": "10.0",
+      "quantity": 1,
+      "total": "10.0",
+      "variant_id": 1
     },
-    "relationships" : {
-      "order" : {
-        "data" : {
-          "type" : "spree_orders"
+    "relationships": {
+      "order": {
+        "data": {
+          "type": "spree_orders"
         }
       },
-      "variant" : {
-        "data" : {
-          "type" : "spree_variants"
+      "variant": {
+        "data": {
+          "type": "spree_variants"
         }
       }
     },
-    "type" : "spree_line_items"
+    "type": "spree_line_items"
   }
 }
 ```
@@ -63,11 +63,13 @@ curl "https://example.com/api/v2/line_items"
 
 ```json
 {
-  "errors" : [
+  "errors": [
     {
-      "detail" : "Quantity is too High",
-      "meta" : {},
-      "title" : "The quantity that you have submitted is astronomically high, please tone it down a bit."
+      "code": "400",
+      "detail": "Quantity is too High",
+      "meta": {},
+      "status": "Bad Request",
+      "title": "The quantity that you have submitted is astronomically high, please tone it down a bit."
     }
   ]
 }
@@ -90,11 +92,13 @@ curl "https://example.com/api/v2/line_items"
 
 ```json
 {
-  "errors" : [
+  "errors": [
     {
-      "detail" : "Record Not Found",
-      "meta" : {},
-      "title" : "One of the records that you were looking for could not be found. Please check to see if the record exists or if you're permitted to read it"
+      "code": "400",
+      "detail": "Record Not Found",
+      "meta": {},
+      "status": "Bad Request",
+      "title": "One of the records that you were looking for could not be found. Please check to see if the record exists or if you're permitted to read it"
     }
   ]
 }
@@ -118,11 +122,13 @@ curl "https://example.com/api/v2/line_items"
 
 ```json
 {
-  "errors" : [
+  "errors": [
     {
-      "detail" : "Product is out of Stock",
-      "meta" : {},
-      "title" : "This product is out of stock for the selected quantity."
+      "code": "400",
+      "detail": "Product is out of Stock",
+      "meta": {},
+      "status": "Bad Request",
+      "title": "This product is out of stock for the selected quantity."
     }
   ]
 }

spec/controllers/spree/api/v2/line_items_controller_spec.rb

@@ -36,8 +36,10 @@
           {
             "errors" : [
               {
+                "code": "400",
                 "detail" : #{Spree.t('api.errors.quantity_too_high.detail').gsub("\n", '').to_json},
                 "meta" : {},
+                "status": "Bad Request",
                 "title" : #{Spree.t('api.errors.quantity_too_high.title').titleize.to_json}
               }
             ]
@@ -57,8 +59,10 @@
           {
             "errors" : [
               {
+                "code": "400",
                 "detail" : #{Spree.t('api.errors.record_not_found.detail').gsub("\n", '').to_json},
                 "meta" : {},
+                "status": "Bad Request",
                 "title" : #{Spree.t('api.errors.record_not_found.title').to_json}
               }
             ]
@@ -82,8 +86,10 @@
           {
             "errors" : [
               {
+                "code": "400",
                 "detail" : "#{Spree.t('api.errors.product_out_of_stock.detail').gsub("\n", '')}",
                 "meta" : {},
+                "status": "Bad Request",
                 "title" : #{Spree.t('api.errors.product_out_of_stock.title').titleize.to_json}
               }
             ]

spec/serializers/spree/error_serializer_spec.rb

@@ -112,5 +112,30 @@
         }
       JSON
     end
+
+    context 'can set a response when it is present' do
+      let(:response) do
+        Response ||= Struct.new(:status_message, :code)
+        Response.new('OK', 200)
+      end
+
+      subject { described_class.new(:test, response: response).as_json }
+
+      it do
+        should be_json_eql <<-JSON
+          {
+            "errors" : [
+              {
+                "code" : 200,
+                "detail" : #{Spree.t('api.errors.test.detail').to_json},
+                "meta" : {},
+                "status" : "OK",
+                "title" : #{Spree.t('api.errors.test.title').titleize.to_json}
+              }
+            ]
+          }
+        JSON
+      end
+    end
   end
 end