committee 3.0.0.alpha → 3.0.0.beta

data/test/middleware/request_validation_open_api_3_test.rb

@@ -7,53 +7,8 @@ describe Committee::Middleware::RequestValidation do
     @app
   end
 
-  ARRAY_PROPERTY = [
-      {
-          "update_time" => "2016-04-01T16:00:00.000+09:00",
-          "per_page" => 1,
-          "nested_coercer_object" => {
-              "update_time" => "2016-04-01T16:00:00.000+09:00",
-              "threshold" => 1.5
-          },
-          "nested_no_coercer_object" => {
-              "per_page" => 1,
-              "threshold" => 1.5
-          },
-          "nested_coercer_array" => [
-              {
-                  "update_time" => "2016-04-01T16:00:00.000+09:00",
-                  "threshold" => 1.5
-              }
-          ],
-          "nested_no_coercer_array" => [
-              {
-                  "per_page" => 1,
-                  "threshold" => 1.5
-              }
-          ],
-          "integer_array" => [
-              1, 2, 3
-          ],
-          "datetime_array" => [
-              "2016-04-01T16:00:00.000+09:00",
-              "2016-04-01T17:00:00.000+09:00",
-              "2016-04-01T18:00:00.000+09:00"
-          ]
-      },
-      {
-          "update_time" => "2016-04-01T16:00:00.000+09:00",
-          "per_page" => 1,
-          "threshold" => 1.5
-      },
-      {
-          "threshold" => 1.5,
-          "per_page" => 1
-      }
-  ]
-
-
   it "OpenAPI3 pass through a valid request" do
-    @app = new_rack_app(open_api_3: open_api_3_schema)
+    @app = new_rack_app(schema: open_api_3_schema)
     params = {
         "string_post_1" => "cloudnasium"
     }
@@ -68,7 +23,7 @@ describe Committee::Middleware::RequestValidation do
       [200, {integer: 1}, []]
     }
 
-    @app = new_rack_app_with_lambda(check_parameter_string, open_api_3: open_api_3_schema)
+    @app = new_rack_app_with_lambda(check_parameter_string, schema: open_api_3_schema)
 
     put "/validate_no_parameter", {no_schema: 'no'}
   end
@@ -81,7 +36,7 @@ describe Committee::Middleware::RequestValidation do
       [200, {}, []]
     }
 
-    @app = new_rack_app_with_lambda(check_parameter, open_api_3: open_api_3_schema, coerce_date_times: true)
+    @app = new_rack_app_with_lambda(check_parameter, schema: open_api_3_schema, coerce_date_times: true)
 
     get "/string_params_coercer", params
     assert_equal 200, last_response.status
@@ -132,26 +87,24 @@ describe Committee::Middleware::RequestValidation do
       [200, {}, []]
     }
 
-    @app = new_rack_app_with_lambda(check_parameter, open_api_3: open_api_3_schema, coerce_date_times: true, coerce_recursive: true)
+    @app = new_rack_app_with_lambda(check_parameter, schema: open_api_3_schema, coerce_date_times: true, coerce_recursive: true)
 
-    post "/string_params_coercer", params
+    header "Content-Type", "application/json"
+    post "/string_params_coercer", JSON.generate(params)
 
     assert_equal 200, last_response.status
   end
 
-  # TODO: support date-time object format check
-=begin
   it "passes given an invalid datetime string with coerce_date_times enabled" do
-    @app = new_rack_app(open_api_3: open_api_3_schema, coerce_date_times: true)
+    @app = new_rack_app(schema: open_api_3_schema, coerce_date_times: true)
     params = {
         "datetime_string" => "invalid_datetime_format"
     }
-    get "/string_params_coercer", JSON.generate(params)
+    get "/string_params_coercer", params
 
     assert_equal 400, last_response.status
-    assert_match(/invalid request/i, last_response.body)
+    assert_match(/invalid_datetime/i, last_response.body)
   end
-=end
 
   it "passes a nested object with recursive option" do
     params = {
@@ -175,136 +128,84 @@ describe Committee::Middleware::RequestValidation do
                                     coerce_query_params: true,
                                     coerce_recursive: true,
                                     coerce_date_times: true,
-                                    open_api_3: open_api_3_schema)
+                                    schema: open_api_3_schema)
 
     get "/string_params_coercer", params
 
     assert_equal 200, last_response.status
   end
 
