rack-json_schema 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 276eb5729514a350ea04991833eb262d34ed663b
-  data.tar.gz: c9d398ae44ccc2ca33813fb210830552e81a876b
+  metadata.gz: 71834752a3561e3bf63a60884a2335f172cc58ff
+  data.tar.gz: d631e1916036d2c632611d7f49571283cf01d069
 SHA512:
-  metadata.gz: a1edd0f145b7b97ee5364e6c3e358df7ae21a47f93c6037c3411a69bf178880867347f446d510186888d8b0b1afc6da178ab5904bdd176336fc509655bbd3782
-  data.tar.gz: 2bd34182a08c20b032c55634413bb67746f53f35b61befa6d9e41a5569c01d6ad652f8a948551729ef47a3950a26140c11aa2de70192b3447946596948fda048
+  metadata.gz: 3496d7e180b999cfb6350ea7db3cfc12ca0f060390ba2715e72eb378cdcf0c52d850a42cc8eec6601dd79381f87f7578f3787520d9ab023066db284651146fc7
+  data.tar.gz: da8d31beb10245571b67fb7e955ee4fb9ffd1ce6ee35d46f47dd6e4ad2c65fa3bdf4c6b069bf62a3f509973d834a7786e867a6b63e971a0aa38ecee0729130c3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.5.0
+- Separate :strict option into 2 other options
+
 ## 1.4.0
 - Allow non JSON Content-Type response on empty body
 

data/lib/rack/json_schema/request_validation.rb

@@ -3,19 +3,26 @@ module Rack
     class RequestValidation
       # Behaves as a rack-middleware
       # @param app [Object] Rack application
+      # @param ignore_invalid_content_type [false, true] Ignore requests with non json content-type
+      # @param ignore_missing_path [false, true] Ignore requests not defined in schema
       # @param schema [Hash] Schema object written in JSON schema format
-      # @param strict [Boolean] Strict mode or not (default: true)
       # @raise [JsonSchema::SchemaError]
-      def initialize(app, schema: nil, strict: nil)
+      def initialize(app, ignore_invalid_content_type: false, ignore_missing_path: false, schema: nil)
         @app = app
+        @ignore_invalid_content_type = ignore_invalid_content_type
+        @ignore_missing_path = ignore_missing_path
         @schema = Schema.new(schema)
-        @strict = strict
       end
 
       # @raise [Rack::JsonSchema::RequestValidation::Error] Raises if given request is invalid to JSON Schema
       # @param env [Hash] Rack env
       def call(env)
-        Validator.call(env: env, schema: @schema, strict: @strict)
+        Validator.call(
+          env: env,
+          ignore_invalid_content_type: @ignore_invalid_content_type,
+          ignore_missing_path: @ignore_missing_path,
+          schema: @schema
+        )
         @app.call(env)
       end
 
@@ -26,12 +33,14 @@ module Rack
         end
 
         # @param env [Hash] Rack env
+        # @param ignore_invalid_content_type [false, true]
+        # @param ignore_missing_path [false, true]
         # @param schema [JsonSchema::Schema] Schema object
-        # @param strict [Boolean] Strict mode or not (default: true)
-        def initialize(env: nil, schema: nil, strict: nil)
+        def initialize(env: nil, ignore_invalid_content_type: false, ignore_missing_path: false, schema: nil)
           @env = env
+          @ignore_invalid_content_type = ignore_invalid_content_type
+          @ignore_missing_path = ignore_missing_path
           @schema = schema
-          @strict = strict
         end
 
         # Raises an error if any error detected
@@ -39,7 +48,7 @@ module Rack
         def call
           if has_link_for_current_action?
             if has_body? && !has_valid_content_type?
-              if strict?
+              unless ignore_invalid_content_type?
                 raise InvalidContentType
               end
             else
@@ -50,7 +59,7 @@ module Rack
                 raise InvalidParameter, "Invalid request.\n#{schema_validation_error_message}"
               end
             end
-          elsif strict?
+          elsif !ignore_missing_path?
             raise LinkNotFound, "Could not find the link definition for request path #{path}."
           end
         end
@@ -84,6 +93,16 @@ module Rack
           mime_type.nil? || Rack::Mime.match?(link.enc_type, mime_type)
         end
 
+        # @return [false, true]
+        def ignore_invalid_content_type?
+          !!@ignore_invalid_content_type
+        end
+
+        # @return [false, true]
+        def ignore_missing_path?
+          !!@ignore_missing_path
+        end
+
         # @return [true, false] True if the current link supports json format
         def content_type_json?
           Rack::Mime.match?(link.enc_type, "application/json")
@@ -142,11 +161,6 @@ module Rack
         def parameters_from_query
           request.GET
         end
-
-        # @return [Boolean] Strict mode or not.
-        def strict?
-          @strict != false
-        end
       end
 
       # Base error class for Rack::JsonSchema::RequestValidation

data/lib/rack/json_schema/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module JsonSchema
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

data/spec/rack/spec_spec.rb

@@ -5,12 +5,13 @@ describe Rack::JsonSchema do
 
   let(:app) do
     local_schema = schema
-    local_strict = strict
+    local_ignore_invalid_content_type = ignore_invalid_content_type
+    local_ignore_missing_path = ignore_missing_path
     local_response_body = response_body
     local_response_headers = response_headers
     Rack::Builder.app do
       use Rack::JsonSchema::ErrorHandler
-      use Rack::JsonSchema::RequestValidation, schema: local_schema, strict: local_strict
+      use Rack::JsonSchema::RequestValidation, ignore_invalid_content_type: local_ignore_invalid_content_type, ignore_missing_path: local_ignore_missing_path, schema: local_schema
       use Rack::JsonSchema::ResponseValidation, schema: local_schema
       run ->(env) do
         [200, local_response_headers, [local_response_body]]
@@ -46,8 +47,12 @@ describe Rack::JsonSchema do
     File.expand_path("../../fixtures/schema.json", __FILE__)
   end
 
-  let(:strict) do
-    true
+  let(:ignore_invalid_content_type) do
+    false
+  end
+
+  let(:ignore_missing_path) do
+    false
   end
 
   let(:response) do
@@ -94,14 +99,18 @@ describe Rack::JsonSchema do
       "/apps"
     end
 
+    shared_context "with undefined route" do
+      let(:path) do
+        "/undefined"
+      end
+    end
+
     context "with defined route" do
       it { should == 200 }
     end
 
     context "with undefined route" do
-      let(:path) do
-        "/undefined"
-      end
+      include_context "with undefined route"
 
       it "returns link_not_found error" do
         should == 404
@@ -112,6 +121,16 @@ describe Rack::JsonSchema do
       end
     end
 
+    context "with undefined route and ignore_missing_path option" do
+      include_context "with undefined route"
+
+      let(:ignore_missing_path) do
+        true
+      end
+
+      it { should == 200 }
+    end
+
     context "with request body & invalid content type", :with_valid_post_request do
       before do
         env["CONTENT_TYPE"] = "text/plain"
@@ -124,15 +143,15 @@ describe Rack::JsonSchema do
           message: "Invalid content type",
         )
       end
+    end
 
-      context "when strict is false" do
-        let(:strict) do
-          false
-        end
+    context "with request body & invalid content type and ignore_invalid_content_type option" do
+      let(:ignore_invalid_content_type) do
+        true
+      end
 
-        it "skips content_type check" do
-          should == 200
-        end
+      it "skips content_type check" do
+        should == 200
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-json_schema
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis