rack-spec 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9d070ee1c712f33a4d50a9480bea910ff8674ba
-  data.tar.gz: 34ec8da54e93829dc3123145add042b246f79e46
+  metadata.gz: 2e30bacadb0a6825eea17ad9ab5dfbd2fa8ace16
+  data.tar.gz: 583d602a06414ccbe915c724c2b35ba961c5dfb1
 SHA512:
-  metadata.gz: 507ee6434b83a63a9a75899500f5778a34aa3854b0c68285ceda7bb63f97ad4a66880712f98d15269c3c07aab4bc54745fd0b3e7fcaa1b358da58764ddea43af
-  data.tar.gz: 0a6076dec2ca43cc4979790b6bfa92e557d119308e2e385f3b3d624079bf7736936b9c77d4f56d12c49c08cdf238c3cc4d3815e66378aee2f9acc2a00fa96312
+  metadata.gz: e74b5eb5fe9e52d278aab9b4ce560576e3349d3bca7e4360cfbcdbad5eb4a2f43117f3867f08eb7473d5b7369a316bae7885703650569db5dbe89ff28ffa9673
+  data.tar.gz: 6e0c5a3a2b268bec4473d52d9f81682fd21782f5333b3d43c8b61c1b1d62d43084e5b1be460bfe76c88d55e877ced9918ca9a49f5a71bf5f1c99f881844bc8dd

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.1.2
+* Change Content-Type validation policy
+* Add Rack::Spec::ResponseValidation
+
 ## v0.1.1
 * Add ErrorHandler rack middleware for building error response
 

data/README.md

@@ -1,10 +1,14 @@
 # Rack::Spec