-=begin
-  it "passes a nested object with coerce_recursive default(true)" do
-    key_name = "update_time"
-    params = {
-        key_name => "2016-04-01T16:00:00.000+09:00",
-        "query" => "cloudnasium",
-        "array_property" => ARRAY_PROPERTY
-    }
-
-    @app = new_rack_app(coerce_query_params: true, coerce_date_times: true, schema: hyper_schema)
-
-    get "/search/apps", params
-    assert_equal 200, last_response.status # schema expect integer but we don't convert string to integer, so 400
-  end
-
-  it "passes given a nested datetime and with coerce_recursive=true and coerce_date_times=true on POST endpoint" do
-    key_name = "update_time"
-    params = {
-        key_name => "2016-04-01T16:00:00.000+09:00",
-        "array_property" => ARRAY_PROPERTY
-    }
-
-    check_parameter = lambda { |env|
-      hash = env['committee.params']
-      assert_equal DateTime, hash['array_property'].first['update_time'].class
-      assert_equal 1, hash['array_property'].first['per_page']
-      assert_equal DateTime, hash['array_property'].first['nested_coercer_object']['update_time'].class
-      assert_equal 1, hash['array_property'].first['nested_no_coercer_object']['per_page']
-      assert_equal 2, hash['array_property'].first['integer_array'][1]
-      assert_equal DateTime, hash['array_property'].first['datetime_array'][0].class
-      assert_equal DateTime, env['committee.params'][key_name].class
-      [200, {}, []]
-    }
-
-    @app = new_rack_app_with_lambda(check_parameter, coerce_date_times: true, coerce_recursive: true, schema: hyper_schema)
-
-    header "Content-Type", "application/json"
-    post "/apps", JSON.generate(params)
-    assert_equal 200, last_response.status
-  end
-
   it "passes given a nested datetime and with coerce_recursive=true and coerce_date_times=true on POST endpoint" do
-    key_name = "update_time"
     params = {
-        key_name => "2016-04-01T16:00:00.000+09:00",
-        "array_property" => ARRAY_PROPERTY
-    }
-
-    check_parameter = lambda { |env|
-      hash = env['committee.params']
-      assert_equal String, hash['array_property'].first['update_time'].class
-      assert_equal 1, hash['array_property'].first['per_page']
-      assert_equal String, hash['array_property'].first['nested_coercer_object']['update_time'].class
-      assert_equal 1, hash['array_property'].first['nested_no_coercer_object']['per_page']
-      assert_equal 2, hash['array_property'].first['integer_array'][1]
-      assert_equal String, hash['array_property'].first['datetime_array'][0].class
-      assert_equal String, env['committee.params'][key_name].class
-      [200, {}, []]
-    }
-
-    @app = new_rack_app_with_lambda(check_parameter, schema: hyper_schema)
-
-    header "Content-Type", "application/json"
-    post "/apps", JSON.generate(params)
-    assert_equal 200, last_response.status
-  end
-
-  it "passes given a nested datetime and with coerce_recursive=false and coerce_date_times=true on POST endpoint" do
-    key_name = "update_time"
-    params = {
-        key_name => "2016-04-01T16:00:00.000+09:00",
-        "array_property" => ARRAY_PROPERTY
-    }
-
-    check_parameter = lambda { |env|
-      hash = env['committee.params']
-      assert_equal String, hash['array_property'].first['update_time'].class
-      assert_equal 1, hash['array_property'].first['per_page']
-      assert_equal String, hash['array_property'].first['nested_coercer_object']['update_time'].class
-      assert_equal 1, hash['array_property'].first['nested_no_coercer_object']['per_page']
-      assert_equal 2, hash['array_property'].first['integer_array'][1]
-      assert_equal String, hash['array_property'].first['datetime_array'][0].class
-      assert_equal DateTime, env['committee.params'][key_name].class
-      [200, {}, []]
-    }
-
-    @app = new_rack_app_with_lambda(check_parameter, coerce_date_times: true, coerce_recursive: false, schema: hyper_schema)
-
-    header "Content-Type", "application/json"
-    post "/apps", JSON.generate(params)
-    assert_equal 200, last_response.status
-  end
-
-
-  it "OpenAPI3 passes given a nested datetime and with coerce_recursive=false and coerce_date_times=false on POST endpoint" do
-    key_name = "update_time"
-    params = {
-        key_name => "2016-04-01T16:00:00.000+09:00",
-        "array_property" => ARRAY_PROPERTY
+        "nested_array" => [
+            {
+                "update_time" => "2016-04-01T16:00:00.000+09:00",
+                "per_page" => 1,
+                "nested_coercer_object" => {
+                    "update_time" => "2016-04-01T16:00:00.000+09:00",
+                    "threshold" => 1.5
+                },
+                "nested_no_coercer_object" => {
+                    "per_page" => 1,
+                    "threshold" => 1.5
+                },
+                "nested_coercer_array" => [
+                    {
+                        "update_time" => "2016-04-01T16:00:00.000+09:00",
+                        "threshold" => 1.5
+                    }
+                ],
+                "nested_no_coercer_array" => [
+                    {
+                        "per_page" => 1,
+                        "threshold" => 1.5
+                    }
+                ],
+                "integer_array" => [
+                    1, 2, 3
+                ],
+                "datetime_array" => [
+                    "2016-04-01T16:00:00.000+09:00",
+                    "2016-04-01T17:00:00.000+09:00",
+                    "2016-04-01T18:00:00.000+09:00"
+                ]
+            },
+            {
+                "update_time" => "2016-04-01T16:00:00.000+09:00",
+                "per_page" => 1,
+                "threshold" => 1.5
+            },
+            {
+                "threshold" => 1.5,
+                "per_page" => 1
+            }
+        ]
     }
 
     check_parameter = lambda { |env|
       hash = env['committee.params']
-      assert_equal String, hash['array_property'].first['update_time'].class
-      assert_equal 1, hash['array_property'].first['per_page']
-      assert_equal String, hash['array_property'].first['nested_coercer_object']['update_time'].class
-      assert_equal 1, hash['array_property'].first['nested_no_coercer_object']['per_page']
-      assert_equal 2, hash['array_property'].first['integer_array'][1]
-      assert_equal String, hash['array_property'].first['datetime_array'][0].class
-      assert_equal String, env['committee.params'][key_name].class
+      array = hash['nested_array']
+
+      assert_equal DateTime, array.first['update_time'].class
+      assert_equal 1, array.first['per_page']
+      assert_equal DateTime, array.first['nested_coercer_object']['update_time'].class
+      assert_equal 1, array.first['nested_no_coercer_object']['per_page']
+      assert_equal 2, array.first['integer_array'][1]
+      assert_equal DateTime, array.first['datetime_array'][0].class
       [200, {}, []]
     }
 
-    @app = new_rack_app_with_lambda(check_parameter, open_api_3: open_api_3_schema)
+    @app = new_rack_app_with_lambda(check_parameter,
+                                    coerce_date_times: true,
+                                    schema: open_api_3_schema)
 
     header "Content-Type", "application/json"
-    post "/apps", JSON.generate(params)
+    post "/string_params_coercer", JSON.generate(params)
     assert_equal 200, last_response.status
   end
-=end
 
   it "OpenAPI3 detects an invalid request" do
-    @app = new_rack_app(open_api_3: open_api_3_schema, strict: true)
+    @app = new_rack_app(schema: open_api_3_schema, strict: true)
     header "Content-Type", "application/json"
     params = {
         "string_post_1" => 1
@@ -316,7 +217,7 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "rescues JSON errors" do
-    @app = new_rack_app(open_api_3: open_api_3_schema)
+    @app = new_rack_app(schema: open_api_3_schema)
     header "Content-Type", "application/json"
     post "/apps", "{x:y}"
     assert_equal 400, last_response.status
@@ -324,7 +225,7 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "take a prefix" do
-    @app = new_rack_app(prefix: "/v1", open_api_3: open_api_3_schema)
+    @app = new_rack_app(prefix: "/v1", schema: open_api_3_schema)
     params = {
         "string_post_1" => "cloudnasium"
     }
@@ -333,147 +234,104 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  it "take a prefix with invalid data" do
+    @app = new_rack_app(prefix: "/v1", schema: open_api_3_schema)
+    params = {
+        "string_post_1" => 1
+    }
+    header "Content-Type", "application/json"
+    post "/v1/characters", JSON.generate(params)
+    assert_equal 400, last_response.status
+    assert_match(/1 class is/i, last_response.body)
+  end
+
   it "ignores paths outside the prefix" do
-    @app = new_rack_app(prefix: "/v1", open_api_3: open_api_3_schema)
-    header "Content-Type", "text/html"
-    get "/hello"
+    @app = new_rack_app(prefix: "/v1", schema: open_api_3_schema)
+    params = {
+        "string_post_1" => 1
+    }
+    header "Content-Type", "application/json"
+    post "/characters", JSON.generate(params)
+    assert_equal 200, last_response.status
+  end
+
+  it "don't check prefix with no option" do
+    @app = new_rack_app(schema: open_api_3_schema)
+    params = {
+        "string_post_1" => 1
+    }
+    header "Content-Type", "application/json"
+    post "/v1/characters", JSON.generate(params)
     assert_equal 200, last_response.status
   end
 
   it "OpenAPI3 pass not exist href" do
-    @app = new_rack_app(open_api_3: open_api_3_schema)
+    @app = new_rack_app(schema: open_api_3_schema)
     get "/unknown"
     assert_equal 200, last_response.status
   end
 
   it "OpenAPI3 pass not exist href in strict mode" do
-    @app = new_rack_app(open_api_3: open_api_3_schema, strict: true)
+    @app = new_rack_app(schema: open_api_3_schema, strict: true)
     get "/unknown"
     assert_equal 404, last_response.status
   end
 
   it "optionally raises an error" do
-    @app = new_rack_app(raise: true, open_api_3: open_api_3_schema)
+    @app = new_rack_app(raise: true, schema: open_api_3_schema)
     header "Content-Type", "application/json"
     assert_raises(Committee::InvalidRequest) do
       post "/characters", "{x:y}"
     end
   end
 
-  # TODO: support check_content_type
-  it "OpenAPI not support check_content_type" do
-    @app = new_rack_app(open_api_3: open_api_3_schema, check_content_type: true)
-
-    e = assert_raises(RuntimeError) {
-      post "/characters", {}
-    }
-
-    assert_equal 'OpenAPI3 not support @check_content_type option', e.message
-  end
-=begin
-  it "optionally content_type check" do
-    @app = new_rack_app(check_content_type: true, open_api_3: open_api_3_schema)
-    params = {
-        "string_post_1" => "cloudnasium"
-    }
-    header "Content-Type", "text/html"
-    post "/characters", JSON.generate(params)
-    assert_equal 400, last_response.status
-  end
-=end
-
-  it "optionally skip content_type check" do
-    @app = new_rack_app(check_content_type: false, open_api_3: open_api_3_schema)
-    params = {
-      "string_post_1" => "cloudnasium"
-    }
-    header "Content-Type", "text/html"
-    post "/characters", JSON.generate(params)
-    assert_equal 200, last_response.status
-  end
-
   it "optionally coerces query params" do
-    @app = new_rack_app(coerce_query_params: true, open_api_3: open_api_3_schema)
+    @app = new_rack_app(coerce_query_params: true, schema: open_api_3_schema)
     header "Content-Type", "application/json"
     get "/string_params_coercer", {"integer_1" => "1"}
     assert_equal 200, last_response.status
   end
 
-=begin
   it "still raises an error if query param coercion is not possible" do
-    @app = new_rack_app(coerce_query_params: true, schema: hyper_schema)
+    @app = new_rack_app(coerce_query_params: false, schema: open_api_3_schema)
     header "Content-Type", "application/json"
-    get "/search/apps", {"per_page" => "foo", "query" => "cloudnasium"}
+    get "/string_params_coercer", {"integer_1" => "1"}
+
     assert_equal 400, last_response.status
-    assert_match(/invalid request/i, last_response.body)
+    assert_match(/1 class/i, last_response.body)
   end
 
-  it "passes through a valid request for OpenAPI" do
+  it "passes through a valid request for OpenAPI3" do
     check_parameter = lambda { |env|
       assert_equal 3, env['rack.request.query_hash']['limit']
       [200, {}, []]
     }
 
-    @app = new_rack_app_with_lambda(check_parameter, schema: open_api_2_schema)
-    get "/api/pets?limit=3", nil, { "HTTP_AUTH_TOKEN" => "xxx" }
+    @app = new_rack_app_with_lambda(check_parameter, schema: open_api_3_schema)
+    get "/characters?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", nil, { "HTTP_AUTH_TOKEN" => "xxx" }
-    assert_equal 400, last_response.status
-    assert_match(/invalid request/i, last_response.body)
-  end
+    @app = new_rack_app(schema: open_api_3_schema)
+    get "/characters?limit=foo"
 
-  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)
+    assert_match(/foo class/i, last_response.body)
   end
