rack-json_schema 1.0.0

data/spec/rack/spec_spec.rb

@@ -0,0 +1,221 @@
+require "spec_helper"
+
+describe Rack::JsonSchema do
+  include Rack::Test::Methods
+
+  let(:app) do
+    local_schema = schema
+    local_response_body = response_body
+    local_response_headers = response_headers
+    Rack::Builder.app do
+      use Rack::JsonSchema::ErrorHandler
+      use Rack::JsonSchema::RequestValidation, schema: local_schema
+      use Rack::JsonSchema::ResponseValidation, schema: local_schema
+      run ->(env) do
+        [200, local_response_headers, [local_response_body]]
+      end
+    end
+  end
+
+  let(:response_headers) do
+    { "Content-Type" => "application/json" }
+  end
+
+  let(:response_body) do
+    if verb == :get
+      [response_data].to_json
+    else
+      response_data.to_json
+    end
+  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__)
+  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
+
+  shared_context "with valid POST request", :with_valid_post_request do
+    before do
+      env["CONTENT_TYPE"] = "application/json"
+    end
+
+    let(:verb) do
+      :post
+    end
+
+    let(:path) do
+      "/apps"
+    end
+
+    let(:params) do
+      { name: "abcd" }.to_json
+    end
+  end
+
+  describe "RequestValidation" do
+    let(:verb) do
+      :get
+    end
+
+    let(:path) do
+      "/apps"
+    end
+
+    context "with defined route" do
+      it { should == 200 }
+    end
+
+    context "with undefined route" do
+      let(:path) do
+        "/undefined"
+      end
+
+      it "returns link_not_found error" do
+        should == 404
+        response.body.should be_json_as(
+          id: "link_not_found",
+          message: "Not found",
+        )
+      end
+    end
+
+    context "with request body & invalid content type", :with_valid_post_request do
+      before do
+        env["CONTENT_TYPE"] = "text/plain"
+      end
+
+      it "returns invalid_content_type error" do
+        should == 400
+        response.body.should be_json_as(
+          id: "invalid_content_type",
+          message: "Invalid content type",
+        )
+      end
+    end
+
+    context "with valid request property", :with_valid_post_request 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
+      end
+
+      it "returns invalid_parameter error" do
+        should == 400
+        response.body.should be_json_as(
+          id: "invalid_parameter",
+          message: %r<\AInvalid request\.\n#/name: failed schema .+: Expected string to match pattern>,
+        )
+      end
+    end
+
+    context "with malformed JSON request body", :with_valid_post_request do
+      let(:params) do
+        "malformed"
+      end
+
+      it "returns invalid_parameter error" do
+        should == 400
+        response.body.should be_json_as(
+          id: "invalid_json",
+          message: "Request body wasn't valid JSON",
+        )
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "rack/builder"
+require "rack/json_schema"
+require "rack/test"
+require "rspec/json_matcher"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.include RSpec::JsonMatcher
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: rack-json_schema
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rspec-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- r7kamura@gmail.com
+executables:
+- specup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/specup
+- lib/rack-json_schema.rb
+- lib/rack/json_schema.rb
+- lib/rack/json_schema/base_request_handler.rb
+- lib/rack/json_schema/docs.rb
+- lib/rack/json_schema/error.rb
+- lib/rack/json_schema/error_handler.rb
+- lib/rack/json_schema/mock.rb
+- lib/rack/json_schema/request_validation.rb
+- lib/rack/json_schema/response_validation.rb
+- lib/rack/json_schema/schema.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_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/rack-json_schema
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: JSON Schema based Rack middlewares
+test_files:
+- spec/fixtures/schema.json
+- spec/rack/spec/docs_spec.rb
+- spec/rack/spec/mock_spec.rb
+- spec/rack/spec_spec.rb
+- spec/spec_helper.rb
+has_rdoc: