rack-json_schema 1.0.0

data/lib/rack/json_schema/schema.rb

@@ -0,0 +1,55 @@
+module Rack
+  module JsonSchema
+
+    # Utility wrapper class for JsonSchema::Schema
+    class Schema
+      # Recursively extracts all links in given JSON schema
+      # @param json_schema [JsonSchema::Schema]
+      # @return [Array] An array of JsonSchema::Schema::Link
+      def self.extract_links(json_schema)
+        links = json_schema.links.select {|link| link.method && link.href }
+        links + json_schema.properties.map {|key, schema| extract_links(schema) }.flatten
+      end
+
+      # @param schema [Hash]
+      # @raise [JsonSchema::SchemaError]
+      # @example
+      #   hash = JSON.parse("schema.json")
+      #   schema = Rack::JsonSchema::Schema.new(hash)
+      def initialize(schema)
+        @json_schema = ::JsonSchema.parse!(schema).tap(&:expand_references!)
+      end
+
+      # @param method [String] Uppercase HTTP method name (e.g. GET, POST)
+      # @param path [String] Path string, which may include URI template
+      # @return [JsonSchema::Scheam::Link, nil] Link defined for the given method and path
+      # @example
+      #   schema.has_link_for?(method: "GET", path: "/recipes/{+id}") #=> nil
+      def link_for(method: nil, path: nil)
+        links_indexed_by_method[method].find do |link|
+          %r<^#{link.href.gsub(/\{(.*?)\}/, "[^/]+")}$> === path
+        end
+      end
+
+      # @return [Array] All links defined in given JSON schema
+      # @example
+      #   schema.links #=> [#<JsonSchema::Schema::Link>]
+      def links
+        @links ||= self.class.extract_links(@json_schema)
+      end
+
+      private
+
+      # @return [Hash] A key-value pair of HTTP method and an Array of links
+      # @note This Hash always returns an Array for any key
+      # @example
+      #   schema.links_indexed_by_method #=> { "GET" => [#<JsonSchema::Schema::Link>] }
+      def links_indexed_by_method
+        @links_indexed_by_method ||= links.inject(Hash.new {|hash, key| hash[key] = [] }) do |result, link|
+          result[link.method.to_s.upcase] << link
+          result
+        end
+      end
+    end
+  end
+end

data/lib/rack/json_schema/version.rb

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

data/rack-json_schema.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/json_schema/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-json_schema"
+  spec.version       = Rack::JsonSchema::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "JSON Schema based Rack middlewares"
+
+  spec.homepage      = "https://github.com/r7kamura/rack-json_schema"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jdoc", ">= 0.0.3"
+  spec.add_dependency "json_schema"
+  spec.add_dependency "multi_json"
+  spec.add_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+  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/fixtures/schema.json

@@ -0,0 +1,152 @@
+{
+  "$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",
+      "type": [
+        "object"
+      ],
+      "required": ["id"],
+      "definitions": {
+        "id": {
+          "description": "unique identifier of app",
+          "example": "01234567-89ab-cdef-0123-456789abcdef",
+          "format": "uuid",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "name": {
+          "description": "unique name of app",
+          "example": "example",
+          "pattern": "^[a-z][a-z0-9-]{3,50}$",
+          "readOnly": false,
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Create a new app.",
+          "href": "/apps",
+          "method": "POST",
+          "rel": "create",
+          "schema": {
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/app/definitions/name"
+              }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Create"
+        },
+        {
+          "description": "Delete an existing app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fid)}",
+          "method": "DELETE",
+          "rel": "destroy",
+          "title": "Delete"
+        },
+        {
+          "description": "Info for existing app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fid)}",
+          "method": "GET",
+          "rel": "self",
+          "title": "Info"
+        },
+        {
+          "description": "List existing apps.",
+          "href": "/apps",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List"
+        },
+        {
+          "description": "Update an existing app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fid)}",
+          "method": "PATCH",
+          "rel": "update",
+          "schema": {
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/app/definitions/name"
+              }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Update"
+        }
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/app/definitions/id"
+        },
+        "name": {
+          "$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,
+          "example": 1,
+          "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": [
+    "object"
+  ],
+  "description": "A schema for a small example API.",
+  "links": [
+    {
+      "href": "http://localhost:5000",
+      "rel": "self"
+    }
+  ],
+  "title": "Example API"
+}

data/spec/rack/spec/docs_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Rack::JsonSchema::Docs do
+  include Rack::Test::Methods
+
+  let(:app) do
+    local_docs_path = docs_path
+    local_schema = schema
+    Rack::Builder.app do
+      use Rack::JsonSchema::Docs, path: local_docs_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(:docs_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
+        "/docs"
+      end
+
+      it "generates API documentation and returns it to request to GET /docs" do
+        should == 200
+        response.body.should include("Example API")
+      end
+    end
+
+    context "with :path option" do
+      let(:docs_path) do
+        "/api_document"
+      end
+
+      let(:path) do
+        "/api_document"
+      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

data/spec/rack/spec/mock_spec.rb

@@ -0,0 +1,126 @@
+require "spec_helper"
+
+describe Rack::JsonSchema::Mock do
+  include Rack::Test::Methods
+
+  let(:app) do
+    local_schema = schema
+    Rack::Builder.app do
+      use Rack::JsonSchema::ErrorHandler
+      use Rack::JsonSchema::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
+      before do
+        schema["definitions"]["recipe"]["definitions"]["id"].delete("example")
+      end
+
+      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