-=end
-
-  describe "coerce_path_params" do
-    it "coerce string to integer" do
-      check_parameter_string = lambda { |env|
-        assert env['committee.params']['integer'].is_a?(Integer)
-        [200, {}, []]
-      }
 
-      @app = new_rack_app_with_lambda(check_parameter_string, open_api_3: open_api_3_schema, coerce_path_params: true)
-      get "/coerce_path_params/1"
-    end
-
-    # TODO: support parameter validation
-    it "path parameter validation" do
-      @app = new_rack_app(open_api_3: open_api_3_schema, coerce_path_params: false)
-      get "/coerce_path_params/1"
+  it "coerce string to integer" do
+    check_parameter_string = lambda { |env|
+      assert env['committee.params']['integer'].is_a?(Integer)
+      [200, {}, []]
+    }
 
-      assert true
-    end
-=begin
-    it "path parameter validation" do
-      @app = new_rack_app_with_lambda(check_parameter_string, open_api_3: open_api_3_schema, coerce_path_params: false)
-      e = assert_raises(RuntimeError) {
-        get "/coerce_path_params/1"
-      }
-
-      assert_equal 'OpenAPI3 not support @coerce_query_params option', e.message
-    end
-=end
+    @app = new_rack_app_with_lambda(check_parameter_string, schema: open_api_3_schema, coerce_path_params: true)
+    get "/coerce_path_params/1"
   end
 
   it "OpenAPI3 raise not support method" do
-    @app = new_rack_app(open_api_3: open_api_3_schema)
+    @app = new_rack_app(schema: open_api_3_schema)
 
     e = assert_raises(RuntimeError) {
       head "/characters", {}
@@ -482,6 +340,25 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 'Committee OpenAPI3 not support head method', e.message
   end
 
+  describe 'check header' do
+    it 'no required header' do
+      @app = new_rack_app(schema: open_api_3_schema, check_header: true)
+
+      get "/header"
+
+      assert_equal 400, last_response.status
+      assert_match(/required parameters integer not exist/i, last_response.body)
+    end
+
+    it 'no required header but not check' do
+      @app = new_rack_app(schema: open_api_3_schema, check_header: false)
+
+      get "/header"
+
+      assert_equal 200, last_response.status
+    end
+  end
+
   private
 
   def new_rack_app(options = {})

data/test/middleware/request_validation_test.rb

@@ -374,23 +374,38 @@ describe Committee::Middleware::RequestValidation do
   end
 
   it "OpenAPI3 pass through a valid request" do
-    @app = new_rack_app(open_api_3: open_api_3_schema)
+    @app = new_rack_app(schema: open_api_3_schema)
     get "/characters"
     assert_equal 200, last_response.status
   end
 
   it "OpenAPI3 pass not exist href" do
-    @app = new_rack_app(open_api_3: open_api_3_schema)
+    @app = new_rack_app(schema: open_api_3_schema)
     get "/unknown"
     assert_equal 200, last_response.status
   end
 
   it "OpenAPI3 pass not exist href in strict mode" do
-    @app = new_rack_app(open_api_3: open_api_3_schema, strict: true)
+    @app = new_rack_app(schema: open_api_3_schema, strict: true)
     get "/unknown"
     assert_equal 404, last_response.status
   end
 
+  it "not exist path and options" do
+    options = {
+        coerce_form_params: true,
+        coerce_date_times: true,
+        coerce_query_params: true,
+        coerce_path_params: true,
+        coerce_recursive: true
+    }
+
+    @app = new_rack_app({schema: hyper_schema}.merge(options))
+    header "Content-Type", "application/x-www-form-urlencoded"
+    post "/unknown"
+    assert_equal 200, last_response.status
+  end
+
   private
 
   def new_rack_app(options = {})