sinatra-schema 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGZiZDNiMDcyM2EzNzM1MjdmZWUxOTkzZGNjY2QxNmVmN2RmODRiMg==
+    OTg4NGUxMjY3YWRjOGI3ZTQ4NDI3ZGU5ZTIyNGU2ZmM1OWQ1ZWUxOQ==
   data.tar.gz: !binary |-
-    ODY0YjViYzM3YmJhYjIzODc3Y2U3ZmMwMzJmM2Q5YzRiN2M4ZjNmYw==
+    MGVlODRhMWE1YzgxZjJhNGYyOWYzYzMyNDMwZWQxNzdiMzZlOTVmNg==
 SHA512:
   metadata.gz: !binary |-
-    MDQwY2YwMzU3MTg3ZDkzMGNiMDY2MTFlNjM0MWFkNjYzNzdhZTQzMWVlYjg1
-    NzdhNzk2NjZlM2YyNjQ1MzQxZjA5ZTNiNWQ0NGI5MjYxYjI3MTUzYjYxODMx
-    NDJhYzMyNDI2NDZjZGJlNjVhYzQxMTQ0OTdjOTRkN2Q1ZmQ3NmY=
+    MzRmMjhjOGEwODY5ZjU5YWU5OTM0MWExMTgwYzllYmVkMjAxNjMwMmI5NTlj
+    ZTg3YmVjOGZjNGRmZDgwMmE1NTcyMWUwMTk2YjIwNGU2ZTIxODNmYmQ0NWVm
+    ZGViNGRhYzgzMzVkNjhmNGMxNGY3M2JlYmE0NDMwMzNmMzk5OTY=
   data.tar.gz: !binary |-
-    YjE1MWY4MTVhYTMxYzEyODU0Mjk3Y2NiY2I5YTA5YjBkMTlmOGE4MmZlOTMw
-    NDlkNzU2MmU2OTg0ZGNiYzdkNWRkZjAwYmQ5OWE0MzNhNGE0MDVjZmVkZWFk
-    NzM3MDNkZmEwOGI1OTY4ZWQ3NTg2ODY0MjBiODRlNDU5YTZlOGE=
+    Njg2Mjg4MGM5YzFiNjY5YWNhZGM4YjIxYThlYzgyNDQyYTg4NzMzZWUxMThj
+    MjJkMTU1MzQzNDNjZGNlN2ZiZGNjMGViZjc0NzAzYzk3NjI3M2QyMjkxYmUz
+    OWM3MjdjNDIyOGQ0ZWE2M2NmZTVkN2RhOTc1NzAwMDEyZDNiZjg=

data/lib/sinatra/schema/dsl/definitions.rb

@@ -40,7 +40,7 @@ module Sinatra
 
         def ref(id)
           unless definition = resource.defs[id] || Sinatra::Schema::Root.instance.find_definition(id)
-            raise "Unknown reference: #{id}"
+            raise BadReference.new(id)
           end
           add definition, true
         end

data/lib/sinatra/schema/error.rb

@@ -0,0 +1,24 @@
+module Sinatra
+  module Schema
+    class Error < StandardError
+    end
+
+    class BadReference < Error
+      def initialize(id)
+        super("Could not resolve property ref #{id}")
+      end
+    end
+
+    class BadRequest < Error
+      def initialize(msg)
+        super(msg)
+      end
+    end
+
+    class BadParams < Error
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/sinatra/schema/link.rb

@@ -23,8 +23,6 @@ module Sinatra
             res = instance_exec(schema_params, &link.action_block)
             link.resource.validate_response!(res)
             res
-          rescue RuntimeError => e
-            halt(400)
           end
         end
       end

data/lib/sinatra/schema/param_parsing.rb

@@ -8,7 +8,7 @@ module Sinatra
         when "application/x-www-form-urlencoded"
           cast_regular_params(properties)
         else
-          raise "Cannot handle media type #{request.media_type}"
+          raise BadRequest.new("Unsupported media type: #{request.media_type}")
         end
       end
 
@@ -21,12 +21,12 @@ module Sinatra
         request.body.rewind # leave it ready for other calls
         supplied_params = MultiJson.decode(body)
         unless supplied_params.is_a?(Hash)
-          raise "Invalid request, expecting a hash"
+          raise BadRequest.new("Invalid JSON request, please encode params as a hash")
         end
 
         indifferent_params(supplied_params)
       rescue MultiJson::ParseError
-        raise "Invalid JSON"
+        raise BadRequest.new("Invalid JSON encoded in request")
       end
 
       def cast_regular_params(properties, root=params)

data/lib/sinatra/schema/param_validation.rb

@@ -4,12 +4,12 @@ module Sinatra
       def validate_params!(params, properties)
         missing = properties.keys.map(&:to_s).sort - params.keys.map(&:to_s).sort
         unless missing.empty?
-          raise "Missing properties: #{missing}"
+          raise BadParams.new("Missing expected params: #{missing.join(',')}")
         end
 
         extra = params.keys.map(&:to_s).sort - properties.keys.map(&:to_s).sort
         unless extra.empty?
-          raise "Unexpected properties: #{extra}"
+          raise BadParams.new("Unexpected params: #{extra.join(',')}")
         end
 
         properties.each do |id, definition|
@@ -18,7 +18,7 @@ module Sinatra
             validate_params!(params[id], definition)
           else
             unless definition.valid?(params[id])
-              raise "Bad param: #{id}"
+              raise BadParams.new("Incorrect format for param '#{id}'. Please encode it as #{definition.type}")
             end
           end
         end

data/lib/sinatra/schema/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Schema
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/sinatra/schema.rb

@@ -4,6 +4,7 @@ require "singleton"
 require "multi_json"
 
 require "sinatra/schema/definition"
+require "sinatra/schema/error"
 require "sinatra/schema/link"
 require "sinatra/schema/param_parsing"
 require "sinatra/schema/param_validation"
@@ -19,6 +20,15 @@ module Sinatra
     def self.registered(app)
       app.helpers ParamParsing
       app.helpers ParamValidation
+
+      app.error(Sinatra::Schema::BadRequest) do |e|
+        halt(400, MultiJson.encode(error: e.message))
+      end
+
+      app.error(Sinatra::Schema::BadParams) do |e|
+        halt(422, MultiJson.encode(error: e.message))
+      end
+
       app.get "/schema" do
         content_type("application/schema+json")
         response.headers["Cache-Control"] = "public, max-age=3600"

data/spec/dsl/definitions_spec.rb

@@ -45,5 +45,12 @@ describe Sinatra::Schema::DSL::Definitions do
       assert_equal 1, other.defs.size
       assert_equal 1, resource.properties.size
     end
+
+    it "raises when we can't resolve the ref" do
+      assert_raises(Sinatra::Schema::BadReference) do
+        dsl.ref :foobar
+      end
+
+    end
   end
 end

data/spec/integration_spec.rb

@@ -21,8 +21,21 @@ describe Sinatra::Schema do
       MultiJson.decode(last_response.body))
   end
 
-  it "validates input" do
-    post "/accounts", foo: "bar"
-    assert_equal 400, last_response.status
+  describe "error handling" do
+    before do
+      header "Content-Type", "application/json"
+    end
+
+    it "converts BadRequest into a 400" do
+      post "/accounts", "{"
+      assert_equal 400, last_response.status
+      assert_equal({ "error" => "Invalid JSON encoded in request" }, last_json)
+    end
+
+    it "converts BadParams into a 422" do
+      post "/accounts", "{}"
+      assert_equal 422, last_response.status
+      assert_equal({ "error" => "Missing expected params: email" }, last_json)
+    end
   end
 end

data/spec/param_parsing_spec.rb

@@ -16,11 +16,17 @@ describe Sinatra::Schema::ParamParsing do
     end
 
     it "handles invalid json" do
-      assert_raises(RuntimeError, "Invalid JSON") do
+      assert_raises(Sinatra::Schema::BadRequest) do
         post "/", "{"
       end
     end
 
+    it "handles params not serialized as a hash" do
+      assert_raises(Sinatra::Schema::BadRequest) do
+        post "/", MultiJson.encode(["lolllll"])
+      end
+    end
+
     it "considers an empty body an empty hash" do
       post "/", ""
       assert_equal Hash.new, last_json
@@ -73,7 +79,7 @@ describe Sinatra::Schema::ParamParsing do
   end
 
   it "errors out on other formats" do
-    assert_raises(RuntimeError, "Cannot handle media type application/xml") do
+    assert_raises(Sinatra::Schema::BadRequest) do
       header "Content-Type", "application/xml"
       post "/", "<omg />"
     end

data/spec/param_validation_spec.rb

@@ -14,28 +14,28 @@ describe Sinatra::Schema::ParamValidation do
 
   it "errors out on unexpected params" do
     $properties = {}
-    assert_raises(RuntimeError, "omg just realized this doesn't do shit") do
+    assert_raises(Sinatra::Schema::BadParams) do
       post "/", MultiJson.encode(foo: "bar")
     end
   end
 
   it "errors out on missing params" do
     $properties = { foo: Sinatra::Schema::Definition.new(type: "string") }
-    assert_raises(RuntimeError) do
+    assert_raises(Sinatra::Schema::BadParams) do
       post "/", "{}"
     end
   end
 
   it "errors out on wrong format" do
     $properties = { bool: Sinatra::Schema::Definition.new(type: "boolean") }
-    assert_raises(RuntimeError) do
+    assert_raises(Sinatra::Schema::BadParams) do
       post "/", MultiJson.encode(bool: "omg")
     end
   end
 
   it "supports nested params" do
     $properties = { foo: { bar: Sinatra::Schema::Definition.new(type: "boolean") }}
-    assert_raises(RuntimeError) do
+    assert_raises(Sinatra::Schema::BadParams) do
       post "/", MultiJson.encode(foo: { bar: "omg" })
       puts last_response.body
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-schema
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Pedro Belo
@@ -138,6 +138,7 @@ files:
 - lib/sinatra/schema/dsl/definitions.rb
 - lib/sinatra/schema/dsl/links.rb
 - lib/sinatra/schema/dsl/resources.rb
+- lib/sinatra/schema/error.rb
 - lib/sinatra/schema/link.rb
 - lib/sinatra/schema/param_parsing.rb
 - lib/sinatra/schema/param_validation.rb