committee 1.15.0 → 2.0.0.pre

data/test/committee_test.rb

@@ -0,0 +1,49 @@
+require_relative "test_helper"
+
+describe Committee do
+  it "debugs based off env" do
+    old = ENV["COMMITTEE_DEBUG"]
+    begin
+      ENV["COMMITTEE_DEBUG"] = nil
+      refute Committee.debug?
+      ENV["COMMITTEE_DEBUG"] = "true"
+      assert Committee.debug?
+    ensure
+      ENV["COMMITTEE_DEBUG"] = old
+    end
+  end
+
+  it "logs debug messages to stderr" do
+    old_stderr = $stderr
+    $stderr = StringIO.new
+    begin
+      stub(Committee).debug? { false }
+      Committee.log_debug "blah"
+      assert_equal "", $stderr.string
+
+      stub(Committee).debug? { true }
+      Committee.log_debug "blah"
+      assert_equal "blah\n", $stderr.string
+    ensure
+      $stderr = old_stderr
+    end
+  end
+
+  it "warns on deprecated unless $VERBOSE is nil" do
+    old_stderr = $stderr
+    old_verbose = $VERBOSE
+    $stderr = StringIO.new
+    begin
+      $VERBOSE = nil
+      Committee.warn_deprecated "blah"
+      assert_equal "", $stderr.string
+
+      $VERBOSE = true
+      Committee.warn_deprecated "blah"
+      assert_equal "blah\n", $stderr.string
+    ensure
+      $stderr = old_stderr
+      $VERBOSE = old_verbose
+    end
+  end
+end

data/test/drivers/hyper_schema_test.rb

@@ -0,0 +1,95 @@
+require_relative "../test_helper"
+
+describe Committee::Drivers::HyperSchema do
+  before do
+    @driver = Committee::Drivers::HyperSchema.new
+  end
+
+  it "has a name" do
+    assert_equal :hyper_schema, @driver.name
+  end
+
+  it "has a schema class" do
+    assert_equal Committee::Drivers::HyperSchema::Schema, @driver.schema_class
+  end
+
+  it "parses a hyper-schema and builds routes" do
+    schema = @driver.parse(hyper_schema_data)
+    assert_kind_of Committee::Drivers::HyperSchema::Schema, schema
+    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::HyperSchema::Link, link
+      end
+    end
+  end
+
+  it "defaults to no path parameters" do
+    assert_equal false, @driver.default_path_params
+  end
+
+  it "defaults to no query parameters" do
+    assert_equal false, @driver.default_query_params
+  end
+end
+
+describe Committee::Drivers::HyperSchema::Link do
+  before do
+    @hyper_schema_link = JsonSchema::Schema::Link.new
+    @hyper_schema_link.enc_type = "application/x-www-form-urlencoded"
+    @hyper_schema_link.href = "/apps"
+    @hyper_schema_link.media_type = "application/json"
+    @hyper_schema_link.method = "GET"
+    @hyper_schema_link.parent = { "title" => "parent" }
+    @hyper_schema_link.rel = "instances"
+    @hyper_schema_link.schema = { "title" => "input" }
+    @hyper_schema_link.target_schema = { "title" => "target" }
+
+    @link = Committee::Drivers::HyperSchema::Link.new(@hyper_schema_link)
+  end
+
+  it "proxies #enc_type" do
+    assert_equal "application/x-www-form-urlencoded", @link.enc_type
+  end
+
+  it "proxies #href" do
+    assert_equal "/apps", @link.href
+  end
+
+  it "proxies #media_type" do
+    assert_equal "application/json", @link.media_type
+  end
+
+  it "proxies #method" do
+    assert_equal "GET", @link.method
+  end
+
+  it "proxies #rel" do
+    assert_equal "instances", @link.rel
+  end
+
+  it "proxies #schema" do
+    assert_equal @hyper_schema_link.schema, @link.schema
+  end
+
+  it "generates 200 #status_success for non-create" do
+    assert_equal 200, @link.status_success
+  end
+
+  it "generates 201 #status_success for create" do
+    @hyper_schema_link.rel = "create"
+    assert_equal 201, @link.status_success
+  end
+
+  it "proxies #target_schema" do
+    assert_equal @hyper_schema_link.target_schema, @link.target_schema
+  end
+end

data/test/drivers/open_api_2_test.rb

@@ -0,0 +1,255 @@
+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 "falls back to no response" do
+    schema_data = schema_data_with_responses({})
+
+    schema = @driver.parse(schema_data)
+    link = schema.routes['GET'][0][1]
+    assert_equal nil, link.status_success
+    assert_equal 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 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 = call(data)
+
+    assert_equal ["limit"], schema.properties.keys
+    assert_equal [], schema.required
+    assert_equal ["integer"], schema.properties["limit"].type
+  end
+
+  it "reflects a required property into a schema" do
+    data = {
+      "parameters" => [
+        {
+          "name" => "limit",
+          "required" => true,
+        }
+      ]
+    }
+    schema = call(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",
+          "items" => {
+            "type" => "string"
+          }
+        }
+      ]
+    }
+    schema = call(data)
+
+    assert_equal ["array"], schema.properties["tags"].type
+    assert_equal({ "type" => "string" }, schema.properties["tags"].items)
+  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
+
+  def call(data)
+    Committee::Drivers::OpenAPI2::ParameterSchemaBuilder.new(data).call
+  end
+end

data/test/drivers_test.rb

@@ -0,0 +1,60 @@
+require_relative "test_helper"
+
+describe Committee::Drivers do
+  DRIVERS = [
+    :hyper_schema,
+    :open_api_2,
+  ].freeze
+
+  it "gets driver with .driver_from_name" do
+    DRIVERS.each do |name|
+      driver = Committee::Drivers.driver_from_name(name)
+      assert_kind_of Committee::Drivers::Driver, driver
+    end
+  end
+
+  it "raises an ArgumentError for an unknown driver with .driver_from_name" do
+    e = assert_raises(ArgumentError) do
+      Committee::Drivers.driver_from_name(:blueprint)
+    end
+    assert_equal %{Committee: unknown driver "blueprint".}, e.message
+  end
+end
+
+describe Committee::Drivers::Driver do
+  DRIVER_METHODS = {
+    :default_path_params  => [],
+    :default_query_params => [],
+    :name                 => [],
+    :parse                => [nil],
+    :schema_class         => [],
+  }
+
+  it "has a set of abstract methods" do
+    driver = Committee::Drivers::Driver.new
+    DRIVER_METHODS.each do |name, args|
+      e = assert_raises do
+        driver.send(name, *args)
+      end
+      assert_equal "needs implementation", e.message,
+        "Incorrect error message while sending #{name}: #{e.message}"
+    end
+  end
+end
+
+describe Committee::Drivers::Schema do
+  SCHEMA_METHODS = {
+    :driver => [],
+  }
+
+  it "has a set of abstract methods" do
+    schema = Committee::Drivers::Schema.new
+    SCHEMA_METHODS.each do |name, args|
+      e = assert_raises do
+        schema.send(name, *args)
+      end
+      assert_equal "needs implementation", e.message,
+        "Incorrect error message while sending #{name}: #{e.message}"
+    end
+  end
+end

data/test/middleware/base_test.rb

@@ -7,8 +7,10 @@ describe Committee::Middleware::Base do
     @app
   end
 
-  it "accepts schema hash" do
-    @app = new_rack_app(schema: JSON.parse(File.read("./test/data/schema.json")))
+  it "accepts just a schema object" do
+    @app = new_rack_app(
+      schema: hyper_schema
+    )
     params = {
       "name" => "cloudnasium"
     }
@@ -17,9 +19,11 @@ describe Committee::Middleware::Base do
     assert_equal 200, last_response.status
   end
 
-  it "accepts schema object" do
-    schema = JsonSchema.parse!(JSON.parse(File.read("./test/data/schema.json")))
-    @app = new_rack_app(schema: schema)
+  it "accepts schema string (legacy behavior)" do
+    mock(Committee).warn_deprecated.with_any_args
+    @app = new_rack_app(
+      schema: JSON.dump(hyper_schema_data)
+    )
     params = {
       "name" => "cloudnasium"
     }
@@ -28,6 +32,46 @@ describe Committee::Middleware::Base do
     assert_equal 200, last_response.status
   end
 
+  it "accepts schema hash (legacy behavior)" do
+    mock(Committee).warn_deprecated.with_any_args
+    @app = new_rack_app(
+      schema: hyper_schema_data
+    )
+    params = {
+      "name" => "cloudnasium"
+    }
+    header "Content-Type", "application/json"
+    post "/apps", JSON.generate(params)
+    assert_equal 200, last_response.status
+  end
+
+  it "accepts schema JsonSchema::Schema object (legacy behavior)" do
+    # Note we don't warn here because this is a recent deprecation and passing
+    # a schema object will not be a huge performance hit. We should probably
+    # start warning on the next version.
+
+    @app = new_rack_app(
+      schema: JsonSchema.parse!(hyper_schema_data)
+    )
+    params = {
+      "name" => "cloudnasium"
+    }
+    header "Content-Type", "application/json"
+    post "/apps", JSON.generate(params)
+    assert_equal 200, last_response.status
+  end
+
+  it "doesn't accept other schema types" do
+    @app = new_rack_app(
+      schema: 7,
+    )
+    e = assert_raises(ArgumentError) do
+      post "/apps"
+    end
+    assert_equal "Committee: schema expected to be a hash or an instance " +
+      "of Committee::Drivers::Schema.", e.message
+  end
+
   private
 
   def new_rack_app(options = {})

data/test/middleware/request_validation_test.rb

@@ -8,7 +8,7 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "passes through a valid request" do
-    @app = new_rack_app
+    @app = new_rack_app(schema: hyper_schema)
     params = {
       "name" => "cloudnasium"
     }
@@ -18,7 +18,7 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "detects an invalid request" do
-    @app = new_rack_app
+    @app = new_rack_app(schema: hyper_schema)
     header "Content-Type", "application/json"
     params = {
       "name" => 1
@@ -29,7 +29,7 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "rescues JSON errors" do
-    @app = new_rack_app
+    @app = new_rack_app(schema: hyper_schema)
     header "Content-Type", "application/json"
     post "/apps", "{x:y}"
     assert_equal 400, last_response.status
@@ -37,7 +37,7 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "takes a prefix" do
-    @app = new_rack_app(prefix: "/v1")
+    @app = new_rack_app(prefix: "/v1", schema: hyper_schema)
     params = {
       "name" => "cloudnasium"
     }
@@ -47,37 +47,26 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "ignores paths outside the prefix" do
-    @app = new_rack_app(prefix: "/v1")
+    @app = new_rack_app(prefix: "/v1", schema: hyper_schema)
     header "Content-Type", "text/html"
     get "/hello"
     assert_equal 200, last_response.status
   end
 
-  it "warns when sending a deprecated string" do
-    mock(Committee).warn_deprecated.with_any_args
-    @app = new_rack_app(schema: File.read("./test/data/schema.json"))
-    params = {
-      "name" => "cloudnasium"
-    }
-    header "Content-Type", "application/json"
-    post "/apps", JSON.generate(params)
-    assert_equal 200, last_response.status
-  end
-
   it "routes to paths not in schema" do
-    @app = new_rack_app
+    @app = new_rack_app(schema: hyper_schema)
     get "/not-a-resource"
     assert_equal 200, last_response.status
   end
 
   it "doesn't route to paths not in schema when in strict mode" do
-    @app = new_rack_app(strict: true)
+    @app = new_rack_app(schema: hyper_schema, strict: true)
     get "/not-a-resource"
     assert_equal 404, last_response.status
   end
 
   it "optionally raises an error" do
-    @app = new_rack_app(raise: true)
+    @app = new_rack_app(raise: true, schema: hyper_schema)
     header "Content-Type", "application/json"
     assert_raises(Committee::InvalidRequest) do
       post "/apps", "{x:y}"
@@ -85,7 +74,7 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "optionally skip content_type check" do
-    @app = new_rack_app(check_content_type: false)
+    @app = new_rack_app(check_content_type: false, schema: hyper_schema)
     params = {
       "name" => "cloudnasium"
     }
@@ -95,26 +84,51 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "optionally coerces query params" do
-    @app = new_rack_app(coerce_query_params: true)
+    @app = new_rack_app(coerce_query_params: true, schema: hyper_schema)
     header "Content-Type", "application/json"
     get "/search/apps", {"per_page" => "10", "query" => "cloudnasium"}
     assert_equal 200, last_response.status
   end
 
   it "still raises an error if query param coercion is not possible" do
-    @app = new_rack_app(coerce_query_params: true)
+    @app = new_rack_app(coerce_query_params: true, schema: hyper_schema)
     header "Content-Type", "application/json"
     get "/search/apps", {"per_page" => "foo", "query" => "cloudnasium"}
     assert_equal 400, last_response.status
     assert_match /invalid request/i, last_response.body
   end
 
+  it "passes through a valid request for OpenAPI" do
+    @app = new_rack_app(schema: open_api_2_schema)
+    get "/api/pets?limit=3"
+    assert_equal 200, last_response.status
+  end
+
+  it "detects an invalid request for OpenAPI" do
+    @app = new_rack_app(schema: open_api_2_schema)
+    get "/api/pets?limit=foo"
+    assert_equal 400, last_response.status
+    assert_match /invalid request/i, last_response.body
+  end
+
+  it "passes through a valid request for OpenAPI including path parameters" do
+    @app = new_rack_app(schema: open_api_2_schema)
+    # not that ID is expect to be an integer
+    get "/api/pets/123"
+    assert_equal 200, last_response.status
+  end
+
+  it "detects an invalid request for OpenAPI including path parameters" do
+    @app = new_rack_app(schema: open_api_2_schema)
+    # not that ID is expect to be an integer
+    get "/api/pets/not-integer"
+    assert_equal 400, last_response.status
+    assert_match /invalid request/i, last_response.body
+  end
+
   private
 
   def new_rack_app(options = {})
-    options = {
-      schema: JSON.parse(File.read("./test/data/schema.json"))
-    }.merge(options)
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run lambda { |_|