committee 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 173ee1ad63a2f3bbd80eb012363b1825186ccf0c
-  data.tar.gz: aada311d9d39946ba34e456cf63d3505ff22558d
+  metadata.gz: 439fbc1ffad016e11c3f03d532ffa9e61289a4a7
+  data.tar.gz: a99fa598c8c5d9f5dc3ce1a596aa598d1a782f6d
 SHA512:
-  metadata.gz: b7d52505a1d958dfd6181834f790a5567a1d6b1f13a8e81f56b4bd7ae60aa83030bb1af920a2ed6cc090fc235f3bd5d683619af072bd94e89be6094486852edf
-  data.tar.gz: 67952f61e059649f6a55d06d92d39e49ec4476f4ffa40ec0e9f0b27c0cb74115c3666268f4927b73f75fac200cbd753cb8d653ba4d238ec712d370ce79320bff
+  metadata.gz: d9ecf7dd62046f8e9046ed7c4cca3981848776d6c6a72becb3a97fe74ea4a080766a331d490b1f84c58b19b1da58786049c4ecd559130532ee8e59c50f0950e3
+  data.tar.gz: 99143e5da92042a35ca7ca95e06155e6d646186408ebf5d27d3726ff40d424628a150f1230171e1409f4117fb8f4031626ffeb0c64048cde6c70029e56eade26

data/lib/committee/middleware/base.rb

@@ -3,12 +3,14 @@ module Committee::Middleware
     def initialize(app, options={})
       @app = app
 
+      @error_class = options.fetch(:error_class, Committee::ValidationError)
       @params_key = options[:params_key] || "committee.params"
       data = options[:schema] || raise("need option `schema`")
       if data.is_a?(String)
         warn_string_deprecated
         data = MultiJson.decode(data)
       end
+      @raise = options[:raise]
       @schema = JsonSchema.parse!(data)
       @schema.expand_references!
       @router = Committee::Router.new(@schema, options)
@@ -26,11 +28,6 @@ module Committee::Middleware
 
     private
 
-    def render_error(status, id, message)
-      [status, { "Content-Type" => "application/json" },
-        [MultiJson.encode({ id: id, message: message }, pretty: true)]]
-    end
-
     def warn_string_deprecated
       Committee.warn_deprecated("Committee: passing a string to `schema` option is deprecated; please send a deserialized hash instead.")
     end

data/lib/committee/middleware/request_validation.rb

@@ -6,7 +6,6 @@ module Committee::Middleware
       @allow_query_params = options.fetch(:allow_query_params, true)
       @check_content_type = options.fetch(:check_content_type, true)
       @optimistic_json    = options.fetch(:optimistic_json, false)
-      @raise              = options[:raise]
       @strict             = options[:strict]
 
       # deprecated
@@ -32,14 +31,17 @@ module Committee::Middleware
       end
     rescue Committee::BadRequest, Committee::InvalidRequest
       raise if @raise
-      render_error(400, :bad_request, $!.message)
+      @error_class.new(400, :bad_request, $!.message).render
     rescue Committee::NotFound
       raise if @raise
-      render_error(404, :not_found,
-        "That request method and path combination isn't defined.")
+      @error_class.new(
+        404,
+        :not_found,
+        "That request method and path combination isn't defined."
+      ).render
     rescue MultiJson::LoadError
       raise Committee::InvalidRequest if @raise
-      render_error(400, :bad_request, "Request body wasn't valid JSON.")
+      @error_class.new(400, :bad_request, "Request body wasn't valid JSON.").render
     end
   end
 end

data/lib/committee/middleware/response_validation.rb

@@ -2,7 +2,6 @@ module Committee::Middleware
   class ResponseValidation < Base
     def initialize(app, options={})
       super
-      @raise = options[:raise]
       @validate_errors = options[:validate_errors]
     end
 
@@ -21,10 +20,10 @@ module Committee::Middleware
       [status, headers, response]
     rescue Committee::InvalidResponse
       raise if @raise
-      render_error(500, :invalid_response, $!.message)
+      @error_class.new(500, :invalid_response, $!.message).render
     rescue MultiJson::LoadError
       raise Committee::InvalidResponse if @raise
-      render_error(500, :invalid_response, "Response wasn't valid JSON.")
+      @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render
     end
 
     def validate?(status)

data/lib/committee/validation_error.rb

@@ -0,0 +1,23 @@
+module Committee
+  class ValidationError
+    attr_reader :id, :message, :status
+
+    def initialize(status, id, message)
+      @status = status
+      @id = id
+      @message = message
+    end
+
+    def error_body
+      { id: id, message: message }
+    end
+
+    def render
+      [
+        status,
+        { "Content-Type" => "application/json" },
+        [MultiJson.encode(error_body)]
+      ]
+    end
+  end
+end

data/lib/committee.rb

@@ -8,6 +8,7 @@ require_relative "committee/request_validator"
 require_relative "committee/response_generator"
 require_relative "committee/response_validator"
 require_relative "committee/router"
+require_relative "committee/validation_error"
 
 require_relative "committee/middleware/base"
 require_relative "committee/middleware/request_validation"

data/test/validation_error_test.rb

@@ -0,0 +1,23 @@
+require_relative "test_helper"
+
+describe Committee::ValidationError do
+  before do
+    @error = Committee::ValidationError.new(400, :bad_request, "Error")
+  end
+
+  it "creates an error body with the id and message" do
+    assert_equal @error.error_body, { id: :bad_request, message: "Error" }
+  end
+
+  it "creates a Rack response object to render" do
+    body = { id: :bad_request, message: "Error" }
+
+    response = [
+      400,
+      { "Content-Type" => "application/json" },
+      [MultiJson.encode(body)]
+    ]
+
+    assert_equal @error.render, response
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Brandur
@@ -131,6 +131,7 @@ files:
 - lib/committee/response_validator.rb
 - lib/committee/router.rb
 - lib/committee/test/methods.rb
+- lib/committee/validation_error.rb
 - test/middleware/request_validation_test.rb
 - test/middleware/response_validation_test.rb
 - test/middleware/stub_test.rb
@@ -141,6 +142,7 @@ files:
 - test/router_test.rb
 - test/test/methods_test.rb
 - test/test_helper.rb
+- test/validation_error_test.rb
 homepage: https://github.com/interagent/committee
 licenses:
 - MIT