committee 3.1.0 → 3.1.1

data/test/validation_error_test.rb

@@ -1,4 +1,6 @@
-require_relative "test_helper"
+# frozen_string_literal: true
+
+require "test_helper"
 
 describe Committee::ValidationError do
   before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -144,6 +144,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -172,15 +200,30 @@ files:
 - lib/committee.rb
 - lib/committee/bin/committee_stub.rb
 - lib/committee/drivers.rb
+- lib/committee/drivers/driver.rb
 - lib/committee/drivers/hyper_schema.rb
+- lib/committee/drivers/hyper_schema/driver.rb
+- lib/committee/drivers/hyper_schema/link.rb
+- lib/committee/drivers/hyper_schema/schema.rb
 - lib/committee/drivers/open_api_2.rb
+- lib/committee/drivers/open_api_2/driver.rb
+- lib/committee/drivers/open_api_2/header_schema_builder.rb
+- lib/committee/drivers/open_api_2/link.rb
+- lib/committee/drivers/open_api_2/parameter_schema_builder.rb
+- lib/committee/drivers/open_api_2/schema.rb
+- lib/committee/drivers/open_api_2/schema_builder.rb
 - lib/committee/drivers/open_api_3.rb
+- lib/committee/drivers/open_api_3/driver.rb
+- lib/committee/drivers/open_api_3/schema.rb
+- lib/committee/drivers/schema.rb
 - lib/committee/errors.rb
+- lib/committee/middleware.rb
 - lib/committee/middleware/base.rb
 - lib/committee/middleware/request_validation.rb
 - lib/committee/middleware/response_validation.rb
 - lib/committee/middleware/stub.rb
 - lib/committee/request_unpacker.rb
+- lib/committee/schema_validator.rb
 - lib/committee/schema_validator/hyper_schema.rb
 - lib/committee/schema_validator/hyper_schema/parameter_coercer.rb
 - lib/committee/schema_validator/hyper_schema/request_validator.rb
@@ -194,15 +237,18 @@ files:
 - lib/committee/schema_validator/open_api_3/response_validator.rb
 - lib/committee/schema_validator/open_api_3/router.rb
 - lib/committee/schema_validator/option.rb
-- lib/committee/schema_validator/schema_validator.rb
 - lib/committee/test/methods.rb
 - lib/committee/validation_error.rb
 - test/bin/committee_stub_test.rb
 - test/bin_test.rb
 - test/committee_test.rb
-- test/drivers/hyper_schema_test.rb
-- test/drivers/open_api_2_test.rb
-- test/drivers/open_api_3_test.rb
+- test/drivers/hyper_schema/driver_test.rb
+- test/drivers/hyper_schema/link_test.rb
+- test/drivers/open_api_2/driver_test.rb
+- test/drivers/open_api_2/header_schema_builder_test.rb
+- test/drivers/open_api_2/link_test.rb
+- test/drivers/open_api_2/parameter_schema_builder_test.rb
+- test/drivers/open_api_3/driver_test.rb
 - test/drivers_test.rb
 - test/middleware/base_test.rb
 - test/middleware/request_validation_open_api_3_test.rb

data/lib/committee/schema_validator/schema_validator.rb

@@ -1,15 +0,0 @@
-class Committee::SchemaValidator
-  class << self
-    def request_media_type(request)
-      request.content_type.to_s.split(";").first.to_s
-    end
-
-    # @param [String] prefix
-    # @return [Regexp]
-    def build_prefix_regexp(prefix)
-      return nil unless prefix
-
-      /\A#{Regexp.escape(prefix)}/.freeze
-    end
-  end
-end

data/test/drivers/open_api_2_test.rb

@@ -1,416 +0,0 @@
-require_relative "../test_helper"
-
-describe Committee::Drivers::OpenAPI2 do
-  before do
-    @driver = Committee::Drivers::OpenAPI2.new
-  end
-
-  it "has a name" do
-    assert_equal :open_api_2, @driver.name
-  end
-
-  it "has a schema class" do
-    assert_equal Committee::Drivers::OpenAPI2::Schema, @driver.schema_class
-  end
-
-  it "parses an OpenAPI 2 spec" do
-    schema = @driver.parse(open_api_2_data)
-    assert_kind_of Committee::Drivers::OpenAPI2::Schema, schema
-    assert_kind_of JsonSchema::Schema, schema.definitions
-    assert_equal @driver, schema.driver
-
-    assert_kind_of Hash, schema.routes
-    refute schema.routes.empty?
-    assert(schema.routes.keys.all? { |m|
-      ["DELETE", "GET", "PATCH", "POST", "PUT"].include?(m)
-    })
-
-    schema.routes.each do |(_, method_routes)|
-      method_routes.each do |regex, link|
-        assert_kind_of Regexp, regex
-        assert_kind_of Committee::Drivers::OpenAPI2::Link, link
-
-        # verify that we've correct generated a parameters schema for each link
-        if link.target_schema
-          assert_kind_of JsonSchema::Schema, link.schema if link.schema
-        end
-
-        if link.target_schema
-          assert_kind_of JsonSchema::Schema, link.target_schema
-        end
-      end
-    end
-  end
-
-  it "names capture groups into href regexes" do
-    schema = @driver.parse(open_api_2_data)
-    assert_equal %r{^\/api\/pets\/(?<id>[^\/]+)$}.inspect,
-      schema.routes["DELETE"][0][0].inspect
-  end
-
-  it "prefers a 200 response first" do
-    schema_data = schema_data_with_responses({
-      '201' => { 'schema' => { 'description' => '201 response' } },
-      '200' => { 'schema' => { 'description' => '200 response' } },
-    })
-
-    schema = @driver.parse(schema_data)
-    link = schema.routes['GET'][0][1]
-    assert_equal 200, link.status_success
-    assert_equal({ 'description' => '200 response' }, link.target_schema.data)
-  end
-
-  it "prefers a 201 response next" do
-    schema_data = schema_data_with_responses({
-      '302' => { 'schema' => { 'description' => '302 response' } },
-      '201' => { 'schema' => { 'description' => '201 response' } },
-    })
-
-    schema = @driver.parse(schema_data)
-    link = schema.routes['GET'][0][1]
-    assert_equal 201, link.status_success
-    assert_equal({ 'description' => '201 response' }, link.target_schema.data)
-  end
-
-  it "prefers any three-digit response next" do
-    schema_data = schema_data_with_responses({
-      'default' => { 'schema' => { 'description' => 'default response' } },
-      '302' => { 'schema' => { 'description' => '302 response' } },
-    })
-
-    schema = @driver.parse(schema_data)
-    link = schema.routes['GET'][0][1]
-    assert_equal 302, link.status_success
-    assert_equal({ 'description' => '302 response' }, link.target_schema.data)
-  end
-
-  it "prefers any numeric three-digit response next" do
-    schema_data = schema_data_with_responses({
-      'default' => { 'schema' => { 'description' => 'default response' } },
-      302 => { 'schema' => { 'description' => '302 response' } },
-    })
-
-    schema = @driver.parse(schema_data)
-    link = schema.routes['GET'][0][1]
-    assert_equal 302, link.status_success
-    assert_equal({ 'description' => '302 response' }, link.target_schema.data)
-  end
-
-  it "falls back to no response" do
-    schema_data = schema_data_with_responses({})
-
-    schema = @driver.parse(schema_data)
-    link = schema.routes['GET'][0][1]
-    assert_nil link.status_success
-    assert_nil link.target_schema
-  end
-
-  it "refuses to parse other version of OpenAPI" do
-    data = open_api_2_data
-    data['swagger'] = '3.0'
-    e = assert_raises(ArgumentError) do
-      @driver.parse(data)
-    end
-    assert_equal "Committee: driver requires OpenAPI 2.0.", e.message
-  end
-
-  it "refuses to parse a spec without mandatory fields" do
-    data = open_api_2_data
-    data['definitions'] = nil
-    e = assert_raises(ArgumentError) do
-      @driver.parse(data)
-    end
-    assert_equal "Committee: no definitions section in spec data.", e.message
-  end
-
-  it "defaults to coercing form parameters" do
-    assert_equal true, @driver.default_coerce_form_params
-  end
-
-  it "defaults to path parameters" do
-    assert_equal true, @driver.default_path_params
-  end
-
-  it "defaults to query parameters" do
-    assert_equal true, @driver.default_query_params
-  end
-
-  def schema_data_with_responses(response_data)
-    {
-      'swagger' => '2.0',
-      'consumes' => ['application/json'],
-      'produces' => ['application/json'],
-      'paths' => {
-        '/foos' => {
-          'get' => {
-            'responses' => response_data,
-          },
-        },
-      },
-      'definitions' => {},
-    }
-  end
-end
-
-describe Committee::Drivers::OpenAPI2::Link do
-  before do
-    @link = Committee::Drivers::OpenAPI2::Link.new
-    @link.enc_type = "application/x-www-form-urlencoded"
-    @link.href = "/apps"
-    @link.media_type = "application/json"
-    @link.method = "GET"
-    @link.status_success = 200
-    @link.schema = { "title" => "input" }
-    @link.target_schema = { "title" => "target" }
-  end
-
-  it "uses set #enc_type" do
-    assert_equal "application/x-www-form-urlencoded", @link.enc_type
-  end
-
-  it "uses set #href" do
-    assert_equal "/apps", @link.href
-  end
-
-  it "uses set #media_type" do
-    assert_equal "application/json", @link.media_type
-  end
-
-  it "uses set #method" do
-    assert_equal "GET", @link.method
-  end
-
-  it "proxies #rel" do
-    e = assert_raises do
-      @link.rel
-    end
-    assert_equal "Committee: rel not implemented for OpenAPI", e.message
-  end
-
-  it "uses set #schema" do
-    assert_equal({ "title" => "input" }, @link.schema)
-  end
-
-  it "uses set #status_success" do
-    assert_equal 200, @link.status_success
-  end
-
-  it "uses set #target_schema" do
-    assert_equal({ "title" => "target" }, @link.target_schema)
-  end
-end
-
-describe Committee::Drivers::OpenAPI2::ParameterSchemaBuilder do
-  before do
-  end
-
-  it "reflects a basic type into a schema" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "limit",
-          "type" => "integer",
-        }
-      ]
-    }
-    schema, schema_data = call(data)
-
-    assert_nil schema_data
-    assert_equal ["limit"], schema.properties.keys
-    assert_equal [], schema.required
-    assert_equal ["integer"], schema.properties["limit"].type
-    assert_nil schema.properties["limit"].enum
-    assert_nil schema.properties["limit"].format
-    assert_nil schema.properties["limit"].pattern
-    assert_nil schema.properties["limit"].min_length
-    assert_nil schema.properties["limit"].max_length
-    assert_nil schema.properties["limit"].min_items
-    assert_nil schema.properties["limit"].max_items
-    assert_nil schema.properties["limit"].unique_items
-    assert_nil schema.properties["limit"].min
-    assert_nil schema.properties["limit"].min_exclusive
-    assert_nil schema.properties["limit"].max
-    assert_nil schema.properties["limit"].max_exclusive
-    assert_nil schema.properties["limit"].multiple_of
-  end
-
-  it "reflects a required property into a schema" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "limit",
-          "required" => true,
-        }
-      ]
-    }
-    schema, schema_data = call(data)
-
-    assert_nil schema_data
-    assert_equal ["limit"], schema.required
-  end
-
-  it "reflects an array with an items schema into a schema" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "tags",
-          "type" => "array",
-          "minItems" => 1,
-          "maxItems" => 10,
-          "uniqueItems" => true,
-          "items" => {
-            "type" => "string"
-          }
-        }
-      ]
-    }
-    schema, schema_data = call(data)
-
-    assert_nil schema_data
-    assert_equal ["array"], schema.properties["tags"].type
-    assert_equal 1, schema.properties["tags"].min_items
-    assert_equal 10, schema.properties["tags"].max_items
-    assert_equal true, schema.properties["tags"].unique_items
-    assert_equal({ "type" => "string" }, schema.properties["tags"].items)
-  end
-
-  it "reflects a enum property into a schema" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "type",
-          "type" => "string",
-          "enum" => ["hoge", "fuga"]
-        }
-      ]
-    }
-    schema, schema_data = call(data)
-
-    assert_nil schema_data
-    assert_equal ["hoge", "fuga"], schema.properties["type"].enum
-  end
-
-  it "reflects string properties into a schema" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "password",
-          "type" => "string",
-          "format" => "password",
-          "pattern" => "[a-zA-Z0-9]+",
-          "minLength" => 6,
-          "maxLength" => 30
-        }
-      ]
-    }
-    schema, schema_data = call(data)
-
-    assert_nil schema_data
-    assert_equal "password", schema.properties["password"].format
-    assert_equal Regexp.new("[a-zA-Z0-9]+"), schema.properties["password"].pattern
-    assert_equal 6, schema.properties["password"].min_length
-    assert_equal 30, schema.properties["password"].max_length
-  end
-
-  it "reflects number properties into a schema" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "limit",
-          "type" => "integer",
-          "minimum" => 20,
-          "exclusiveMinimum" => true,
-          "maximum" => 100,
-          "exclusiveMaximum" => false,
-          "multipleOf" => 10
-        }
-      ]
-    }
-    schema, schema_data = call(data)
-
-    assert_nil schema_data
-    assert_equal 20, schema.properties["limit"].min
-    assert_equal true, schema.properties["limit"].min_exclusive
-    assert_equal 100, schema.properties["limit"].max
-    assert_equal false, schema.properties["limit"].max_exclusive
-    assert_equal 10, schema.properties["limit"].multiple_of
-  end
-
-  it "returns schema data for a body parameter" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "payload",
-          "in" => "body",
-          "schema" => {
-            "$ref" => "#/definitions/foo",
-          }
-        }
-      ]
-    }
-    schema, schema_data = call(data)
-
-    assert_nil schema
-    assert_equal({ "$ref" => "#/definitions/foo" }, schema_data)
-  end
-
-  it "requires that certain fields are present" do
-    data = {
-      "parameters" => [
-        {
-        }
-      ]
-    }
-    e = assert_raises ArgumentError do
-      call(data)
-    end
-    assert_equal "Committee: no name section in link data.", e.message
-  end
-
-  it "requires that body parameters not be mixed with form parameters" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "payload",
-          "in" => "body",
-        },
-        {
-          "name" => "limit",
-          "in" => "form",
-        },
-      ]
-    }
-    e = assert_raises ArgumentError do
-      call(data)
-    end
-    assert_equal "Committee: can't mix body parameter with form parameters.",
-      e.message
-  end
-
-  def call(data)
-    Committee::Drivers::OpenAPI2::ParameterSchemaBuilder.new(data).call
-  end
-end
-
-describe Committee::Drivers::OpenAPI2::HeaderSchemaBuilder do
-  it "returns schema data for header" do
-    data = {
-      "parameters" => [
-        {
-          "name" => "AUTH_TOKEN",
-          "type" => "string",
-          "in" => "header",
-        }
-      ]
-    }
-    schema = call(data)
-
-    assert_equal ["string"], schema.properties["AUTH_TOKEN"].type
-  end
-
-  private
-
-  def call(data)
-    Committee::Drivers::OpenAPI2::HeaderSchemaBuilder.new(data).call
-  end
-end