rack-json_schema 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef655a50e6b11b211d6c48f8b638c6f12ed80b2c
-  data.tar.gz: 614a49ef7e5fcecac371e7d3b2746e6d5c940a79
+  metadata.gz: 13b64aeff3cae973d98aaf8f50c868a8b2223318
+  data.tar.gz: 30059b1a8a875156c441daf348cfe4ec245309dc
 SHA512:
-  metadata.gz: 8f1374e7ac063d401e43cdf6f9430f1f5c551b01b793ee77f7c344f5c34195c79b4f6b820bbb915c7645b66deeb0d1450ad25c1f196698337dcc0f78ed37fe44
-  data.tar.gz: 80c3ed15950aa3d4db33a62576772f17cf23071bfb92bff6029356734bccdd3e3d789deaa61190a3ef9dd775edfd15bb45db8625a09d6c6e4f92d3fc8b325406
+  metadata.gz: a3b043a0df3ae347ac84a03ab87bc843b76479dde93ad7f479752e34609e0ff0658cd2e1e6e9ddce0c16b139ff60144a4f24f1613e00f4e9d03f6481332a1374
+  data.tar.gz: 960189e3f983e32e73376a518a7cedfa53e1ec9479d9829c2a8b25a3b184cced50f3d7ae8a4f4e5a636c26179e1cf8dc721b09d96531df78ce024bda60bb0772

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.0.2
+* Bundled all middlewares into `specup` executable command
+
 ## 1.0.1
 * Add Rack::JsonSchema::SchemaProvider
 

data/README.md

@@ -1,6 +1,14 @@
 # Rack::JsonSchema
 [JSON Schema](http://json-schema.org/) based Rack middlewares.
 
+* [Rack::JsonSchema::RequestValidation](#rackjsonschemarequestvalidation)
+* [Rack::JsonSchema::ResponseValidation](#rackjsonschemaresponsevalidation)
+* [Rack::JsonSchema::Mock](#rackjsonschemamock)
+* [Rack::JsonSchema::ErrorHandler](#rackjsonschemaerrorhandler)
+* [Rack::JsonSchema::Docs](#rackjsonschemadocs)
+* [Rack::JsonSchema::SchemaProvider](#rackjsonschemaschemaprovider)
+* [specup](#specup)
+
 ## Usage
 ```ruby
 str = File.read("schema.json")
@@ -23,25 +31,25 @@ Validates request and raises errors below.
 * Rack::JsonSchema::RequestValidation::LinkNotFound
 
 ```sh
-$ curl http://localhost:9292/users
+$ curl http://localhost:8080/users
 {
   "id": "link_not_found",
   "message": "Not found"
 }
 
-$ curl http://localhost:9292/apps -H "Content-Type: application/json" -d "invalid-json"
+$ curl http://localhost:8080/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 "{}"
+$ curl http://localhost:8080/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"}'
+$ curl http://localhost:8080/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."
@@ -55,13 +63,13 @@ Validates request and raises errors below.
 * Rack::JsonSchema::RequestValidation::InvalidResponseType
 
 ```sh
-$ curl http://localhost:9292/apps
+$ curl http://localhost:8080/apps
 {
   "id": "invalid_response_content_type",
   "message": "Response Content-Type wasn't for JSON"
 }
 
-$ curl http://localhost:9292/apps
+$ curl http://localhost:8080/apps
 {
   "id": "invalid_response_type",
   "message": "#: failed schema #/definitions/app: Expected data to be of type \"object\"; value was: [\"message\", \"dummy\"]."
@@ -72,7 +80,7 @@ $ curl http://localhost:9292/apps
 Generates dummy response from JSON schema.
 
 ```sh
-$ curl http://localhost:9292/apps/1
+$ curl http://localhost:8080/apps/1
 [
   {
     "id": "01234567-89ab-cdef-0123-456789abcdef",
@@ -80,34 +88,25 @@ $ curl http://localhost:9292/apps/1
   }
 ]
 
-$ curl http://localhost:9292/apps/01234567-89ab-cdef-0123-456789abcdef
+$ curl http://localhost:8080/apps/01234567-89ab-cdef-0123-456789abcdef
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example"
 }
 
-$ curl http://localhost:9292/apps/1 -d '{"name":"example"}'
+$ curl http://localhost:8080/apps/1 -d '{"name":"example"}'
 {
   "id": "01234567-89ab-cdef-0123-456789abcdef",
   "name": "example"
 }
 
-$ curl http://localhost:9292/recipes
+$ curl http://localhost:8080/recipes
 {
   "id": "example_not_found",
   "message": "No example found for #/definitions/recipe/id"
 }
 ```
 
-Note: `specup` executable command is bundled to rackup dummy API server.
-
-```sh
-$ specup schema.json
-[2014-06-06 23:01:35] INFO  WEBrick 1.3.1
-[2014-06-06 23:01:35] INFO  ruby 2.0.0 (2013-06-27) [x86_64-darwin12.5.0]
-[2014-06-06 23:01:35] INFO  WEBrick::HTTPServer#start: pid=24303 port=8080
-```
-
 ### Rack::JsonSchema::ErrorHandler
 Returns appropriate error response including following properties when RequestValidation raises error.
 
@@ -156,20 +155,26 @@ Returns API documentation as a text/plain content, rendered in GitHub flavored M
 * API documentation is powered by [jdoc](https://github.com/r7kamura/jdoc) gem
 * This middleware is also bundled in the `specup` executable command
 
+### Rack::JsonSchema::SchemaProvider
+Serves JSON Schema at `GET /schema`.
+
+* You can give `path` option to change default path: `GET /schema`
+* This middleware is also bundled in the `specup` executable command
+
+## specup
+`specup` executable command is bundled to rackup handy mock API server.
+It validates requests,
+and returns dummy response,
+also returns auto-generated API documentation at `GET /docs`,
+and JSON Schema itself at `GET /schema`.
+
 ```sh
 $ specup schema.json
 [2014-06-06 23:01:35] INFO  WEBrick 1.3.1
 [2014-06-06 23:01:35] INFO  ruby 2.0.0 (2013-06-27) [x86_64-darwin12.5.0]
 [2014-06-06 23:01:35] INFO  WEBrick::HTTPServer#start: pid=24303 port=8080
 
-$ curl :8080/docs -i
-HTTP/1.1 200 OK
-Content-Type: text/plain; charset=utf-8
-Server: WEBrick/1.3.1 (Ruby/2.1.1/2014-02-24)
-Date: Sat, 07 Jun 2014 19:58:04 GMT
-Content-Length: 2175
-Connection: Keep-Alive
-
+$ curl :8080/docs
 # Example API
 * [App](#app)
  * [GET /apps](#get-apps)
@@ -179,47 +184,10 @@ Connection: Keep-Alive
  * [DELETE /apps/:id](#delete-appsid)
 * [Recipe](#recipe)
  * [GET /recipes](#get-recipes)
-
-## App
-An app is a program to be deployed.
-
-### Properties
-* id - unique identifier of app
- * Example: `01234567-89ab-cdef-0123-456789abcdef`
- * Type: string
- * Format: uuid
- * ReadOnly: true
-* name - unique name of app
- * Example: `example`
- * Type: string
- * Patern: `(?-mix:^[a-z][a-z0-9-]{3,50}$)`
-
-### GET /apps
-List existing apps.
-
 ...
-```
-
-### Rack::JsonSchema::SchemaProvider
-Serves JSON Schema at `GET /schema`.
-
-* You can give `path` option to change default path: `GET /schema`
-* This middleware is also bundled in the `specup` executable command
-
-```sh
-$ specup schema.json
-[2014-06-06 23:01:35] INFO  WEBrick 1.3.1
-[2014-06-06 23:01:35] INFO  ruby 2.0.0 (2013-06-27) [x86_64-darwin12.5.0]
-[2014-06-06 23:01:35] INFO  WEBrick::HTTPServer#start: pid=24303 port=8080
 
-$ curl :8080/schema -i
+$ curl :8080/schema
 HTTP/1.1 200 OK
-Content-Type: text/plain; charset=utf-8
-Server: WEBrick/1.3.1 (Ruby/2.1.1/2014-02-24)
-Date: Sat, 07 Jun 2014 19:58:04 GMT
-Content-Length: 2175
-Connection: Keep-Alive
-
 {
   "$schema": "http://json-schema.org/draft-04/hyper-schema",
   "definitions": {
@@ -232,3 +200,18 @@ Connection: Keep-Alive
     }
   }
 }
+
+$ curl :8080/apps/1
+[
+  {
+    "id": "01234567-89ab-cdef-0123-456789abcdef",
+    "name": "example"
+  }
+]
+
+$ curl :8080/apps -H "Content-Type: application/json" -d '{"name":1}'
+{
+  "id": "invalid_parameter",
+  "message": "Invalid request.\n#/name: failed schema #/definitions/app/links/0/schema/properties/name: Expected data to be of type \"string\"; value was: 1."
+}
+```

data/bin/specup

@@ -23,6 +23,8 @@ app = Rack::Builder.new do
   use Rack::JsonSchema::Docs, schema: schema
   use Rack::JsonSchema::SchemaProvider, schema: schema
   use Rack::JsonSchema::ErrorHandler
+  use Rack::JsonSchema::RequestValidation, schema: schema
+  use Rack::JsonSchema::ResponseValidation, schema: schema
   use Rack::JsonSchema::Mock, schema: schema
   run ->(env) { [404, {}, ["Not found"]] }
 end

data/lib/rack/json_schema/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module JsonSchema
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-json_schema
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ryo Nakamura