committee 3.0.0.beta → 3.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5019abacff975df04498c8e2f04d04601dd6a99d1f3a621acafa6cf0873170fa
-  data.tar.gz: 0a08b6be4a680675cd985abf1fad733e55eee9a47368f852148cf732de5f68ff
+  metadata.gz: 2a84dd861016ddeaee3ad16d447427f58aa2bca50347412a1ad6096240a85880
+  data.tar.gz: 4b7f456688b1be6456af985971c84b1387c0d8af5ef7c4c4545f6fd65c8c8929
 SHA512:
-  metadata.gz: 179c89e72e306d1b79317a98ac7d3a1284edbecaaf13a04f9c7ab168724381988dfde7b4d45287c5f44d54f62d02296e959621f56038a55492e841e0d772021c
-  data.tar.gz: 9668d280fa56807e4101ac150dd04fdc280c0e0db4e04d17bbad26a031dca914388320f1dc7aaaefaeb6d4e41e11a01b51eb0f50254181a298df275eb6e50063
+  metadata.gz: e491038b0ef712064edfab1417dc7c57834f501270530638d978a528b7ba4e50d80b757bf0c0533dd5238fc4ac69595f1216bcc64ddddd516cf9a643a7b42c45
+  data.tar.gz: 95e05627014f67f46f4bd9976d6895109dbbce41a48ca4cf830120b1ddbd18d4434fb08878d0acbce94fabf3b4354ed3422548c3a406f2af0bf882bdea8981df

data/lib/committee/bin/committee_stub.rb

@@ -10,7 +10,7 @@ module Committee
       def get_app(schema, options)
         cache = {}
 
-        raise Committee::NotSupportOpenAPI3.new("OpenAPI3 not support stub") unless schema.support_stub?
+        raise Committee::OpenAPI3Unsupported.new("Stubs are not yet supported for OpenAPI 3") unless schema.supports_stub?
 
         Rack::Builder.new {
           unless options[:tolerant]

data/lib/committee/drivers/hyper_schema.rb

@@ -1,5 +1,9 @@
 module Committee::Drivers
   class HyperSchema < Committee::Drivers::Driver
+    def default_coerce_date_times
+      false
+    end
+
     # Whether parameters that were form-encoded will be coerced by default.
     def default_coerce_form_params
       false
@@ -17,10 +21,6 @@ module Committee::Drivers
       false
     end
 
-    def default_coerce_date_times
-      false
-    end
-
     def default_validate_success_only
       true
     end

data/lib/committee/drivers/open_api_2.rb

@@ -1,5 +1,9 @@
 module Committee::Drivers
   class OpenAPI2 < Committee::Drivers::Driver
+    def default_coerce_date_times
+      false
+    end
+
     # Whether parameters that were form-encoded will be coerced by default.
     def default_coerce_form_params
       true
@@ -17,10 +21,6 @@ module Committee::Drivers
       true
     end
 
-    def default_coerce_date_times
-      false
-    end
-
     def default_validate_success_only
       true
     end

data/lib/committee/drivers/open_api_3.rb

@@ -1,5 +1,9 @@
 module Committee::Drivers
   class OpenAPI3 < Committee::Drivers::Driver
+    def default_coerce_date_times
+      true
+    end
+
     # Whether parameters that were form-encoded will be coerced by default.
     def default_coerce_form_params
       true
@@ -17,10 +21,6 @@ module Committee::Drivers
       true
     end
 
-    def default_coerce_date_times
-      true
-    end
-
     def default_validate_success_only
       false
     end
@@ -29,15 +29,15 @@ module Committee::Drivers
       :open_api_3
     end
 
-    def schema_class
-      Committee::Drivers::OpenAPI3::Schema
-    end
-
     # @return [Committee::Drivers::OpenAPI3::Schema]
     def parse(open_api)
       schema_class.new(self, open_api)
     end
 
+    def schema_class
+      Committee::Drivers::OpenAPI3::Schema
+    end
+
     class Schema < Committee::Drivers::Schema
       attr_reader :open_api
       attr_reader :validator_option
@@ -50,7 +50,7 @@ module Committee::Drivers
         @driver = driver
       end
 
-      def support_stub?
+      def supports_stub?
         false
       end
 

data/lib/committee/drivers.rb

@@ -16,30 +16,30 @@ module Committee
     end
 
     # load and build drive from JSON file
-    # @param [String] filepath
+    # @param [String] schema_path
     # @return [Committee::Driver]
-    def self.load_from_json(filepath)
-      load_from_data(JSON.parse(File.read(filepath)))
+    def self.load_from_json(schema_path)
+      load_from_data(JSON.parse(File.read(schema_path)))
     end
 
     # load and build drive from YAML file
-    # @param [String] filepath
+    # @param [String] schema_path
     # @return [Committee::Driver]
-    def self.load_from_yaml(filepath)
-      load_from_data(YAML.load_file(filepath))
+    def self.load_from_yaml(schema_path)
+      load_from_data(YAML.load_file(schema_path))
     end
 
     # load and build drive from file
-    # @param [String] filepath
+    # @param [String] schema_path
     # @return [Committee::Driver]
-    def self.load_from_file(filepath)
-      case File.extname(filepath)
+    def self.load_from_file(schema_path)
+      case File.extname(schema_path)
       when '.json'
-        load_from_json(filepath)
+        load_from_json(schema_path)
       when '.yaml', '.yml'
-        load_from_yaml(filepath)
+        load_from_yaml(schema_path)
       else
-        raise "committee filepath option support '.yaml', '.yml', '.json' files only"
+        raise "Committee only supports the following file extensions: '.json', '.yaml', '.yml'"
       end
     end
 
@@ -110,8 +110,8 @@ module Committee
         raise "needs implementation"
       end
 
-      # OpenAPI3 not support stub but JSON Hyper-Schema and OpenAPI2 support
-      def support_stub?
+      # Stubs are supported in JSON Hyper-Schema and OpenAPI 2, but not yet in OpenAPI 3
+      def supports_stub?
         true
       end
     end

data/lib/committee/errors.rb

@@ -17,6 +17,6 @@ module Committee
   class ReferenceNotFound < Error
   end
 
-  class NotSupportOpenAPI3 < Error
+  class OpenAPI3Unsupported < Error
   end
 end

data/lib/committee/middleware/base.rb

@@ -25,7 +25,7 @@ module Committee::Middleware
       def get_schema(options)
         schema = options[:schema]
         unless schema
-          schema = Committee::Drivers::load_from_file(options[:filepath]) if options[:filepath]
+          schema = Committee::Drivers::load_from_file(options[:schema_path]) if options[:schema_path]
 
           raise(ArgumentError, "Committee: need option `schema` or `filepath`") unless schema
         end

data/lib/committee/middleware/stub.rb

@@ -1,4 +1,4 @@
-# Don't Support OpenAPI3
+# Stub is not yet supported in OpenAPI 3
 
 module Committee::Middleware
   class Stub < Base
@@ -15,7 +15,7 @@ module Committee::Middleware
 
       @call = options[:call]
 
-      raise Committee::NotSupportOpenAPI3.new("OpenAPI3 not support stub") unless @schema.support_stub?
+      raise Committee::OpenAPI3Unsupported.new("Stubs are not yet supported for OpenAPI 3") unless @schema.supports_stub?
     end
 
     def handle(request)

data/lib/committee/schema_validator/open_api_3.rb

@@ -10,7 +10,6 @@ class Committee::SchemaValidator
 
     def request_validate(request)
       path_params = validator_option.coerce_path_params ? coerce_path_params : {}
-      # coerce_query_params(request) if validator_option.coerce_query_params
 
       request_unpack(request)
 
@@ -39,7 +38,7 @@ class Committee::SchemaValidator
     end
 
     def coerce_form_params(_parameter)
-      # nothing because when request_schema_validation, check and coerce
+      # Empty because request_schema_validation checks and coerces
     end
 
     private

data/test/bin/committee_stub_test.rb

@@ -26,8 +26,8 @@ describe Committee::Bin::CommitteeStub do
     assert_equal "1234", options[:port]
   end
 
-  it "OpenAPI3 not support Stub" do
-    assert_raises(Committee::NotSupportOpenAPI3) do
+  it "is not supported in OpenAPI 3" do
+    assert_raises(Committee::OpenAPI3Unsupported) do
       @bin.get_app(open_api_3_schema, {})
     end
   end

data/test/drivers/open_api_3_test.rb

@@ -37,41 +37,41 @@ describe Committee::Drivers::OpenAPI3 do
   describe "Schema" do
     describe "#operation_object" do
       describe "path template" do
-        it "get normal path" do
+        it "gets a normal path" do
           obj = open_api_3_schema.operation_object("/path_template_test/no_template", "get")
           assert_equal "/path_template_test/no_template", obj.original_path
         end
 
-        it "get template path" do
+        it "gets a template path" do
           obj = open_api_3_schema.operation_object("/path_template_test/test", "get")
           assert_equal "/path_template_test/{template_name}", obj.original_path
         end
 
-        it "get nested template path" do
+        it "gets a nested template path" do
           obj = open_api_3_schema.operation_object("/path_template_test/abc/nested", "get")
           assert_equal "/path_template_test/{template_name}/nested", obj.original_path
           assert_equal({"template_name"=>"abc"}, obj.path_params)
         end
 
-        it "get double nested template path" do
+        it "gets a double nested template path" do
           obj = open_api_3_schema.operation_object("/path_template_test/test/nested/abc", "get")
           assert_equal "/path_template_test/{template_name}/nested/{nested_parameter}", obj.original_path
           assert_equal({"template_name"=>"test", "nested_parameter" => "abc"}, obj.path_params)
         end
 
-        it "get twice nested template path" do
+        it "gets a twice nested template path" do
           obj = open_api_3_schema.operation_object("/path_template_test/test/abc", "get")
           assert_equal "/path_template_test/{template_name}/{nested_parameter}", obj.original_path
           assert_equal({"template_name"=>"test", "nested_parameter" => "abc"}, obj.path_params)
         end
 
-        it "get twice nested concrete path" do
+        it "gets a twice nested concrete path" do
           obj = open_api_3_schema.operation_object("/path_template_test/test/abc/finish", "get")
           assert_equal "/path_template_test/{template_name}/{nested_parameter}/finish", obj.original_path
           assert_equal({"template_name"=>"test", "nested_parameter" => "abc"}, obj.path_params)
         end
 
-        it "get ambiguous path" do
+        it "gets an ambiguous path" do
           obj = open_api_3_schema.operation_object("/ambiguous/no_template", "get")
           assert_equal "/{ambiguous}/no_template", obj.original_path
           assert_equal({"ambiguous"=>"ambiguous"}, obj.path_params)

data/test/drivers_test.rb

@@ -21,69 +21,69 @@ describe Committee::Drivers do
     assert_equal %{Committee: unknown driver "blueprint".}, e.message
   end
 
-  describe 'load_from_file(filepath)' do
-    it 'load OpenAPI2' do
-      s = Committee::Drivers.load_from_file(open_api_2_filepath)
+  describe 'load_from_file(schema_path)' do
+    it 'loads OpenAPI2' do
+      s = Committee::Drivers.load_from_file(open_api_2_schema_path)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::OpenAPI2::Schema, s
     end
 
-    it 'load Hyper-Schema' do
-      s = Committee::Drivers.load_from_file(hyper_schema_filepath)
+    it 'loads Hyper-Schema' do
+      s = Committee::Drivers.load_from_file(hyper_schema_schema_path)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::HyperSchema::Schema, s
     end
 
-    it 'load OpenAPI3' do
-      s = Committee::Drivers.load_from_file(open_api_3_filepath)
+    it 'loads OpenAPI 3' do
+      s = Committee::Drivers.load_from_file(open_api_3_schema_path)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
     end
 
-    it 'load unsupported file extension' do
+    it 'errors on an unsupported file extension' do
       e = assert_raises(StandardError) do
         Committee::Drivers.load_from_file('test.xml')
       end
-      assert_equal "committee filepath option support '.yaml', '.yml', '.json' files only", e.message
+      assert_equal "Committee only supports the following file extensions: '.json', '.yaml', '.yml'", e.message
     end
   end
 
-  describe 'load_from_json(filepath)' do
-    it 'load OpenAPI2' do
-      s = Committee::Drivers.load_from_json(open_api_2_filepath)
+  describe 'load_from_json(schema_path)' do
+    it 'loads OpenAPI2' do
+      s = Committee::Drivers.load_from_json(open_api_2_schema_path)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::OpenAPI2::Schema, s
     end
 
-    it 'load Hyper-Schema' do
-      s = Committee::Drivers.load_from_json(hyper_schema_filepath)
+    it 'loads Hyper-Schema' do
+      s = Committee::Drivers.load_from_json(hyper_schema_schema_path)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::HyperSchema::Schema, s
     end
   end
 
-  describe 'load_from_yaml(filepath)' do
-    it 'load OpenAPI3' do
-      s = Committee::Drivers.load_from_yaml(open_api_3_filepath)
+  describe 'load_from_yaml(schema_path)' do
+    it 'loads OpenAPI3' do
+      s = Committee::Drivers.load_from_yaml(open_api_3_schema_path)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
     end
   end
 
-  describe 'load_from_data(filepath)' do
-    it 'load OpenAPI3' do
+  describe 'load_from_data(schema_path)' do
+    it 'loads OpenAPI3' do
       s = Committee::Drivers.load_from_data(open_api_3_data)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
     end
 
-    it 'load OpenAPI2' do
+    it 'loads OpenAPI2' do
       s = Committee::Drivers.load_from_data(open_api_2_data)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::OpenAPI2::Schema, s
     end
 
-    it 'load Hyper-Schema' do
+    it 'loads Hyper-Schema' do
       s = Committee::Drivers.load_from_data(hyper_schema_data)
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::HyperSchema::Schema, s

data/test/middleware/base_test.rb

@@ -29,7 +29,7 @@ describe Committee::Middleware::Base do
     assert_equal 200, last_response.status
   end
 
-  it "don't accepts schema string" do
+  it "doesn't accept a schema string" do
     @app = new_rack_app(
       schema: JSON.dump(hyper_schema_data)
     )
@@ -46,7 +46,7 @@ describe Committee::Middleware::Base do
                      "of Committee::Drivers::Schema.", e.message
   end
 
-  it "don't accepts schema hash" do
+  it "doesn't accept a schema hash" do
     @app = new_rack_app(
       schema: hyper_schema_data
     )
@@ -63,7 +63,7 @@ describe Committee::Middleware::Base do
                      "of Committee::Drivers::Schema.", e.message
   end
 
-  it "don't accepts schema JsonSchema::Schema object" do
+  it "doesn't accept a JsonSchema::Schema object" do
     @app = new_rack_app(
       schema: JsonSchema.parse!(hyper_schema_data)
     )
@@ -90,7 +90,7 @@ describe Committee::Middleware::Base do
     assert_equal "Committee: schema expected to be an instance of Committee::Drivers::Schema.", e.message
   end
 
-  it "schema not exist" do
+  it "errors when no schema is specified" do
     @app = new_rack_app
     e = assert_raises(ArgumentError) do
       post "/apps"
@@ -100,18 +100,18 @@ describe Committee::Middleware::Base do
   end
 
   describe 'initialize option' do
-    it "filepath option with hyper-schema" do
-      b = Committee::Middleware::Base.new(nil, filepath: hyper_schema_filepath)
+    it "schema_path option with hyper-schema" do
+      b = Committee::Middleware::Base.new(nil, schema_path: hyper_schema_schema_path)
       assert_kind_of Committee::Drivers::HyperSchema::Schema, b.instance_variable_get(:@schema)
     end
 
-    it "filepath option with OpenAPI2" do
-      b = Committee::Middleware::Base.new(nil, filepath: open_api_2_filepath)
+    it "schema_path option with OpenAPI2" do
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_2_schema_path)
       assert_kind_of Committee::Drivers::OpenAPI2::Schema, b.instance_variable_get(:@schema)
     end
 
     it "filepath option with OpenAPI3" do
-      b = Committee::Middleware::Base.new(nil, filepath: open_api_3_filepath)
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_schema_path)
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, b.instance_variable_get(:@schema)
     end
   end

data/test/middleware/request_validation_open_api_3_test.rb

@@ -18,7 +18,7 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
-  it "not parameter requset" do
+  it "not parameter request" do
     check_parameter_string = lambda { |_|
       [200, {integer: 1}, []]
     }

data/test/middleware/stub_test.rb

@@ -100,7 +100,7 @@ describe Committee::Middleware::Stub do
     cache = {}
     @app = new_rack_app(cache: cache, schema: open_api_3_schema)
 
-    assert_raises(Committee::NotSupportOpenAPI3) do
+    assert_raises(Committee::OpenAPI3Unsupported) do
       get "/characters"
     end
   end

data/test/request_unpacker_test.rb

@@ -122,7 +122,7 @@ describe Committee::RequestUnpacker do
     end
   end
 
-  it "coerces form params with coerce_form_params and a OpenAPI3 schema" do
+  it "coerces form params with coerce_form_params and an OpenAPI3 schema" do
     %w[application/x-www-form-urlencoded multipart/form-data].each do |content_type|
       env = {
           "CONTENT_TYPE" => content_type,

data/test/test_helper.rb

@@ -48,11 +48,11 @@ ValidPet = {
 }.freeze
 
 def hyper_schema
-  @hyper_schema ||= Committee::Drivers.load_from_json(hyper_schema_filepath)
+  @hyper_schema ||= Committee::Drivers.load_from_json(hyper_schema_schema_path)
 end
 
 def open_api_2_schema
-  @open_api_2_schema ||= Committee::Drivers.load_from_file(open_api_2_filepath)
+  @open_api_2_schema ||= Committee::Drivers.load_from_file(open_api_2_schema_path)
 end
 
 def open_api_3_schema
@@ -61,26 +61,27 @@ end
 
 # Don't cache this because we'll often manipulate the created hash in tests.
 def hyper_schema_data
-  JSON.parse(File.read(hyper_schema_filepath))
+  JSON.parse(File.read(hyper_schema_schema_path))
 end
 
 # Don't cache this because we'll often manipulate the created hash in tests.
 def open_api_2_data
-  JSON.parse(File.read(open_api_2_filepath))
+  JSON.parse(File.read(open_api_2_schema_path))
 end
 
 def open_api_3_data
-  YAML.load_file(open_api_3_filepath)
+  YAML.load_file(open_api_3_schema_path)
 end
 
-def hyper_schema_filepath
+def hyper_schema_schema_path
   "./test/data/hyperschema/paas.json"
 end
 
-def open_api_2_filepath
+def open_api_2_schema_path
   "./test/data/openapi2/petstore-expanded.json"
 end
 
-def open_api_3_filepath
-  "./test/data/openapi3/normal.yml"
+def open_api_3_schema_path
+  "./test/data/openapi3/normal.yaml"
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta
+  version: 3.0.0.beta2
 platform: ruby
 authors:
 - Brandur
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-19 00:00:00.000000000 Z
+date: 2019-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -242,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.