rack-json_schema 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52921d3192984f9d393b0501b2d4953b5bb3be36
-  data.tar.gz: 635f81c7e1ac5b97893fca271f6326aefe2d03d4
+  metadata.gz: ef655a50e6b11b211d6c48f8b638c6f12ed80b2c
+  data.tar.gz: 614a49ef7e5fcecac371e7d3b2746e6d5c940a79
 SHA512:
-  metadata.gz: 0c0a01694af3f7ab3df6c1579c6f5e755aba351abf08c3e8f8fa1490e87bcdef8a99ee25bdee239dbc26f9881c44a70b958ff04cfe74bdd37df137153f4774ac
-  data.tar.gz: d746e6349cf8c99755502182ae338c75ef13f1eba04b8bcd287778aabe802739b1137ac91f70219504ec28c485b0a70de33a9747eb7977ca133175861a7ead8f
+  metadata.gz: 8f1374e7ac063d401e43cdf6f9430f1f5c551b01b793ee77f7c344f5c34195c79b4f6b820bbb915c7645b66deeb0d1450ad25c1f196698337dcc0f78ed37fe44
+  data.tar.gz: 80c3ed15950aa3d4db33a62576772f17cf23071bfb92bff6029356734bccdd3e3d789deaa61190a3ef9dd775edfd15bb45db8625a09d6c6e4f92d3fc8b325406

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.0.1
+* Add Rack::JsonSchema::SchemaProvider
+
 ## 1.0.0
 * Rename: rack-spec -> rack-json_schema
 
@@ -17,36 +20,36 @@
 * Add Rack::JsonSchema::Mock
 * Prettify response JSON
 
-## v0.1.3
+## 0.1.3
 * Array response support of Rack::JsonSchema::ResponseValidation
 
-## v0.1.2
+## 0.1.2
 * Change Content-Type validation policy
 * Add Rack::JsonSchema::ResponseValidation
 
-## v0.1.1
+## 0.1.1
 * Add ErrorHandler rack middleware for building error response
 
-## v0.1.0
+## 0.1.0
 * Rebuilt entire code based on JSON schema
 
-## v0.0.5
+## 0.0.5
 * Change RESTful resource API (#get, #post, #put, and #delete)
 
-## v0.0.4
+## 0.0.4
 * Add Rack::JsonSchema::Restful, strongly conventional RESTful API Provider
 
-## v0.0.3
+## 0.0.3
 * Add a new constraint: required
 * More DRY way for validator definition
 
-## v0.0.2
+## 0.0.2
 * Change key name: queryParameters -> parameters
 * Add a new constraint: only
 * Add a new constraint: minimumLength
 * Add a new constraint: maxinumLength
 
-## v0.0.1
+## 0.0.1
 * Add a new constraint: type
 * Add a new constraint: minimum
 * Add a new constraint: maxinum

data/README.md

@@ -7,6 +7,7 @@ str = File.read("schema.json")
 schema = JSON.parse(str)
 
 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 if ENV["RACK_ENV"] == "test"
@@ -198,3 +199,36 @@ 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
+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": {
+    "app": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "description": "An app is a program to be deployed.",
+      "id": "schemata/app",
+      "title": "App",
+      ...
+    }
+  }
+}

data/bin/specup

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

data/lib/rack/json_schema/schema_provider.rb

@@ -0,0 +1,45 @@
+module Rack
+  module JsonSchema
+    class SchemaProvider
+      DEFAULT_PATH = "/schema"
+
+      # Behaves as a rack-middleware
+      # @param app [Object] Rack application
+      # @param path [String, nil] URL path to return JSON Schema (default: /schema)
+      # @param schema [Hash] Schema object written in JSON schema format
+      # @raise [JsonSchema::SchemaError]
+      def initialize(app, path: nil, schema: nil)
+        @app = app
+        @path = path
+        @schema = schema
+      end
+
+      # Returns rendered document for document request
+      # @return [Array] Rack response
+      # @param env [Hash] Rack env
+      def call(env)
+        if env["REQUEST_METHOD"] == "GET" && env["PATH_INFO"] == path
+          [
+            200,
+            { "Content-Type" => "application/json" },
+            [rendered_schema],
+          ]
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      # @return [String] Path to return document
+      def path
+        @path || DEFAULT_PATH
+      end
+
+      # @return [String] Rendered JSON Schema in JSON format
+      def rendered_schema
+        MultiJson.encode(@schema, pretty: true)
+      end
+    end
+  end
+end

data/lib/rack/json_schema/version.rb

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

data/lib/rack/json_schema.rb

@@ -12,4 +12,5 @@ require "rack/json_schema/mock"
 require "rack/json_schema/request_validation"
 require "rack/json_schema/response_validation"
 require "rack/json_schema/schema"
+require "rack/json_schema/schema_provider"
 require "rack/json_schema/version"

data/spec/rack/spec/schema_provider_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Rack::JsonSchema::SchemaProvider do
+  include Rack::Test::Methods
+
+  let(:app) do
+    local_schema_url_path = schema_url_path
+    local_schema = schema
+    Rack::Builder.app do
+      use Rack::JsonSchema::SchemaProvider, path: local_schema_url_path, 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(:schema_url_path) do
+    nil
+  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
+    let(:verb) do
+      :get
+    end
+
+    context "without :path option" do
+      let(:path) do
+        "/schema"
+      end
+
+      it "returns JSON Schema to request to GET /schema" do
+        should == 200
+        response.body.should include("app")
+      end
+    end
+
+    context "with :path option" do
+      let(:schema_url_path) do
+        "/json_schema"
+      end
+
+      let(:path) do
+        "/json_schema"
+      end
+
+      it "responds to specified path" do
+        should == 200
+        response.body.should_not == "dummy"
+      end
+    end
+
+    context "without targeted request" do
+      let(:path) do
+        "/apps"
+      end
+
+      it "delegates request to inner app" do
+        should == 200
+        response.body.should == "dummy"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-json_schema
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -189,11 +189,13 @@ files:
 - lib/rack/json_schema/request_validation.rb
 - lib/rack/json_schema/response_validation.rb
 - lib/rack/json_schema/schema.rb
+- lib/rack/json_schema/schema_provider.rb
 - lib/rack/json_schema/version.rb
 - rack-json_schema.gemspec
 - spec/fixtures/schema.json
 - spec/rack/spec/docs_spec.rb
 - spec/rack/spec/mock_spec.rb
+- spec/rack/spec/schema_provider_spec.rb
 - spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/rack-json_schema
@@ -224,6 +226,7 @@ test_files:
 - spec/fixtures/schema.json
 - spec/rack/spec/docs_spec.rb
 - spec/rack/spec/mock_spec.rb
+- spec/rack/spec/schema_provider_spec.rb
 - spec/rack/spec_spec.rb
 - spec/spec_helper.rb
 has_rdoc: