rack-spec 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a554761d92c1fbeb80f0983023a2cc61970cb9f6
-  data.tar.gz: 578034987add0a2733821b66a3d7fa9743e9aaac
+  metadata.gz: a9d070ee1c712f33a4d50a9480bea910ff8674ba
+  data.tar.gz: 34ec8da54e93829dc3123145add042b246f79e46
 SHA512:
-  metadata.gz: c12e918bd0224e9968dc856e0bd3fcc89293b1133bd1d6ed35c6c49d02ee8bff9ed988078f3281fd34947b99b128f8453bf22350eb820fad334262613e807e47
-  data.tar.gz: c95c7728c4d01ffb2066b3193102e08a44ef9202c9da36b343027352f7e77d1f76219a39762e23c954b6b34ad4f4afa6f2e69a81636e65436eb095fbd16c6809
+  metadata.gz: 507ee6434b83a63a9a75899500f5778a34aa3854b0c68285ceda7bb63f97ad4a66880712f98d15269c3c07aab4bc54745fd0b3e7fcaa1b358da58764ddea43af
+  data.tar.gz: 0a6076dec2ca43cc4979790b6bfa92e557d119308e2e385f3b3d624079bf7736936b9c77d4f56d12c49c08cdf238c3cc4d3815e66378aee2f9acc2a00fa96312

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.1.1
+* Add ErrorHandler rack middleware for building error response
+
 ## v0.1.0
 * Rebuilt entire code based on JSON schema
 

data/README.md

@@ -1,11 +1,49 @@
 # Rack::Spec
 Generate API server from [JSON Schema](http://json-schema.org/).
 
-## RequestValidation
+## Usage
+```ruby
+use Rack::Spec::ErrorHandler
+use Rack::Spec::RequestValidation, schema: JSON.parse(File.read("schema.json")))
+```
+
+### Example
+```sh
+$ curl http://localhost:9292/recipes
+{"id":"link_not_found","message":"Not found"}
+
+$ curl http://localhost:9292/apps -H "Content-Type: application/json" -d "invalid-json"
+{"id":"invalid_json","message":"Request body wasn't valid JSON"}
+
+$ curl http://localhost:9292/apps -H "Content-Type: text/plain" -d "{}"
+{"id":"invalid_content_type","message":"Invalid content type"}
+
+$ curl http://localhost:9292/apps -H "Content-Type: application/json" -d '{"name":"x"}'
+{"id":"invalid_parameter","message":"Invalid request.\n#/name: failed schema #/definitions/app/links/0/schema/properties/name: Expected string to match pattern \"/^[a-z][a-z0-9-]{3,50}$/\", value was: x."}
+```
+
+### Rack::Spec::RequestValidation
 * Raise `Rack::Spec::RequestValidation::LinkNotFound` when given request is not defined in schema
 * Raise `Rack::Spec::RequestValidation::InvalidContentType` for invalid content type
 * Raise `Rack::Spec::RequestValidation::InvalidParameter` for invalid request parameter
 
-```ruby
-use Rack::Spec::RequestValidation, schema: JSON.parse("schema.json")
+### Rack::Spec::ErrorHandler
+Returns appropriate error response including following properties when RequestValidation raises error.
+
+* id: Error type identifier (e.g. `link_not_found`, `invalid_content_type`)
+* message: Human readable message (e.g. `Not Found`, `Invalid Content-Type`)
+
+### Errors
+```
+StandardError
+|
+Rack::Spec::Error
+|
+Rack::Spec::RequestValidation::Error
+|
+|--Rack::Spec::RequestValidation::LinkNotFound
+|
+|--Rack::Spec::RequestValidation::InvalidContentType
+|
+`--Rack::Spec::RequestValidation::InvalidParameter
 ```

data/lib/rack/spec.rb

@@ -2,6 +2,8 @@ require "json"
 require "json_schema"
 require "multi_json"
 
+require "rack/spec/error_handler"
+require "rack/spec/error"
 require "rack/spec/request_validation"
 require "rack/spec/schema"
 require "rack/spec/version"

data/lib/rack/spec/error.rb

@@ -0,0 +1,30 @@
+module Rack
+  module Spec
+    class Error < StandardError
+      # @return [Array] Rack response
+      def to_rack_response
+        [status, headers, [body]]
+      end
+
+      private
+
+      # @note Override this
+      def status
+        500
+      end
+
+      # @note Override this
+      def id
+        "internal_server_error"
+      end
+
+      def headers
+        { "Content-Type" => "application/json" }
+      end
+
+      def body
+        { id: id, message: message }.to_json
+      end
+    end
+  end
+end

data/lib/rack/spec/error_handler.rb

@@ -0,0 +1,19 @@
+module Rack
+  module Spec
+    class ErrorHandler
+      # Behaves as a rack middleware
+      # @param app [Object] Rack application
+      def initialize(app)
+        @app = app
+      end
+
+      # Behaves as a rack middleware
+      # @param env [Hash] Rack env
+      def call(env)
+        @app.call(env)
+      rescue Rack::Spec::Error => exception
+        exception.to_rack_response
+      end
+    end
+  end
+end

data/lib/rack/spec/request_validation.rb

@@ -38,21 +38,27 @@ module Rack
             raise LinkNotFound
           when has_body? && !has_valid_content_type?
             raise InvalidContentType
-          when has_schema? && !has_valid_parameter?
-            raise InvalidParameter
+          when has_body? && !has_valid_json?
+            raise InvalidJson
+          when has_body? && has_schema? && !has_valid_parameter?
+            raise InvalidParameter, "Invalid request.\n#{schema_validation_error_message}"
           end
         end
 
         private
 
-        # @return [true, false] True if request parameters are all valid
-        def has_valid_parameter?
-          valid, errors = link.schema.validate(parameters)
-          valid
+        def has_valid_json?
+          parameters
+          true
         rescue MultiJson::ParseError
           false
         end
 
+        # @return [true, false] True if request parameters are all valid
+        def has_valid_parameter?
+          schema_validation_result[0]
+        end
+
         # @return [true, false] True if any schema is defined for the current action
         def has_schema?
           !!link.schema
@@ -73,6 +79,21 @@ module Rack
           !!link
         end
 
+        # @return [Array] A result of schema validation for the current action
+        def schema_validation_result
+          @schema_validation_result ||= link.schema.validate(parameters)
+        end
+
+        # @return [Array] Errors of schema validation
+        def schema_validation_errors
+          schema_validation_result[1]
+        end
+
+        # @return [String] Joined error message to the result of schema validation
+        def schema_validation_error_message
+          JsonSchema::SchemaError.aggregate(schema_validation_errors).join("\n")
+        end
+
         # @return [JsonSchema::Schema::Link, nil] Link for the current action
         def link
           if instance_variable_defined?(:@link)
@@ -134,19 +155,63 @@ module Rack
       end
 
       # Base error class for Rack::Spec::RequestValidation
-      class Error < StandardError
+      class Error < Error
       end
 
       # Error class for case when no link defined for given request
       class LinkNotFound < Error
+        def initialize
+          super("Not found")
+        end
+
+        def status
+          404
+        end
+
+        def id
+          "link_not_found"
+        end
       end
 
       # Error class for invalid request content type
       class InvalidContentType < Error
+        def initialize
+          super("Invalid content type")
+        end
+
+        def status
+          400
+        end
+
+        def id
+          "invalid_content_type"
+        end
+      end
+
+      # Error class for invalid JSON
+      class InvalidJson < Error
+        def initialize
+          super("Request body wasn't valid JSON")
+        end
+
+        def status
+          400
+        end
+
+        def id
+          "invalid_json"
+        end
       end
 
       # Error class for invalid request parameter
       class InvalidParameter < Error
+        def status
+          400
+        end
+
+        def id
+          "invalid_parameter"
+        end
       end
     end
   end

data/lib/rack/spec/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Spec
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/rack-spec.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "2.14.1"
   spec.add_development_dependency "rspec-console"
+  spec.add_development_dependency "rspec-json_matcher"
 end

data/spec/rack/spec/request_validation_spec.rb

@@ -6,6 +6,7 @@ describe Rack::Spec::RequestValidation do
   let(:app) do
     data = schema
     Rack::Builder.app do
+      use Rack::Spec::ErrorHandler
       use Rack::Spec::RequestValidation, schema: data
       run ->(env) do
         [200, {}, ["OK"]]
@@ -75,8 +76,12 @@ describe Rack::Spec::RequestValidation do
         "/undefined"
       end
 
-      it "raises Rack::Spec::RequestValidation::LinkNotFound" do
-        expect { subject }.to raise_error(Rack::Spec::RequestValidation::LinkNotFound)
+      it "returns link_not_found error" do
+        should == 404
+        response.body.should be_json_as(
+          id: "link_not_found",
+          message: "Not found",
+        )
       end
     end
 
@@ -85,8 +90,12 @@ describe Rack::Spec::RequestValidation do
         env["CONTENT_TYPE"] = "text/plain"
       end
 
-      it "raises Rack::Spec::RequestValidation::InvalidContentType" do
-        expect { subject }.to raise_error(Rack::Spec::RequestValidation::InvalidContentType)
+      it "returns invalid_content_type error" do
+        should == 400
+        response.body.should be_json_as(
+          id: "invalid_content_type",
+          message: "Invalid content type",
+        )
       end
     end
 
@@ -99,8 +108,12 @@ describe Rack::Spec::RequestValidation do
         { name: "ab" }.to_json
       end
 
-      it "raises Rack::Spec::RequestValidation::InvalidParameter" do
-        expect { subject }.to raise_error(Rack::Spec::RequestValidation::InvalidParameter)
+      it "returns invalid_parameter error" do
+        should == 400
+        response.body.should be_json_as(
+          id: "invalid_parameter",
+          message: %r<\AInvalid request\.\n#/name: failed schema .+: Expected string to match pattern>,
+        )
       end
     end
 
@@ -109,8 +122,12 @@ describe Rack::Spec::RequestValidation do
         "malformed"
       end
 
-      it "raises Rack::Spec::RequestValidation::InvalidParameter" do
-        expect { subject }.to raise_error(Rack::Spec::RequestValidation::InvalidParameter)
+      it "returns invalid_parameter error" do
+        should == 400
+        response.body.should be_json_as(
+          id: "invalid_json",
+          message: "Request body wasn't valid JSON",
+        )
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
 require "rack/builder"
 require "rack/spec"
 require "rack/test"
+require "rspec/json_matcher"
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.include RSpec::JsonMatcher
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - r7kamura@gmail.com
@@ -137,6 +151,8 @@ files:
 - Rakefile
 - lib/rack-spec.rb
 - lib/rack/spec.rb
+- lib/rack/spec/error.rb
+- lib/rack/spec/error_handler.rb
 - lib/rack/spec/request_validation.rb
 - lib/rack/spec/schema.rb
 - lib/rack/spec/version.rb