-Generate API server from [JSON Schema](http://json-schema.org/).
+[JSON Schema](http://json-schema.org/) based Rack middlewares.
 
 ## Usage
 ```ruby
+str = File.read("schema.json")
+schema = JSON.parse(str)
+
 use Rack::Spec::ErrorHandler
-use Rack::Spec::RequestValidation, schema: JSON.parse(File.read("schema.json")))
+use Rack::Spec::RequestValidation, schema: schema
+use Rack::Spec::ResponseValidation, schema: schema if ENV["RACK_ENV"] == "test"
 ```
 
 ### Example
@@ -23,9 +27,18 @@ $ curl http://localhost:9292/apps -H "Content-Type: application/json" -d '{"name
 ```
 
 ### 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
+Validates request and raises following errors:
+
+* Rack::Spec::RequestValidation::InvalidContentType
+* Rack::Spec::RequestValidation::InvalidJson
+* Rack::Spec::RequestValidation::InvalidParameter
+* Rack::Spec::RequestValidation::LinkNotFound
+
+### Rack::Spec::RequestValidation
+Validates response and raises following errors:
+
+* Rack::Spec::RequestValidation::InvalidResponseContentType
+* Rack::Spec::RequestValidation::InvalidResponseType
 
 ### Rack::Spec::ErrorHandler
 Returns appropriate error response including following properties when RequestValidation raises error.
@@ -39,11 +52,19 @@ StandardError
 |
 Rack::Spec::Error
 |
-Rack::Spec::RequestValidation::Error
-|
-|--Rack::Spec::RequestValidation::LinkNotFound
-|
-|--Rack::Spec::RequestValidation::InvalidContentType
+|--Rack::Spec::RequestValidation::Error
+|  |
+|  |--Rack::Spec::RequestValidation::InvalidContentType
+|  |
+|  |--Rack::Spec::RequestValidation::InvalidJson
+|  |
+|  |--Rack::Spec::RequestValidation::InvalidParameter
+|  |
+|  `--Rack::Spec::RequestValidation::LinkNotFound
 |
-`--Rack::Spec::RequestValidation::InvalidParameter
+`--Rack::Spec::ResponseValidation::Error
+   |
+   |--Rack::Spec::ResponseValidation::InvalidResponseContentType
+   |
+   `--Rack::Spec::ResponseValidation::InvalidResponseType
 ```

data/lib/rack/spec.rb

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

data/lib/rack/spec/base_validator.rb

@@ -0,0 +1,53 @@
+module Rack
+  module Spec
+    class BaseValidator
+      # Utility wrapper method
+      def self.call(**args)
+        new(**args).call
+      end
+
+      # @param env [Hash] Rack env
+      # @param schema [JsonSchema::Schema] Schema object
+      def initialize(env: nil, schema: nil)
+        @env = env
+        @schema = schema
+      end
+
+      private
+
+      # Treats env as a utility object to easily extract method and path
+      # @return [Rack::Request]
+      def request
+        @request ||= Rack::Request.new(@env)
+      end
+
+      # @return [String] HTTP request method
+      # @example
+      #   method #=> "GET"
+      def method
+        request.request_method
+      end
+
+      # @return [String] Request path
+      # @example
+      #   path #=> "/recipes"
+      def path
+        request.path_info
+      end
+
+      # @return [JsonSchema::Schema::Link, nil] Link for the current action
+      def link
+        if instance_variable_defined?(:@link)
+          @link
+        else
+          @link = @schema.link_for(method: method, path: path)
+        end
+      end
+
+      # @return [true, false] True if link is defined for the current action
+      def has_link_for_current_action?
+        !!link
+      end
+    end
+  end
+end

data/lib/rack/spec/request_validation.rb

@@ -10,14 +10,14 @@ module Rack
         @schema = Schema.new(schema)
       end
 
-      # Behaves as a rack-middleware
+      # @raise [Rack::Spec::RequestValidation::Error] Raises if given request is invalid to JSON Schema
       # @param env [Hash] Rack env
       def call(env)
         Validator.call(env: env, schema: @schema)
         @app.call(env)
       end
 
-      class Validator
+      class Validator < BaseValidator
         # Utility wrapper method
         def self.call(**args)
           new(**args).call
@@ -71,12 +71,7 @@ module Rack
 
         # @return [true, false] True if no or matched content type given
         def has_valid_content_type?
-          content_type.nil? || Rack::Mime.match?(link.enc_type, content_type)
-        end
-
-        # @return [true, false] True if link is defined for the current action
-        def has_link_for_current_action?
-          !!link
+          mime_type.nil? || Rack::Mime.match?(link.enc_type, mime_type)
         end
 
         # @return [Array] A result of schema validation for the current action
@@ -94,40 +89,11 @@ module Rack
           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)
-            @link
-          else
-            @link = @schema.link_for(method: method, path: path)
-          end
-        end
-
-        # Treats env as a utility object to easily extract method and path
-        # @return [Rack::Request]
-        def request
-          @request ||= Rack::Request.new(@env)
-        end
-
-        # @return [String] HTTP request method
-        # @example
-        #   method #=> "GET"
-        def method
-          request.request_method
-        end
-
-        # @return [String] Request path
-        # @example
-        #   path #=> "/recipes"
-        def path
-          request.path_info
-        end
-
-        # @return [String] Request content type
+        # @return [String, nil] Request MIME Type specified in Content-Type header field
         # @example
-        #   path #=> "application/json"
-        def content_type
-          request.content_type
+        #   mime_type #=> "application/json"
+        def mime_type
+          request.content_type.split(";").first if request.content_type
         end
 
         # @return [String] request body

data/lib/rack/spec/response_validation.rb

@@ -0,0 +1,114 @@
+module Rack
+  module Spec
+    class ResponseValidation
+      # Behaves as a rack-middleware
+      # @param app [Object] Rack application
+      # @param schema [Hash] Schema object written in JSON schema format
+      # @raise [JsonSchema::SchemaError]
+      def initialize(app, schema: nil)
+        @app = app
+        @schema = Schema.new(schema)
+      end
+
+      # @raise [Rack::Spec::ResponseValidation::Error]
+      # @param env [Hash] Rack env
+      def call(env)
+        @app.call(env).tap do |response|
+          Validator.call(env: env, response: response, schema: @schema)
+        end
+      end
+
+      class Validator < BaseValidator
+        # @param env [Hash] Rack env
+        # @param response [Array] Rack response
+        # @param schema [JsonSchema::Schema] Schema object
+        def initialize(env: nil, response: nil, schema: nil)
+          @env = env
+          @response = response
+          @schema = schema
+        end
+
+        # Raises an error if any error detected
+        # @raise [Rack::Spec::ResponseValidation::InvalidResponse]
+        def call
+          case
+          when !has_json_content_type?
+            raise InvalidResponseContentType
+          when !valid?
+            raise InvalidResponseType, validator.errors
+          end
+        end
+
+        # @return [true, false] True if response Content-Type is for JSON
+        def has_json_content_type?
+          %r<\Aapplication/.*json> === headers["Content-Type"]
+        end
+
+        # @return [true, false] True if given data is valid to the JSON schema
+        def valid?
+          !has_link_for_current_action? || validator.validate(data)
+        end
+
+        # @return [Array, Hash] Response body data, decoded from JSON
+        def data
+          MultiJson.decode(body)
+        end
+
+        # @return [JsonSchema::Validator]
+        # @note The result is memoized for returning errors in invalid case
+        def validator
+          @validator ||= JsonSchema::Validator.new(schema_for_current_link)
+        end
+
+        # @return [JsonSchema::Schema] Schema for current link, specified by targetSchema or parent schema
+        def schema_for_current_link
+          link.target_schema || link.parent
+        end
+
+        # @return [Hash] Response headers
+        def headers
+          @response[1]
+        end
+
+        # @return [String] Response body
+        def body
+          @response[2].reduce("") do |result, str|
+            result << str
+          end
+        end
+      end
+
+      # Base error class for Rack::Spec::ResponseValidation
+      class Error < Error
+      end
+
+      class InvalidResponseType < Error
+        def initialize(errors)
+          super JsonSchema::SchemaError.aggregate(errors).join(" ")
+        end
+
+        def id
+          "invalid_response_type"
+        end
+
+        def status
+          500
+        end
+      end
+
+      class InvalidResponseContentType < Error
+        def initialize
+          super("Response Content-Type wasn't for JSON")
+        end
+
+        def id
+          "invalid_response_content_type"
+        end
+
+        def status
+          500
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/version.rb

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

data/rack-spec.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Rack::Spec::VERSION
   spec.authors       = ["Ryo Nakamura"]
   spec.email         = ["r7kamura@gmail.com"]
-  spec.summary       = "Spec based web-application middleware for Rack."
+  spec.summary       = "JSON Schema based Rack middlewares"
 
   spec.homepage      = "https://github.com/r7kamura/rack-spec"
   spec.license       = "MIT"

data/spec/fixtures/schema.json

@@ -9,6 +9,7 @@
       "type": [
         "object"
       ],
+      "required": ["id"],
       "definitions": {
         "id": {
           "description": "unique identifier of app",

data/spec/rack/{spec/request_validation_spec.rb → spec_spec.rb}

@@ -1,26 +1,44 @@
 require "spec_helper"
 
-describe Rack::Spec::RequestValidation do
+describe Rack::Spec do
   include Rack::Test::Methods
 
   let(:app) do
-    data = schema
+    local_schema = schema
+    local_response_body = response_body
+    local_response_headers = response_headers
     Rack::Builder.app do
       use Rack::Spec::ErrorHandler
-      use Rack::Spec::RequestValidation, schema: data
+      use Rack::Spec::RequestValidation, schema: local_schema
+      use Rack::Spec::ResponseValidation, schema: local_schema
       run ->(env) do
-        [200, {}, ["OK"]]
+        [200, local_response_headers, [local_response_body]]
       end
     end
   end
 
+  let(:response_headers) do
+    { "Content-Type" => "application/json" }
+  end
+
+  let(:response_body) do
+    response_data.to_json
+  end
+
+  let(:response_data) do
+    {
+      id: "01234567-89ab-cdef-0123-456789abcdef",
+      name: "example",
+    }
+  end
+
   let(:schema) do
     str = File.read(schema_path)
     JSON.parse(str)
   end
 
   let(:schema_path) do
-    File.expand_path("../../../fixtures/schema.json", __FILE__)
+    File.expand_path("../../fixtures/schema.json", __FILE__)
   end
 
   let(:response) do
@@ -58,7 +76,7 @@ describe Rack::Spec::RequestValidation do
     end
   end
 
-  describe "#call" do
+  describe "RequestValidation" do
     let(:verb) do
       :get
     end
@@ -103,6 +121,13 @@ describe Rack::Spec::RequestValidation do
       it { should == 200 }
     end
 
+    context "with suffixed content type", :with_valid_post_request do
+      before do
+        env["CONTENT_TYPE"] = "application/json; charset=utf8"
+      end
+      it { should == 200 }
+    end
+
     context "with invalid request property", :with_valid_post_request do
       let(:params) do
         { name: "ab" }.to_json
@@ -131,4 +156,62 @@ describe Rack::Spec::RequestValidation do
       end
     end
   end
+
+  describe "ResponseValidation" do
+    let(:verb) do
+      :get
+    end
+
+    let(:path) do
+      "/apps"
+    end
+
+    let(:body) do
+      {
+        foo: "bar",
+      }.to_json
+    end
+
+    context "with response content type except for JSON" do
+      let(:response_headers) do
+        { "Content-Type" => "text/plain" }
+      end
+
+      it "returns invalid_response_content_type error" do
+        should == 500
+        response.body.should be_json_as(
+          id: "invalid_response_content_type",
+          message: "Response Content-Type wasn't for JSON",
+        )
+      end
+    end
+
+    context "without required field" do
+      before do
+        response_data.delete(:id)
+      end
+
+      it "returns invalid_response_type error" do
+        should == 500
+        response.body.should be_json_as(
+          id: "invalid_response_type",
+          message: /Missing required keys "id" in object/,
+        )
+      end
+    end
+
+    context "with invalid pattern string field" do
+      before do
+        response_data[:id] = "123"
+      end
+
+      it "returns invalid_response_type error" do
+        should == 500
+        response.body.should be_json_as(
+          id: "invalid_response_type",
+          message: /Expected data to match "uuid" format, value was: 123/,
+        )
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -151,14 +151,16 @@ files:
 - Rakefile
 - lib/rack-spec.rb
 - lib/rack/spec.rb
+- lib/rack/spec/base_validator.rb
 - lib/rack/spec/error.rb
 - lib/rack/spec/error_handler.rb
 - lib/rack/spec/request_validation.rb
+- lib/rack/spec/response_validation.rb
 - lib/rack/spec/schema.rb
 - lib/rack/spec/version.rb
 - rack-spec.gemspec
 - spec/fixtures/schema.json
-- spec/rack/spec/request_validation_spec.rb
+- spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/rack-spec
 licenses:
@@ -183,9 +185,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Spec based web-application middleware for Rack.
+summary: JSON Schema based Rack middlewares
 test_files:
 - spec/fixtures/schema.json
-- spec/rack/spec/request_validation_spec.rb
+- spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 has_rdoc: