committee 1.15.0 → 5.0.0

data/lib/committee/middleware/response_validation.rb

@@ -1,35 +1,58 @@
-module Committee::Middleware
-  class ResponseValidation < Base
-    attr_reader :validate_errors
+# frozen_string_literal: true
 
-    def initialize(app, options = {})
-      super
-      @validate_errors = options[:validate_errors]
-    end
+module Committee
+  module Middleware
+    class ResponseValidation < Base
+      attr_reader :validate_success_only
+
+      def initialize(app, options = {})
+        super
+        @strict = options[:strict]
+        @validate_success_only = @schema.validator_option.validate_success_only
+      end
+
+      def handle(request)
+        status, headers, response = @app.call(request.env)
+
+        begin
+          v = build_schema_validator(request)
+          v.response_validate(status, headers, response, @strict) if v.link_exist? && self.class.validate?(status, validate_success_only)
+
+        rescue Committee::InvalidResponse
+          handle_exception($!, request.env)
 
-    def handle(request)
-      status, headers, response = @app.call(request.env)
+          raise if @raise
+          return @error_class.new(500, :invalid_response, $!.message).render unless @ignore_error
+        rescue JSON::ParserError
+          handle_exception($!, request.env)
 
-      if validate?(status) && link = @router.find_request_link(request)
-        full_body = ""
-        response.each do |chunk|
-          full_body << chunk
+          raise Committee::InvalidResponse if @raise
+          return @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render unless @ignore_error
         end
-        data = JSON.parse(full_body)
-        Committee::ResponseValidator.new(link, validate_errors: validate_errors).call(status, headers, data)
+
+        [status, headers, response]
       end
 
-      [status, headers, response]
-    rescue Committee::InvalidResponse
-      raise if @raise
-      @error_class.new(500, :invalid_response, $!.message).render
-    rescue JSON::ParserError
-      raise Committee::InvalidResponse if @raise
-      @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render
-    end
+      class << self
+        def validate?(status, validate_success_only)
+          case status
+          when 204
+            false
+          when 200..299
+            true
+          when 304
+            false
+          else
+            !validate_success_only
+          end
+        end
+      end
+
+      private
 
-    def validate?(status)
-      Committee::ResponseValidator.validate?(status, validate_errors: validate_errors)
+      def handle_exception(e, env)
+        @error_handler.call(e, env) if @error_handler
+      end
     end
   end
 end

data/lib/committee/middleware/stub.rb

@@ -1,49 +1,74 @@
-module Committee::Middleware
-  class Stub < Base
-    def initialize(app, options={})
-      super
-      @cache = {}
-      @call  = options[:call]
-    end
+# frozen_string_literal: true
 
-    def handle(request)
-      if link = @router.find_request_link(request)
-        headers = { "Content-Type" => "application/json" }
-        data = cache(link.method, link.href) do
-          Committee::ResponseGenerator.new.call(link)
-        end
-        if @call
-          request.env["committee.response"] = data
-          call_status, call_headers, call_body = @app.call(request.env)
+# Stub is not yet supported in OpenAPI 3
+
+module Committee
+  module Middleware
+    class Stub < Base
+      def initialize(app, options={})
+        super
+
+        # A bug in Committee's cache implementation meant that it wasn't working
+        # for a very long time, even for people who thought they were taking
+        # advantage of it. I repaired the caching feature, but have disable it by
+        # default so that we don't need to introduce any class-level variables
+        # that could have memory leaking implications. To enable caching, just
+        # pass an empty hash to this option.
+        @cache = options[:cache]
+
+        @call = options[:call]
+
+        raise Committee::OpenAPI3Unsupported.new("Stubs are not yet supported for OpenAPI 3") unless @schema.supports_stub?
+      end
+
+      def handle(request)
+        link, _ = @router.find_request_link(request)
+        if link
+          headers = { "Content-Type" => "application/json" }
 
-          # a committee.suppress signal initiates a direct pass through
-          if request.env["committee.suppress"] == true
-            return call_status, call_headers, call_body
+          data, schema = cache(link) do
+            Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
           end
 
-          # otherwise keep the headers and whatever data manipulations were
-          # made, and stub normally
-          headers.merge!(call_headers)
+          if @call
+            request.env["committee.response"] = data
+            request.env["committee.response_schema"] = schema
+            call_status, call_headers, call_body = @app.call(request.env)
 
-          # allow allow the handler to change the data object (if unchanged, it
-          # will be the same one that we set above)
-          data = request.env["committee.response"]
+            # a committee.suppress signal initiates a direct pass through
+            if request.env["committee.suppress"] == true
+              return call_status, call_headers, call_body
+            end
+
+            # otherwise keep the headers and whatever data manipulations were
+            # made, and stub normally
+            headers.merge!(call_headers)
+
+            # allow the handler to change the data object (if unchanged, it
+            # will be the same one that we set above)
+            data = request.env["committee.response"]
+          end
+
+          [link.status_success, headers, [JSON.pretty_generate(data)]]
+        else
+          @app.call(request.env)
         end
-        status = link.rel == "create" ? 201 : 200
-        [status, headers, [JSON.pretty_generate(data)]]
-      else
-        @app.call(request.env)
       end
-    end
 
-    private
+      private
+
+      def cache(link)
+        return yield unless @cache
 
-    def cache(method, href)
-      key = "#{method}+#{href}"
-      if @cache[key]
-        @cache[key]
-      else
-        @cache[key] = yield
+        # Just the object ID is enough to uniquely identify the link, but store
+        # the method and href so that we can more easily introspect the cache if
+        # necessary.
+        key = "#{link.object_id}##{link.method}+#{link.href}"
+        if @cache[key]
+          @cache[key]
+        else
+          @cache[key] = yield
+        end
       end
     end
   end

data/lib/committee/middleware.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Committee
+  module Middleware
+  end
+end
+
+require_relative "middleware/base"
+require_relative "middleware/request_validation"
+require_relative "middleware/response_validation"
+require_relative "middleware/stub"

data/lib/committee/request_unpacker.rb

@@ -1,83 +1,91 @@
+# frozen_string_literal: true
+
 module Committee
   class RequestUnpacker
-    def initialize(request, options={})
-      @request = request
+    class << self
+      # Enable string or symbol key access to the nested params hash.
+      #
+      # (Copied from Sinatra)
+      def indifferent_params(object)
+        case object
+        when Hash
+          new_hash = Committee::Utils.indifferent_hash
+          object.each { |key, value| new_hash[key] = indifferent_params(value) }
+          new_hash
+        when Array
+          object.map { |item| indifferent_params(item) }
+        else
+          object
+        end
+      end
+    end
 
+    def initialize(options={})
       @allow_form_params  = options[:allow_form_params]
+      @allow_get_body     = options[:allow_get_body]
       @allow_query_params = options[:allow_query_params]
       @optimistic_json    = options[:optimistic_json]
     end
 
-    def call
+    # return params and is_form_params
+    def unpack_request_params(request)
       # if Content-Type is empty or JSON, and there was a request body, try to
       # interpret it as JSON
-      params = if !@request.media_type || @request.media_type =~ %r{application/.*json}
-        parse_json
+      params = if !request.media_type || request.media_type =~ %r{application/(?:.*\+)?json}
+        parse_json(request)
       elsif @optimistic_json
         begin
-          parse_json
+          parse_json(request)
         rescue JSON::ParserError
           nil
         end
       end
 
-      params = if params
-        params
-      elsif @allow_form_params && @request.media_type == "application/x-www-form-urlencoded"
+      return [params, false] if params
+
+      if @allow_form_params && %w[application/x-www-form-urlencoded multipart/form-data].include?(request.media_type)
         # Actually, POST means anything in the request body, could be from
         # PUT or PATCH too. Silly Rack.
-        indifferent_params(@request.POST)
-      else
-        {}
+        return [request.POST, true] if request.POST
       end
 
-      if @allow_query_params
-        indifferent_params(@request.GET).merge(params)
-      else
-        params
-      end
+      [{}, false]
     end
 
-    private
-
-    # Creates a Hash with indifferent access.
-    #
-    # (Copied from Sinatra)
-    def indifferent_hash
-      Hash.new { |hash,key| hash[key.to_s] if Symbol === key }
+    def unpack_query_params(request)
+      @allow_query_params ? self.class.indifferent_params(request.GET) : {}
     end
 
-    # Enable string or symbol key access to the nested params hash.
-    #
-    # (Copied from Sinatra)
-    def indifferent_params(object)
-      case object
-      when Hash
-        new_hash = indifferent_hash
-        object.each { |key, value| new_hash[key] = indifferent_params(value) }
-        new_hash
-      when Array
-        object.map { |item| indifferent_params(item) }
-      else
-        object
+    def unpack_headers(request)
+      env = request.env
+      base = env.keys.grep(/HTTP_/).inject({}) do |headers, key|
+        headerized_key = key.gsub(/^HTTP_/, '').gsub(/_/, '-')
+        headers[headerized_key] = env[key]
+        headers
       end
+
+      base['Content-Type'] = env['CONTENT_TYPE'] if env['CONTENT_TYPE']
+      base
     end
 
-    def parse_json
-      if (body = @request.body.read).length != 0
-        @request.body.rewind
-        hash = JSON.parse(body)
-        # We want a hash specifically. '42', 42, and [42] will all be
-        # decoded properly, but we can't use them here.
-        if !hash.is_a?(Hash)
-          raise BadRequest,
-            "Invalid JSON input. Require object with parameters as keys."
-        end
-        indifferent_params(hash)
+    private
+
+    def parse_json(request)
+      return nil if request.request_method == "GET" && !@allow_get_body
+
+      body = request.body.read
       # if request body is empty, we just have empty params
-      else
-        nil
+      return nil if body.length == 0
+
+      request.body.rewind
+      hash = JSON.parse(body)
+      # We want a hash specifically. '42', 42, and [42] will all be
+      # decoded properly, but we can't use them here.
+      if !hash.is_a?(Hash)
+        raise BadRequest,
+              "Invalid JSON input. Require object with parameters as keys."
       end
+      self.class.indifferent_params(hash)
     end
   end
 end

data/lib/committee/schema_validator/hyper_schema/parameter_coercer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class HyperSchema
+      class ParameterCoercer
+        def initialize(params, schema, options = {})
+          @params = params
+          @schema = schema
+
+          @coerce_date_times = options.fetch(:coerce_date_times, false)
+          @coerce_recursive = options.fetch(:coerce_recursive, false)
+        end
+
+        def call!
+          coerce_object!(@params, @schema)
+        end
+
+        private
+
+          def coerce_object!(hash, schema)
+            return false unless schema.respond_to?(:properties)
+
+            is_coerced = false
+            schema.properties.each do |k, s|
+              original_val = hash[k]
+              unless original_val.nil?
+                new_value, is_changed = coerce_value!(original_val, s)
+                if is_changed
+                  hash[k] = new_value
+                  is_coerced = true
+                end
+              end
+            end
+
+            is_coerced
+          end
+
+          def coerce_value!(original_val, s)
+            s.type.each do |to_type|
+              if @coerce_date_times && to_type == "string" && s.format == "date-time"
+                coerced_val = parse_date_time(original_val)
+                return coerced_val, true if coerced_val
+              end
+
+              return original_val, true if @coerce_recursive && (to_type == "array") && coerce_array_data!(original_val, s)
+
+              return original_val, true if @coerce_recursive && (to_type == "object") && coerce_object!(original_val, s)
+            end
+            return nil, false
+          end
+
+          def coerce_array_data!(original_val, schema)
+            return false unless schema.respond_to?(:items)
+            return false unless original_val.is_a?(Array)
+
+            is_coerced = false
+            original_val.each_with_index do |d, index|
+              new_value, is_changed = coerce_value!(d, schema.items)
+              if is_changed
+                original_val[index] = new_value
+                is_coerced = true
+              end
+            end
+
+            is_coerced
+          end
+
+          def parse_date_time(original_val)
+            begin
+              DateTime.parse(original_val)
+            rescue ArgumentError => e
+              raise ::Committee::InvalidResponse unless e.message =~ /invalid date/
+            end
+          end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/hyper_schema/request_validator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class HyperSchema
+      class RequestValidator
+        def initialize(link, options = {})
+          @link = link
+          @check_content_type = options.fetch(:check_content_type, true)
+          @check_header = options.fetch(:check_header, true)
+        end
+
+        def call(request, params, headers)
+          check_content_type!(request, params) if @check_content_type
+          if @link.schema
+            valid, errors = @link.schema.validate(params)
+            if !valid
+              errors = JsonSchema::SchemaError.aggregate(errors).join("\n")
+              raise InvalidRequest, "Invalid request.\n\n#{errors}"
+            end
+          end
+
+          if @check_header && @link.respond_to?(:header_schema) && @link.header_schema
+            valid, errors = @link.header_schema.validate(headers)
+            if !valid
+              errors = JsonSchema::SchemaError.aggregate(errors).join("\n")
+              raise InvalidRequest, "Invalid request.\n\n#{errors}"
+            end
+          end
+        end
+
+        private
+
+        def check_content_type!(request, data)
+          content_type = ::Committee::SchemaValidator.request_media_type(request)
+          if content_type && @link.enc_type && !empty_request?(request)
+            unless Rack::Mime.match?(content_type, @link.enc_type)
+              raise Committee::InvalidRequest,
+                %{"Content-Type" request header must be set to "#{@link.enc_type}".}
+            end
+          end
+        end
+
+        def empty_request?(request)
+          # small optimization: assume GET and DELETE don't have bodies
+          return true if request.get? || request.delete? || !request.body
+
+          data = request.body.read
+          request.body.rewind
+          data.empty?
+        end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/hyper_schema/response_generator.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class HyperSchema
+      class ResponseGenerator
+        def call(link)
+          schema = target_schema(link)
+          data = generate_properties(link, schema)
+
+          # List is a special case; wrap data in an array.
+          #
+          # This is poor form that's here so as not to introduce breaking behavior.
+          # The "instances" value of "rel" is a Heroku-ism and was originally
+          # introduced before we understood how to use "targetSchema". It's not
+          # meaningful with the context of the hyper-schema specification and
+          # should be eventually be removed.
+          if legacy_hyper_schema_rel?(link)
+            data = [data]
+          end
+
+          [data, schema]
+        end
+
+        private
+
+        # These are basic types that are part of the JSON schema for which we'll
+        # emit zero values when generating a response. For a schema that allows
+        # multiple of the types in the list, types are preferred in the order in
+        # which they're defined.
+        SCALAR_TYPES = {
+          "boolean" => false,
+          "integer" => 0,
+          "number"  => 0.0,
+          "string"  => "",
+
+          # Prefer null last.
+          "null" => nil,
+        }.freeze
+
+        def generate_properties(link, schema)
+          # special example attribute was included; use its value
+          if schema.data && !schema.data["example"].nil?
+            schema.data["example"]
+
+          elsif !schema.all_of.empty? || !schema.properties.empty?
+            data = {}
+            schema.all_of.each do |subschema|
+              data.merge!(generate_properties(link, subschema))
+            end
+            schema.properties.map do |key, value|
+              data[key] = generate_properties(link, value)
+            end
+            data
+
+          elsif schema.type.include?("array") && !schema.items.nil?
+            [generate_properties(link, schema.items)]
+
+          elsif schema.enum
+            schema.enum.first
+
+          elsif schema.type.any? { |t| SCALAR_TYPES.include?(t) }
+            SCALAR_TYPES.each do |k, v|
+              break(v) if schema.type.include?(k)
+            end
+
+          # Generate an empty array for arrays.
+          elsif schema.type == ["array"]
+            []
+
+          # Schema is an object with no properties: just generate an empty object.
+          elsif schema.type == ["object"]
+            {}
+
+          else
+            raise(%{At "#{link.method} #{link.href}" "#{schema.pointer}": no } +
+              %{"example" attribute and "null" } +
+              %{is not allowed; don't know how to generate property.})
+          end
+        end
+
+        def legacy_hyper_schema_rel?(link)
+          link.is_a?(Committee::Drivers::HyperSchema::Link) &&
+            link.rel == "instances" &&
+            !link.target_schema
+        end
+
+        # Gets the target schema of a link. This is normally just the standard
+        # response schema, but we allow some legacy behavior for hyper-schema links
+        # tagged with rel=instances to instead use the schema of their parent
+        # resource.
+        def target_schema(link)
+          if link.target_schema
+            link.target_schema
+          elsif legacy_hyper_schema_rel?(link)
+            link.parent
+          end
+        end
+      end
+    end
+  end
+end

data/lib/committee/schema_validator/hyper_schema/response_validator.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Committee
+  module SchemaValidator
+    class HyperSchema
+      class ResponseValidator
+        attr_reader :validate_success_only
+
+        def initialize(link, options = {})
+          @link = link
+          @validate_success_only = options[:validate_success_only]
+
+          @validator = JsonSchema::Validator.new(target_schema(link))
+        end
+
+        def call(status, headers, data)
+          unless [204, 304].include?(status) # 204 No Content or 304 Not Modified
+            response = Rack::Response.new(data, status, headers)
+            check_content_type!(response)
+          end
+
+          # List is a special case; expect data in an array.
+          #
+          # This is poor form that's here so as not to introduce breaking behavior.
+          # The "instances" value of "rel" is a Heroku-ism and was originally
+          # introduced before we understood how to use "targetSchema". It's not
+          # meaningful with the context of the hyper-schema specification and
+          # should be eventually be removed.
+          if legacy_hyper_schema_rel?(@link)
+            if !data.is_a?(Array)
+              raise InvalidResponse, "List endpoints must return an array of objects."
+            end
+
+            # only consider the first object during the validation from here on
+            # (but only in cases where `targetSchema` is not set)
+            data = data[0]
+
+            # if the array was empty, allow it through
+            return if data == nil
+          end
+
+          if Committee::Middleware::ResponseValidation.validate?(status, validate_success_only) && !@validator.validate(data)
+            errors = JsonSchema::SchemaError.aggregate(@validator.errors).join("\n")
+            raise InvalidResponse, "Invalid response.\n\n#{errors}"
+          end
+        end
+
+        private
+
+        def response_media_type(response)
+          if response.respond_to?(:media_type)
+            response.media_type.to_s
+          else
+            # for rack compatibility. In rack v 1.5.0, Rack::Response doesn't have media_type
+            response.content_type.to_s.split(";").first.to_s
+          end
+        end
+
+
+        def check_content_type!(response)
+          if @link.media_type
+            unless Rack::Mime.match?(response_media_type(response), @link.media_type)
+              raise Committee::InvalidResponse,
+                %{"Content-Type" response header must be set to "#{@link.media_type}".}
+            end
+          end
+        end
+
+        def legacy_hyper_schema_rel?(link)
+          link.is_a?(Committee::Drivers::HyperSchema::Link) &&
+            link.rel == "instances" &&
+            !link.target_schema
+        end
+
+        # Gets the target schema of a link. This is normally just the standard
+        # response schema, but we allow some legacy behavior for hyper-schema links
+        # tagged with rel=instances to instead use the schema of their parent
+        # resource.
+        def target_schema(link)
+          if link.target_schema
+            link.target_schema
+          elsif legacy_hyper_schema_rel?(link)
+            link.parent
+          end
+        end
+      end
+    end
+  end
+end