committee_firetail 5.0.0

data/lib/committee/validation_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Committee
+  class ValidationError
+    attr_reader :id, :message, :status, :request
+
+    def initialize(status, id, message, request = nil)
+      @status = status
+      @id = id
+      @message = message
+      @request = request
+    end
+
+    def error_body
+      { id: id, message: message }
+    end
+
+    def render
+      [
+        status,
+        { "Content-Type" => "application/json" },
+        [JSON.generate(error_body)]
+      ]
+    end
+  end
+end

data/lib/committee/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Committee
+    VERSION = '5.0.0'.freeze
+end

data/lib/committee.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "json"
+require "yaml"
+require "json_schema"
+require "rack"
+require 'openapi_parser'
+
+require_relative "committee/version"
+
+module Committee
+  def self.debug?
+    ENV["COMMITTEE_DEBUG"]
+  end
+
+  def self.log_debug(message)
+    $stderr.puts(message) if debug?
+  end
+
+  def self.need_good_option(message)
+    warn(message)
+  end
+
+  def self.warn_deprecated_until_6(cond, message)
+    raise "remove deprecated!"  unless Committee::VERSION.start_with?("5")
+    warn("[DEPRECATION] #{message}") if cond
+  end
+end
+
+require_relative "committee/utils"
+require_relative "committee/drivers"
+require_relative "committee/errors"
+require_relative "committee/middleware"
+require_relative "committee/request_unpacker"
+require_relative "committee/schema_validator"
+require_relative "committee/validation_error"
+
+require_relative "committee/bin/committee_stub"
+require_relative "committee/test/methods"
+require_relative "committee/test/schema_coverage"

data/test/bin/committee_stub_test.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::Bin::CommitteeStub do
+  before do
+    @bin = Committee::Bin::CommitteeStub.new
+  end
+
+  it "produces a Rack app" do
+    app = @bin.get_app(hyper_schema, {})
+    assert_kind_of Rack::Builder, app
+  end
+
+  it "parses command line options" do
+    options, parser = @bin.get_options_parser
+
+    parser.parse!(["--help"])
+    assert_equal true, options[:help]
+
+    parser.parse!([
+      "--driver", "open_api_2",
+      "--tolerant", "true",
+      "--port", "1234"
+    ])
+    assert_equal :open_api_2, options[:driver]
+    assert_equal true, options[:tolerant]
+    assert_equal "1234", options[:port]
+  end
+
+  it "is not supported in OpenAPI 3" do
+    assert_raises(Committee::OpenAPI3Unsupported) do
+      @bin.get_app(open_api_3_schema, {})
+    end
+  end
+end
+
+describe Committee::Bin::CommitteeStub, "app" do
+  include Rack::Test::Methods
+
+  before do
+    @bin = Committee::Bin::CommitteeStub.new
+  end
+
+  def app
+    options = {}
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = false
+
+    @bin.get_app(hyper_schema, options)
+  end
+
+  it "defaults to a 404" do
+    get "/foos"
+    assert_equal 404, last_response.status
+  end
+end

data/test/bin_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+#
+# The purpose of this sets of tests is just to include our Ruby executables
+# where possible so that we can get very basic sanity checks on their syntax
+# (which is something that of course Ruby can't do by default).
+#
+# We can do this without actually executing them because they're gated by `if
+# $0 == __FILE__` statements.
+#
+
+describe "executables in bin/" do
+  before do
+    @bin_dir = File.expand_path("../../bin", __FILE__)
+    ARGV[0] = '-h'
+  end
+
+  it "has roughly valid Ruby structure for committee-stub" do
+    assert_output(%r{Usage: rackup \[options\] \[JSON Schema file\]}) do
+      load File.join(@bin_dir, "committee-stub")
+    end
+  end
+end

data/test/committee_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "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 need_good_option" do
+    old_stderr = $stderr
+    $stderr = StringIO.new
+    begin
+      Committee.need_good_option "show"
+      assert_equal "show\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_until_6 true, "blah"
+      assert_equal "", $stderr.string
+
+      $VERBOSE = true
+      Committee.warn_deprecated_until_6 true, "blah"
+      assert_equal "[DEPRECATION] blah\n", $stderr.string
+    ensure
+      $stderr = old_stderr
+      $VERBOSE = old_verbose
+    end
+  end
+
+
+  it "doesn't warns on deprecated if cond is false" do
+    old_stderr = $stderr
+    old_verbose = $VERBOSE
+    $stderr = StringIO.new
+    begin
+      $VERBOSE = true
+      Committee.warn_deprecated_until_6 false, "blah"
+      assert_equal "", $stderr.string
+    ensure
+      $stderr = old_stderr
+      $VERBOSE = old_verbose
+    end
+  end
+end

data/test/drivers/hyper_schema/driver_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::Drivers::HyperSchema::Driver do
+  before do
+    @driver = Committee::Drivers::HyperSchema::Driver.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 not coercing form parameters" do
+    assert_equal false, @driver.default_coerce_form_params
+  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
+

data/test/drivers/hyper_schema/link_test.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+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/driver_test.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::Drivers::OpenAPI2::Driver do
+  before do
+    @driver = Committee::Drivers::OpenAPI2::Driver.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
+

data/test/drivers/open_api_2/header_schema_builder_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+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

data/test/drivers/open_api_2/link_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+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
+