rack-spec 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3052bec055e4531609acc4f509cf2109088495d7
-  data.tar.gz: cfeeb3b1b98f02388affd0445fe3f26fcb0aeafe
+  metadata.gz: 87132891a38319e6296f71af99cfb46bb54d9041
+  data.tar.gz: 2a9700230c057c9894140ffad108f90fb6a314b3
 SHA512:
-  metadata.gz: 72ed9fed21dac59c45ce32cd123a26a1b6b970f8814f749704092e6f72b7ac7712924748bfb23566eeb439fd6ea4fec79d400bbee8e68edd4cd3fea5f3ea84ce
-  data.tar.gz: 830a617bad45287beba0865e2d8e1288e199a0a5eba055261a4aae3931fdf61d3bcab4ce3667aae7477d39ef6ed5d8d292cc0bfee5aea02a0a79231cfd9699a7
+  metadata.gz: e7ce5b2e4e7385afbcfc7cd0b3cb2b83a5b8492d4e91d43d0ec4cf79714aca7c3aaffad2e239e22bf2bba68f626182b1510107c7c063cc29144c0e91238a3fb1
+  data.tar.gz: 489751d27fb8458b88939c3b71e46ebcd89d48fbd7212f39bfc21de8e8e5f41b391020248f5a781e251a2fd847b849ea28a682b8af063ffe93329a00ebde2e06

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.4
+* Add Rack::Spec::Mock
+* Prettify response JSON
+
 ## v0.1.3
 * Array response support of Rack::Spec::ResponseValidation
 

data/README.md

@@ -9,49 +9,117 @@ schema = JSON.parse(str)
 use Rack::Spec::ErrorHandler
 use Rack::Spec::RequestValidation, schema: schema
 use Rack::Spec::ResponseValidation, schema: schema if ENV["RACK_ENV"] == "test"
+use Rack::Spec::Mock, schema: schema if ENV["RACK_ENV"] == "mock"
 ```
 
-### Example
+### Rack::Spec::RequestValidation
+Validates request and raises errors below.
+
+* Rack::Spec::RequestValidation::InvalidContentType
+* Rack::Spec::RequestValidation::InvalidJson
+* Rack::Spec::RequestValidation::InvalidParameter
+* Rack::Spec::RequestValidation::LinkNotFound
+
 ```sh
-$ curl http://localhost:9292/recipes
-{"id":"link_not_found","message":"Not found"}
+$ curl http://localhost:9292/users
+{
+  "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"}
+{
+  "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"}
+{
+  "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."}
+{
+  "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
-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::ResponseValidation
+Validates request and raises errors below.
 
 * Rack::Spec::RequestValidation::InvalidResponseContentType
 * Rack::Spec::RequestValidation::InvalidResponseType
 
+```sh
+$ curl http://localhost:9292/apps
+{
+  "id": "invalid_response_content_type",
+  "message": "Response Content-Type wasn't for JSON"
+}
+
+$ curl http://localhost:9292/apps
+{
+  "id": "invalid_response_type",
+  "message": "#: failed schema #/definitions/app: Expected data to be of type \"object\"; value was: [\"message\", \"dummy\"]."
+}
+```
+
+### Rack::Spec::Mock
+Generates dummy response by using example property in JSON schema.
+
+```sh
+$ curl http://localhost:9292/apps/1
+[
+  {
+    "id": "01234567-89ab-cdef-0123-456789abcdef",
+    "name": "example"
+  }
+]
+
+$ curl http://localhost:9292/apps/01234567-89ab-cdef-0123-456789abcdef
+{
+  "id": "01234567-89ab-cdef-0123-456789abcdef",
+  "name": "example"
+}
+
+$ curl http://localhost:9292/apps/1 -d '{"name":"example"}'
+{
+  "id": "01234567-89ab-cdef-0123-456789abcdef",
+  "name": "example"
+}
+
+$ curl http://localhost:9292/recipes
+{
+  "id": "example_not_found",
+  "message": "No example found for #/definitions/recipe/id"
+}
+```
+
 ### 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`)
+* message: Human readable message
+* id: Error type identifier listed below
+ * invalid_content_type
+ * invalid_json
+ * invalid_parameter
+ * invalid_response_content_type
+ * invalid_response_type
+ * link_not_found
+
+Here is a tree of all possible errors defined in Rack::Spec.
 
-### Errors
 ```
 StandardError
 |
 Rack::Spec::Error
 |
+|--Rack::Spec::Mock::Error
+|  |
+|  `--Rack::Spec::RequestValidation::ExampleNotFound
+|
 |--Rack::Spec::RequestValidation::Error
 |  |
 |  |--Rack::Spec::RequestValidation::InvalidContentType

data/lib/rack/spec.rb

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

data/lib/rack/spec/{base_validator.rb → base_request_handler.rb}

@@ -1,6 +1,7 @@
 module Rack
   module Spec
-    class BaseValidator
+    # Base class for providing some utility methods to handle Rack env and JSON Schema
+    class BaseRequestHandler
       # Utility wrapper method
       def self.call(**args)
         new(**args).call
@@ -48,6 +49,16 @@ module Rack
       def has_link_for_current_action?
         !!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 [true, false] True if response is intended to be list data
+      def has_list_data?
+        link.rel == "instances" && !link.target_schema
+      end
     end
   end
 end

data/lib/rack/spec/error.rb

@@ -23,7 +23,7 @@ module Rack
       end
 
       def body
-        { id: id, message: message }.to_json
+        MultiJson.encode({ id: id, message: message }, pretty: true) + "\n"
       end
     end
   end

data/lib/rack/spec/mock.rb

@@ -0,0 +1,93 @@
+module Rack
+  module Spec
+    class Mock
+      # 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
+
+      # @param env [Hash] Rack env
+      def call(env)
+        RequestHandler.call(app: @app, env: env, schema: @schema)
+      end
+
+      class RequestHandler < BaseRequestHandler
+        # @param app [Object] Rack application
+        def initialize(app: nil, **args)
+          @app = app
+          super(**args)
+        end
+
+        # Returns dummy response if JSON schema is defined for the current link
+        # @return [Array] Rack response
+        def call
+          if has_link_for_current_action?
+            dummy_response
+          else
+            @app.call(@env)
+          end
+        end
+
+        private
+
+        def dummy_response
+          [dummy_status, dummy_headers, [dummy_body]]
+        end
+
+        def dummy_status
+          method == "POST" ? 201 : 200
+        end
+
+        def dummy_headers
+          { "Content-Type" => "application/json" }
+        end
+
+        def dummy_body
+          document = ResponseGenerator.call(schema_for_current_link)
+          document = [document] if has_list_data?
+          MultiJson.encode(document, pretty: true) + "\n"
+        end
+      end
+
+      class ResponseGenerator
+        # Generates example response Hash from given schema
+        # @return [Hash]
+        # @example
+        #   Rack::Spec::Mock::ResponseGenerator(schema) #=> { "id" => 1, "name" => "example" }
+        def self.call(schema)
+          schema.properties.inject({}) do |result, (key, value)|
+            result.merge(
+              key => case
+              when !value.properties.empty?
+                call(value)
+              when !value.data["example"].nil?
+                value.data["example"]
+              when value.type.include?("null")
+                nil
+              else
+                raise ExampleNotFound, "No example found for #{schema.pointer}/#{key}"
+              end
+            )
+          end
+        end
+      end
+
+      class Error < Error
+      end
+
+      class ExampleNotFound < Error
+        def id
+          "example_not_found"
+        end
+
+        def status
+          500
+        end
+      end
+    end
+  end
+end

data/lib/rack/spec/request_validation.rb

@@ -17,7 +17,7 @@ module Rack
         @app.call(env)
       end
 
-      class Validator < BaseValidator
+      class Validator < BaseRequestHandler
         # Utility wrapper method
         def self.call(**args)
           new(**args).call

data/lib/rack/spec/response_validation.rb

@@ -18,7 +18,7 @@ module Rack
         end
       end
 
-      class Validator < BaseValidator
+      class Validator < BaseRequestHandler
         # @param env [Hash] Rack env
         # @param response [Array] Rack response
         # @param schema [JsonSchema::Schema] Schema object
@@ -28,14 +28,16 @@ module Rack
           @schema = schema
         end
 
-        # Raises an error if any error detected
+        # Raises an error if any error detected, skipping validation for non-defined link
         # @raise [Rack::Spec::ResponseValidation::InvalidResponse]
         def call
-          case
-          when !has_json_content_type?
-            raise InvalidResponseContentType
-          when !valid?
-            raise InvalidResponseType, validator.errors
+          if has_link_for_current_action?
+            case
+            when !has_json_content_type?
+              raise InvalidResponseContentType
+            when !valid?
+              raise InvalidResponseType, validator.errors
+            end
           end
         end
 
@@ -46,7 +48,7 @@ module Rack
 
         # @return [true, false] True if given data is valid to the JSON schema
         def valid?
-          !has_link_for_current_action? || validator.validate(example_item)
+          validator.validate(example_item)
         end
 
         # @return [Hash] Choose an item from response data, to be validated
@@ -58,11 +60,6 @@ module Rack
           end
         end
 
-        # @return [true, false] True if response is intended to be list data
-        def has_list_data?
-          link.rel == "instances" && !link.target_schema
-        end
-
         # @return [Array, Hash] Response body data, decoded from JSON
         def data
           MultiJson.decode(body)
@@ -74,11 +71,6 @@ module Rack
           @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]
@@ -86,9 +78,9 @@ module Rack
 
         # @return [String] Response body
         def body
-          @response[2].reduce("") do |result, str|
-            result << str
-          end
+          result = ""
+          @response[2].each {|str| result << str }
+          result
         end
       end
 

data/lib/rack/spec/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Spec
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/spec/fixtures/schema.json

@@ -95,11 +95,46 @@
           "$ref": "#/definitions/app/definitions/name"
         }
       }
+    },
+    "recipe": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "description": "cooking Recipe",
+      "title": "Recipe",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "id": {
+          "description": "unique identifier of recipe",
+          "format": "uuid",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "List recipes",
+          "href": "/recipes",
+          "method": "GET",
+          "rel": "instances",
+          "title": "list"
+        }
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/recipe/definitions/id"
+        }
+      }
     }
   },
   "properties": {
     "app": {
       "$ref": "#/definitions/app"
+    },
+    "recipe": {
+      "$ref": "#/definitions/recipe"
     }
   },
   "type": [

data/spec/rack/spec/mock_spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+describe Rack::Spec::Mock do
+  include Rack::Test::Methods
+
+  let(:app) do
+    local_schema = schema
+    Rack::Builder.app do
+      use Rack::Spec::ErrorHandler
+      use Rack::Spec::Mock, schema: local_schema
+      run ->(env) do
+        [
+          200,
+          {},
+          ["dummy"],
+        ]
+      end
+    end
+  end
+
+  let(:schema) do
+    str = File.read(schema_path)
+    JSON.parse(str)
+  end
+
+  let(:schema_path) do
+    File.expand_path("../../../fixtures/schema.json", __FILE__)
+  end
+
+  let(:response) do
+    last_response
+  end
+
+  let(:env) do
+    {}
+  end
+
+  let(:params) do
+    {}
+  end
+
+  subject do
+    send(verb, path, params, env)
+    response.status
+  end
+
+  describe "#call" do
+    context "with list API" do
+      let(:verb) do
+        :get
+      end
+
+      let(:path) do
+        "/apps"
+      end
+
+      it "returns Array dummy response" do
+        should == 200
+        response.body.should be_json_as(
+          [
+            {
+              id: schema["definitions"]["app"]["definitions"]["id"]["example"],
+              name: schema["definitions"]["app"]["definitions"]["name"]["example"],
+            }
+          ]
+        )
+      end
+    end
+
+    context "with info API" do
+      let(:verb) do
+        :get
+      end
+
+      let(:path) do
+        "/apps/1"
+      end
+
+      it "returns dummy response" do
+        should == 200
+        response.body.should be_json_as(
+          {
+            id: schema["definitions"]["app"]["definitions"]["id"]["example"],
+            name: schema["definitions"]["app"]["definitions"]["name"]["example"],
+          }
+        )
+      end
+    end
+
+    context "with POST API" do
+      let(:verb) do
+        :post
+      end
+
+      let(:path) do
+        "/apps"
+      end
+
+      it "returns dummy response with 201" do
+        should == 201
+      end
+    end
+
+    context "without example" do
+      let(:verb) do
+        :get
+      end
+
+      let(:path) do
+        "/recipes"
+      end
+
+      it "returns example_not_found error" do
+        should == 500
+        response.body.should be_json_as(
+          id: "example_not_found",
+          message: "No example found for #/definitions/recipe/id",
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -151,15 +151,17 @@ files:
 - Rakefile
 - lib/rack-spec.rb
 - lib/rack/spec.rb
-- lib/rack/spec/base_validator.rb
+- lib/rack/spec/base_request_handler.rb
 - lib/rack/spec/error.rb
 - lib/rack/spec/error_handler.rb
+- lib/rack/spec/mock.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/mock_spec.rb
 - spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/rack-spec
@@ -188,6 +190,7 @@ specification_version: 4
 summary: JSON Schema based Rack middlewares
 test_files:
 - spec/fixtures/schema.json
+- spec/rack/spec/mock_spec.rb
 - spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 has_rdoc: